2 * Copyright (c) 2008, 2009 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <arpa/inet.h>
26 #include "mac-learning.h"
29 #include "ofp-print.h"
32 #include "openflow/openflow.h"
34 #include "poll-loop.h"
40 #define THIS_MODULE VLM_in_band
43 #define IB_BASE_PRIORITY 18181800
46 IBR_FROM_LOCAL_PORT, /* Sent by the local port. */
47 IBR_OFP_TO_LOCAL, /* Sent to secure channel on local port. */
48 IBR_ARP_FROM_LOCAL, /* ARP from the local port. */
49 IBR_ARP_TO_LOCAL, /* ARP to the local port. */
50 IBR_ARP_FROM_CTL, /* ARP from the controller. */
51 IBR_TO_CTL_OFP_SRC, /* To controller, OpenFlow source port. */
52 IBR_TO_CTL_OFP_DST, /* To controller, OpenFlow dest port. */
53 IBR_FROM_CTL_OFP_SRC, /* From controller, OpenFlow source port. */
54 IBR_FROM_CTL_OFP_DST, /* From controller, OpenFlow dest port. */
55 #if OFP_TCP_PORT != OFP_SSL_PORT
56 #error Need to support separate TCP and SSL flows.
65 unsigned int priority;
69 struct ofproto *ofproto;
70 struct rconn *controller;
71 struct status_category *ss_cat;
73 /* Keeping track of controller's MAC address. */
74 uint32_t ip; /* Current IP, 0 if unknown. */
75 uint32_t last_ip; /* Last known IP, 0 if never known. */
76 uint8_t mac[ETH_ADDR_LEN]; /* Current MAC, 0 if unknown. */
77 uint8_t last_mac[ETH_ADDR_LEN]; /* Last known MAC, 0 if never known */
79 time_t next_refresh; /* Next time to refresh MAC address. */
81 /* Keeping track of the local port's MAC address. */
82 uint8_t local_mac[ETH_ADDR_LEN]; /* Current MAC. */
83 time_t next_local_refresh; /* Next time to refresh MAC address. */
85 /* Rules that we set up. */
86 struct ib_rule rules[N_IB_RULES];
89 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 60);
91 static const uint8_t *
92 get_controller_mac(struct in_band *ib)
94 time_t now = time_now();
95 uint32_t controller_ip;
97 controller_ip = rconn_get_remote_ip(ib->controller);
98 if (controller_ip != ib->ip || now >= ib->next_refresh) {
101 ib->ip = controller_ip;
103 /* Look up MAC address. */
104 memset(ib->mac, 0, sizeof ib->mac);
106 uint32_t local_ip = rconn_get_local_ip(ib->controller);
110 in4.s_addr = local_ip;
111 if (netdev_find_dev_by_in4(&in4, &ib->dev_name)) {
112 retval = netdev_nodev_arp_lookup(ib->dev_name, ib->ip,
115 VLOG_DBG_RL(&rl, "cannot look up controller MAC address "
117 IP_ARGS(&ib->ip), strerror(retval));
120 VLOG_DBG_RL(&rl, "cannot find device with IP address "IP_FMT,
124 have_mac = !eth_addr_is_zero(ib->mac);
126 /* Log changes in IP, MAC addresses. */
127 if (ib->ip && ib->ip != ib->last_ip) {
128 VLOG_DBG("controller IP address changed from "IP_FMT
129 " to "IP_FMT, IP_ARGS(&ib->last_ip), IP_ARGS(&ib->ip));
130 ib->last_ip = ib->ip;
132 if (have_mac && memcmp(ib->last_mac, ib->mac, ETH_ADDR_LEN)) {
133 VLOG_DBG("controller MAC address changed from "ETH_ADDR_FMT" to "
135 ETH_ADDR_ARGS(ib->last_mac), ETH_ADDR_ARGS(ib->mac));
136 memcpy(ib->last_mac, ib->mac, ETH_ADDR_LEN);
139 /* Schedule next refresh.
141 * If we have an IP address but not a MAC address, then refresh
142 * quickly, since we probably will get a MAC address soon (via ARP).
143 * Otherwise, we can afford to wait a little while. */
144 ib->next_refresh = now + (!ib->ip || have_mac ? 10 : 1);
146 return !eth_addr_is_zero(ib->mac) ? ib->mac : NULL;
149 static const uint8_t *
150 get_local_mac(struct in_band *ib)
152 time_t now = time_now();
153 if (now >= ib->next_local_refresh) {
154 uint8_t ea[ETH_ADDR_LEN];
155 if (ib->dev_name && (!netdev_nodev_get_etheraddr(ib->dev_name, ea))) {
156 memcpy(ib->local_mac, ea, ETH_ADDR_LEN);
158 ib->next_local_refresh = now + 1;
160 return !eth_addr_is_zero(ib->local_mac) ? ib->local_mac : NULL;
164 in_band_status_cb(struct status_reply *sr, void *in_band_)
166 struct in_band *in_band = in_band_;
168 if (!eth_addr_is_zero(in_band->local_mac)) {
169 status_reply_put(sr, "local-mac="ETH_ADDR_FMT,
170 ETH_ADDR_ARGS(in_band->local_mac));
173 if (!eth_addr_is_zero(in_band->mac)) {
174 status_reply_put(sr, "controller-mac="ETH_ADDR_FMT,
175 ETH_ADDR_ARGS(in_band->mac));
180 drop_flow(struct in_band *in_band, int rule_idx)
182 struct ib_rule *rule = &in_band->rules[rule_idx];
184 if (rule->installed) {
185 rule->installed = false;
186 ofproto_delete_flow(in_band->ofproto, &rule->flow, rule->wildcards,
191 /* out_port and fixed_fields are assumed never to change. */
193 setup_flow(struct in_band *in_band, int rule_idx, const flow_t *flow,
194 uint32_t fixed_fields, uint16_t out_port)
196 struct ib_rule *rule = &in_band->rules[rule_idx];
198 if (!rule->installed || memcmp(flow, &rule->flow, sizeof *flow)) {
199 union ofp_action action;
201 drop_flow(in_band, rule_idx);
203 rule->installed = true;
205 rule->wildcards = OFPFW_ALL & ~fixed_fields;
206 rule->priority = IB_BASE_PRIORITY + (N_IB_RULES - rule_idx);
208 action.type = htons(OFPAT_OUTPUT);
209 action.output.len = htons(sizeof action);
210 action.output.port = htons(out_port);
211 action.output.max_len = htons(0);
212 ofproto_add_flow(in_band->ofproto, &rule->flow, rule->wildcards,
213 rule->priority, &action, 1, 0);
218 in_band_run(struct in_band *in_band)
220 const uint8_t *controller_mac;
221 const uint8_t *local_mac;
224 if (time_now() < MIN(in_band->next_refresh, in_band->next_local_refresh)) {
228 /* NOTE: A router may sit between the switch and controller, so
229 * we could not tie this to the controller's MAC address. If the
230 * switch and controller are on different subnets, we should be
231 * using the router's MAC address in the 'controller_mac'. */
232 controller_mac = get_controller_mac(in_band);
233 local_mac = get_local_mac(in_band);
235 /* Switch traffic sent by the local port. */
236 memset(&flow, 0, sizeof flow);
237 flow.in_port = ODPP_LOCAL;
238 setup_flow(in_band, IBR_FROM_LOCAL_PORT, &flow, OFPFW_IN_PORT,
242 /* Deliver traffic sent over the secure channel to the connection's
244 memset(&flow, 0, sizeof flow);
245 flow.dl_type = htons(ETH_TYPE_IP);
246 memcpy(flow.dl_dst, local_mac, ETH_ADDR_LEN);
247 flow.nw_proto = IP_TYPE_TCP;
248 flow.tp_src = htons(OFP_TCP_PORT);
249 setup_flow(in_band, IBR_OFP_TO_LOCAL, &flow,
250 (OFPFW_DL_TYPE | OFPFW_DL_DST | OFPFW_NW_PROTO
251 | OFPFW_TP_SRC), OFPP_NORMAL);
253 /* Allow the connection's interface to be the source of ARP traffic. */
254 memset(&flow, 0, sizeof flow);
255 flow.dl_type = htons(ETH_TYPE_ARP);
256 memcpy(flow.dl_src, local_mac, ETH_ADDR_LEN);
257 setup_flow(in_band, IBR_ARP_FROM_LOCAL, &flow,
258 OFPFW_DL_TYPE | OFPFW_DL_SRC, OFPP_NORMAL);
260 /* Allow the connection's interface to receive directed ARP traffic. */
261 memset(&flow, 0, sizeof flow);
262 flow.dl_type = htons(ETH_TYPE_ARP);
263 memcpy(flow.dl_dst, local_mac, ETH_ADDR_LEN);
264 setup_flow(in_band, IBR_ARP_TO_LOCAL, &flow,
265 OFPFW_DL_TYPE | OFPFW_DL_DST, OFPP_NORMAL);
267 drop_flow(in_band, IBR_OFP_TO_LOCAL);
268 drop_flow(in_band, IBR_ARP_FROM_LOCAL);
269 drop_flow(in_band, IBR_ARP_TO_LOCAL);
272 if (controller_mac) {
273 /* Switch ARP requests sent by the controller. (OFPP_NORMAL will "do
274 * the right thing" regarding VLANs here.) */
275 memset(&flow, 0, sizeof flow);
276 flow.dl_type = htons(ETH_TYPE_ARP);
277 memcpy(flow.dl_dst, eth_addr_broadcast, ETH_ADDR_LEN);
278 memcpy(flow.dl_src, controller_mac, ETH_ADDR_LEN);
279 setup_flow(in_band, IBR_ARP_FROM_CTL, &flow,
280 OFPFW_DL_TYPE | OFPFW_DL_DST | OFPFW_DL_SRC,
283 /* OpenFlow traffic to or from the controller.
285 * (A given field's value is completely ignored if it is wildcarded,
286 * which is why we can get away with using a single 'flow' in each
288 memset(&flow, 0, sizeof flow);
289 flow.dl_type = htons(ETH_TYPE_IP);
290 memcpy(flow.dl_src, controller_mac, ETH_ADDR_LEN);
291 memcpy(flow.dl_dst, controller_mac, ETH_ADDR_LEN);
292 flow.nw_proto = IP_TYPE_TCP;
293 flow.tp_src = htons(OFP_TCP_PORT);
294 flow.tp_dst = htons(OFP_TCP_PORT);
295 setup_flow(in_band, IBR_TO_CTL_OFP_SRC, &flow,
296 (OFPFW_DL_TYPE | OFPFW_DL_DST | OFPFW_NW_PROTO
297 | OFPFW_TP_SRC), OFPP_NORMAL);
298 setup_flow(in_band, IBR_TO_CTL_OFP_DST, &flow,
299 (OFPFW_DL_TYPE | OFPFW_DL_DST | OFPFW_NW_PROTO
300 | OFPFW_TP_DST), OFPP_NORMAL);
301 setup_flow(in_band, IBR_FROM_CTL_OFP_SRC, &flow,
302 (OFPFW_DL_TYPE | OFPFW_DL_SRC | OFPFW_NW_PROTO
303 | OFPFW_TP_SRC), OFPP_NORMAL);
304 setup_flow(in_band, IBR_FROM_CTL_OFP_DST, &flow,
305 (OFPFW_DL_TYPE | OFPFW_DL_SRC | OFPFW_NW_PROTO
306 | OFPFW_TP_DST), OFPP_NORMAL);
308 drop_flow(in_band, IBR_ARP_FROM_CTL);
309 drop_flow(in_band, IBR_TO_CTL_OFP_DST);
310 drop_flow(in_band, IBR_TO_CTL_OFP_SRC);
311 drop_flow(in_band, IBR_FROM_CTL_OFP_DST);
312 drop_flow(in_band, IBR_FROM_CTL_OFP_SRC);
317 in_band_wait(struct in_band *in_band)
319 time_t now = time_now();
320 time_t wakeup = MIN(in_band->next_refresh, in_band->next_local_refresh);
322 poll_timer_wait((wakeup - now) * 1000);
324 poll_immediate_wake();
329 in_band_flushed(struct in_band *in_band)
333 for (i = 0; i < N_IB_RULES; i++) {
334 in_band->rules[i].installed = false;
339 in_band_create(struct ofproto *ofproto, struct switch_status *ss,
340 struct rconn *controller, struct in_band **in_bandp)
342 struct in_band *in_band;
344 in_band = xcalloc(1, sizeof *in_band);
345 in_band->ofproto = ofproto;
346 in_band->controller = controller;
347 in_band->ss_cat = switch_status_register(ss, "in-band",
348 in_band_status_cb, in_band);
349 in_band->next_refresh = TIME_MIN;
350 in_band->next_local_refresh = TIME_MIN;
351 in_band->dev_name = NULL;
357 in_band_destroy(struct in_band *in_band)
360 switch_status_unregister(in_band->ss_cat);
361 /* We don't own the rconn. */