2 * Copyright (c) 2008, 2009, 2010, 2011 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.
18 #include "learning-switch.h"
22 #include <netinet/in.h>
26 #include "byte-order.h"
27 #include "classifier.h"
30 #include "mac-learning.h"
32 #include "ofp-parse.h"
33 #include "ofp-print.h"
35 #include "openflow/openflow.h"
36 #include "poll-loop.h"
43 VLOG_DEFINE_THIS_MODULE(learning_switch);
46 struct hmap_node hmap_node; /* Hash node for port number. */
47 uint16_t port_no; /* OpenFlow port number, in host byte order. */
48 uint32_t queue_id; /* OpenFlow queue number. */
52 /* If nonnegative, the switch sets up flows that expire after the given
53 * number of seconds (or never expire, if the value is OFP_FLOW_PERMANENT).
54 * Otherwise, the switch processes every packet. */
57 unsigned long long int datapath_id;
58 time_t last_features_request;
59 struct mac_learning *ml; /* NULL to act as hub instead of switch. */
60 struct flow_wildcards wc; /* Wildcards to apply to flows. */
61 bool action_normal; /* Use OFPP_NORMAL? */
63 /* Queue distribution. */
64 uint32_t default_queue; /* Default OpenFlow queue, or UINT32_MAX. */
65 struct hmap queue_numbers; /* Map from port number to lswitch_port. */
66 struct shash queue_names; /* Map from port name to lswitch_port. */
68 /* Number of outgoing queued packets on the rconn. */
69 struct rconn_packet_counter *queued;
72 /* The log messages here could actually be useful in debugging, so keep the
73 * rate limit relatively high. */
74 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
76 static void queue_tx(struct lswitch *, struct rconn *, struct ofpbuf *);
77 static void send_features_request(struct lswitch *, struct rconn *);
79 static void process_switch_features(struct lswitch *,
80 struct ofp_switch_features *);
81 static void process_packet_in(struct lswitch *, struct rconn *,
82 const struct ofp_packet_in *);
83 static void process_echo_request(struct lswitch *, struct rconn *,
84 const struct ofp_header *);
86 /* Creates and returns a new learning switch whose configuration is given by
89 * 'rconn' is used to send out an OpenFlow features request. */
91 lswitch_create(struct rconn *rconn, const struct lswitch_config *cfg)
95 sw = xzalloc(sizeof *sw);
96 sw->max_idle = cfg->max_idle;
98 sw->last_features_request = time_now() - 1;
99 sw->ml = cfg->mode == LSW_LEARN ? mac_learning_create() : NULL;
100 sw->action_normal = cfg->mode == LSW_NORMAL;
102 flow_wildcards_init_exact(&sw->wc);
103 if (cfg->wildcards) {
106 if (cfg->wildcards == UINT32_MAX) {
107 /* Try to wildcard as many fields as possible, but we cannot
108 * wildcard all fields. We need in_port to detect moves. We need
109 * Ethernet source and dest and VLAN to do L2 learning. */
110 ofpfw = (OFPFW_DL_TYPE | OFPFW_NW_SRC_ALL | OFPFW_NW_DST_ALL
111 | OFPFW_NW_TOS | OFPFW_NW_PROTO
112 | OFPFW_TP_SRC | OFPFW_TP_DST);
114 ofpfw = cfg->wildcards;
117 ofputil_wildcard_from_openflow(ofpfw, &sw->wc);
120 sw->default_queue = cfg->default_queue;
121 hmap_init(&sw->queue_numbers);
122 shash_init(&sw->queue_names);
123 if (cfg->port_queues) {
124 struct shash_node *node;
126 SHASH_FOR_EACH (node, cfg->port_queues) {
127 struct lswitch_port *port = xmalloc(sizeof *port);
128 hmap_node_nullify(&port->hmap_node);
129 port->queue_id = (uintptr_t) node->data;
130 shash_add(&sw->queue_names, node->name, port);
134 sw->queued = rconn_packet_counter_create();
135 send_features_request(sw, rconn);
137 if (cfg->default_flows) {
138 const struct ofpbuf *b;
140 LIST_FOR_EACH (b, list_node, cfg->default_flows) {
141 struct ofpbuf *copy = ofpbuf_clone(b);
142 int error = rconn_send(rconn, copy, NULL);
144 VLOG_INFO_RL(&rl, "%s: failed to queue default flows (%s)",
145 rconn_get_name(rconn), strerror(error));
157 lswitch_destroy(struct lswitch *sw)
160 struct lswitch_port *node, *next;
162 HMAP_FOR_EACH_SAFE (node, next, hmap_node, &sw->queue_numbers) {
163 hmap_remove(&sw->queue_numbers, &node->hmap_node);
166 shash_destroy(&sw->queue_names);
167 mac_learning_destroy(sw->ml);
168 rconn_packet_counter_destroy(sw->queued);
173 /* Takes care of necessary 'sw' activity, except for receiving packets (which
174 * the caller must do). */
176 lswitch_run(struct lswitch *sw)
179 mac_learning_run(sw->ml, NULL);
184 lswitch_wait(struct lswitch *sw)
187 mac_learning_wait(sw->ml);
191 /* Processes 'msg', which should be an OpenFlow received on 'rconn', according
192 * to the learning switch state in 'sw'. The most likely result of processing
193 * is that flow-setup and packet-out OpenFlow messages will be sent out on
196 lswitch_process_packet(struct lswitch *sw, struct rconn *rconn,
197 const struct ofpbuf *msg)
199 const struct ofp_header *oh = msg->data;
200 const struct ofputil_msg_type *type;
202 if (sw->datapath_id == 0
203 && oh->type != OFPT_ECHO_REQUEST
204 && oh->type != OFPT_FEATURES_REPLY) {
205 send_features_request(sw, rconn);
209 ofputil_decode_msg_type(oh, &type);
210 switch (ofputil_msg_type_code(type)) {
211 case OFPUTIL_OFPT_ECHO_REQUEST:
212 process_echo_request(sw, rconn, msg->data);
215 case OFPUTIL_OFPT_FEATURES_REPLY:
216 process_switch_features(sw, msg->data);
219 case OFPUTIL_OFPT_PACKET_IN:
220 process_packet_in(sw, rconn, msg->data);
223 case OFPUTIL_OFPT_FLOW_REMOVED:
227 case OFPUTIL_INVALID:
228 case OFPUTIL_OFPT_HELLO:
229 case OFPUTIL_OFPT_ERROR:
230 case OFPUTIL_OFPT_ECHO_REPLY:
231 case OFPUTIL_OFPT_FEATURES_REQUEST:
232 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
233 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
234 case OFPUTIL_OFPT_SET_CONFIG:
235 case OFPUTIL_OFPT_PORT_STATUS:
236 case OFPUTIL_OFPT_PACKET_OUT:
237 case OFPUTIL_OFPT_FLOW_MOD:
238 case OFPUTIL_OFPT_PORT_MOD:
239 case OFPUTIL_OFPT_BARRIER_REQUEST:
240 case OFPUTIL_OFPT_BARRIER_REPLY:
241 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
242 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
243 case OFPUTIL_OFPST_DESC_REQUEST:
244 case OFPUTIL_OFPST_FLOW_REQUEST:
245 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
246 case OFPUTIL_OFPST_TABLE_REQUEST:
247 case OFPUTIL_OFPST_PORT_REQUEST:
248 case OFPUTIL_OFPST_QUEUE_REQUEST:
249 case OFPUTIL_OFPST_DESC_REPLY:
250 case OFPUTIL_OFPST_FLOW_REPLY:
251 case OFPUTIL_OFPST_QUEUE_REPLY:
252 case OFPUTIL_OFPST_PORT_REPLY:
253 case OFPUTIL_OFPST_TABLE_REPLY:
254 case OFPUTIL_OFPST_AGGREGATE_REPLY:
255 case OFPUTIL_NXT_ROLE_REQUEST:
256 case OFPUTIL_NXT_ROLE_REPLY:
257 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
258 case OFPUTIL_NXT_SET_FLOW_FORMAT:
259 case OFPUTIL_NXT_FLOW_MOD:
260 case OFPUTIL_NXT_FLOW_REMOVED:
261 case OFPUTIL_NXST_FLOW_REQUEST:
262 case OFPUTIL_NXST_AGGREGATE_REQUEST:
263 case OFPUTIL_NXST_FLOW_REPLY:
264 case OFPUTIL_NXST_AGGREGATE_REPLY:
266 if (VLOG_IS_DBG_ENABLED()) {
267 char *s = ofp_to_string(msg->data, msg->size, 2);
268 VLOG_DBG_RL(&rl, "%016llx: OpenFlow packet ignored: %s",
276 send_features_request(struct lswitch *sw, struct rconn *rconn)
278 time_t now = time_now();
279 if (now >= sw->last_features_request + 1) {
281 struct ofp_switch_config *osc;
283 /* Send OFPT_FEATURES_REQUEST. */
284 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &b);
285 queue_tx(sw, rconn, b);
287 /* Send OFPT_SET_CONFIG. */
288 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &b);
289 osc->miss_send_len = htons(OFP_DEFAULT_MISS_SEND_LEN);
290 queue_tx(sw, rconn, b);
292 sw->last_features_request = now;
297 queue_tx(struct lswitch *sw, struct rconn *rconn, struct ofpbuf *b)
299 int retval = rconn_send_with_limit(rconn, b, sw->queued, 10);
300 if (retval && retval != ENOTCONN) {
301 if (retval == EAGAIN) {
302 VLOG_INFO_RL(&rl, "%016llx: %s: tx queue overflow",
303 sw->datapath_id, rconn_get_name(rconn));
305 VLOG_WARN_RL(&rl, "%016llx: %s: send: %s",
306 sw->datapath_id, rconn_get_name(rconn),
313 process_switch_features(struct lswitch *sw, struct ofp_switch_features *osf)
318 sw->datapath_id = ntohll(osf->datapath_id);
320 n_ports = (ntohs(osf->header.length) - sizeof *osf) / sizeof *osf->ports;
321 for (i = 0; i < n_ports; i++) {
322 struct ofp_phy_port *opp = &osf->ports[i];
323 struct lswitch_port *lp;
325 opp->name[OFP_MAX_PORT_NAME_LEN - 1] = '\0';
326 lp = shash_find_data(&sw->queue_names, opp->name);
327 if (lp && hmap_node_is_null(&lp->hmap_node)) {
328 lp->port_no = ntohs(opp->port_no);
329 hmap_insert(&sw->queue_numbers, &lp->hmap_node,
330 hash_int(lp->port_no, 0));
336 lswitch_choose_destination(struct lswitch *sw, const struct flow *flow)
340 /* Learn the source MAC. */
341 if (mac_learning_may_learn(sw->ml, flow->dl_src, 0)) {
342 struct mac_entry *mac = mac_learning_insert(sw->ml, flow->dl_src, 0);
343 if (mac_entry_is_new(mac) || mac->port.i != flow->in_port) {
344 VLOG_DBG_RL(&rl, "%016llx: learned that "ETH_ADDR_FMT" is on "
345 "port %"PRIu16, sw->datapath_id,
346 ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
348 mac->port.i = flow->in_port;
349 mac_learning_changed(sw->ml, mac);
353 /* Drop frames for reserved multicast addresses. */
354 if (eth_addr_is_reserved(flow->dl_dst)) {
358 out_port = OFPP_FLOOD;
360 struct mac_entry *mac;
362 mac = mac_learning_lookup(sw->ml, flow->dl_dst, 0, NULL);
364 out_port = mac->port.i;
365 if (out_port == flow->in_port) {
366 /* Don't send a packet back out its input port. */
372 /* Check if we need to use "NORMAL" action. */
373 if (sw->action_normal && out_port != OFPP_FLOOD) {
381 get_queue_id(const struct lswitch *sw, uint16_t in_port)
383 const struct lswitch_port *port;
385 HMAP_FOR_EACH_WITH_HASH (port, hmap_node, hash_int(in_port, 0),
386 &sw->queue_numbers) {
387 if (port->port_no == in_port) {
388 return port->queue_id;
392 return sw->default_queue;
396 process_packet_in(struct lswitch *sw, struct rconn *rconn,
397 const struct ofp_packet_in *opi)
399 uint16_t in_port = ntohs(opi->in_port);
403 struct ofp_action_header actions[2];
406 size_t pkt_ofs, pkt_len;
410 /* Ignore packets sent via output to OFPP_CONTROLLER. This library never
411 * uses such an action. You never know what experiments might be going on,
412 * though, and it seems best not to interfere with them. */
413 if (opi->reason != OFPR_NO_MATCH) {
417 /* Extract flow data from 'opi' into 'flow'. */
418 pkt_ofs = offsetof(struct ofp_packet_in, data);
419 pkt_len = ntohs(opi->header.length) - pkt_ofs;
420 ofpbuf_use_const(&pkt, opi->data, pkt_len);
421 flow_extract(&pkt, 0, in_port, &flow);
423 /* Choose output port. */
424 out_port = lswitch_choose_destination(sw, &flow);
427 queue_id = get_queue_id(sw, in_port);
428 if (out_port == OFPP_NONE) {
430 } else if (queue_id == UINT32_MAX || out_port >= OFPP_MAX) {
431 struct ofp_action_output oao;
433 memset(&oao, 0, sizeof oao);
434 oao.type = htons(OFPAT_OUTPUT);
435 oao.len = htons(sizeof oao);
436 oao.port = htons(out_port);
438 memcpy(actions, &oao, sizeof oao);
439 actions_len = sizeof oao;
441 struct ofp_action_enqueue oae;
443 memset(&oae, 0, sizeof oae);
444 oae.type = htons(OFPAT_ENQUEUE);
445 oae.len = htons(sizeof oae);
446 oae.port = htons(out_port);
447 oae.queue_id = htonl(queue_id);
449 memcpy(actions, &oae, sizeof oae);
450 actions_len = sizeof oae;
452 assert(actions_len <= sizeof actions);
454 /* Send the packet, and possibly the whole flow, to the output port. */
455 if (sw->max_idle >= 0 && (!sw->ml || out_port != OFPP_FLOOD)) {
456 struct ofpbuf *buffer;
457 struct cls_rule rule;
459 /* The output port is known, or we always flood everything, so add a
461 cls_rule_init(&flow, &sw->wc, 0, &rule);
462 buffer = make_add_flow(&rule, ntohl(opi->buffer_id),
463 sw->max_idle, actions_len);
464 ofpbuf_put(buffer, actions, actions_len);
465 queue_tx(sw, rconn, buffer);
467 /* If the switch didn't buffer the packet, we need to send a copy. */
468 if (ntohl(opi->buffer_id) == UINT32_MAX && actions_len > 0) {
470 make_packet_out(&pkt, UINT32_MAX, in_port,
471 actions, actions_len / sizeof *actions));
474 /* We don't know that MAC, or we don't set up flows. Send along the
475 * packet without setting up a flow. */
476 if (ntohl(opi->buffer_id) != UINT32_MAX || actions_len > 0) {
478 make_packet_out(&pkt, ntohl(opi->buffer_id), in_port,
479 actions, actions_len / sizeof *actions));
485 process_echo_request(struct lswitch *sw, struct rconn *rconn,
486 const struct ofp_header *rq)
488 queue_tx(sw, rconn, make_echo_reply(rq));