2 * Copyright (c) 2009, 2010 Nicira Networks.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
22 #include <sys/socket.h>
24 #include <netinet/in.h>
27 #include "classifier.h"
29 #include "discovery.h"
31 #include "dynamic-string.h"
32 #include "fail-open.h"
36 #include "mac-learning.h"
40 #include "ofp-print.h"
42 #include "ofproto-sflow.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
46 #include "openvswitch/datapath-protocol.h"
50 #include "poll-loop.h"
54 #include "stream-ssl.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto)
65 #include "sflow_api.h"
69 TABLEID_CLASSIFIER = 1
74 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
75 struct netdev *netdev;
76 struct ofp_phy_port opp; /* In host byte order. */
80 static void ofport_free(struct ofport *);
81 static void hton_ofp_phy_port(struct ofp_phy_port *);
83 static int xlate_actions(const union ofp_action *in, size_t n_in,
84 const flow_t *flow, struct ofproto *ofproto,
85 const struct ofpbuf *packet,
86 struct odp_actions *out, tag_type *tags,
87 bool *may_set_up_flow, uint16_t *nf_output_iface);
92 uint64_t flow_cookie; /* Controller-issued identifier.
93 (Kept in network-byte order.) */
94 uint16_t idle_timeout; /* In seconds from time of last use. */
95 uint16_t hard_timeout; /* In seconds from time of creation. */
96 bool send_flow_removed; /* Send a flow removed message? */
97 long long int used; /* Last-used time (0 if never used). */
98 long long int created; /* Creation time. */
99 uint64_t packet_count; /* Number of packets received. */
100 uint64_t byte_count; /* Number of bytes received. */
101 uint64_t accounted_bytes; /* Number of bytes passed to account_cb. */
102 tag_type tags; /* Tags (set only by hooks). */
103 struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
105 /* If 'super' is non-NULL, this rule is a subrule, that is, it is an
106 * exact-match rule (having cr.wc.wildcards of 0) generated from the
107 * wildcard rule 'super'. In this case, 'list' is an element of the
110 * If 'super' is NULL, this rule is a super-rule, and 'list' is the head of
111 * a list of subrules. A super-rule with no wildcards (where
112 * cr.wc.wildcards is 0) will never have any subrules. */
118 * 'n_actions' is the number of elements in the 'actions' array. A single
119 * action may take up more more than one element's worth of space.
121 * A subrule has no actions (it uses the super-rule's actions). */
123 union ofp_action *actions;
127 * A super-rule with wildcard fields never has ODP actions (since the
128 * datapath only supports exact-match flows). */
129 bool installed; /* Installed in datapath? */
130 bool may_install; /* True ordinarily; false if actions must
131 * be reassessed for every packet. */
133 union odp_action *odp_actions;
137 rule_is_hidden(const struct rule *rule)
139 /* Subrules are merely an implementation detail, so hide them from the
141 if (rule->super != NULL) {
145 /* Rules with priority higher than UINT16_MAX are set up by ofproto itself
146 * (e.g. by in-band control) and are intentionally hidden from the
148 if (rule->cr.priority > UINT16_MAX) {
155 static struct rule *rule_create(struct ofproto *, struct rule *super,
156 const union ofp_action *, size_t n_actions,
157 uint16_t idle_timeout, uint16_t hard_timeout,
158 uint64_t flow_cookie, bool send_flow_removed);
159 static void rule_free(struct rule *);
160 static void rule_destroy(struct ofproto *, struct rule *);
161 static struct rule *rule_from_cls_rule(const struct cls_rule *);
162 static void rule_insert(struct ofproto *, struct rule *,
163 struct ofpbuf *packet, uint16_t in_port);
164 static void rule_remove(struct ofproto *, struct rule *);
165 static bool rule_make_actions(struct ofproto *, struct rule *,
166 const struct ofpbuf *packet);
167 static void rule_install(struct ofproto *, struct rule *,
168 struct rule *displaced_rule);
169 static void rule_uninstall(struct ofproto *, struct rule *);
170 static void rule_post_uninstall(struct ofproto *, struct rule *);
171 static void send_flow_removed(struct ofproto *p, struct rule *rule,
172 long long int now, uint8_t reason);
174 /* ofproto supports two kinds of OpenFlow connections:
176 * - "Primary" connections to ordinary OpenFlow controllers. ofproto
177 * maintains persistent connections to these controllers and by default
178 * sends them asynchronous messages such as packet-ins.
180 * - "Service" connections, e.g. from ovs-ofctl. When these connections
181 * drop, it is the other side's responsibility to reconnect them if
182 * necessary. ofproto does not send them asynchronous messages by default.
184 * Currently, active (tcp, ssl, unix) connections are always "primary"
185 * connections and passive (ptcp, pssl, punix) connections are always "service"
186 * connections. There is no inherent reason for this, but it reflects the
190 OFCONN_PRIMARY, /* An ordinary OpenFlow controller. */
191 OFCONN_SERVICE /* A service connection, e.g. "ovs-ofctl". */
194 /* A listener for incoming OpenFlow "service" connections. */
196 struct hmap_node node; /* In struct ofproto's "services" hmap. */
197 struct pvconn *pvconn; /* OpenFlow connection listener. */
199 /* These are not used by ofservice directly. They are settings for
200 * accepted "struct ofconn"s from the pvconn. */
201 int probe_interval; /* Max idle time before probing, in seconds. */
202 int rate_limit; /* Max packet-in rate in packets per second. */
203 int burst_limit; /* Limit on accumulating packet credits. */
206 static struct ofservice *ofservice_lookup(struct ofproto *,
208 static int ofservice_create(struct ofproto *,
209 const struct ofproto_controller *);
210 static void ofservice_reconfigure(struct ofservice *,
211 const struct ofproto_controller *);
212 static void ofservice_destroy(struct ofproto *, struct ofservice *);
214 /* An OpenFlow connection. */
216 struct ofproto *ofproto; /* The ofproto that owns this connection. */
217 struct list node; /* In struct ofproto's "all_conns" list. */
218 struct rconn *rconn; /* OpenFlow connection. */
219 enum ofconn_type type; /* Type. */
221 /* OFPT_PACKET_IN related data. */
222 struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
223 struct pinsched *schedulers[2]; /* Indexed by reason code; see below. */
224 struct pktbuf *pktbuf; /* OpenFlow packet buffers. */
225 int miss_send_len; /* Bytes to send of buffered packets. */
227 /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
228 * requests, and the maximum number before we stop reading OpenFlow
230 #define OFCONN_REPLY_MAX 100
231 struct rconn_packet_counter *reply_counter;
233 /* type == OFCONN_PRIMARY only. */
234 enum nx_role role; /* Role. */
235 struct hmap_node hmap_node; /* In struct ofproto's "controllers" map. */
236 struct discovery *discovery; /* Controller discovery object, if enabled. */
237 struct status_category *ss; /* Switch status category. */
238 enum ofproto_band band; /* In-band or out-of-band? */
241 /* We use OFPR_NO_MATCH and OFPR_ACTION as indexes into struct ofconn's
242 * "schedulers" array. Their values are 0 and 1, and their meanings and values
243 * coincide with _ODPL_MISS_NR and _ODPL_ACTION_NR, so this is convenient. In
244 * case anything ever changes, check their values here. */
245 #define N_SCHEDULERS 2
246 BUILD_ASSERT_DECL(OFPR_NO_MATCH == 0);
247 BUILD_ASSERT_DECL(OFPR_NO_MATCH == _ODPL_MISS_NR);
248 BUILD_ASSERT_DECL(OFPR_ACTION == 1);
249 BUILD_ASSERT_DECL(OFPR_ACTION == _ODPL_ACTION_NR);
251 static struct ofconn *ofconn_create(struct ofproto *, struct rconn *,
253 static void ofconn_destroy(struct ofconn *);
254 static void ofconn_run(struct ofconn *, struct ofproto *);
255 static void ofconn_wait(struct ofconn *);
256 static bool ofconn_receives_async_msgs(const struct ofconn *);
257 static char *ofconn_make_name(const struct ofproto *, const char *target);
258 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
260 static void queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
261 struct rconn_packet_counter *counter);
263 static void send_packet_in(struct ofproto *, struct ofpbuf *odp_msg);
264 static void do_send_packet_in(struct ofpbuf *odp_msg, void *ofconn);
268 uint64_t datapath_id; /* Datapath ID. */
269 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
270 char *mfr_desc; /* Manufacturer. */
271 char *hw_desc; /* Hardware. */
272 char *sw_desc; /* Software version. */
273 char *serial_desc; /* Serial number. */
274 char *dp_desc; /* Datapath description. */
278 struct netdev_monitor *netdev_monitor;
279 struct hmap ports; /* Contains "struct ofport"s. */
280 struct shash port_by_name;
284 struct switch_status *switch_status;
285 struct fail_open *fail_open;
286 struct netflow *netflow;
287 struct ofproto_sflow *sflow;
289 /* In-band control. */
290 struct in_band *in_band;
291 long long int next_in_band_update;
292 struct sockaddr_in *extra_in_band_remotes;
293 size_t n_extra_remotes;
296 struct classifier cls;
297 bool need_revalidate;
298 long long int next_expiration;
299 struct tag_set revalidate_set;
300 bool tun_id_from_cookie;
302 /* OpenFlow connections. */
303 struct hmap controllers; /* Controller "struct ofconn"s. */
304 struct list all_conns; /* Contains "struct ofconn"s. */
305 enum ofproto_fail_mode fail_mode;
307 /* OpenFlow listeners. */
308 struct hmap services; /* Contains "struct ofservice"s. */
309 struct pvconn **snoops;
312 /* Hooks for ovs-vswitchd. */
313 const struct ofhooks *ofhooks;
316 /* Used by default ofhooks. */
317 struct mac_learning *ml;
320 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
322 static const struct ofhooks default_ofhooks;
324 static uint64_t pick_datapath_id(const struct ofproto *);
325 static uint64_t pick_fallback_dpid(void);
327 static int ofproto_expire(struct ofproto *);
329 static void update_stats(struct ofproto *, struct rule *,
330 const struct odp_flow_stats *);
331 static bool revalidate_rule(struct ofproto *p, struct rule *rule);
332 static void revalidate_cb(struct cls_rule *rule_, void *p_);
334 static void handle_odp_msg(struct ofproto *, struct ofpbuf *);
336 static void handle_openflow(struct ofconn *, struct ofproto *,
339 static void refresh_port_groups(struct ofproto *);
341 static struct ofport *get_port(const struct ofproto *, uint16_t odp_port);
342 static void update_port(struct ofproto *, const char *devname);
343 static int init_ports(struct ofproto *);
344 static void reinit_ports(struct ofproto *);
347 ofproto_create(const char *datapath, const char *datapath_type,
348 const struct ofhooks *ofhooks, void *aux,
349 struct ofproto **ofprotop)
351 struct odp_stats stats;
358 /* Connect to datapath and start listening for messages. */
359 error = dpif_open(datapath, datapath_type, &dpif);
361 VLOG_ERR("failed to open datapath %s: %s", datapath, strerror(error));
364 error = dpif_get_dp_stats(dpif, &stats);
366 VLOG_ERR("failed to obtain stats for datapath %s: %s",
367 datapath, strerror(error));
371 error = dpif_recv_set_mask(dpif, ODPL_MISS | ODPL_ACTION | ODPL_SFLOW);
373 VLOG_ERR("failed to listen on datapath %s: %s",
374 datapath, strerror(error));
378 dpif_flow_flush(dpif);
379 dpif_recv_purge(dpif);
381 /* Initialize settings. */
382 p = xzalloc(sizeof *p);
383 p->fallback_dpid = pick_fallback_dpid();
384 p->datapath_id = p->fallback_dpid;
385 p->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
386 p->hw_desc = xstrdup(DEFAULT_HW_DESC);
387 p->sw_desc = xstrdup(DEFAULT_SW_DESC);
388 p->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
389 p->dp_desc = xstrdup(DEFAULT_DP_DESC);
391 /* Initialize datapath. */
393 p->netdev_monitor = netdev_monitor_create();
394 hmap_init(&p->ports);
395 shash_init(&p->port_by_name);
396 p->max_ports = stats.max_ports;
398 /* Initialize submodules. */
399 p->switch_status = switch_status_create(p);
405 /* Initialize flow table. */
406 classifier_init(&p->cls);
407 p->need_revalidate = false;
408 p->next_expiration = time_msec() + 1000;
409 tag_set_init(&p->revalidate_set);
411 /* Initialize OpenFlow connections. */
412 list_init(&p->all_conns);
413 hmap_init(&p->controllers);
414 hmap_init(&p->services);
418 /* Initialize hooks. */
420 p->ofhooks = ofhooks;
424 p->ofhooks = &default_ofhooks;
426 p->ml = mac_learning_create();
429 /* Pick final datapath ID. */
430 p->datapath_id = pick_datapath_id(p);
431 VLOG_INFO("using datapath ID %016"PRIx64, p->datapath_id);
438 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
440 uint64_t old_dpid = p->datapath_id;
441 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
442 if (p->datapath_id != old_dpid) {
443 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
445 /* Force all active connections to reconnect, since there is no way to
446 * notify a controller that the datapath ID has changed. */
447 ofproto_reconnect_controllers(p);
452 is_discovery_controller(const struct ofproto_controller *c)
454 return !strcmp(c->target, "discover");
458 is_in_band_controller(const struct ofproto_controller *c)
460 return is_discovery_controller(c) || c->band == OFPROTO_IN_BAND;
463 /* Creates a new controller in 'ofproto'. Some of the settings are initially
464 * drawn from 'c', but update_controller() needs to be called later to finish
465 * the new ofconn's configuration. */
467 add_controller(struct ofproto *ofproto, const struct ofproto_controller *c)
469 struct discovery *discovery;
470 struct ofconn *ofconn;
472 if (is_discovery_controller(c)) {
473 int error = discovery_create(c->accept_re, c->update_resolv_conf,
474 ofproto->dpif, ofproto->switch_status,
483 ofconn = ofconn_create(ofproto, rconn_create(5, 8), OFCONN_PRIMARY);
484 ofconn->pktbuf = pktbuf_create();
485 ofconn->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
487 ofconn->discovery = discovery;
489 char *name = ofconn_make_name(ofproto, c->target);
490 rconn_connect(ofconn->rconn, c->target, name);
493 hmap_insert(&ofproto->controllers, &ofconn->hmap_node,
494 hash_string(c->target, 0));
497 /* Reconfigures 'ofconn' to match 'c'. This function cannot update an ofconn's
498 * target or turn discovery on or off (these are done by creating new ofconns
499 * and deleting old ones), but it can update the rest of an ofconn's
502 update_controller(struct ofconn *ofconn, const struct ofproto_controller *c)
506 ofconn->band = (is_in_band_controller(c)
507 ? OFPROTO_IN_BAND : OFPROTO_OUT_OF_BAND);
509 rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
511 probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
512 rconn_set_probe_interval(ofconn->rconn, probe_interval);
514 if (ofconn->discovery) {
515 discovery_set_update_resolv_conf(ofconn->discovery,
516 c->update_resolv_conf);
517 discovery_set_accept_controller_re(ofconn->discovery, c->accept_re);
520 ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
524 ofconn_get_target(const struct ofconn *ofconn)
526 return ofconn->discovery ? "discover" : rconn_get_target(ofconn->rconn);
529 static struct ofconn *
530 find_controller_by_target(struct ofproto *ofproto, const char *target)
532 struct ofconn *ofconn;
534 HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
535 hash_string(target, 0), &ofproto->controllers) {
536 if (!strcmp(ofconn_get_target(ofconn), target)) {
544 update_in_band_remotes(struct ofproto *ofproto)
546 const struct ofconn *ofconn;
547 struct sockaddr_in *addrs;
548 size_t max_addrs, n_addrs;
552 /* Allocate enough memory for as many remotes as we could possibly have. */
553 max_addrs = ofproto->n_extra_remotes + hmap_count(&ofproto->controllers);
554 addrs = xmalloc(max_addrs * sizeof *addrs);
557 /* Add all the remotes. */
559 HMAP_FOR_EACH (ofconn, hmap_node, &ofproto->controllers) {
560 struct sockaddr_in *sin = &addrs[n_addrs];
562 if (ofconn->band == OFPROTO_OUT_OF_BAND) {
566 sin->sin_addr.s_addr = rconn_get_remote_ip(ofconn->rconn);
567 if (sin->sin_addr.s_addr) {
568 sin->sin_port = rconn_get_remote_port(ofconn->rconn);
571 if (ofconn->discovery) {
575 for (i = 0; i < ofproto->n_extra_remotes; i++) {
576 addrs[n_addrs++] = ofproto->extra_in_band_remotes[i];
579 /* Create or update or destroy in-band.
581 * Ordinarily we only enable in-band if there's at least one remote
582 * address, but discovery needs the in-band rules for DHCP to be installed
583 * even before we know any remote addresses. */
584 if (n_addrs || discovery) {
585 if (!ofproto->in_band) {
586 in_band_create(ofproto, ofproto->dpif, ofproto->switch_status,
589 if (ofproto->in_band) {
590 in_band_set_remotes(ofproto->in_band, addrs, n_addrs);
592 ofproto->next_in_band_update = time_msec() + 1000;
594 in_band_destroy(ofproto->in_band);
595 ofproto->in_band = NULL;
603 update_fail_open(struct ofproto *p)
605 struct ofconn *ofconn;
607 if (!hmap_is_empty(&p->controllers)
608 && p->fail_mode == OFPROTO_FAIL_STANDALONE) {
609 struct rconn **rconns;
613 p->fail_open = fail_open_create(p, p->switch_status);
617 rconns = xmalloc(hmap_count(&p->controllers) * sizeof *rconns);
618 HMAP_FOR_EACH (ofconn, hmap_node, &p->controllers) {
619 rconns[n++] = ofconn->rconn;
622 fail_open_set_controllers(p->fail_open, rconns, n);
623 /* p->fail_open takes ownership of 'rconns'. */
625 fail_open_destroy(p->fail_open);
631 ofproto_set_controllers(struct ofproto *p,
632 const struct ofproto_controller *controllers,
633 size_t n_controllers)
635 struct shash new_controllers;
636 struct ofconn *ofconn, *next_ofconn;
637 struct ofservice *ofservice, *next_ofservice;
641 /* Create newly configured controllers and services.
642 * Create a name to ofproto_controller mapping in 'new_controllers'. */
643 shash_init(&new_controllers);
644 for (i = 0; i < n_controllers; i++) {
645 const struct ofproto_controller *c = &controllers[i];
647 if (!vconn_verify_name(c->target) || !strcmp(c->target, "discover")) {
648 if (!find_controller_by_target(p, c->target)) {
649 add_controller(p, c);
651 } else if (!pvconn_verify_name(c->target)) {
652 if (!ofservice_lookup(p, c->target) && ofservice_create(p, c)) {
656 VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
657 dpif_name(p->dpif), c->target);
661 shash_add_once(&new_controllers, c->target, &controllers[i]);
664 /* Delete controllers that are no longer configured.
665 * Update configuration of all now-existing controllers. */
667 HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &p->controllers) {
668 struct ofproto_controller *c;
670 c = shash_find_data(&new_controllers, ofconn_get_target(ofconn));
672 ofconn_destroy(ofconn);
674 update_controller(ofconn, c);
681 /* Delete services that are no longer configured.
682 * Update configuration of all now-existing services. */
683 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &p->services) {
684 struct ofproto_controller *c;
686 c = shash_find_data(&new_controllers,
687 pvconn_get_name(ofservice->pvconn));
689 ofservice_destroy(p, ofservice);
691 ofservice_reconfigure(ofservice, c);
695 shash_destroy(&new_controllers);
697 update_in_band_remotes(p);
700 if (!hmap_is_empty(&p->controllers) && !ss_exists) {
701 ofconn = CONTAINER_OF(hmap_first(&p->controllers),
702 struct ofconn, hmap_node);
703 ofconn->ss = switch_status_register(p->switch_status, "remote",
704 rconn_status_cb, ofconn->rconn);
709 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
711 p->fail_mode = fail_mode;
715 /* Drops the connections between 'ofproto' and all of its controllers, forcing
716 * them to reconnect. */
718 ofproto_reconnect_controllers(struct ofproto *ofproto)
720 struct ofconn *ofconn;
722 LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
723 rconn_reconnect(ofconn->rconn);
728 any_extras_changed(const struct ofproto *ofproto,
729 const struct sockaddr_in *extras, size_t n)
733 if (n != ofproto->n_extra_remotes) {
737 for (i = 0; i < n; i++) {
738 const struct sockaddr_in *old = &ofproto->extra_in_band_remotes[i];
739 const struct sockaddr_in *new = &extras[i];
741 if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
742 old->sin_port != new->sin_port) {
750 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
751 * in-band control should guarantee access, in the same way that in-band
752 * control guarantees access to OpenFlow controllers. */
754 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
755 const struct sockaddr_in *extras, size_t n)
757 if (!any_extras_changed(ofproto, extras, n)) {
761 free(ofproto->extra_in_band_remotes);
762 ofproto->n_extra_remotes = n;
763 ofproto->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
765 update_in_band_remotes(ofproto);
769 ofproto_set_desc(struct ofproto *p,
770 const char *mfr_desc, const char *hw_desc,
771 const char *sw_desc, const char *serial_desc,
774 struct ofp_desc_stats *ods;
777 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
778 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
779 sizeof ods->mfr_desc);
782 p->mfr_desc = xstrdup(mfr_desc);
785 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
786 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
787 sizeof ods->hw_desc);
790 p->hw_desc = xstrdup(hw_desc);
793 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
794 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
795 sizeof ods->sw_desc);
798 p->sw_desc = xstrdup(sw_desc);
801 if (strlen(serial_desc) >= sizeof ods->serial_num) {
802 VLOG_WARN("truncating serial_desc, must be less than %zu "
804 sizeof ods->serial_num);
806 free(p->serial_desc);
807 p->serial_desc = xstrdup(serial_desc);
810 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
811 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
812 sizeof ods->dp_desc);
815 p->dp_desc = xstrdup(dp_desc);
820 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
821 const struct svec *svec)
823 struct pvconn **pvconns = *pvconnsp;
824 size_t n_pvconns = *n_pvconnsp;
828 for (i = 0; i < n_pvconns; i++) {
829 pvconn_close(pvconns[i]);
833 pvconns = xmalloc(svec->n * sizeof *pvconns);
835 for (i = 0; i < svec->n; i++) {
836 const char *name = svec->names[i];
837 struct pvconn *pvconn;
840 error = pvconn_open(name, &pvconn);
842 pvconns[n_pvconns++] = pvconn;
844 VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
852 *n_pvconnsp = n_pvconns;
858 ofproto_set_snoops(struct ofproto *ofproto, const struct svec *snoops)
860 return set_pvconns(&ofproto->snoops, &ofproto->n_snoops, snoops);
864 ofproto_set_netflow(struct ofproto *ofproto,
865 const struct netflow_options *nf_options)
867 if (nf_options && nf_options->collectors.n) {
868 if (!ofproto->netflow) {
869 ofproto->netflow = netflow_create();
871 return netflow_set_options(ofproto->netflow, nf_options);
873 netflow_destroy(ofproto->netflow);
874 ofproto->netflow = NULL;
880 ofproto_set_sflow(struct ofproto *ofproto,
881 const struct ofproto_sflow_options *oso)
883 struct ofproto_sflow *os = ofproto->sflow;
886 struct ofport *ofport;
888 os = ofproto->sflow = ofproto_sflow_create(ofproto->dpif);
889 refresh_port_groups(ofproto);
890 HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
891 ofproto_sflow_add_port(os, ofport->odp_port,
892 netdev_get_name(ofport->netdev));
895 ofproto_sflow_set_options(os, oso);
897 ofproto_sflow_destroy(os);
898 ofproto->sflow = NULL;
903 ofproto_get_datapath_id(const struct ofproto *ofproto)
905 return ofproto->datapath_id;
909 ofproto_has_primary_controller(const struct ofproto *ofproto)
911 return !hmap_is_empty(&ofproto->controllers);
914 enum ofproto_fail_mode
915 ofproto_get_fail_mode(const struct ofproto *p)
921 ofproto_get_snoops(const struct ofproto *ofproto, struct svec *snoops)
925 for (i = 0; i < ofproto->n_snoops; i++) {
926 svec_add(snoops, pvconn_get_name(ofproto->snoops[i]));
931 ofproto_destroy(struct ofproto *p)
933 struct ofservice *ofservice, *next_ofservice;
934 struct ofconn *ofconn, *next_ofconn;
935 struct ofport *ofport, *next_ofport;
942 /* Destroy fail-open and in-band early, since they touch the classifier. */
943 fail_open_destroy(p->fail_open);
946 in_band_destroy(p->in_band);
948 free(p->extra_in_band_remotes);
950 ofproto_flush_flows(p);
951 classifier_destroy(&p->cls);
953 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &p->all_conns) {
954 ofconn_destroy(ofconn);
956 hmap_destroy(&p->controllers);
959 netdev_monitor_destroy(p->netdev_monitor);
960 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
961 hmap_remove(&p->ports, &ofport->hmap_node);
964 shash_destroy(&p->port_by_name);
966 switch_status_destroy(p->switch_status);
967 netflow_destroy(p->netflow);
968 ofproto_sflow_destroy(p->sflow);
970 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &p->services) {
971 ofservice_destroy(p, ofservice);
973 hmap_destroy(&p->services);
975 for (i = 0; i < p->n_snoops; i++) {
976 pvconn_close(p->snoops[i]);
980 mac_learning_destroy(p->ml);
985 free(p->serial_desc);
988 hmap_destroy(&p->ports);
994 ofproto_run(struct ofproto *p)
996 int error = ofproto_run1(p);
998 error = ofproto_run2(p, false);
1004 process_port_change(struct ofproto *ofproto, int error, char *devname)
1006 if (error == ENOBUFS) {
1007 reinit_ports(ofproto);
1008 } else if (!error) {
1009 update_port(ofproto, devname);
1014 /* Returns a "preference level" for snooping 'ofconn'. A higher return value
1015 * means that 'ofconn' is more interesting for monitoring than a lower return
1018 snoop_preference(const struct ofconn *ofconn)
1020 switch (ofconn->role) {
1021 case NX_ROLE_MASTER:
1028 /* Shouldn't happen. */
1033 /* One of ofproto's "snoop" pvconns has accepted a new connection on 'vconn'.
1034 * Connects this vconn to a controller. */
1036 add_snooper(struct ofproto *ofproto, struct vconn *vconn)
1038 struct ofconn *ofconn, *best;
1040 /* Pick a controller for monitoring. */
1042 LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
1043 if (ofconn->type == OFCONN_PRIMARY
1044 && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
1050 rconn_add_monitor(best->rconn, vconn);
1052 VLOG_INFO_RL(&rl, "no controller connection to snoop");
1058 ofproto_run1(struct ofproto *p)
1060 struct ofconn *ofconn, *next_ofconn;
1061 struct ofservice *ofservice;
1066 if (shash_is_empty(&p->port_by_name)) {
1070 for (i = 0; i < 50; i++) {
1073 error = dpif_recv(p->dpif, &buf);
1075 if (error == ENODEV) {
1076 /* Someone destroyed the datapath behind our back. The caller
1077 * better destroy us and give up, because we're just going to
1078 * spin from here on out. */
1079 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
1080 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
1081 dpif_name(p->dpif));
1087 handle_odp_msg(p, buf);
1090 while ((error = dpif_port_poll(p->dpif, &devname)) != EAGAIN) {
1091 process_port_change(p, error, devname);
1093 while ((error = netdev_monitor_poll(p->netdev_monitor,
1094 &devname)) != EAGAIN) {
1095 process_port_change(p, error, devname);
1099 if (time_msec() >= p->next_in_band_update) {
1100 update_in_band_remotes(p);
1102 in_band_run(p->in_band);
1105 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &p->all_conns) {
1106 ofconn_run(ofconn, p);
1109 /* Fail-open maintenance. Do this after processing the ofconns since
1110 * fail-open checks the status of the controller rconn. */
1112 fail_open_run(p->fail_open);
1115 HMAP_FOR_EACH (ofservice, node, &p->services) {
1116 struct vconn *vconn;
1119 retval = pvconn_accept(ofservice->pvconn, OFP_VERSION, &vconn);
1121 struct rconn *rconn;
1124 rconn = rconn_create(ofservice->probe_interval, 0);
1125 name = ofconn_make_name(p, vconn_get_name(vconn));
1126 rconn_connect_unreliably(rconn, vconn, name);
1129 ofconn = ofconn_create(p, rconn, OFCONN_SERVICE);
1130 ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
1131 ofservice->burst_limit);
1132 } else if (retval != EAGAIN) {
1133 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
1137 for (i = 0; i < p->n_snoops; i++) {
1138 struct vconn *vconn;
1141 retval = pvconn_accept(p->snoops[i], OFP_VERSION, &vconn);
1143 add_snooper(p, vconn);
1144 } else if (retval != EAGAIN) {
1145 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
1149 if (time_msec() >= p->next_expiration) {
1150 int delay = ofproto_expire(p);
1151 p->next_expiration = time_msec() + delay;
1152 COVERAGE_INC(ofproto_expiration);
1156 netflow_run(p->netflow);
1159 ofproto_sflow_run(p->sflow);
1165 struct revalidate_cbdata {
1166 struct ofproto *ofproto;
1167 bool revalidate_all; /* Revalidate all exact-match rules? */
1168 bool revalidate_subrules; /* Revalidate all exact-match subrules? */
1169 struct tag_set revalidate_set; /* Set of tags to revalidate. */
1173 ofproto_run2(struct ofproto *p, bool revalidate_all)
1175 if (p->need_revalidate || revalidate_all
1176 || !tag_set_is_empty(&p->revalidate_set)) {
1177 struct revalidate_cbdata cbdata;
1179 cbdata.revalidate_all = revalidate_all;
1180 cbdata.revalidate_subrules = p->need_revalidate;
1181 cbdata.revalidate_set = p->revalidate_set;
1182 tag_set_init(&p->revalidate_set);
1183 COVERAGE_INC(ofproto_revalidate);
1184 classifier_for_each(&p->cls, CLS_INC_EXACT, revalidate_cb, &cbdata);
1185 p->need_revalidate = false;
1192 ofproto_wait(struct ofproto *p)
1194 struct ofservice *ofservice;
1195 struct ofconn *ofconn;
1198 dpif_recv_wait(p->dpif);
1199 dpif_port_poll_wait(p->dpif);
1200 netdev_monitor_poll_wait(p->netdev_monitor);
1201 LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1202 ofconn_wait(ofconn);
1205 poll_timer_wait_until(p->next_in_band_update);
1206 in_band_wait(p->in_band);
1209 fail_open_wait(p->fail_open);
1212 ofproto_sflow_wait(p->sflow);
1214 if (!tag_set_is_empty(&p->revalidate_set)) {
1215 poll_immediate_wake();
1217 if (p->need_revalidate) {
1218 /* Shouldn't happen, but if it does just go around again. */
1219 VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1220 poll_immediate_wake();
1221 } else if (p->next_expiration != LLONG_MAX) {
1222 poll_timer_wait_until(p->next_expiration);
1224 HMAP_FOR_EACH (ofservice, node, &p->services) {
1225 pvconn_wait(ofservice->pvconn);
1227 for (i = 0; i < p->n_snoops; i++) {
1228 pvconn_wait(p->snoops[i]);
1233 ofproto_revalidate(struct ofproto *ofproto, tag_type tag)
1235 tag_set_add(&ofproto->revalidate_set, tag);
1239 ofproto_get_revalidate_set(struct ofproto *ofproto)
1241 return &ofproto->revalidate_set;
1245 ofproto_is_alive(const struct ofproto *p)
1247 return !hmap_is_empty(&p->controllers);
1250 /* Deletes port number 'odp_port' from the datapath for 'ofproto'.
1252 * This is almost the same as calling dpif_port_del() directly on the
1253 * datapath, but it also makes 'ofproto' close its open netdev for the port
1254 * (if any). This makes it possible to create a new netdev of a different
1255 * type under the same name, which otherwise the netdev library would refuse
1256 * to do because of the conflict. (The netdev would eventually get closed on
1257 * the next trip through ofproto_run(), but this interface is more direct.)
1259 * Returns 0 if successful, otherwise a positive errno. */
1261 ofproto_port_del(struct ofproto *ofproto, uint16_t odp_port)
1263 struct ofport *ofport = get_port(ofproto, odp_port);
1264 const char *name = ofport ? (char *) ofport->opp.name : "<unknown>";
1267 error = dpif_port_del(ofproto->dpif, odp_port);
1269 VLOG_ERR("%s: failed to remove port %"PRIu16" (%s) interface (%s)",
1270 dpif_name(ofproto->dpif), odp_port, name, strerror(error));
1271 } else if (ofport) {
1272 /* 'name' is ofport->opp.name and update_port() is going to destroy
1273 * 'ofport'. Just in case update_port() refers to 'name' after it
1274 * destroys 'ofport', make a copy of it around the update_port()
1276 char *devname = xstrdup(name);
1277 update_port(ofproto, devname);
1284 ofproto_send_packet(struct ofproto *p, const flow_t *flow,
1285 const union ofp_action *actions, size_t n_actions,
1286 const struct ofpbuf *packet)
1288 struct odp_actions odp_actions;
1291 error = xlate_actions(actions, n_actions, flow, p, packet, &odp_actions,
1297 /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
1299 dpif_execute(p->dpif, flow->in_port, odp_actions.actions,
1300 odp_actions.n_actions, packet);
1305 ofproto_add_flow(struct ofproto *p,
1306 const flow_t *flow, uint32_t wildcards, unsigned int priority,
1307 const union ofp_action *actions, size_t n_actions,
1311 rule = rule_create(p, NULL, actions, n_actions,
1312 idle_timeout >= 0 ? idle_timeout : 5 /* XXX */,
1314 cls_rule_from_flow(flow, wildcards, priority, &rule->cr);
1315 rule_insert(p, rule, NULL, 0);
1319 ofproto_delete_flow(struct ofproto *ofproto, const flow_t *flow,
1320 uint32_t wildcards, unsigned int priority)
1324 rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
1328 rule_remove(ofproto, rule);
1333 destroy_rule(struct cls_rule *rule_, void *ofproto_)
1335 struct rule *rule = rule_from_cls_rule(rule_);
1336 struct ofproto *ofproto = ofproto_;
1338 /* Mark the flow as not installed, even though it might really be
1339 * installed, so that rule_remove() doesn't bother trying to uninstall it.
1340 * There is no point in uninstalling it individually since we are about to
1341 * blow away all the flows with dpif_flow_flush(). */
1342 rule->installed = false;
1344 rule_remove(ofproto, rule);
1348 ofproto_flush_flows(struct ofproto *ofproto)
1350 COVERAGE_INC(ofproto_flush);
1351 classifier_for_each(&ofproto->cls, CLS_INC_ALL, destroy_rule, ofproto);
1352 dpif_flow_flush(ofproto->dpif);
1353 if (ofproto->in_band) {
1354 in_band_flushed(ofproto->in_band);
1356 if (ofproto->fail_open) {
1357 fail_open_flushed(ofproto->fail_open);
1362 reinit_ports(struct ofproto *p)
1364 struct svec devnames;
1365 struct ofport *ofport;
1366 struct odp_port *odp_ports;
1370 svec_init(&devnames);
1371 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1372 svec_add (&devnames, (char *) ofport->opp.name);
1374 dpif_port_list(p->dpif, &odp_ports, &n_odp_ports);
1375 for (i = 0; i < n_odp_ports; i++) {
1376 svec_add (&devnames, odp_ports[i].devname);
1380 svec_sort_unique(&devnames);
1381 for (i = 0; i < devnames.n; i++) {
1382 update_port(p, devnames.names[i]);
1384 svec_destroy(&devnames);
1388 refresh_port_group(struct ofproto *p, unsigned int group)
1392 struct ofport *port;
1394 assert(group == DP_GROUP_ALL || group == DP_GROUP_FLOOD);
1396 ports = xmalloc(hmap_count(&p->ports) * sizeof *ports);
1398 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1399 if (group == DP_GROUP_ALL || !(port->opp.config & OFPPC_NO_FLOOD)) {
1400 ports[n_ports++] = port->odp_port;
1403 dpif_port_group_set(p->dpif, group, ports, n_ports);
1410 refresh_port_groups(struct ofproto *p)
1412 size_t n_flood = refresh_port_group(p, DP_GROUP_FLOOD);
1413 size_t n_all = refresh_port_group(p, DP_GROUP_ALL);
1415 ofproto_sflow_set_group_sizes(p->sflow, n_flood, n_all);
1419 static struct ofport *
1420 make_ofport(const struct odp_port *odp_port)
1422 struct netdev_options netdev_options;
1423 enum netdev_flags flags;
1424 struct ofport *ofport;
1425 struct netdev *netdev;
1429 memset(&netdev_options, 0, sizeof netdev_options);
1430 netdev_options.name = odp_port->devname;
1431 netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1433 error = netdev_open(&netdev_options, &netdev);
1435 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1436 "cannot be opened (%s)",
1437 odp_port->devname, odp_port->port,
1438 odp_port->devname, strerror(error));
1442 ofport = xmalloc(sizeof *ofport);
1443 ofport->netdev = netdev;
1444 ofport->odp_port = odp_port->port;
1445 ofport->opp.port_no = odp_port_to_ofp_port(odp_port->port);
1446 netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1447 memcpy(ofport->opp.name, odp_port->devname,
1448 MIN(sizeof ofport->opp.name, sizeof odp_port->devname));
1449 ofport->opp.name[sizeof ofport->opp.name - 1] = '\0';
1451 netdev_get_flags(netdev, &flags);
1452 ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1454 netdev_get_carrier(netdev, &carrier);
1455 ofport->opp.state = carrier ? 0 : OFPPS_LINK_DOWN;
1457 netdev_get_features(netdev,
1458 &ofport->opp.curr, &ofport->opp.advertised,
1459 &ofport->opp.supported, &ofport->opp.peer);
1464 ofport_conflicts(const struct ofproto *p, const struct odp_port *odp_port)
1466 if (get_port(p, odp_port->port)) {
1467 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1470 } else if (shash_find(&p->port_by_name, odp_port->devname)) {
1471 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1480 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1482 const struct ofp_phy_port *a = &a_->opp;
1483 const struct ofp_phy_port *b = &b_->opp;
1485 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1486 return (a->port_no == b->port_no
1487 && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1488 && !strcmp((char *) a->name, (char *) b->name)
1489 && a->state == b->state
1490 && a->config == b->config
1491 && a->curr == b->curr
1492 && a->advertised == b->advertised
1493 && a->supported == b->supported
1494 && a->peer == b->peer);
1498 send_port_status(struct ofproto *p, const struct ofport *ofport,
1501 /* XXX Should limit the number of queued port status change messages. */
1502 struct ofconn *ofconn;
1503 LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1504 struct ofp_port_status *ops;
1507 if (!ofconn_receives_async_msgs(ofconn)) {
1511 ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1512 ops->reason = reason;
1513 ops->desc = ofport->opp;
1514 hton_ofp_phy_port(&ops->desc);
1515 queue_tx(b, ofconn, NULL);
1520 ofport_install(struct ofproto *p, struct ofport *ofport)
1522 const char *netdev_name = (const char *) ofport->opp.name;
1524 netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1525 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->odp_port, 0));
1526 shash_add(&p->port_by_name, netdev_name, ofport);
1528 ofproto_sflow_add_port(p->sflow, ofport->odp_port, netdev_name);
1533 ofport_remove(struct ofproto *p, struct ofport *ofport)
1535 netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1536 hmap_remove(&p->ports, &ofport->hmap_node);
1537 shash_delete(&p->port_by_name,
1538 shash_find(&p->port_by_name, (char *) ofport->opp.name));
1540 ofproto_sflow_del_port(p->sflow, ofport->odp_port);
1545 ofport_free(struct ofport *ofport)
1548 netdev_close(ofport->netdev);
1553 static struct ofport *
1554 get_port(const struct ofproto *ofproto, uint16_t odp_port)
1556 struct ofport *port;
1558 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1559 hash_int(odp_port, 0), &ofproto->ports) {
1560 if (port->odp_port == odp_port) {
1568 update_port(struct ofproto *p, const char *devname)
1570 struct odp_port odp_port;
1571 struct ofport *old_ofport;
1572 struct ofport *new_ofport;
1575 COVERAGE_INC(ofproto_update_port);
1577 /* Query the datapath for port information. */
1578 error = dpif_port_query_by_name(p->dpif, devname, &odp_port);
1580 /* Find the old ofport. */
1581 old_ofport = shash_find_data(&p->port_by_name, devname);
1584 /* There's no port named 'devname' but there might be a port with
1585 * the same port number. This could happen if a port is deleted
1586 * and then a new one added in its place very quickly, or if a port
1587 * is renamed. In the former case we want to send an OFPPR_DELETE
1588 * and an OFPPR_ADD, and in the latter case we want to send a
1589 * single OFPPR_MODIFY. We can distinguish the cases by comparing
1590 * the old port's ifindex against the new port, or perhaps less
1591 * reliably but more portably by comparing the old port's MAC
1592 * against the new port's MAC. However, this code isn't that smart
1593 * and always sends an OFPPR_MODIFY (XXX). */
1594 old_ofport = get_port(p, odp_port.port);
1596 } else if (error != ENOENT && error != ENODEV) {
1597 VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1598 "%s", strerror(error));
1602 /* Create a new ofport. */
1603 new_ofport = !error ? make_ofport(&odp_port) : NULL;
1605 /* Eliminate a few pathological cases. */
1606 if (!old_ofport && !new_ofport) {
1608 } else if (old_ofport && new_ofport) {
1609 /* Most of the 'config' bits are OpenFlow soft state, but
1610 * OFPPC_PORT_DOWN is maintained the kernel. So transfer the OpenFlow
1611 * bits from old_ofport. (make_ofport() only sets OFPPC_PORT_DOWN and
1612 * leaves the other bits 0.) */
1613 new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1615 if (ofport_equal(old_ofport, new_ofport)) {
1616 /* False alarm--no change. */
1617 ofport_free(new_ofport);
1622 /* Now deal with the normal cases. */
1624 ofport_remove(p, old_ofport);
1627 ofport_install(p, new_ofport);
1629 send_port_status(p, new_ofport ? new_ofport : old_ofport,
1630 (!old_ofport ? OFPPR_ADD
1631 : !new_ofport ? OFPPR_DELETE
1633 ofport_free(old_ofport);
1635 /* Update port groups. */
1636 refresh_port_groups(p);
1640 init_ports(struct ofproto *p)
1642 struct odp_port *ports;
1647 error = dpif_port_list(p->dpif, &ports, &n_ports);
1652 for (i = 0; i < n_ports; i++) {
1653 const struct odp_port *odp_port = &ports[i];
1654 if (!ofport_conflicts(p, odp_port)) {
1655 struct ofport *ofport = make_ofport(odp_port);
1657 ofport_install(p, ofport);
1662 refresh_port_groups(p);
1666 static struct ofconn *
1667 ofconn_create(struct ofproto *p, struct rconn *rconn, enum ofconn_type type)
1669 struct ofconn *ofconn = xzalloc(sizeof *ofconn);
1670 ofconn->ofproto = p;
1671 list_push_back(&p->all_conns, &ofconn->node);
1672 ofconn->rconn = rconn;
1673 ofconn->type = type;
1674 ofconn->role = NX_ROLE_OTHER;
1675 ofconn->packet_in_counter = rconn_packet_counter_create ();
1676 ofconn->pktbuf = NULL;
1677 ofconn->miss_send_len = 0;
1678 ofconn->reply_counter = rconn_packet_counter_create ();
1683 ofconn_destroy(struct ofconn *ofconn)
1685 if (ofconn->type == OFCONN_PRIMARY) {
1686 hmap_remove(&ofconn->ofproto->controllers, &ofconn->hmap_node);
1688 discovery_destroy(ofconn->discovery);
1690 list_remove(&ofconn->node);
1691 switch_status_unregister(ofconn->ss);
1692 rconn_destroy(ofconn->rconn);
1693 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1694 rconn_packet_counter_destroy(ofconn->reply_counter);
1695 pktbuf_destroy(ofconn->pktbuf);
1700 ofconn_run(struct ofconn *ofconn, struct ofproto *p)
1705 if (ofconn->discovery) {
1706 char *controller_name;
1707 if (rconn_is_connectivity_questionable(ofconn->rconn)) {
1708 discovery_question_connectivity(ofconn->discovery);
1710 if (discovery_run(ofconn->discovery, &controller_name)) {
1711 if (controller_name) {
1712 char *ofconn_name = ofconn_make_name(p, controller_name);
1713 rconn_connect(ofconn->rconn, controller_name, ofconn_name);
1716 rconn_disconnect(ofconn->rconn);
1721 for (i = 0; i < N_SCHEDULERS; i++) {
1722 pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1725 rconn_run(ofconn->rconn);
1727 if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1728 /* Limit the number of iterations to prevent other tasks from
1730 for (iteration = 0; iteration < 50; iteration++) {
1731 struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1736 fail_open_maybe_recover(p->fail_open);
1738 handle_openflow(ofconn, p, of_msg);
1739 ofpbuf_delete(of_msg);
1743 if (!ofconn->discovery && !rconn_is_alive(ofconn->rconn)) {
1744 ofconn_destroy(ofconn);
1749 ofconn_wait(struct ofconn *ofconn)
1753 if (ofconn->discovery) {
1754 discovery_wait(ofconn->discovery);
1756 for (i = 0; i < N_SCHEDULERS; i++) {
1757 pinsched_wait(ofconn->schedulers[i]);
1759 rconn_run_wait(ofconn->rconn);
1760 if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1761 rconn_recv_wait(ofconn->rconn);
1763 COVERAGE_INC(ofproto_ofconn_stuck);
1767 /* Returns true if 'ofconn' should receive asynchronous messages. */
1769 ofconn_receives_async_msgs(const struct ofconn *ofconn)
1771 if (ofconn->type == OFCONN_PRIMARY) {
1772 /* Primary controllers always get asynchronous messages unless they
1773 * have configured themselves as "slaves". */
1774 return ofconn->role != NX_ROLE_SLAVE;
1776 /* Service connections don't get asynchronous messages unless they have
1777 * explicitly asked for them by setting a nonzero miss send length. */
1778 return ofconn->miss_send_len > 0;
1782 /* Returns a human-readable name for an OpenFlow connection between 'ofproto'
1783 * and 'target', suitable for use in log messages for identifying the
1786 * The name is dynamically allocated. The caller should free it (with free())
1787 * when it is no longer needed. */
1789 ofconn_make_name(const struct ofproto *ofproto, const char *target)
1791 return xasprintf("%s<->%s", dpif_base_name(ofproto->dpif), target);
1795 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1799 for (i = 0; i < N_SCHEDULERS; i++) {
1800 struct pinsched **s = &ofconn->schedulers[i];
1804 *s = pinsched_create(rate, burst,
1805 ofconn->ofproto->switch_status);
1807 pinsched_set_limits(*s, rate, burst);
1810 pinsched_destroy(*s);
1817 ofservice_reconfigure(struct ofservice *ofservice,
1818 const struct ofproto_controller *c)
1820 ofservice->probe_interval = c->probe_interval;
1821 ofservice->rate_limit = c->rate_limit;
1822 ofservice->burst_limit = c->burst_limit;
1825 /* Creates a new ofservice in 'ofproto'. Returns 0 if successful, otherwise a
1826 * positive errno value. */
1828 ofservice_create(struct ofproto *ofproto, const struct ofproto_controller *c)
1830 struct ofservice *ofservice;
1831 struct pvconn *pvconn;
1834 error = pvconn_open(c->target, &pvconn);
1839 ofservice = xzalloc(sizeof *ofservice);
1840 hmap_insert(&ofproto->services, &ofservice->node,
1841 hash_string(c->target, 0));
1842 ofservice->pvconn = pvconn;
1844 ofservice_reconfigure(ofservice, c);
1850 ofservice_destroy(struct ofproto *ofproto, struct ofservice *ofservice)
1852 hmap_remove(&ofproto->services, &ofservice->node);
1853 pvconn_close(ofservice->pvconn);
1857 /* Finds and returns the ofservice within 'ofproto' that has the given
1858 * 'target', or a null pointer if none exists. */
1859 static struct ofservice *
1860 ofservice_lookup(struct ofproto *ofproto, const char *target)
1862 struct ofservice *ofservice;
1864 HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1865 &ofproto->services) {
1866 if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1873 /* Caller is responsible for initializing the 'cr' member of the returned
1875 static struct rule *
1876 rule_create(struct ofproto *ofproto, struct rule *super,
1877 const union ofp_action *actions, size_t n_actions,
1878 uint16_t idle_timeout, uint16_t hard_timeout,
1879 uint64_t flow_cookie, bool send_flow_removed)
1881 struct rule *rule = xzalloc(sizeof *rule);
1882 rule->idle_timeout = idle_timeout;
1883 rule->hard_timeout = hard_timeout;
1884 rule->flow_cookie = flow_cookie;
1885 rule->used = rule->created = time_msec();
1886 rule->send_flow_removed = send_flow_removed;
1887 rule->super = super;
1889 list_push_back(&super->list, &rule->list);
1891 list_init(&rule->list);
1893 if (n_actions > 0) {
1894 rule->n_actions = n_actions;
1895 rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1897 netflow_flow_clear(&rule->nf_flow);
1898 netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->created);
1903 static struct rule *
1904 rule_from_cls_rule(const struct cls_rule *cls_rule)
1906 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1910 rule_free(struct rule *rule)
1912 free(rule->actions);
1913 free(rule->odp_actions);
1917 /* Destroys 'rule'. If 'rule' is a subrule, also removes it from its
1918 * super-rule's list of subrules. If 'rule' is a super-rule, also iterates
1919 * through all of its subrules and revalidates them, destroying any that no
1920 * longer has a super-rule (which is probably all of them).
1922 * Before calling this function, the caller must make have removed 'rule' from
1923 * the classifier. If 'rule' is an exact-match rule, the caller is also
1924 * responsible for ensuring that it has been uninstalled from the datapath. */
1926 rule_destroy(struct ofproto *ofproto, struct rule *rule)
1929 struct rule *subrule, *next;
1930 LIST_FOR_EACH_SAFE (subrule, next, list, &rule->list) {
1931 revalidate_rule(ofproto, subrule);
1934 list_remove(&rule->list);
1940 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1942 const union ofp_action *oa;
1943 struct actions_iterator i;
1945 if (out_port == htons(OFPP_NONE)) {
1948 for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1949 oa = actions_next(&i)) {
1950 if (action_outputs_to_port(oa, out_port)) {
1957 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
1958 * 'packet', which arrived on 'in_port'.
1960 * Takes ownership of 'packet'. */
1962 execute_odp_actions(struct ofproto *ofproto, uint16_t in_port,
1963 const union odp_action *actions, size_t n_actions,
1964 struct ofpbuf *packet)
1966 if (n_actions == 1 && actions[0].type == ODPAT_CONTROLLER) {
1967 /* As an optimization, avoid a round-trip from userspace to kernel to
1968 * userspace. This also avoids possibly filling up kernel packet
1969 * buffers along the way. */
1970 struct odp_msg *msg;
1972 msg = ofpbuf_push_uninit(packet, sizeof *msg);
1973 msg->type = _ODPL_ACTION_NR;
1974 msg->length = sizeof(struct odp_msg) + packet->size;
1975 msg->port = in_port;
1977 msg->arg = actions[0].controller.arg;
1979 send_packet_in(ofproto, packet);
1985 error = dpif_execute(ofproto->dpif, in_port,
1986 actions, n_actions, packet);
1987 ofpbuf_delete(packet);
1992 /* Executes the actions indicated by 'rule' on 'packet', which is in flow
1993 * 'flow' and is considered to have arrived on ODP port 'in_port'. 'packet'
1994 * must have at least sizeof(struct ofp_packet_in) bytes of headroom.
1996 * The flow that 'packet' actually contains does not need to actually match
1997 * 'rule'; the actions in 'rule' will be applied to it either way. Likewise,
1998 * the packet and byte counters for 'rule' will be credited for the packet sent
1999 * out whether or not the packet actually matches 'rule'.
2001 * If 'rule' is an exact-match rule and 'flow' actually equals the rule's flow,
2002 * the caller must already have accurately composed ODP actions for it given
2003 * 'packet' using rule_make_actions(). If 'rule' is a wildcard rule, or if
2004 * 'rule' is an exact-match rule but 'flow' is not the rule's flow, then this
2005 * function will compose a set of ODP actions based on 'rule''s OpenFlow
2006 * actions and apply them to 'packet'.
2008 * Takes ownership of 'packet'. */
2010 rule_execute(struct ofproto *ofproto, struct rule *rule,
2011 struct ofpbuf *packet, const flow_t *flow)
2013 const union odp_action *actions;
2014 struct odp_flow_stats stats;
2016 struct odp_actions a;
2018 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2020 /* Grab or compose the ODP actions.
2022 * The special case for an exact-match 'rule' where 'flow' is not the
2023 * rule's flow is important to avoid, e.g., sending a packet out its input
2024 * port simply because the ODP actions were composed for the wrong
2026 if (rule->cr.wc.wildcards || !flow_equal(flow, &rule->cr.flow)) {
2027 struct rule *super = rule->super ? rule->super : rule;
2028 if (xlate_actions(super->actions, super->n_actions, flow, ofproto,
2029 packet, &a, NULL, 0, NULL)) {
2030 ofpbuf_delete(packet);
2033 actions = a.actions;
2034 n_actions = a.n_actions;
2036 actions = rule->odp_actions;
2037 n_actions = rule->n_odp_actions;
2040 /* Execute the ODP actions. */
2041 flow_extract_stats(flow, packet, &stats);
2042 if (execute_odp_actions(ofproto, flow->in_port,
2043 actions, n_actions, packet)) {
2044 update_stats(ofproto, rule, &stats);
2045 rule->used = time_msec();
2046 netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->used);
2050 /* Inserts 'rule' into 'p''s flow table.
2052 * If 'packet' is nonnull, takes ownership of 'packet', executes 'rule''s
2053 * actions on it and credits the statistics for sending the packet to 'rule'.
2054 * 'packet' must have at least sizeof(struct ofp_packet_in) bytes of
2057 rule_insert(struct ofproto *p, struct rule *rule, struct ofpbuf *packet,
2060 struct rule *displaced_rule;
2062 /* Insert the rule in the classifier. */
2063 displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
2064 if (!rule->cr.wc.wildcards) {
2065 rule_make_actions(p, rule, packet);
2068 /* Send the packet and credit it to the rule. */
2071 flow_extract(packet, 0, in_port, &flow);
2072 rule_execute(p, rule, packet, &flow);
2075 /* Install the rule in the datapath only after sending the packet, to
2076 * avoid packet reordering. */
2077 if (rule->cr.wc.wildcards) {
2078 COVERAGE_INC(ofproto_add_wc_flow);
2079 p->need_revalidate = true;
2081 rule_install(p, rule, displaced_rule);
2084 /* Free the rule that was displaced, if any. */
2085 if (displaced_rule) {
2086 rule_destroy(p, displaced_rule);
2090 static struct rule *
2091 rule_create_subrule(struct ofproto *ofproto, struct rule *rule,
2094 struct rule *subrule = rule_create(ofproto, rule, NULL, 0,
2095 rule->idle_timeout, rule->hard_timeout,
2097 COVERAGE_INC(ofproto_subrule_create);
2098 cls_rule_from_flow(flow, 0, (rule->cr.priority <= UINT16_MAX ? UINT16_MAX
2099 : rule->cr.priority), &subrule->cr);
2100 classifier_insert_exact(&ofproto->cls, &subrule->cr);
2105 /* Remove 'rule' from 'ofproto' and free up the associated memory:
2107 * - If 'rule' was installed in the datapath, uninstalls it and updates
2108 * 'rule''s statistics (or its super-rule's statistics, if it is a
2109 * subrule), via rule_uninstall().
2111 * - Removes 'rule' from the classifier.
2113 * - If 'rule' is a super-rule that has subrules, revalidates (and possibly
2114 * uninstalls and destroys) its subrules, via rule_destroy().
2117 rule_remove(struct ofproto *ofproto, struct rule *rule)
2119 if (rule->cr.wc.wildcards) {
2120 COVERAGE_INC(ofproto_del_wc_flow);
2121 ofproto->need_revalidate = true;
2123 rule_uninstall(ofproto, rule);
2125 classifier_remove(&ofproto->cls, &rule->cr);
2126 rule_destroy(ofproto, rule);
2129 /* Returns true if the actions changed, false otherwise. */
2131 rule_make_actions(struct ofproto *p, struct rule *rule,
2132 const struct ofpbuf *packet)
2134 const struct rule *super;
2135 struct odp_actions a;
2138 assert(!rule->cr.wc.wildcards);
2140 super = rule->super ? rule->super : rule;
2142 xlate_actions(super->actions, super->n_actions, &rule->cr.flow, p,
2143 packet, &a, &rule->tags, &rule->may_install,
2144 &rule->nf_flow.output_iface);
2146 actions_len = a.n_actions * sizeof *a.actions;
2147 if (rule->n_odp_actions != a.n_actions
2148 || memcmp(rule->odp_actions, a.actions, actions_len)) {
2149 COVERAGE_INC(ofproto_odp_unchanged);
2150 free(rule->odp_actions);
2151 rule->n_odp_actions = a.n_actions;
2152 rule->odp_actions = xmemdup(a.actions, actions_len);
2160 do_put_flow(struct ofproto *ofproto, struct rule *rule, int flags,
2161 struct odp_flow_put *put)
2163 memset(&put->flow.stats, 0, sizeof put->flow.stats);
2164 put->flow.key = rule->cr.flow;
2165 put->flow.actions = rule->odp_actions;
2166 put->flow.n_actions = rule->n_odp_actions;
2167 put->flow.flags = 0;
2169 return dpif_flow_put(ofproto->dpif, put);
2173 rule_install(struct ofproto *p, struct rule *rule, struct rule *displaced_rule)
2175 assert(!rule->cr.wc.wildcards);
2177 if (rule->may_install) {
2178 struct odp_flow_put put;
2179 if (!do_put_flow(p, rule,
2180 ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS,
2182 rule->installed = true;
2183 if (displaced_rule) {
2184 update_stats(p, displaced_rule, &put.flow.stats);
2185 rule_post_uninstall(p, displaced_rule);
2188 } else if (displaced_rule) {
2189 rule_uninstall(p, displaced_rule);
2194 rule_reinstall(struct ofproto *ofproto, struct rule *rule)
2196 if (rule->installed) {
2197 struct odp_flow_put put;
2198 COVERAGE_INC(ofproto_dp_missed);
2199 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY, &put);
2201 rule_install(ofproto, rule, NULL);
2206 rule_update_actions(struct ofproto *ofproto, struct rule *rule)
2208 bool actions_changed;
2209 uint16_t new_out_iface, old_out_iface;
2211 old_out_iface = rule->nf_flow.output_iface;
2212 actions_changed = rule_make_actions(ofproto, rule, NULL);
2214 if (rule->may_install) {
2215 if (rule->installed) {
2216 if (actions_changed) {
2217 struct odp_flow_put put;
2218 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY
2219 | ODPPF_ZERO_STATS, &put);
2220 update_stats(ofproto, rule, &put.flow.stats);
2222 /* Temporarily set the old output iface so that NetFlow
2223 * messages have the correct output interface for the old
2225 new_out_iface = rule->nf_flow.output_iface;
2226 rule->nf_flow.output_iface = old_out_iface;
2227 rule_post_uninstall(ofproto, rule);
2228 rule->nf_flow.output_iface = new_out_iface;
2231 rule_install(ofproto, rule, NULL);
2234 rule_uninstall(ofproto, rule);
2239 rule_account(struct ofproto *ofproto, struct rule *rule, uint64_t extra_bytes)
2241 uint64_t total_bytes = rule->byte_count + extra_bytes;
2243 if (ofproto->ofhooks->account_flow_cb
2244 && total_bytes > rule->accounted_bytes)
2246 ofproto->ofhooks->account_flow_cb(
2247 &rule->cr.flow, rule->tags, rule->odp_actions, rule->n_odp_actions,
2248 total_bytes - rule->accounted_bytes, ofproto->aux);
2249 rule->accounted_bytes = total_bytes;
2253 /* 'rule' must be an exact-match rule in 'p'.
2255 * If 'rule' is installed in the datapath, uninstalls it and updates's
2256 * statistics. If 'rule' is a subrule, the statistics that are updated are
2257 * actually its super-rule's statistics; otherwise 'rule''s own statistics are
2260 * If 'rule' is not installed, this function has no effect. */
2262 rule_uninstall(struct ofproto *p, struct rule *rule)
2264 assert(!rule->cr.wc.wildcards);
2265 if (rule->installed) {
2266 struct odp_flow odp_flow;
2268 odp_flow.key = rule->cr.flow;
2269 odp_flow.actions = NULL;
2270 odp_flow.n_actions = 0;
2272 if (!dpif_flow_del(p->dpif, &odp_flow)) {
2273 update_stats(p, rule, &odp_flow.stats);
2275 rule->installed = false;
2277 rule_post_uninstall(p, rule);
2282 is_controller_rule(struct rule *rule)
2284 /* If the only action is send to the controller then don't report
2285 * NetFlow expiration messages since it is just part of the control
2286 * logic for the network and not real traffic. */
2290 && rule->super->n_actions == 1
2291 && action_outputs_to_port(&rule->super->actions[0],
2292 htons(OFPP_CONTROLLER)));
2296 rule_post_uninstall(struct ofproto *ofproto, struct rule *rule)
2298 struct rule *super = rule->super;
2300 rule_account(ofproto, rule, 0);
2302 if (ofproto->netflow && !is_controller_rule(rule)) {
2303 struct ofexpired expired;
2304 expired.flow = rule->cr.flow;
2305 expired.packet_count = rule->packet_count;
2306 expired.byte_count = rule->byte_count;
2307 expired.used = rule->used;
2308 netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
2311 super->packet_count += rule->packet_count;
2312 super->byte_count += rule->byte_count;
2314 /* Reset counters to prevent double counting if the rule ever gets
2316 rule->packet_count = 0;
2317 rule->byte_count = 0;
2318 rule->accounted_bytes = 0;
2320 netflow_flow_clear(&rule->nf_flow);
2325 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
2326 struct rconn_packet_counter *counter)
2328 update_openflow_length(msg);
2329 if (rconn_send(ofconn->rconn, msg, counter)) {
2335 send_error(const struct ofconn *ofconn, const struct ofp_header *oh,
2336 int error, const void *data, size_t len)
2339 struct ofp_error_msg *oem;
2341 if (!(error >> 16)) {
2342 VLOG_WARN_RL(&rl, "not sending bad error code %d to controller",
2347 COVERAGE_INC(ofproto_error);
2348 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR,
2349 oh ? oh->xid : 0, &buf);
2350 oem->type = htons((unsigned int) error >> 16);
2351 oem->code = htons(error & 0xffff);
2352 memcpy(oem->data, data, len);
2353 queue_tx(buf, ofconn, ofconn->reply_counter);
2357 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
2360 size_t oh_length = ntohs(oh->length);
2361 send_error(ofconn, oh, error, oh, MIN(oh_length, 64));
2365 hton_ofp_phy_port(struct ofp_phy_port *opp)
2367 opp->port_no = htons(opp->port_no);
2368 opp->config = htonl(opp->config);
2369 opp->state = htonl(opp->state);
2370 opp->curr = htonl(opp->curr);
2371 opp->advertised = htonl(opp->advertised);
2372 opp->supported = htonl(opp->supported);
2373 opp->peer = htonl(opp->peer);
2377 handle_echo_request(struct ofconn *ofconn, struct ofp_header *oh)
2379 struct ofp_header *rq = oh;
2380 queue_tx(make_echo_reply(rq), ofconn, ofconn->reply_counter);
2385 handle_features_request(struct ofproto *p, struct ofconn *ofconn,
2386 struct ofp_header *oh)
2388 struct ofp_switch_features *osf;
2390 struct ofport *port;
2392 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
2393 osf->datapath_id = htonll(p->datapath_id);
2394 osf->n_buffers = htonl(pktbuf_capacity());
2396 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
2397 OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
2398 osf->actions = htonl((1u << OFPAT_OUTPUT) |
2399 (1u << OFPAT_SET_VLAN_VID) |
2400 (1u << OFPAT_SET_VLAN_PCP) |
2401 (1u << OFPAT_STRIP_VLAN) |
2402 (1u << OFPAT_SET_DL_SRC) |
2403 (1u << OFPAT_SET_DL_DST) |
2404 (1u << OFPAT_SET_NW_SRC) |
2405 (1u << OFPAT_SET_NW_DST) |
2406 (1u << OFPAT_SET_NW_TOS) |
2407 (1u << OFPAT_SET_TP_SRC) |
2408 (1u << OFPAT_SET_TP_DST) |
2409 (1u << OFPAT_ENQUEUE));
2411 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2412 hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
2415 queue_tx(buf, ofconn, ofconn->reply_counter);
2420 handle_get_config_request(struct ofproto *p, struct ofconn *ofconn,
2421 struct ofp_header *oh)
2424 struct ofp_switch_config *osc;
2428 /* Figure out flags. */
2429 dpif_get_drop_frags(p->dpif, &drop_frags);
2430 flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
2433 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
2434 osc->flags = htons(flags);
2435 osc->miss_send_len = htons(ofconn->miss_send_len);
2436 queue_tx(buf, ofconn, ofconn->reply_counter);
2442 handle_set_config(struct ofproto *p, struct ofconn *ofconn,
2443 struct ofp_switch_config *osc)
2448 error = check_ofp_message(&osc->header, OFPT_SET_CONFIG, sizeof *osc);
2452 flags = ntohs(osc->flags);
2454 if (ofconn->type == OFCONN_PRIMARY && ofconn->role != NX_ROLE_SLAVE) {
2455 switch (flags & OFPC_FRAG_MASK) {
2456 case OFPC_FRAG_NORMAL:
2457 dpif_set_drop_frags(p->dpif, false);
2459 case OFPC_FRAG_DROP:
2460 dpif_set_drop_frags(p->dpif, true);
2463 VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
2469 ofconn->miss_send_len = ntohs(osc->miss_send_len);
2475 add_output_group_action(struct odp_actions *actions, uint16_t group,
2476 uint16_t *nf_output_iface)
2478 odp_actions_add(actions, ODPAT_OUTPUT_GROUP)->output_group.group = group;
2480 if (group == DP_GROUP_ALL || group == DP_GROUP_FLOOD) {
2481 *nf_output_iface = NF_OUT_FLOOD;
2486 add_controller_action(struct odp_actions *actions, uint16_t max_len)
2488 union odp_action *a = odp_actions_add(actions, ODPAT_CONTROLLER);
2489 a->controller.arg = max_len;
2492 struct action_xlate_ctx {
2494 flow_t flow; /* Flow to which these actions correspond. */
2495 int recurse; /* Recursion level, via xlate_table_action. */
2496 struct ofproto *ofproto;
2497 const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
2498 * null pointer if we are revalidating
2499 * without a packet to refer to. */
2502 struct odp_actions *out; /* Datapath actions. */
2503 tag_type *tags; /* Tags associated with OFPP_NORMAL actions. */
2504 bool may_set_up_flow; /* True ordinarily; false if the actions must
2505 * be reassessed for every packet. */
2506 uint16_t nf_output_iface; /* Output interface index for NetFlow. */
2509 /* Maximum depth of flow table recursion (due to NXAST_RESUBMIT actions) in a
2510 * flow translation. */
2511 #define MAX_RESUBMIT_RECURSION 8
2513 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2514 struct action_xlate_ctx *ctx);
2517 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
2519 const struct ofport *ofport = get_port(ctx->ofproto, port);
2522 if (ofport->opp.config & OFPPC_NO_FWD) {
2523 /* Forwarding disabled on port. */
2528 * We don't have an ofport record for this port, but it doesn't hurt to
2529 * allow forwarding to it anyhow. Maybe such a port will appear later
2530 * and we're pre-populating the flow table.
2534 odp_actions_add(ctx->out, ODPAT_OUTPUT)->output.port = port;
2535 ctx->nf_output_iface = port;
2538 static struct rule *
2539 lookup_valid_rule(struct ofproto *ofproto, const flow_t *flow)
2542 rule = rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
2544 /* The rule we found might not be valid, since we could be in need of
2545 * revalidation. If it is not valid, don't return it. */
2548 && ofproto->need_revalidate
2549 && !revalidate_rule(ofproto, rule)) {
2550 COVERAGE_INC(ofproto_invalidated);
2558 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2560 if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2561 uint16_t old_in_port;
2564 /* Look up a flow with 'in_port' as the input port. Then restore the
2565 * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2566 * have surprising behavior). */
2567 old_in_port = ctx->flow.in_port;
2568 ctx->flow.in_port = in_port;
2569 rule = lookup_valid_rule(ctx->ofproto, &ctx->flow);
2570 ctx->flow.in_port = old_in_port;
2578 do_xlate_actions(rule->actions, rule->n_actions, ctx);
2582 struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2584 VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2585 MAX_RESUBMIT_RECURSION);
2590 xlate_output_action__(struct action_xlate_ctx *ctx,
2591 uint16_t port, uint16_t max_len)
2594 uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2596 ctx->nf_output_iface = NF_OUT_DROP;
2600 add_output_action(ctx, ctx->flow.in_port);
2603 xlate_table_action(ctx, ctx->flow.in_port);
2606 if (!ctx->ofproto->ofhooks->normal_cb(&ctx->flow, ctx->packet,
2607 ctx->out, ctx->tags,
2608 &ctx->nf_output_iface,
2609 ctx->ofproto->aux)) {
2610 COVERAGE_INC(ofproto_uninstallable);
2611 ctx->may_set_up_flow = false;
2615 add_output_group_action(ctx->out, DP_GROUP_FLOOD,
2616 &ctx->nf_output_iface);
2619 add_output_group_action(ctx->out, DP_GROUP_ALL, &ctx->nf_output_iface);
2621 case OFPP_CONTROLLER:
2622 add_controller_action(ctx->out, max_len);
2625 add_output_action(ctx, ODPP_LOCAL);
2628 odp_port = ofp_port_to_odp_port(port);
2629 if (odp_port != ctx->flow.in_port) {
2630 add_output_action(ctx, odp_port);
2635 if (prev_nf_output_iface == NF_OUT_FLOOD) {
2636 ctx->nf_output_iface = NF_OUT_FLOOD;
2637 } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2638 ctx->nf_output_iface = prev_nf_output_iface;
2639 } else if (prev_nf_output_iface != NF_OUT_DROP &&
2640 ctx->nf_output_iface != NF_OUT_FLOOD) {
2641 ctx->nf_output_iface = NF_OUT_MULTI;
2646 xlate_output_action(struct action_xlate_ctx *ctx,
2647 const struct ofp_action_output *oao)
2649 xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2652 /* If the final ODP action in 'ctx' is "pop priority", drop it, as an
2653 * optimization, because we're going to add another action that sets the
2654 * priority immediately after, or because there are no actions following the
2657 remove_pop_action(struct action_xlate_ctx *ctx)
2659 size_t n = ctx->out->n_actions;
2660 if (n > 0 && ctx->out->actions[n - 1].type == ODPAT_POP_PRIORITY) {
2661 ctx->out->n_actions--;
2666 xlate_enqueue_action(struct action_xlate_ctx *ctx,
2667 const struct ofp_action_enqueue *oae)
2669 uint16_t ofp_port, odp_port;
2673 error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
2676 /* Fall back to ordinary output action. */
2677 xlate_output_action__(ctx, ntohs(oae->port), 0);
2681 /* Figure out ODP output port. */
2682 ofp_port = ntohs(oae->port);
2683 if (ofp_port != OFPP_IN_PORT) {
2684 odp_port = ofp_port_to_odp_port(ofp_port);
2686 odp_port = ctx->flow.in_port;
2689 /* Add ODP actions. */
2690 remove_pop_action(ctx);
2691 odp_actions_add(ctx->out, ODPAT_SET_PRIORITY)->priority.priority
2693 add_output_action(ctx, odp_port);
2694 odp_actions_add(ctx->out, ODPAT_POP_PRIORITY);
2696 /* Update NetFlow output port. */
2697 if (ctx->nf_output_iface == NF_OUT_DROP) {
2698 ctx->nf_output_iface = odp_port;
2699 } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
2700 ctx->nf_output_iface = NF_OUT_MULTI;
2705 xlate_set_queue_action(struct action_xlate_ctx *ctx,
2706 const struct nx_action_set_queue *nasq)
2711 error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
2714 /* Couldn't translate queue to a priority, so ignore. A warning
2715 * has already been logged. */
2719 remove_pop_action(ctx);
2720 odp_actions_add(ctx->out, ODPAT_SET_PRIORITY)->priority.priority
2725 xlate_nicira_action(struct action_xlate_ctx *ctx,
2726 const struct nx_action_header *nah)
2728 const struct nx_action_resubmit *nar;
2729 const struct nx_action_set_tunnel *nast;
2730 const struct nx_action_set_queue *nasq;
2731 union odp_action *oa;
2732 int subtype = ntohs(nah->subtype);
2734 assert(nah->vendor == htonl(NX_VENDOR_ID));
2736 case NXAST_RESUBMIT:
2737 nar = (const struct nx_action_resubmit *) nah;
2738 xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2741 case NXAST_SET_TUNNEL:
2742 nast = (const struct nx_action_set_tunnel *) nah;
2743 oa = odp_actions_add(ctx->out, ODPAT_SET_TUNNEL);
2744 ctx->flow.tun_id = oa->tunnel.tun_id = nast->tun_id;
2747 case NXAST_DROP_SPOOFED_ARP:
2748 if (ctx->flow.dl_type == htons(ETH_TYPE_ARP)) {
2749 odp_actions_add(ctx->out, ODPAT_DROP_SPOOFED_ARP);
2753 case NXAST_SET_QUEUE:
2754 nasq = (const struct nx_action_set_queue *) nah;
2755 xlate_set_queue_action(ctx, nasq);
2758 case NXAST_POP_QUEUE:
2759 odp_actions_add(ctx->out, ODPAT_POP_PRIORITY);
2762 /* If you add a new action here that modifies flow data, don't forget to
2763 * update the flow key in ctx->flow at the same time. */
2766 VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
2772 do_xlate_actions(const union ofp_action *in, size_t n_in,
2773 struct action_xlate_ctx *ctx)
2775 struct actions_iterator iter;
2776 const union ofp_action *ia;
2777 const struct ofport *port;
2779 port = get_port(ctx->ofproto, ctx->flow.in_port);
2780 if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2781 port->opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
2782 ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2783 /* Drop this flow. */
2787 for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2788 uint16_t type = ntohs(ia->type);
2789 union odp_action *oa;
2793 xlate_output_action(ctx, &ia->output);
2796 case OFPAT_SET_VLAN_VID:
2797 oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_VID);
2798 ctx->flow.dl_vlan = oa->vlan_vid.vlan_vid = ia->vlan_vid.vlan_vid;
2801 case OFPAT_SET_VLAN_PCP:
2802 oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_PCP);
2803 ctx->flow.dl_vlan_pcp = oa->vlan_pcp.vlan_pcp = ia->vlan_pcp.vlan_pcp;
2806 case OFPAT_STRIP_VLAN:
2807 odp_actions_add(ctx->out, ODPAT_STRIP_VLAN);
2808 ctx->flow.dl_vlan = htons(OFP_VLAN_NONE);
2809 ctx->flow.dl_vlan_pcp = 0;
2812 case OFPAT_SET_DL_SRC:
2813 oa = odp_actions_add(ctx->out, ODPAT_SET_DL_SRC);
2814 memcpy(oa->dl_addr.dl_addr,
2815 ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2816 memcpy(ctx->flow.dl_src,
2817 ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2820 case OFPAT_SET_DL_DST:
2821 oa = odp_actions_add(ctx->out, ODPAT_SET_DL_DST);
2822 memcpy(oa->dl_addr.dl_addr,
2823 ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2824 memcpy(ctx->flow.dl_dst,
2825 ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2828 case OFPAT_SET_NW_SRC:
2829 oa = odp_actions_add(ctx->out, ODPAT_SET_NW_SRC);
2830 ctx->flow.nw_src = oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2833 case OFPAT_SET_NW_DST:
2834 oa = odp_actions_add(ctx->out, ODPAT_SET_NW_DST);
2835 ctx->flow.nw_dst = oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2838 case OFPAT_SET_NW_TOS:
2839 oa = odp_actions_add(ctx->out, ODPAT_SET_NW_TOS);
2840 ctx->flow.nw_tos = oa->nw_tos.nw_tos = ia->nw_tos.nw_tos;
2843 case OFPAT_SET_TP_SRC:
2844 oa = odp_actions_add(ctx->out, ODPAT_SET_TP_SRC);
2845 ctx->flow.tp_src = oa->tp_port.tp_port = ia->tp_port.tp_port;
2848 case OFPAT_SET_TP_DST:
2849 oa = odp_actions_add(ctx->out, ODPAT_SET_TP_DST);
2850 ctx->flow.tp_dst = oa->tp_port.tp_port = ia->tp_port.tp_port;
2854 xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
2858 xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
2862 VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
2869 xlate_actions(const union ofp_action *in, size_t n_in,
2870 const flow_t *flow, struct ofproto *ofproto,
2871 const struct ofpbuf *packet,
2872 struct odp_actions *out, tag_type *tags, bool *may_set_up_flow,
2873 uint16_t *nf_output_iface)
2875 tag_type no_tags = 0;
2876 struct action_xlate_ctx ctx;
2877 COVERAGE_INC(ofproto_ofp2odp);
2878 odp_actions_init(out);
2881 ctx.ofproto = ofproto;
2882 ctx.packet = packet;
2884 ctx.tags = tags ? tags : &no_tags;
2885 ctx.may_set_up_flow = true;
2886 ctx.nf_output_iface = NF_OUT_DROP;
2887 do_xlate_actions(in, n_in, &ctx);
2888 remove_pop_action(&ctx);
2890 /* Check with in-band control to see if we're allowed to set up this
2892 if (!in_band_rule_check(ofproto->in_band, flow, out)) {
2893 ctx.may_set_up_flow = false;
2896 if (may_set_up_flow) {
2897 *may_set_up_flow = ctx.may_set_up_flow;
2899 if (nf_output_iface) {
2900 *nf_output_iface = ctx.nf_output_iface;
2902 if (odp_actions_overflow(out)) {
2903 COVERAGE_INC(odp_overflow);
2904 odp_actions_init(out);
2905 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
2910 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2911 * error message code (composed with ofp_mkerr()) for the caller to propagate
2912 * upward. Otherwise, returns 0.
2914 * 'oh' is used to make log messages more informative. */
2916 reject_slave_controller(struct ofconn *ofconn, const struct ofp_header *oh)
2918 if (ofconn->type == OFCONN_PRIMARY && ofconn->role == NX_ROLE_SLAVE) {
2919 static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
2922 type_name = ofp_message_type_to_string(oh->type);
2923 VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
2927 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2934 handle_packet_out(struct ofproto *p, struct ofconn *ofconn,
2935 struct ofp_header *oh)
2937 struct ofp_packet_out *opo;
2938 struct ofpbuf payload, *buffer;
2939 struct odp_actions actions;
2945 error = reject_slave_controller(ofconn, oh);
2950 error = check_ofp_packet_out(oh, &payload, &n_actions, p->max_ports);
2954 opo = (struct ofp_packet_out *) oh;
2956 COVERAGE_INC(ofproto_packet_out);
2957 if (opo->buffer_id != htonl(UINT32_MAX)) {
2958 error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
2960 if (error || !buffer) {
2968 flow_extract(&payload, 0, ofp_port_to_odp_port(ntohs(opo->in_port)), &flow);
2969 error = xlate_actions((const union ofp_action *) opo->actions, n_actions,
2970 &flow, p, &payload, &actions, NULL, NULL, NULL);
2975 dpif_execute(p->dpif, flow.in_port, actions.actions, actions.n_actions,
2977 ofpbuf_delete(buffer);
2983 update_port_config(struct ofproto *p, struct ofport *port,
2984 uint32_t config, uint32_t mask)
2986 mask &= config ^ port->opp.config;
2987 if (mask & OFPPC_PORT_DOWN) {
2988 if (config & OFPPC_PORT_DOWN) {
2989 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2991 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2994 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP | OFPPC_NO_FWD)
2995 if (mask & REVALIDATE_BITS) {
2996 COVERAGE_INC(ofproto_costly_flags);
2997 port->opp.config ^= mask & REVALIDATE_BITS;
2998 p->need_revalidate = true;
3000 #undef REVALIDATE_BITS
3001 if (mask & OFPPC_NO_FLOOD) {
3002 port->opp.config ^= OFPPC_NO_FLOOD;
3003 refresh_port_groups(p);
3005 if (mask & OFPPC_NO_PACKET_IN) {
3006 port->opp.config ^= OFPPC_NO_PACKET_IN;
3011 handle_port_mod(struct ofproto *p, struct ofconn *ofconn,
3012 struct ofp_header *oh)
3014 const struct ofp_port_mod *opm;
3015 struct ofport *port;
3018 error = reject_slave_controller(ofconn, oh);
3022 error = check_ofp_message(oh, OFPT_PORT_MOD, sizeof *opm);
3026 opm = (struct ofp_port_mod *) oh;
3028 port = get_port(p, ofp_port_to_odp_port(ntohs(opm->port_no)));
3030 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
3031 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
3032 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
3034 update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
3035 if (opm->advertise) {
3036 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
3042 static struct ofpbuf *
3043 make_stats_reply(uint32_t xid, uint16_t type, size_t body_len)
3045 struct ofp_stats_reply *osr;
3048 msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
3049 osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
3051 osr->flags = htons(0);
3055 static struct ofpbuf *
3056 start_stats_reply(const struct ofp_stats_request *request, size_t body_len)
3058 return make_stats_reply(request->header.xid, request->type, body_len);
3062 append_stats_reply(size_t nbytes, struct ofconn *ofconn, struct ofpbuf **msgp)
3064 struct ofpbuf *msg = *msgp;
3065 assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
3066 if (nbytes + msg->size > UINT16_MAX) {
3067 struct ofp_stats_reply *reply = msg->data;
3068 reply->flags = htons(OFPSF_REPLY_MORE);
3069 *msgp = make_stats_reply(reply->header.xid, reply->type, nbytes);
3070 queue_tx(msg, ofconn, ofconn->reply_counter);
3072 return ofpbuf_put_uninit(*msgp, nbytes);
3076 handle_desc_stats_request(struct ofproto *p, struct ofconn *ofconn,
3077 struct ofp_stats_request *request)
3079 struct ofp_desc_stats *ods;
3082 msg = start_stats_reply(request, sizeof *ods);
3083 ods = append_stats_reply(sizeof *ods, ofconn, &msg);
3084 memset(ods, 0, sizeof *ods);
3085 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
3086 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
3087 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
3088 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
3089 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
3090 queue_tx(msg, ofconn, ofconn->reply_counter);
3096 handle_table_stats_request(struct ofproto *p, struct ofconn *ofconn,
3097 struct ofp_stats_request *request)
3099 struct ofp_table_stats *ots;
3101 struct odp_stats dpstats;
3102 int n_exact, n_subrules, n_wild;
3105 msg = start_stats_reply(request, sizeof *ots * 2);
3107 /* Count rules of various kinds. */
3109 CLASSIFIER_FOR_EACH_EXACT_RULE (rule, cr, &p->cls) {
3114 n_exact = classifier_count_exact(&p->cls) - n_subrules;
3115 n_wild = classifier_count(&p->cls) - classifier_count_exact(&p->cls);
3118 dpif_get_dp_stats(p->dpif, &dpstats);
3119 ots = append_stats_reply(sizeof *ots, ofconn, &msg);
3120 memset(ots, 0, sizeof *ots);
3121 ots->table_id = TABLEID_HASH;
3122 strcpy(ots->name, "hash");
3123 ots->wildcards = htonl(0);
3124 ots->max_entries = htonl(dpstats.max_capacity);
3125 ots->active_count = htonl(n_exact);
3126 ots->lookup_count = htonll(dpstats.n_frags + dpstats.n_hit +
3128 ots->matched_count = htonll(dpstats.n_hit); /* XXX */
3130 /* Classifier table. */
3131 ots = append_stats_reply(sizeof *ots, ofconn, &msg);
3132 memset(ots, 0, sizeof *ots);
3133 ots->table_id = TABLEID_CLASSIFIER;
3134 strcpy(ots->name, "classifier");
3135 ots->wildcards = p->tun_id_from_cookie ? htonl(OVSFW_ALL)
3137 ots->max_entries = htonl(65536);
3138 ots->active_count = htonl(n_wild);
3139 ots->lookup_count = htonll(0); /* XXX */
3140 ots->matched_count = htonll(0); /* XXX */
3142 queue_tx(msg, ofconn, ofconn->reply_counter);
3147 append_port_stat(struct ofport *port, struct ofconn *ofconn,
3148 struct ofpbuf **msgp)
3150 struct netdev_stats stats;
3151 struct ofp_port_stats *ops;
3153 /* Intentionally ignore return value, since errors will set
3154 * 'stats' to all-1s, which is correct for OpenFlow, and
3155 * netdev_get_stats() will log errors. */
3156 netdev_get_stats(port->netdev, &stats);
3158 ops = append_stats_reply(sizeof *ops, ofconn, msgp);
3159 ops->port_no = htons(port->opp.port_no);
3160 memset(ops->pad, 0, sizeof ops->pad);
3161 ops->rx_packets = htonll(stats.rx_packets);
3162 ops->tx_packets = htonll(stats.tx_packets);
3163 ops->rx_bytes = htonll(stats.rx_bytes);
3164 ops->tx_bytes = htonll(stats.tx_bytes);
3165 ops->rx_dropped = htonll(stats.rx_dropped);
3166 ops->tx_dropped = htonll(stats.tx_dropped);
3167 ops->rx_errors = htonll(stats.rx_errors);
3168 ops->tx_errors = htonll(stats.tx_errors);
3169 ops->rx_frame_err = htonll(stats.rx_frame_errors);
3170 ops->rx_over_err = htonll(stats.rx_over_errors);
3171 ops->rx_crc_err = htonll(stats.rx_crc_errors);
3172 ops->collisions = htonll(stats.collisions);
3176 handle_port_stats_request(struct ofproto *p, struct ofconn *ofconn,
3177 struct ofp_stats_request *osr,
3180 struct ofp_port_stats_request *psr;
3181 struct ofp_port_stats *ops;
3183 struct ofport *port;
3185 if (arg_size != sizeof *psr) {
3186 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3188 psr = (struct ofp_port_stats_request *) osr->body;
3190 msg = start_stats_reply(osr, sizeof *ops * 16);
3191 if (psr->port_no != htons(OFPP_NONE)) {
3192 port = get_port(p, ofp_port_to_odp_port(ntohs(psr->port_no)));
3194 append_port_stat(port, ofconn, &msg);
3197 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3198 append_port_stat(port, ofconn, &msg);
3202 queue_tx(msg, ofconn, ofconn->reply_counter);
3206 struct flow_stats_cbdata {
3207 struct ofproto *ofproto;
3208 struct ofconn *ofconn;
3213 /* Obtains statistic counters for 'rule' within 'p' and stores them into
3214 * '*packet_countp' and '*byte_countp'. If 'rule' is a wildcarded rule, the
3215 * returned statistic include statistics for all of 'rule''s subrules. */
3217 query_stats(struct ofproto *p, struct rule *rule,
3218 uint64_t *packet_countp, uint64_t *byte_countp)
3220 uint64_t packet_count, byte_count;
3221 struct rule *subrule;
3222 struct odp_flow *odp_flows;
3225 /* Start from historical data for 'rule' itself that are no longer tracked
3226 * by the datapath. This counts, for example, subrules that have
3228 packet_count = rule->packet_count;
3229 byte_count = rule->byte_count;
3231 /* Prepare to ask the datapath for statistics on 'rule', or if it is
3232 * wildcarded then on all of its subrules.
3234 * Also, add any statistics that are not tracked by the datapath for each
3235 * subrule. This includes, for example, statistics for packets that were
3236 * executed "by hand" by ofproto via dpif_execute() but must be accounted
3238 n_odp_flows = rule->cr.wc.wildcards ? list_size(&rule->list) : 1;
3239 odp_flows = xzalloc(n_odp_flows * sizeof *odp_flows);
3240 if (rule->cr.wc.wildcards) {
3242 LIST_FOR_EACH (subrule, list, &rule->list) {
3243 odp_flows[i++].key = subrule->cr.flow;
3244 packet_count += subrule->packet_count;
3245 byte_count += subrule->byte_count;
3248 odp_flows[0].key = rule->cr.flow;
3251 /* Fetch up-to-date statistics from the datapath and add them in. */
3252 if (!dpif_flow_get_multiple(p->dpif, odp_flows, n_odp_flows)) {
3254 for (i = 0; i < n_odp_flows; i++) {
3255 struct odp_flow *odp_flow = &odp_flows[i];
3256 packet_count += odp_flow->stats.n_packets;
3257 byte_count += odp_flow->stats.n_bytes;
3262 /* Return the stats to the caller. */
3263 *packet_countp = packet_count;
3264 *byte_countp = byte_count;
3268 flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
3270 struct rule *rule = rule_from_cls_rule(rule_);
3271 struct flow_stats_cbdata *cbdata = cbdata_;
3272 struct ofp_flow_stats *ofs;
3273 uint64_t packet_count, byte_count;
3274 size_t act_len, len;
3275 long long int tdiff = time_msec() - rule->created;
3276 uint32_t sec = tdiff / 1000;
3277 uint32_t msec = tdiff - (sec * 1000);
3279 if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
3283 act_len = sizeof *rule->actions * rule->n_actions;
3284 len = offsetof(struct ofp_flow_stats, actions) + act_len;
3286 query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
3288 ofs = append_stats_reply(len, cbdata->ofconn, &cbdata->msg);
3289 ofs->length = htons(len);
3290 ofs->table_id = rule->cr.wc.wildcards ? TABLEID_CLASSIFIER : TABLEID_HASH;
3292 flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards,
3293 cbdata->ofproto->tun_id_from_cookie, &ofs->match);
3294 ofs->duration_sec = htonl(sec);
3295 ofs->duration_nsec = htonl(msec * 1000000);
3296 ofs->cookie = rule->flow_cookie;
3297 ofs->priority = htons(rule->cr.priority);
3298 ofs->idle_timeout = htons(rule->idle_timeout);
3299 ofs->hard_timeout = htons(rule->hard_timeout);
3300 memset(ofs->pad2, 0, sizeof ofs->pad2);
3301 ofs->packet_count = htonll(packet_count);
3302 ofs->byte_count = htonll(byte_count);
3303 if (rule->n_actions > 0) {
3304 memcpy(ofs->actions, rule->actions, act_len);
3309 table_id_to_include(uint8_t table_id)
3311 return (table_id == TABLEID_HASH ? CLS_INC_EXACT
3312 : table_id == TABLEID_CLASSIFIER ? CLS_INC_WILD
3313 : table_id == 0xff ? CLS_INC_ALL
3318 handle_flow_stats_request(struct ofproto *p, struct ofconn *ofconn,
3319 const struct ofp_stats_request *osr,
3322 struct ofp_flow_stats_request *fsr;
3323 struct flow_stats_cbdata cbdata;
3324 struct cls_rule target;
3326 if (arg_size != sizeof *fsr) {
3327 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3329 fsr = (struct ofp_flow_stats_request *) osr->body;
3331 COVERAGE_INC(ofproto_flows_req);
3333 cbdata.ofconn = ofconn;
3334 cbdata.out_port = fsr->out_port;
3335 cbdata.msg = start_stats_reply(osr, 1024);
3336 cls_rule_from_match(&fsr->match, 0, false, 0, &target);
3337 classifier_for_each_match(&p->cls, &target,
3338 table_id_to_include(fsr->table_id),
3339 flow_stats_cb, &cbdata);
3340 queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3344 struct flow_stats_ds_cbdata {
3345 struct ofproto *ofproto;
3350 flow_stats_ds_cb(struct cls_rule *rule_, void *cbdata_)
3352 struct rule *rule = rule_from_cls_rule(rule_);
3353 struct flow_stats_ds_cbdata *cbdata = cbdata_;
3354 struct ds *results = cbdata->results;
3355 struct ofp_match match;
3356 uint64_t packet_count, byte_count;
3357 size_t act_len = sizeof *rule->actions * rule->n_actions;
3359 /* Don't report on subrules. */
3360 if (rule->super != NULL) {
3364 query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
3365 flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards,
3366 cbdata->ofproto->tun_id_from_cookie, &match);
3368 ds_put_format(results, "duration=%llds, ",
3369 (time_msec() - rule->created) / 1000);
3370 ds_put_format(results, "priority=%u, ", rule->cr.priority);
3371 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3372 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3373 ofp_print_match(results, &match, true);
3375 ofp_print_actions(results, &rule->actions->header, act_len);
3377 ds_put_cstr(results, "\n");
3380 /* Adds a pretty-printed description of all flows to 'results', including
3381 * those marked hidden by secchan (e.g., by in-band control). */
3383 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3385 struct ofp_match match;
3386 struct cls_rule target;
3387 struct flow_stats_ds_cbdata cbdata;
3389 memset(&match, 0, sizeof match);
3390 match.wildcards = htonl(OVSFW_ALL);
3393 cbdata.results = results;
3395 cls_rule_from_match(&match, 0, false, 0, &target);
3396 classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
3397 flow_stats_ds_cb, &cbdata);
3400 struct aggregate_stats_cbdata {
3401 struct ofproto *ofproto;
3403 uint64_t packet_count;
3404 uint64_t byte_count;
3409 aggregate_stats_cb(struct cls_rule *rule_, void *cbdata_)
3411 struct rule *rule = rule_from_cls_rule(rule_);
3412 struct aggregate_stats_cbdata *cbdata = cbdata_;
3413 uint64_t packet_count, byte_count;
3415 if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
3419 query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
3421 cbdata->packet_count += packet_count;
3422 cbdata->byte_count += byte_count;
3427 handle_aggregate_stats_request(struct ofproto *p, struct ofconn *ofconn,
3428 const struct ofp_stats_request *osr,
3431 struct ofp_aggregate_stats_request *asr;
3432 struct ofp_aggregate_stats_reply *reply;
3433 struct aggregate_stats_cbdata cbdata;
3434 struct cls_rule target;
3437 if (arg_size != sizeof *asr) {
3438 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3440 asr = (struct ofp_aggregate_stats_request *) osr->body;
3442 COVERAGE_INC(ofproto_agg_request);
3444 cbdata.out_port = asr->out_port;
3445 cbdata.packet_count = 0;
3446 cbdata.byte_count = 0;
3448 cls_rule_from_match(&asr->match, 0, false, 0, &target);
3449 classifier_for_each_match(&p->cls, &target,
3450 table_id_to_include(asr->table_id),
3451 aggregate_stats_cb, &cbdata);
3453 msg = start_stats_reply(osr, sizeof *reply);
3454 reply = append_stats_reply(sizeof *reply, ofconn, &msg);
3455 reply->flow_count = htonl(cbdata.n_flows);
3456 reply->packet_count = htonll(cbdata.packet_count);
3457 reply->byte_count = htonll(cbdata.byte_count);
3458 queue_tx(msg, ofconn, ofconn->reply_counter);
3462 struct queue_stats_cbdata {
3463 struct ofconn *ofconn;
3464 struct ofport *ofport;
3469 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3470 const struct netdev_queue_stats *stats)
3472 struct ofp_queue_stats *reply;
3474 reply = append_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
3475 reply->port_no = htons(cbdata->ofport->opp.port_no);
3476 memset(reply->pad, 0, sizeof reply->pad);
3477 reply->queue_id = htonl(queue_id);
3478 reply->tx_bytes = htonll(stats->tx_bytes);
3479 reply->tx_packets = htonll(stats->tx_packets);
3480 reply->tx_errors = htonll(stats->tx_errors);
3484 handle_queue_stats_dump_cb(uint32_t queue_id,
3485 struct netdev_queue_stats *stats,
3488 struct queue_stats_cbdata *cbdata = cbdata_;
3490 put_queue_stats(cbdata, queue_id, stats);
3494 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3495 struct queue_stats_cbdata *cbdata)
3497 cbdata->ofport = port;
3498 if (queue_id == OFPQ_ALL) {
3499 netdev_dump_queue_stats(port->netdev,
3500 handle_queue_stats_dump_cb, cbdata);
3502 struct netdev_queue_stats stats;
3504 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3505 put_queue_stats(cbdata, queue_id, &stats);
3511 handle_queue_stats_request(struct ofproto *ofproto, struct ofconn *ofconn,
3512 const struct ofp_stats_request *osr,
3515 struct ofp_queue_stats_request *qsr;
3516 struct queue_stats_cbdata cbdata;
3517 struct ofport *port;
3518 unsigned int port_no;
3521 if (arg_size != sizeof *qsr) {
3522 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3524 qsr = (struct ofp_queue_stats_request *) osr->body;
3526 COVERAGE_INC(ofproto_queue_req);
3528 cbdata.ofconn = ofconn;
3529 cbdata.msg = start_stats_reply(osr, 128);
3531 port_no = ntohs(qsr->port_no);
3532 queue_id = ntohl(qsr->queue_id);
3533 if (port_no == OFPP_ALL) {
3534 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3535 handle_queue_stats_for_port(port, queue_id, &cbdata);
3537 } else if (port_no < ofproto->max_ports) {
3538 port = get_port(ofproto, ofp_port_to_odp_port(port_no));
3540 handle_queue_stats_for_port(port, queue_id, &cbdata);
3543 ofpbuf_delete(cbdata.msg);
3544 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
3546 queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3552 handle_stats_request(struct ofproto *p, struct ofconn *ofconn,
3553 struct ofp_header *oh)
3555 struct ofp_stats_request *osr;
3559 error = check_ofp_message_array(oh, OFPT_STATS_REQUEST, sizeof *osr,
3564 osr = (struct ofp_stats_request *) oh;
3566 switch (ntohs(osr->type)) {
3568 return handle_desc_stats_request(p, ofconn, osr);
3571 return handle_flow_stats_request(p, ofconn, osr, arg_size);
3573 case OFPST_AGGREGATE:
3574 return handle_aggregate_stats_request(p, ofconn, osr, arg_size);
3577 return handle_table_stats_request(p, ofconn, osr);
3580 return handle_port_stats_request(p, ofconn, osr, arg_size);
3583 return handle_queue_stats_request(p, ofconn, osr, arg_size);
3586 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
3589 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
3593 static long long int
3594 msec_from_nsec(uint64_t sec, uint32_t nsec)
3596 return !sec ? 0 : sec * 1000 + nsec / 1000000;
3600 update_time(struct ofproto *ofproto, struct rule *rule,
3601 const struct odp_flow_stats *stats)
3603 long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
3604 if (used > rule->used) {
3606 if (rule->super && used > rule->super->used) {
3607 rule->super->used = used;
3609 netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
3614 update_stats(struct ofproto *ofproto, struct rule *rule,
3615 const struct odp_flow_stats *stats)
3617 if (stats->n_packets) {
3618 update_time(ofproto, rule, stats);
3619 rule->packet_count += stats->n_packets;
3620 rule->byte_count += stats->n_bytes;
3621 netflow_flow_update_flags(&rule->nf_flow, stats->tcp_flags);
3625 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3626 * in which no matching flow already exists in the flow table.
3628 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3629 * ofp_actions, to 'p''s flow table. Returns 0 on success or an OpenFlow error
3630 * code as encoded by ofp_mkerr() on failure.
3632 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3635 add_flow(struct ofproto *p, struct ofconn *ofconn,
3636 const struct ofp_flow_mod *ofm, size_t n_actions)
3638 struct ofpbuf *packet;
3643 if (ofm->flags & htons(OFPFF_CHECK_OVERLAP)) {
3647 flow_from_match(&ofm->match, p->tun_id_from_cookie, ofm->cookie,
3649 if (classifier_rule_overlaps(&p->cls, &flow, wildcards,
3650 ntohs(ofm->priority))) {
3651 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
3655 rule = rule_create(p, NULL, (const union ofp_action *) ofm->actions,
3656 n_actions, ntohs(ofm->idle_timeout),
3657 ntohs(ofm->hard_timeout), ofm->cookie,
3658 ofm->flags & htons(OFPFF_SEND_FLOW_REM));
3659 cls_rule_from_match(&ofm->match, ntohs(ofm->priority),
3660 p->tun_id_from_cookie, ofm->cookie, &rule->cr);
3663 if (ofm->buffer_id != htonl(UINT32_MAX)) {
3664 error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
3668 in_port = UINT16_MAX;
3671 rule_insert(p, rule, packet, in_port);
3675 static struct rule *
3676 find_flow_strict(struct ofproto *p, const struct ofp_flow_mod *ofm)
3681 flow_from_match(&ofm->match, p->tun_id_from_cookie, ofm->cookie,
3683 return rule_from_cls_rule(classifier_find_rule_exactly(
3684 &p->cls, &flow, wildcards,
3685 ntohs(ofm->priority)));
3689 send_buffered_packet(struct ofproto *ofproto, struct ofconn *ofconn,
3690 struct rule *rule, const struct ofp_flow_mod *ofm)
3692 struct ofpbuf *packet;
3697 if (ofm->buffer_id == htonl(UINT32_MAX)) {
3701 error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
3707 flow_extract(packet, 0, in_port, &flow);
3708 rule_execute(ofproto, rule, packet, &flow);
3713 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3715 struct modify_flows_cbdata {
3716 struct ofproto *ofproto;
3717 const struct ofp_flow_mod *ofm;
3722 static int modify_flow(struct ofproto *, const struct ofp_flow_mod *,
3723 size_t n_actions, struct rule *);
3724 static void modify_flows_cb(struct cls_rule *, void *cbdata_);
3726 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
3727 * encoded by ofp_mkerr() on failure.
3729 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3732 modify_flows_loose(struct ofproto *p, struct ofconn *ofconn,
3733 const struct ofp_flow_mod *ofm, size_t n_actions)
3735 struct modify_flows_cbdata cbdata;
3736 struct cls_rule target;
3740 cbdata.n_actions = n_actions;
3741 cbdata.match = NULL;
3743 cls_rule_from_match(&ofm->match, 0, p->tun_id_from_cookie, ofm->cookie,
3746 classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
3747 modify_flows_cb, &cbdata);
3749 /* This credits the packet to whichever flow happened to happened to
3750 * match last. That's weird. Maybe we should do a lookup for the
3751 * flow that actually matches the packet? Who knows. */
3752 send_buffered_packet(p, ofconn, cbdata.match, ofm);
3755 return add_flow(p, ofconn, ofm, n_actions);
3759 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3760 * code as encoded by ofp_mkerr() on failure.
3762 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3765 modify_flow_strict(struct ofproto *p, struct ofconn *ofconn,
3766 struct ofp_flow_mod *ofm, size_t n_actions)
3768 struct rule *rule = find_flow_strict(p, ofm);
3769 if (rule && !rule_is_hidden(rule)) {
3770 modify_flow(p, ofm, n_actions, rule);
3771 return send_buffered_packet(p, ofconn, rule, ofm);
3773 return add_flow(p, ofconn, ofm, n_actions);
3777 /* Callback for modify_flows_loose(). */
3779 modify_flows_cb(struct cls_rule *rule_, void *cbdata_)
3781 struct rule *rule = rule_from_cls_rule(rule_);
3782 struct modify_flows_cbdata *cbdata = cbdata_;
3784 if (!rule_is_hidden(rule)) {
3785 cbdata->match = rule;
3786 modify_flow(cbdata->ofproto, cbdata->ofm, cbdata->n_actions, rule);
3790 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
3791 * been identified as a flow in 'p''s flow table to be modified, by changing
3792 * the rule's actions to match those in 'ofm' (which is followed by 'n_actions'
3793 * ofp_action[] structures). */
3795 modify_flow(struct ofproto *p, const struct ofp_flow_mod *ofm,
3796 size_t n_actions, struct rule *rule)
3798 size_t actions_len = n_actions * sizeof *rule->actions;
3800 rule->flow_cookie = ofm->cookie;
3802 /* If the actions are the same, do nothing. */
3803 if (n_actions == rule->n_actions
3804 && (!n_actions || !memcmp(ofm->actions, rule->actions, actions_len)))
3809 /* Replace actions. */
3810 free(rule->actions);
3811 rule->actions = n_actions ? xmemdup(ofm->actions, actions_len) : NULL;
3812 rule->n_actions = n_actions;
3814 /* Make sure that the datapath gets updated properly. */
3815 if (rule->cr.wc.wildcards) {
3816 COVERAGE_INC(ofproto_mod_wc_flow);
3817 p->need_revalidate = true;
3819 rule_update_actions(p, rule);
3825 /* OFPFC_DELETE implementation. */
3827 struct delete_flows_cbdata {
3828 struct ofproto *ofproto;
3832 static void delete_flows_cb(struct cls_rule *, void *cbdata_);
3833 static void delete_flow(struct ofproto *, struct rule *, uint16_t out_port);
3835 /* Implements OFPFC_DELETE. */
3837 delete_flows_loose(struct ofproto *p, const struct ofp_flow_mod *ofm)
3839 struct delete_flows_cbdata cbdata;
3840 struct cls_rule target;
3843 cbdata.out_port = ofm->out_port;
3845 cls_rule_from_match(&ofm->match, 0, p->tun_id_from_cookie, ofm->cookie,
3848 classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
3849 delete_flows_cb, &cbdata);
3852 /* Implements OFPFC_DELETE_STRICT. */
3854 delete_flow_strict(struct ofproto *p, struct ofp_flow_mod *ofm)
3856 struct rule *rule = find_flow_strict(p, ofm);
3858 delete_flow(p, rule, ofm->out_port);
3862 /* Callback for delete_flows_loose(). */
3864 delete_flows_cb(struct cls_rule *rule_, void *cbdata_)
3866 struct rule *rule = rule_from_cls_rule(rule_);
3867 struct delete_flows_cbdata *cbdata = cbdata_;
3869 delete_flow(cbdata->ofproto, rule, cbdata->out_port);
3872 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
3873 * been identified as a flow to delete from 'p''s flow table, by deleting the
3874 * flow and sending out a OFPT_FLOW_REMOVED message to any interested
3877 * Will not delete 'rule' if it is hidden. Will delete 'rule' only if
3878 * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
3879 * specified 'out_port'. */
3881 delete_flow(struct ofproto *p, struct rule *rule, uint16_t out_port)
3883 if (rule_is_hidden(rule)) {
3887 if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
3891 send_flow_removed(p, rule, time_msec(), OFPRR_DELETE);
3892 rule_remove(p, rule);
3896 handle_flow_mod(struct ofproto *p, struct ofconn *ofconn,
3897 struct ofp_flow_mod *ofm)
3899 struct ofp_match orig_match;
3903 error = reject_slave_controller(ofconn, &ofm->header);
3907 error = check_ofp_message_array(&ofm->header, OFPT_FLOW_MOD, sizeof *ofm,
3908 sizeof *ofm->actions, &n_actions);
3913 /* We do not support the emergency flow cache. It will hopefully
3914 * get dropped from OpenFlow in the near future. */
3915 if (ofm->flags & htons(OFPFF_EMERG)) {
3916 /* There isn't a good fit for an error code, so just state that the
3917 * flow table is full. */
3918 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
3921 /* Normalize ofp->match. If normalization actually changes anything, then
3922 * log the differences. */
3923 ofm->match.pad1[0] = ofm->match.pad2[0] = 0;
3924 orig_match = ofm->match;
3925 normalize_match(&ofm->match);
3926 if (memcmp(&ofm->match, &orig_match, sizeof orig_match)) {
3927 static struct vlog_rate_limit normal_rl = VLOG_RATE_LIMIT_INIT(1, 1);
3928 if (!VLOG_DROP_INFO(&normal_rl)) {
3929 char *old = ofp_match_to_literal_string(&orig_match);
3930 char *new = ofp_match_to_literal_string(&ofm->match);
3931 VLOG_INFO("%s: normalization changed ofp_match, details:",
3932 rconn_get_name(ofconn->rconn));
3933 VLOG_INFO(" pre: %s", old);
3934 VLOG_INFO("post: %s", new);
3940 if (!ofm->match.wildcards) {
3941 ofm->priority = htons(UINT16_MAX);
3944 error = validate_actions((const union ofp_action *) ofm->actions,
3945 n_actions, p->max_ports);
3950 switch (ntohs(ofm->command)) {
3952 return add_flow(p, ofconn, ofm, n_actions);
3955 return modify_flows_loose(p, ofconn, ofm, n_actions);
3957 case OFPFC_MODIFY_STRICT:
3958 return modify_flow_strict(p, ofconn, ofm, n_actions);
3961 delete_flows_loose(p, ofm);
3964 case OFPFC_DELETE_STRICT:
3965 delete_flow_strict(p, ofm);
3969 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
3974 handle_tun_id_from_cookie(struct ofproto *p, struct nxt_tun_id_cookie *msg)
3978 error = check_ofp_message(&msg->header, OFPT_VENDOR, sizeof *msg);
3983 p->tun_id_from_cookie = !!msg->set;
3988 handle_role_request(struct ofproto *ofproto,
3989 struct ofconn *ofconn, struct nicira_header *msg)
3991 struct nx_role_request *nrr;
3992 struct nx_role_request *reply;
3996 if (ntohs(msg->header.length) != sizeof *nrr) {
3997 VLOG_WARN_RL(&rl, "received role request of length %u (expected %zu)",
3998 ntohs(msg->header.length), sizeof *nrr);
3999 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4001 nrr = (struct nx_role_request *) msg;
4003 if (ofconn->type != OFCONN_PRIMARY) {
4004 VLOG_WARN_RL(&rl, "ignoring role request on non-controller "
4006 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4009 role = ntohl(nrr->role);
4010 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
4011 && role != NX_ROLE_SLAVE) {
4012 VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
4014 /* There's no good error code for this. */
4015 return ofp_mkerr(OFPET_BAD_REQUEST, -1);
4018 if (role == NX_ROLE_MASTER) {
4019 struct ofconn *other;
4021 HMAP_FOR_EACH (other, hmap_node, &ofproto->controllers) {
4022 if (other->role == NX_ROLE_MASTER) {
4023 other->role = NX_ROLE_SLAVE;
4027 ofconn->role = role;
4029 reply = make_openflow_xid(sizeof *reply, OFPT_VENDOR, msg->header.xid,
4031 reply->nxh.vendor = htonl(NX_VENDOR_ID);
4032 reply->nxh.subtype = htonl(NXT_ROLE_REPLY);
4033 reply->role = htonl(role);
4034 queue_tx(buf, ofconn, ofconn->reply_counter);
4040 handle_vendor(struct ofproto *p, struct ofconn *ofconn, void *msg)
4042 struct ofp_vendor_header *ovh = msg;
4043 struct nicira_header *nh;
4045 if (ntohs(ovh->header.length) < sizeof(struct ofp_vendor_header)) {
4046 VLOG_WARN_RL(&rl, "received vendor message of length %u "
4047 "(expected at least %zu)",
4048 ntohs(ovh->header.length), sizeof(struct ofp_vendor_header));
4049 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4051 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
4052 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
4054 if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
4055 VLOG_WARN_RL(&rl, "received Nicira vendor message of length %u "
4056 "(expected at least %zu)",
4057 ntohs(ovh->header.length), sizeof(struct nicira_header));
4058 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4062 switch (ntohl(nh->subtype)) {
4063 case NXT_STATUS_REQUEST:
4064 return switch_status_handle_request(p->switch_status, ofconn->rconn,
4067 case NXT_TUN_ID_FROM_COOKIE:
4068 return handle_tun_id_from_cookie(p, msg);
4070 case NXT_ROLE_REQUEST:
4071 return handle_role_request(p, ofconn, msg);
4074 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
4078 handle_barrier_request(struct ofconn *ofconn, struct ofp_header *oh)
4080 struct ofp_header *ob;
4083 /* Currently, everything executes synchronously, so we can just
4084 * immediately send the barrier reply. */
4085 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
4086 queue_tx(buf, ofconn, ofconn->reply_counter);
4091 handle_openflow(struct ofconn *ofconn, struct ofproto *p,
4092 struct ofpbuf *ofp_msg)
4094 struct ofp_header *oh = ofp_msg->data;
4097 COVERAGE_INC(ofproto_recv_openflow);
4099 case OFPT_ECHO_REQUEST:
4100 error = handle_echo_request(ofconn, oh);
4103 case OFPT_ECHO_REPLY:
4107 case OFPT_FEATURES_REQUEST:
4108 error = handle_features_request(p, ofconn, oh);
4111 case OFPT_GET_CONFIG_REQUEST:
4112 error = handle_get_config_request(p, ofconn, oh);
4115 case OFPT_SET_CONFIG:
4116 error = handle_set_config(p, ofconn, ofp_msg->data);
4119 case OFPT_PACKET_OUT:
4120 error = handle_packet_out(p, ofconn, ofp_msg->data);
4124 error = handle_port_mod(p, ofconn, oh);
4128 error = handle_flow_mod(p, ofconn, ofp_msg->data);
4131 case OFPT_STATS_REQUEST:
4132 error = handle_stats_request(p, ofconn, oh);
4136 error = handle_vendor(p, ofconn, ofp_msg->data);
4139 case OFPT_BARRIER_REQUEST:
4140 error = handle_barrier_request(ofconn, oh);
4144 if (VLOG_IS_WARN_ENABLED()) {
4145 char *s = ofp_to_string(oh, ntohs(oh->length), 2);
4146 VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
4149 error = ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
4154 send_error_oh(ofconn, ofp_msg->data, error);
4159 handle_odp_miss_msg(struct ofproto *p, struct ofpbuf *packet)
4161 struct odp_msg *msg = packet->data;
4163 struct ofpbuf payload;
4166 payload.data = msg + 1;
4167 payload.size = msg->length - sizeof *msg;
4168 flow_extract(&payload, msg->arg, msg->port, &flow);
4170 /* Check with in-band control to see if this packet should be sent
4171 * to the local port regardless of the flow table. */
4172 if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
4173 union odp_action action;
4175 memset(&action, 0, sizeof(action));
4176 action.output.type = ODPAT_OUTPUT;
4177 action.output.port = ODPP_LOCAL;
4178 dpif_execute(p->dpif, flow.in_port, &action, 1, &payload);
4181 rule = lookup_valid_rule(p, &flow);
4183 /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
4184 struct ofport *port = get_port(p, msg->port);
4186 if (port->opp.config & OFPPC_NO_PACKET_IN) {
4187 COVERAGE_INC(ofproto_no_packet_in);
4188 /* XXX install 'drop' flow entry */
4189 ofpbuf_delete(packet);
4193 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, msg->port);
4196 COVERAGE_INC(ofproto_packet_in);
4197 send_packet_in(p, packet);
4201 if (rule->cr.wc.wildcards) {
4202 rule = rule_create_subrule(p, rule, &flow);
4203 rule_make_actions(p, rule, packet);
4205 if (!rule->may_install) {
4206 /* The rule is not installable, that is, we need to process every
4207 * packet, so process the current packet and set its actions into
4209 rule_make_actions(p, rule, packet);
4211 /* XXX revalidate rule if it needs it */
4215 if (rule->super && rule->super->cr.priority == FAIL_OPEN_PRIORITY) {
4217 * Extra-special case for fail-open mode.
4219 * We are in fail-open mode and the packet matched the fail-open rule,
4220 * but we are connected to a controller too. We should send the packet
4221 * up to the controller in the hope that it will try to set up a flow
4222 * and thereby allow us to exit fail-open.
4224 * See the top-level comment in fail-open.c for more information.
4226 send_packet_in(p, ofpbuf_clone_with_headroom(packet,
4227 DPIF_RECV_MSG_PADDING));
4230 ofpbuf_pull(packet, sizeof *msg);
4231 rule_execute(p, rule, packet, &flow);
4232 rule_reinstall(p, rule);
4236 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
4238 struct odp_msg *msg = packet->data;
4240 switch (msg->type) {
4241 case _ODPL_ACTION_NR:
4242 COVERAGE_INC(ofproto_ctlr_action);
4243 send_packet_in(p, packet);
4246 case _ODPL_SFLOW_NR:
4248 ofproto_sflow_received(p->sflow, msg);
4250 ofpbuf_delete(packet);
4254 handle_odp_miss_msg(p, packet);
4258 VLOG_WARN_RL(&rl, "received ODP message of unexpected type %"PRIu32,
4264 /* Flow expiration. */
4266 struct expire_cbdata {
4267 struct ofproto *ofproto;
4271 static int ofproto_dp_max_idle(const struct ofproto *);
4272 static void ofproto_update_used(struct ofproto *);
4273 static void rule_expire(struct cls_rule *, void *cbdata);
4275 /* This function is called periodically by ofproto_run(). Its job is to
4276 * collect updates for the flows that have been installed into the datapath,
4277 * most importantly when they last were used, and then use that information to
4278 * expire flows that have not been used recently.
4280 * Returns the number of milliseconds after which it should be called again. */
4282 ofproto_expire(struct ofproto *ofproto)
4284 struct expire_cbdata cbdata;
4286 /* Update 'used' for each flow in the datapath. */
4287 ofproto_update_used(ofproto);
4289 /* Expire idle flows.
4291 * A wildcarded flow is idle only when all of its subrules have expired due
4292 * to becoming idle, so iterate through the exact-match flows first. */
4293 cbdata.ofproto = ofproto;
4294 cbdata.dp_max_idle = ofproto_dp_max_idle(ofproto);
4295 classifier_for_each(&ofproto->cls, CLS_INC_EXACT, rule_expire, &cbdata);
4296 classifier_for_each(&ofproto->cls, CLS_INC_WILD, rule_expire, &cbdata);
4298 /* Let the hook know that we're at a stable point: all outstanding data
4299 * in existing flows has been accounted to the account_cb. Thus, the
4300 * hook can now reasonably do operations that depend on having accurate
4301 * flow volume accounting (currently, that's just bond rebalancing). */
4302 if (ofproto->ofhooks->account_checkpoint_cb) {
4303 ofproto->ofhooks->account_checkpoint_cb(ofproto->aux);
4306 return MIN(cbdata.dp_max_idle, 1000);
4309 /* Update 'used' member of each flow currently installed into the datapath. */
4311 ofproto_update_used(struct ofproto *p)
4313 struct odp_flow *flows;
4318 error = dpif_flow_list_all(p->dpif, &flows, &n_flows);
4323 for (i = 0; i < n_flows; i++) {
4324 struct odp_flow *f = &flows[i];
4327 rule = rule_from_cls_rule(
4328 classifier_find_rule_exactly(&p->cls, &f->key, 0, UINT16_MAX));
4330 if (rule && rule->installed) {
4331 update_time(p, rule, &f->stats);
4332 rule_account(p, rule, f->stats.n_bytes);
4334 /* There's a flow in the datapath that we know nothing about.
4336 COVERAGE_INC(ofproto_unexpected_rule);
4337 dpif_flow_del(p->dpif, f);
4344 /* Calculates and returns the number of milliseconds of idle time after which
4345 * flows should expire from the datapath and we should fold their statistics
4346 * into their parent rules in userspace. */
4348 ofproto_dp_max_idle(const struct ofproto *ofproto)
4351 * Idle time histogram.
4353 * Most of the time a switch has a relatively small number of flows. When
4354 * this is the case we might as well keep statistics for all of them in
4355 * userspace and to cache them in the kernel datapath for performance as
4358 * As the number of flows increases, the memory required to maintain
4359 * statistics about them in userspace and in the kernel becomes
4360 * significant. However, with a large number of flows it is likely that
4361 * only a few of them are "heavy hitters" that consume a large amount of
4362 * bandwidth. At this point, only heavy hitters are worth caching in the
4363 * kernel and maintaining in userspaces; other flows we can discard.
4365 * The technique used to compute the idle time is to build a histogram with
4366 * N_BUCKETS bucket whose width is BUCKET_WIDTH msecs each. Each flow that
4367 * is installed in the kernel gets dropped in the appropriate bucket.
4368 * After the histogram has been built, we compute the cutoff so that only
4369 * the most-recently-used 1% of flows (but at least 1000 flows) are kept
4370 * cached. At least the most-recently-used bucket of flows is kept, so
4371 * actually an arbitrary number of flows can be kept in any given
4372 * expiration run (though the next run will delete most of those unless
4373 * they receive additional data).
4375 * This requires a second pass through the exact-match flows, in addition
4376 * to the pass made by ofproto_update_used(), because the former function
4377 * never looks at uninstallable flows.
4379 enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4380 enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4381 int buckets[N_BUCKETS] = { 0 };
4387 total = classifier_count_exact(&ofproto->cls);
4388 if (total <= 1000) {
4389 return N_BUCKETS * BUCKET_WIDTH;
4392 /* Build histogram. */
4394 CLASSIFIER_FOR_EACH_EXACT_RULE (rule, cr, &ofproto->cls) {
4395 long long int idle = now - rule->used;
4396 int bucket = (idle <= 0 ? 0
4397 : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4398 : (unsigned int) idle / BUCKET_WIDTH);
4402 /* Find the first bucket whose flows should be expired. */
4403 for (bucket = 0; bucket < N_BUCKETS; bucket++) {
4404 if (buckets[bucket]) {
4407 subtotal += buckets[bucket++];
4408 } while (bucket < N_BUCKETS && subtotal < MAX(1000, total / 100));
4413 if (VLOG_IS_DBG_ENABLED()) {
4417 ds_put_cstr(&s, "keep");
4418 for (i = 0; i < N_BUCKETS; i++) {
4420 ds_put_cstr(&s, ", drop");
4423 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4426 VLOG_INFO("%s: %s (msec:count)",
4427 dpif_name(ofproto->dpif), ds_cstr(&s));
4431 return bucket * BUCKET_WIDTH;
4435 rule_active_timeout(struct ofproto *ofproto, struct rule *rule)
4437 if (ofproto->netflow && !is_controller_rule(rule) &&
4438 netflow_active_timeout_expired(ofproto->netflow, &rule->nf_flow)) {
4439 struct ofexpired expired;
4440 struct odp_flow odp_flow;
4442 /* Get updated flow stats.
4444 * XXX We could avoid this call entirely if (1) ofproto_update_used()
4445 * updated TCP flags and (2) the dpif_flow_list_all() in
4446 * ofproto_update_used() zeroed TCP flags. */
4447 memset(&odp_flow, 0, sizeof odp_flow);
4448 if (rule->installed) {
4449 odp_flow.key = rule->cr.flow;
4450 odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
4451 dpif_flow_get(ofproto->dpif, &odp_flow);
4453 if (odp_flow.stats.n_packets) {
4454 update_time(ofproto, rule, &odp_flow.stats);
4455 netflow_flow_update_flags(&rule->nf_flow,
4456 odp_flow.stats.tcp_flags);
4460 expired.flow = rule->cr.flow;
4461 expired.packet_count = rule->packet_count +
4462 odp_flow.stats.n_packets;
4463 expired.byte_count = rule->byte_count + odp_flow.stats.n_bytes;
4464 expired.used = rule->used;
4466 netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
4470 /* If 'cls_rule' is an OpenFlow rule, that has expired according to OpenFlow
4471 * rules, then delete it entirely.
4473 * If 'cls_rule' is a subrule, that has not been used recently, remove it from
4474 * the datapath and fold its statistics back into its super-rule.
4476 * (This is a callback function for classifier_for_each().) */
4478 rule_expire(struct cls_rule *cls_rule, void *cbdata_)
4480 struct expire_cbdata *cbdata = cbdata_;
4481 struct ofproto *ofproto = cbdata->ofproto;
4482 struct rule *rule = rule_from_cls_rule(cls_rule);
4483 long long int hard_expire, idle_expire, expire, now;
4485 /* Calculate OpenFlow expiration times for 'rule'. */
4486 hard_expire = (rule->hard_timeout
4487 ? rule->created + rule->hard_timeout * 1000
4489 idle_expire = (rule->idle_timeout
4490 && (rule->super || list_is_empty(&rule->list))
4491 ? rule->used + rule->idle_timeout * 1000
4493 expire = MIN(hard_expire, idle_expire);
4497 /* 'rule' has not expired according to OpenFlow rules. */
4498 if (!rule->cr.wc.wildcards) {
4499 if (now >= rule->used + cbdata->dp_max_idle) {
4500 /* This rule is idle, so drop it to free up resources. */
4502 /* It's not part of the OpenFlow flow table, so we can
4503 * delete it entirely and fold its statistics into its
4505 rule_remove(ofproto, rule);
4507 /* It is part of the OpenFlow flow table, so we have to
4508 * keep the rule but we can at least uninstall it from the
4510 rule_uninstall(ofproto, rule);
4513 /* Send NetFlow active timeout if appropriate. */
4514 rule_active_timeout(cbdata->ofproto, rule);
4518 /* 'rule' has expired according to OpenFlow rules. */
4519 COVERAGE_INC(ofproto_expired);
4521 /* Update stats. (This is a no-op if the rule expired due to an idle
4522 * timeout, because that only happens when the rule has no subrules
4524 if (rule->cr.wc.wildcards) {
4525 struct rule *subrule, *next;
4526 LIST_FOR_EACH_SAFE (subrule, next, list, &rule->list) {
4527 rule_remove(cbdata->ofproto, subrule);
4530 rule_uninstall(cbdata->ofproto, rule);
4533 /* Get rid of the rule. */
4534 if (!rule_is_hidden(rule)) {
4535 send_flow_removed(cbdata->ofproto, rule, now,
4537 ? OFPRR_HARD_TIMEOUT : OFPRR_IDLE_TIMEOUT));
4539 rule_remove(cbdata->ofproto, rule);
4544 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
4546 struct rule *sub = rule_from_cls_rule(sub_);
4547 struct revalidate_cbdata *cbdata = cbdata_;
4549 if (cbdata->revalidate_all
4550 || (cbdata->revalidate_subrules && sub->super)
4551 || (tag_set_intersects(&cbdata->revalidate_set, sub->tags))) {
4552 revalidate_rule(cbdata->ofproto, sub);
4557 revalidate_rule(struct ofproto *p, struct rule *rule)
4559 const flow_t *flow = &rule->cr.flow;
4561 COVERAGE_INC(ofproto_revalidate_rule);
4564 super = rule_from_cls_rule(classifier_lookup_wild(&p->cls, flow));
4566 rule_remove(p, rule);
4568 } else if (super != rule->super) {
4569 COVERAGE_INC(ofproto_revalidate_moved);
4570 list_remove(&rule->list);
4571 list_push_back(&super->list, &rule->list);
4572 rule->super = super;
4573 rule->hard_timeout = super->hard_timeout;
4574 rule->idle_timeout = super->idle_timeout;
4575 rule->created = super->created;
4580 rule_update_actions(p, rule);
4584 static struct ofpbuf *
4585 compose_flow_removed(struct ofproto *p, const struct rule *rule,
4586 long long int now, uint8_t reason)
4588 struct ofp_flow_removed *ofr;
4590 long long int tdiff = now - rule->created;
4591 uint32_t sec = tdiff / 1000;
4592 uint32_t msec = tdiff - (sec * 1000);
4594 ofr = make_openflow(sizeof *ofr, OFPT_FLOW_REMOVED, &buf);
4595 flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, p->tun_id_from_cookie,
4597 ofr->cookie = rule->flow_cookie;
4598 ofr->priority = htons(rule->cr.priority);
4599 ofr->reason = reason;
4600 ofr->duration_sec = htonl(sec);
4601 ofr->duration_nsec = htonl(msec * 1000000);
4602 ofr->idle_timeout = htons(rule->idle_timeout);
4603 ofr->packet_count = htonll(rule->packet_count);
4604 ofr->byte_count = htonll(rule->byte_count);
4610 send_flow_removed(struct ofproto *p, struct rule *rule,
4611 long long int now, uint8_t reason)
4613 struct ofconn *ofconn;
4614 struct ofconn *prev;
4615 struct ofpbuf *buf = NULL;
4617 if (!rule->send_flow_removed) {
4621 /* We limit the maximum number of queued flow expirations it by accounting
4622 * them under the counter for replies. That works because preventing
4623 * OpenFlow requests from being processed also prevents new flows from
4624 * being added (and expiring). (It also prevents processing OpenFlow
4625 * requests that would not add new flows, so it is imperfect.) */
4628 LIST_FOR_EACH (ofconn, node, &p->all_conns) {
4629 if (rconn_is_connected(ofconn->rconn)
4630 && ofconn_receives_async_msgs(ofconn)) {
4632 queue_tx(ofpbuf_clone(buf), prev, prev->reply_counter);
4634 buf = compose_flow_removed(p, rule, now, reason);
4640 queue_tx(buf, prev, prev->reply_counter);
4644 /* pinsched callback for sending 'packet' on 'ofconn'. */
4646 do_send_packet_in(struct ofpbuf *packet, void *ofconn_)
4648 struct ofconn *ofconn = ofconn_;
4650 rconn_send_with_limit(ofconn->rconn, packet,
4651 ofconn->packet_in_counter, 100);
4654 /* Takes 'packet', which has been converted with do_convert_to_packet_in(), and
4655 * finalizes its content for sending on 'ofconn', and passes it to 'ofconn''s
4656 * packet scheduler for sending.
4658 * 'max_len' specifies the maximum number of bytes of the packet to send on
4659 * 'ofconn' (INT_MAX specifies no limit).
4661 * If 'clone' is true, the caller retains ownership of 'packet'. Otherwise,
4662 * ownership is transferred to this function. */
4664 schedule_packet_in(struct ofconn *ofconn, struct ofpbuf *packet, int max_len,
4667 struct ofproto *ofproto = ofconn->ofproto;
4668 struct ofp_packet_in *opi = packet->data;
4669 uint16_t in_port = ofp_port_to_odp_port(ntohs(opi->in_port));
4670 int send_len, trim_size;
4674 if (opi->reason == OFPR_ACTION) {
4675 buffer_id = UINT32_MAX;
4676 } else if (ofproto->fail_open && fail_open_is_active(ofproto->fail_open)) {
4677 buffer_id = pktbuf_get_null();
4678 } else if (!ofconn->pktbuf) {
4679 buffer_id = UINT32_MAX;
4681 struct ofpbuf payload;
4682 payload.data = opi->data;
4683 payload.size = packet->size - offsetof(struct ofp_packet_in, data);
4684 buffer_id = pktbuf_save(ofconn->pktbuf, &payload, in_port);
4687 /* Figure out how much of the packet to send. */
4688 send_len = ntohs(opi->total_len);
4689 if (buffer_id != UINT32_MAX) {
4690 send_len = MIN(send_len, ofconn->miss_send_len);
4692 send_len = MIN(send_len, max_len);
4694 /* Adjust packet length and clone if necessary. */
4695 trim_size = offsetof(struct ofp_packet_in, data) + send_len;
4697 packet = ofpbuf_clone_data(packet->data, trim_size);
4700 packet->size = trim_size;
4703 /* Update packet headers. */
4704 opi->buffer_id = htonl(buffer_id);
4705 update_openflow_length(packet);
4707 /* Hand over to packet scheduler. It might immediately call into
4708 * do_send_packet_in() or it might buffer it for a while (until a later
4709 * call to pinsched_run()). */
4710 pinsched_send(ofconn->schedulers[opi->reason], in_port,
4711 packet, do_send_packet_in, ofconn);
4714 /* Replace struct odp_msg header in 'packet' by equivalent struct
4715 * ofp_packet_in. The odp_msg must have sufficient headroom to do so (e.g. as
4716 * returned by dpif_recv()).
4718 * The conversion is not complete: the caller still needs to trim any unneeded
4719 * payload off the end of the buffer, set the length in the OpenFlow header,
4720 * and set buffer_id. Those require us to know the controller settings and so
4721 * must be done on a per-controller basis.
4723 * Returns the maximum number of bytes of the packet that should be sent to
4724 * the controller (INT_MAX if no limit). */
4726 do_convert_to_packet_in(struct ofpbuf *packet)
4728 struct odp_msg *msg = packet->data;
4729 struct ofp_packet_in *opi;
4735 /* Extract relevant header fields */
4736 if (msg->type == _ODPL_ACTION_NR) {
4737 reason = OFPR_ACTION;
4740 reason = OFPR_NO_MATCH;
4743 total_len = msg->length - sizeof *msg;
4744 in_port = odp_port_to_ofp_port(msg->port);
4746 /* Repurpose packet buffer by overwriting header. */
4747 ofpbuf_pull(packet, sizeof(struct odp_msg));
4748 opi = ofpbuf_push_zeros(packet, offsetof(struct ofp_packet_in, data));
4749 opi->header.version = OFP_VERSION;
4750 opi->header.type = OFPT_PACKET_IN;
4751 opi->total_len = htons(total_len);
4752 opi->in_port = htons(in_port);
4753 opi->reason = reason;
4758 /* Given 'packet' containing an odp_msg of type _ODPL_ACTION_NR or
4759 * _ODPL_MISS_NR, sends an OFPT_PACKET_IN message to each OpenFlow controller
4760 * as necessary according to their individual configurations.
4762 * 'packet' must have sufficient headroom to convert it into a struct
4763 * ofp_packet_in (e.g. as returned by dpif_recv()).
4765 * Takes ownership of 'packet'. */
4767 send_packet_in(struct ofproto *ofproto, struct ofpbuf *packet)
4769 struct ofconn *ofconn, *prev;
4772 max_len = do_convert_to_packet_in(packet);
4775 LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
4776 if (ofconn_receives_async_msgs(ofconn)) {
4778 schedule_packet_in(prev, packet, max_len, true);
4784 schedule_packet_in(prev, packet, max_len, false);
4786 ofpbuf_delete(packet);
4791 pick_datapath_id(const struct ofproto *ofproto)
4793 const struct ofport *port;
4795 port = get_port(ofproto, ODPP_LOCAL);
4797 uint8_t ea[ETH_ADDR_LEN];
4800 error = netdev_get_etheraddr(port->netdev, ea);
4802 return eth_addr_to_uint64(ea);
4804 VLOG_WARN("could not get MAC address for %s (%s)",
4805 netdev_get_name(port->netdev), strerror(error));
4807 return ofproto->fallback_dpid;
4811 pick_fallback_dpid(void)
4813 uint8_t ea[ETH_ADDR_LEN];
4814 eth_addr_nicira_random(ea);
4815 return eth_addr_to_uint64(ea);
4819 default_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
4820 struct odp_actions *actions, tag_type *tags,
4821 uint16_t *nf_output_iface, void *ofproto_)
4823 struct ofproto *ofproto = ofproto_;
4826 /* Drop frames for reserved multicast addresses. */
4827 if (eth_addr_is_reserved(flow->dl_dst)) {
4831 /* Learn source MAC (but don't try to learn from revalidation). */
4832 if (packet != NULL) {
4833 tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
4835 GRAT_ARP_LOCK_NONE);
4837 /* The log messages here could actually be useful in debugging,
4838 * so keep the rate limit relatively high. */
4839 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
4840 VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
4841 ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
4842 ofproto_revalidate(ofproto, rev_tag);
4846 /* Determine output port. */
4847 out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags,
4850 add_output_group_action(actions, DP_GROUP_FLOOD, nf_output_iface);
4851 } else if (out_port != flow->in_port) {
4852 odp_actions_add(actions, ODPAT_OUTPUT)->output.port = out_port;
4853 *nf_output_iface = out_port;
4861 static const struct ofhooks default_ofhooks = {
4862 default_normal_ofhook_cb,