2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
26 #include "byte-order.h"
27 #include "classifier.h"
30 #include "dynamic-string.h"
33 #include "meta-flow.h"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
39 #include "ofp-print.h"
42 #include "ofproto-provider.h"
43 #include "openflow/nicira-ext.h"
44 #include "openflow/openflow.h"
48 #include "poll-loop.h"
54 #include "unaligned.h"
58 VLOG_DEFINE_THIS_MODULE(ofproto);
60 COVERAGE_DEFINE(ofproto_error);
61 COVERAGE_DEFINE(ofproto_flush);
62 COVERAGE_DEFINE(ofproto_no_packet_in);
63 COVERAGE_DEFINE(ofproto_packet_out);
64 COVERAGE_DEFINE(ofproto_queue_req);
65 COVERAGE_DEFINE(ofproto_recv_openflow);
66 COVERAGE_DEFINE(ofproto_reinit_ports);
67 COVERAGE_DEFINE(ofproto_uninstallable);
68 COVERAGE_DEFINE(ofproto_update_port);
71 S_OPENFLOW, /* Processing OpenFlow commands. */
72 S_EVICT, /* Evicting flows from over-limit tables. */
73 S_FLUSH, /* Deleting all flow table rules. */
76 enum ofoperation_type {
83 /* A single OpenFlow request can execute any number of operations. The
84 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
85 * ofconn to which an error reply should be sent if necessary.
87 * ofproto initiates some operations internally. These operations are still
88 * assigned to groups but will not have an associated ofconn. */
90 struct ofproto *ofproto; /* Owning ofproto. */
91 struct list ofproto_node; /* In ofproto's "pending" list. */
92 struct list ops; /* List of "struct ofoperation"s. */
93 int n_running; /* Number of ops still pending. */
95 /* Data needed to send OpenFlow reply on failure or to send a buffered
98 * If list_is_empty(ofconn_node) then this ofopgroup never had an
99 * associated ofconn or its ofconn's connection dropped after it initiated
100 * the operation. In the latter case 'ofconn' is a wild pointer that
101 * refers to freed memory, so the 'ofconn' member must be used only if
102 * !list_is_empty(ofconn_node).
104 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
105 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
106 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
107 uint32_t buffer_id; /* Buffer id from original request. */
110 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
111 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
112 const struct ofp_header *,
114 static void ofopgroup_submit(struct ofopgroup *);
115 static void ofopgroup_complete(struct ofopgroup *);
117 /* A single flow table operation. */
119 struct ofopgroup *group; /* Owning group. */
120 struct list group_node; /* In ofopgroup's "ops" list. */
121 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
122 struct rule *rule; /* Rule being operated upon. */
123 enum ofoperation_type type; /* Type of operation. */
125 /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
127 struct ofpact *ofpacts;
131 /* OFOPERATION_DELETE. */
132 enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
134 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
135 uint16_t idle_timeout; /* Rule's old idle timeout. */
136 uint16_t hard_timeout; /* Rule's old hard timeout. */
137 enum ofputil_flow_mod_flags flags; /* Rule's old flags. */
138 enum ofperr error; /* 0 if no error. */
141 static struct ofoperation *ofoperation_create(struct ofopgroup *,
143 enum ofoperation_type,
144 enum ofp_flow_removed_reason);
145 static void ofoperation_destroy(struct ofoperation *);
148 static void oftable_init(struct oftable *);
149 static void oftable_destroy(struct oftable *);
151 static void oftable_set_name(struct oftable *, const char *name);
153 static void oftable_disable_eviction(struct oftable *);
154 static void oftable_enable_eviction(struct oftable *,
155 const struct mf_subfield *fields,
158 static void oftable_remove_rule(struct rule *rule) OVS_RELEASES(rule->rwlock);
159 static void oftable_remove_rule__(struct ofproto *ofproto,
160 struct classifier *cls, struct rule *rule)
161 OVS_REQ_WRLOCK(cls->rwlock) OVS_RELEASES(rule->rwlock);
162 static void oftable_insert_rule(struct rule *);
164 /* A set of rules within a single OpenFlow table (oftable) that have the same
165 * values for the oftable's eviction_fields. A rule to be evicted, when one is
166 * needed, is taken from the eviction group that contains the greatest number
169 * An oftable owns any number of eviction groups, each of which contains any
172 * Membership in an eviction group is imprecise, based on the hash of the
173 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
174 * That is, if two rules have different eviction_fields, but those
175 * eviction_fields hash to the same value, then they will belong to the same
176 * eviction_group anyway.
178 * (When eviction is not enabled on an oftable, we don't track any eviction
179 * groups, to save time and space.) */
180 struct eviction_group {
181 struct hmap_node id_node; /* In oftable's "eviction_groups_by_id". */
182 struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
183 struct heap rules; /* Contains "struct rule"s. */
186 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep)
187 OVS_TRY_WRLOCK(true, (*rulep)->rwlock);
188 static void ofproto_evict(struct ofproto *);
189 static uint32_t rule_eviction_priority(struct rule *);
190 static void eviction_group_add_rule(struct rule *);
191 static void eviction_group_remove_rule(struct rule *);
193 /* Criteria that flow_mod and other operations use for selecting rules on
194 * which to operate. */
195 struct rule_criteria {
196 /* An OpenFlow table or 255 for all tables. */
199 /* OpenFlow matching criteria. Interpreted different in "loose" way by
200 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
201 * defined in the OpenFlow spec. */
204 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
205 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
206 * The rule will not be selected if M is 1 and B != C. */
208 ovs_be64 cookie_mask;
210 /* Selection based on actions within a rule:
212 * If out_port != OFPP_ANY, selects only rules that output to out_port.
213 * If out_group != OFPG_ALL, select only rules that output to out_group. */
218 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
219 const struct match *match,
220 unsigned int priority,
221 ovs_be64 cookie, ovs_be64 cookie_mask,
222 ofp_port_t out_port, uint32_t out_group);
223 static void rule_criteria_destroy(struct rule_criteria *);
226 static void ofport_destroy__(struct ofport *);
227 static void ofport_destroy(struct ofport *);
229 static void update_port(struct ofproto *, const char *devname);
230 static int init_ports(struct ofproto *);
231 static void reinit_ports(struct ofproto *);
234 static void ofproto_rule_destroy(struct rule *);
235 static void ofproto_rule_destroy__(struct rule *);
236 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
237 static bool rule_is_modifiable(const struct rule *);
240 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
241 struct ofputil_flow_mod *,
242 const struct ofp_header *);
243 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
244 struct ofputil_flow_mod *,
245 const struct ofp_header *, struct list *);
246 static void delete_flow__(struct rule *rule, struct ofopgroup *,
247 enum ofp_flow_removed_reason)
248 OVS_RELEASES(rule->rwlock);
249 static enum ofperr add_group(struct ofproto *, struct ofputil_group_mod *);
250 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
251 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
252 struct ofputil_flow_mod *,
253 const struct ofp_header *);
254 static void calc_duration(long long int start, long long int now,
255 uint32_t *sec, uint32_t *nsec);
258 static uint64_t pick_datapath_id(const struct ofproto *);
259 static uint64_t pick_fallback_dpid(void);
260 static void ofproto_destroy__(struct ofproto *);
261 static void update_mtu(struct ofproto *, struct ofport *);
262 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
265 static void ofproto_unixctl_init(void);
267 /* All registered ofproto classes, in probe order. */
268 static const struct ofproto_class **ofproto_classes;
269 static size_t n_ofproto_classes;
270 static size_t allocated_ofproto_classes;
272 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
273 unsigned n_handler_threads;
274 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
276 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
277 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
279 /* Initial mappings of port to OpenFlow number mappings. */
280 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
282 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
284 /* The default value of true waits for flow restore. */
285 static bool flow_restore_wait = true;
287 /* Must be called to initialize the ofproto library.
289 * The caller may pass in 'iface_hints', which contains an shash of
290 * "iface_hint" elements indexed by the interface's name. The provider
291 * may use these hints to describe the startup configuration in order to
292 * reinitialize its state. The caller owns the provided data, so a
293 * provider will make copies of anything required. An ofproto provider
294 * will remove any existing state that is not described by the hint, and
295 * may choose to remove it all. */
297 ofproto_init(const struct shash *iface_hints)
299 struct shash_node *node;
302 ofproto_class_register(&ofproto_dpif_class);
304 /* Make a local copy, since we don't own 'iface_hints' elements. */
305 SHASH_FOR_EACH(node, iface_hints) {
306 const struct iface_hint *orig_hint = node->data;
307 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
308 const char *br_type = ofproto_normalize_type(orig_hint->br_type);
310 new_hint->br_name = xstrdup(orig_hint->br_name);
311 new_hint->br_type = xstrdup(br_type);
312 new_hint->ofp_port = orig_hint->ofp_port;
314 shash_add(&init_ofp_ports, node->name, new_hint);
317 for (i = 0; i < n_ofproto_classes; i++) {
318 ofproto_classes[i]->init(&init_ofp_ports);
322 /* 'type' should be a normalized datapath type, as returned by
323 * ofproto_normalize_type(). Returns the corresponding ofproto_class
324 * structure, or a null pointer if there is none registered for 'type'. */
325 static const struct ofproto_class *
326 ofproto_class_find__(const char *type)
330 for (i = 0; i < n_ofproto_classes; i++) {
331 const struct ofproto_class *class = ofproto_classes[i];
336 class->enumerate_types(&types);
337 found = sset_contains(&types, type);
338 sset_destroy(&types);
344 VLOG_WARN("unknown datapath type %s", type);
348 /* Registers a new ofproto class. After successful registration, new ofprotos
349 * of that type can be created using ofproto_create(). */
351 ofproto_class_register(const struct ofproto_class *new_class)
355 for (i = 0; i < n_ofproto_classes; i++) {
356 if (ofproto_classes[i] == new_class) {
361 if (n_ofproto_classes >= allocated_ofproto_classes) {
362 ofproto_classes = x2nrealloc(ofproto_classes,
363 &allocated_ofproto_classes,
364 sizeof *ofproto_classes);
366 ofproto_classes[n_ofproto_classes++] = new_class;
370 /* Unregisters a datapath provider. 'type' must have been previously
371 * registered and not currently be in use by any ofprotos. After
372 * unregistration new datapaths of that type cannot be opened using
373 * ofproto_create(). */
375 ofproto_class_unregister(const struct ofproto_class *class)
379 for (i = 0; i < n_ofproto_classes; i++) {
380 if (ofproto_classes[i] == class) {
381 for (i++; i < n_ofproto_classes; i++) {
382 ofproto_classes[i - 1] = ofproto_classes[i];
388 VLOG_WARN("attempted to unregister an ofproto class that is not "
393 /* Clears 'types' and enumerates all registered ofproto types into it. The
394 * caller must first initialize the sset. */
396 ofproto_enumerate_types(struct sset *types)
400 for (i = 0; i < n_ofproto_classes; i++) {
401 ofproto_classes[i]->enumerate_types(types);
405 /* Returns the fully spelled out name for the given ofproto 'type'.
407 * Normalized type string can be compared with strcmp(). Unnormalized type
408 * string might be the same even if they have different spellings. */
410 ofproto_normalize_type(const char *type)
412 return type && type[0] ? type : "system";
415 /* Clears 'names' and enumerates the names of all known created ofprotos with
416 * the given 'type'. The caller must first initialize the sset. Returns 0 if
417 * successful, otherwise a positive errno value.
419 * Some kinds of datapaths might not be practically enumerable. This is not
420 * considered an error. */
422 ofproto_enumerate_names(const char *type, struct sset *names)
424 const struct ofproto_class *class = ofproto_class_find__(type);
425 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
429 ofproto_create(const char *datapath_name, const char *datapath_type,
430 struct ofproto **ofprotop)
432 const struct ofproto_class *class;
433 struct ofproto *ofproto;
439 ofproto_unixctl_init();
441 datapath_type = ofproto_normalize_type(datapath_type);
442 class = ofproto_class_find__(datapath_type);
444 VLOG_WARN("could not create datapath %s of unknown type %s",
445 datapath_name, datapath_type);
449 ofproto = class->alloc();
451 VLOG_ERR("failed to allocate datapath %s of type %s",
452 datapath_name, datapath_type);
457 memset(ofproto, 0, sizeof *ofproto);
458 ofproto->ofproto_class = class;
459 ofproto->name = xstrdup(datapath_name);
460 ofproto->type = xstrdup(datapath_type);
461 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
462 hash_string(ofproto->name, 0));
463 ofproto->datapath_id = 0;
464 ofproto->forward_bpdu = false;
465 ofproto->fallback_dpid = pick_fallback_dpid();
466 ofproto->mfr_desc = NULL;
467 ofproto->hw_desc = NULL;
468 ofproto->sw_desc = NULL;
469 ofproto->serial_desc = NULL;
470 ofproto->dp_desc = NULL;
471 ofproto->frag_handling = OFPC_FRAG_NORMAL;
472 hmap_init(&ofproto->ports);
473 shash_init(&ofproto->port_by_name);
474 simap_init(&ofproto->ofp_requests);
475 ofproto->max_ports = ofp_to_u16(OFPP_MAX);
476 ofproto->eviction_group_timer = LLONG_MIN;
477 ofproto->tables = NULL;
478 ofproto->n_tables = 0;
479 hindex_init(&ofproto->cookies);
480 list_init(&ofproto->expirable);
481 ovs_mutex_init_recursive(&ofproto->expirable_mutex);
482 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
483 ofproto->state = S_OPENFLOW;
484 list_init(&ofproto->pending);
485 ofproto->n_pending = 0;
486 hmap_init(&ofproto->deletions);
487 ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
488 ofproto->first_op = ofproto->last_op = LLONG_MIN;
489 ofproto->next_op_report = LLONG_MAX;
490 ofproto->op_backoff = LLONG_MIN;
491 ofproto->vlan_bitmap = NULL;
492 ofproto->vlans_changed = false;
493 ofproto->min_mtu = INT_MAX;
494 ovs_rwlock_init(&ofproto->groups_rwlock);
495 hmap_init(&ofproto->groups);
497 error = ofproto->ofproto_class->construct(ofproto);
499 VLOG_ERR("failed to open datapath %s: %s",
500 datapath_name, ovs_strerror(error));
501 ofproto_destroy__(ofproto);
505 /* The "max_ports" member should have been set by ->construct(ofproto).
506 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
507 ofproto->ofp_port_ids = bitmap_allocate(ofproto->max_ports);
508 bitmap_set1(ofproto->ofp_port_ids, 0);
510 /* Check that hidden tables, if any, are at the end. */
511 ovs_assert(ofproto->n_tables);
512 for (i = 0; i + 1 < ofproto->n_tables; i++) {
513 enum oftable_flags flags = ofproto->tables[i].flags;
514 enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
516 ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
519 ofproto->datapath_id = pick_datapath_id(ofproto);
522 /* Initialize meters table. */
523 if (ofproto->ofproto_class->meter_get_features) {
524 ofproto->ofproto_class->meter_get_features(ofproto,
525 &ofproto->meter_features);
527 memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
529 ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
530 * sizeof(struct meter *));
536 /* Must be called (only) by an ofproto implementation in its constructor
537 * function. See the large comment on 'construct' in struct ofproto_class for
540 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
542 struct oftable *table;
544 ovs_assert(!ofproto->n_tables);
545 ovs_assert(n_tables >= 1 && n_tables <= 255);
547 ofproto->n_tables = n_tables;
548 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
549 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
554 /* To be optionally called (only) by an ofproto implementation in its
555 * constructor function. See the large comment on 'construct' in struct
556 * ofproto_class for details.
558 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
559 * will then ensure that actions passed into the ofproto implementation will
560 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
561 * function is not called, there will be no such restriction.
563 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
564 * the 'max_ports' restriction. */
566 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
568 ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
569 ofproto->max_ports = max_ports;
573 ofproto_get_datapath_id(const struct ofproto *ofproto)
575 return ofproto->datapath_id;
579 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
581 uint64_t old_dpid = p->datapath_id;
582 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
583 if (p->datapath_id != old_dpid) {
584 /* Force all active connections to reconnect, since there is no way to
585 * notify a controller that the datapath ID has changed. */
586 ofproto_reconnect_controllers(p);
591 ofproto_set_controllers(struct ofproto *p,
592 const struct ofproto_controller *controllers,
593 size_t n_controllers, uint32_t allowed_versions)
595 connmgr_set_controllers(p->connmgr, controllers, n_controllers,
600 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
602 connmgr_set_fail_mode(p->connmgr, fail_mode);
605 /* Drops the connections between 'ofproto' and all of its controllers, forcing
606 * them to reconnect. */
608 ofproto_reconnect_controllers(struct ofproto *ofproto)
610 connmgr_reconnect(ofproto->connmgr);
613 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
614 * in-band control should guarantee access, in the same way that in-band
615 * control guarantees access to OpenFlow controllers. */
617 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
618 const struct sockaddr_in *extras, size_t n)
620 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
623 /* Sets the OpenFlow queue used by flows set up by in-band control on
624 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
625 * flows will use the default queue. */
627 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
629 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
632 /* Sets the number of flows at which eviction from the kernel flow table
635 ofproto_set_flow_eviction_threshold(unsigned threshold)
637 flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
641 /* Sets the path for handling flow misses. */
643 ofproto_set_flow_miss_model(unsigned model)
645 flow_miss_model = model;
648 /* If forward_bpdu is true, the NORMAL action will forward frames with
649 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
650 * the NORMAL action will drop these frames. */
652 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
654 bool old_val = ofproto->forward_bpdu;
655 ofproto->forward_bpdu = forward_bpdu;
656 if (old_val != ofproto->forward_bpdu) {
657 if (ofproto->ofproto_class->forward_bpdu_changed) {
658 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
663 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
664 * 'idle_time', in seconds, and the maximum number of MAC table entries to
667 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
670 if (ofproto->ofproto_class->set_mac_table_config) {
671 ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
676 /* Sets number of upcall handler threads. The default is
677 * (number of online cores - 2). */
679 ofproto_set_n_handler_threads(unsigned limit)
682 n_handler_threads = limit;
684 int n_proc = sysconf(_SC_NPROCESSORS_ONLN);
685 n_handler_threads = n_proc > 2 ? n_proc - 2 : 1;
690 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
693 p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
697 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
699 return connmgr_set_snoops(ofproto->connmgr, snoops);
703 ofproto_set_netflow(struct ofproto *ofproto,
704 const struct netflow_options *nf_options)
706 if (nf_options && sset_is_empty(&nf_options->collectors)) {
710 if (ofproto->ofproto_class->set_netflow) {
711 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
713 return nf_options ? EOPNOTSUPP : 0;
718 ofproto_set_sflow(struct ofproto *ofproto,
719 const struct ofproto_sflow_options *oso)
721 if (oso && sset_is_empty(&oso->targets)) {
725 if (ofproto->ofproto_class->set_sflow) {
726 return ofproto->ofproto_class->set_sflow(ofproto, oso);
728 return oso ? EOPNOTSUPP : 0;
733 ofproto_set_ipfix(struct ofproto *ofproto,
734 const struct ofproto_ipfix_bridge_exporter_options *bo,
735 const struct ofproto_ipfix_flow_exporter_options *fo,
738 if (ofproto->ofproto_class->set_ipfix) {
739 return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
741 return (bo || fo) ? EOPNOTSUPP : 0;
746 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
748 flow_restore_wait = flow_restore_wait_db;
752 ofproto_get_flow_restore_wait(void)
754 return flow_restore_wait;
758 /* Spanning Tree Protocol (STP) configuration. */
760 /* Configures STP on 'ofproto' using the settings defined in 's'. If
761 * 's' is NULL, disables STP.
763 * Returns 0 if successful, otherwise a positive errno value. */
765 ofproto_set_stp(struct ofproto *ofproto,
766 const struct ofproto_stp_settings *s)
768 return (ofproto->ofproto_class->set_stp
769 ? ofproto->ofproto_class->set_stp(ofproto, s)
773 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
774 * 'enabled' member of 's' is false, then the other members are not
777 * Returns 0 if successful, otherwise a positive errno value. */
779 ofproto_get_stp_status(struct ofproto *ofproto,
780 struct ofproto_stp_status *s)
782 return (ofproto->ofproto_class->get_stp_status
783 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
787 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
788 * in 's'. The caller is responsible for assigning STP port numbers
789 * (using the 'port_num' member in the range of 1 through 255, inclusive)
790 * and ensuring there are no duplicates. If the 's' is NULL, then STP
791 * is disabled on the port.
793 * Returns 0 if successful, otherwise a positive errno value.*/
795 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
796 const struct ofproto_port_stp_settings *s)
798 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
800 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
801 ofproto->name, ofp_port);
805 return (ofproto->ofproto_class->set_stp_port
806 ? ofproto->ofproto_class->set_stp_port(ofport, s)
810 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
811 * 's'. If the 'enabled' member in 's' is false, then the other members
812 * are not meaningful.
814 * Returns 0 if successful, otherwise a positive errno value.*/
816 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
817 struct ofproto_port_stp_status *s)
819 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
821 VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
822 "port %"PRIu16, ofproto->name, ofp_port);
826 return (ofproto->ofproto_class->get_stp_port_status
827 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
831 /* Queue DSCP configuration. */
833 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
834 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
835 * to implement QoS. Instead, it is used to implement features which require
836 * knowledge of what queues exist on a port, and some basic information about
839 * Returns 0 if successful, otherwise a positive errno value. */
841 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
842 const struct ofproto_port_queue *queues,
845 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
848 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
849 ofproto->name, ofp_port);
853 return (ofproto->ofproto_class->set_queues
854 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
858 /* Connectivity Fault Management configuration. */
860 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
862 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
864 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
865 if (ofport && ofproto->ofproto_class->set_cfm) {
866 ofproto->ofproto_class->set_cfm(ofport, NULL);
870 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
871 * basic configuration from the configuration members in 'cfm', and the remote
872 * maintenance point ID from remote_mpid. Ignores the statistics members of
875 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
877 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
878 const struct cfm_settings *s)
880 struct ofport *ofport;
883 ofport = ofproto_get_port(ofproto, ofp_port);
885 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
886 ofproto->name, ofp_port);
890 /* XXX: For configuration simplicity, we only support one remote_mpid
891 * outside of the CFM module. It's not clear if this is the correct long
892 * term solution or not. */
893 error = (ofproto->ofproto_class->set_cfm
894 ? ofproto->ofproto_class->set_cfm(ofport, s)
897 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
898 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
899 ovs_strerror(error));
903 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
904 * 'ofproto' does not have a port 'ofp_port'. */
906 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
907 const struct smap *cfg)
909 struct ofport *ofport;
912 ofport = ofproto_get_port(ofproto, ofp_port);
914 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
915 ofproto->name, ofp_port);
919 error = (ofproto->ofproto_class->set_bfd
920 ? ofproto->ofproto_class->set_bfd(ofport, cfg)
923 VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
924 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
925 ovs_strerror(error));
929 /* Populates 'status' with key value pairs indicating the status of the BFD
930 * session on 'ofp_port'. This information is intended to be populated in the
931 * OVS database. Has no effect if 'ofp_port' is not na OpenFlow port in
934 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
937 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
938 return (ofport && ofproto->ofproto_class->get_bfd_status
939 ? ofproto->ofproto_class->get_bfd_status(ofport, status)
943 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
944 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
945 * 0 if LACP partner information is not current (generally indicating a
946 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
948 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
950 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
951 return (ofport && ofproto->ofproto_class->port_is_lacp_current
952 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
958 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
959 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
960 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
961 * configuration plus, if there is more than one slave, a bonding
964 * If 'aux' is already registered then this function updates its configuration
965 * to 's'. Otherwise, this function registers a new bundle.
967 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
970 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
971 const struct ofproto_bundle_settings *s)
973 return (ofproto->ofproto_class->bundle_set
974 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
978 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
979 * If no such bundle has been registered, this has no effect. */
981 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
983 return ofproto_bundle_register(ofproto, aux, NULL);
987 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
988 * If 'aux' is already registered then this function updates its configuration
989 * to 's'. Otherwise, this function registers a new mirror. */
991 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
992 const struct ofproto_mirror_settings *s)
994 return (ofproto->ofproto_class->mirror_set
995 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
999 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1000 * If no mirror has been registered, this has no effect. */
1002 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1004 return ofproto_mirror_register(ofproto, aux, NULL);
1007 /* Retrieves statistics from mirror associated with client data pointer
1008 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1009 * 'bytes', respectively. If a particular counters is not supported,
1010 * the appropriate argument is set to UINT64_MAX. */
1012 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1013 uint64_t *packets, uint64_t *bytes)
1015 if (!ofproto->ofproto_class->mirror_get_stats) {
1016 *packets = *bytes = UINT64_MAX;
1020 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1024 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1025 * which all packets are flooded, instead of using MAC learning. If
1026 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1028 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1031 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1033 return (ofproto->ofproto_class->set_flood_vlans
1034 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1038 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1039 * output for a mirror. */
1041 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1043 return (ofproto->ofproto_class->is_mirror_output_bundle
1044 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1048 /* Configuration of OpenFlow tables. */
1050 /* Returns the number of OpenFlow tables in 'ofproto'. */
1052 ofproto_get_n_tables(const struct ofproto *ofproto)
1054 return ofproto->n_tables;
1057 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1058 * settings from 's'. 'table_id' must be in the range 0 through the number of
1059 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1061 * For read-only tables, only the name may be configured. */
1063 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1064 const struct ofproto_table_settings *s)
1066 struct oftable *table;
1068 ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1069 table = &ofproto->tables[table_id];
1071 oftable_set_name(table, s->name);
1073 if (table->flags & OFTABLE_READONLY) {
1078 oftable_enable_eviction(table, s->groups, s->n_groups);
1080 oftable_disable_eviction(table);
1083 table->max_flows = s->max_flows;
1084 ovs_rwlock_rdlock(&table->cls.rwlock);
1085 if (classifier_count(&table->cls) > table->max_flows
1086 && table->eviction_fields) {
1087 /* 'table' contains more flows than allowed. We might not be able to
1088 * evict them right away because of the asynchronous nature of flow
1089 * table changes. Schedule eviction for later. */
1090 switch (ofproto->state) {
1092 ofproto->state = S_EVICT;
1096 /* We're already deleting flows, nothing more to do. */
1100 ovs_rwlock_unlock(&table->cls.rwlock);
1104 ofproto_has_snoops(const struct ofproto *ofproto)
1106 return connmgr_has_snoops(ofproto->connmgr);
1110 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1112 connmgr_get_snoops(ofproto->connmgr, snoops);
1115 /* Deletes 'rule' from 'cls' within 'ofproto'.
1117 * The 'cls' argument is redundant (it is &ofproto->tables[rule->table_id].cls)
1118 * but it allows Clang to do better checking. */
1120 ofproto_delete_rule(struct ofproto *ofproto, struct classifier *cls,
1122 OVS_REQ_WRLOCK(cls->rwlock)
1124 struct ofopgroup *group;
1126 ovs_assert(!rule->pending);
1127 ovs_assert(cls == &ofproto->tables[rule->table_id].cls);
1129 group = ofopgroup_create_unattached(ofproto);
1130 ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1131 ovs_rwlock_wrlock(&rule->rwlock);
1132 oftable_remove_rule__(ofproto, cls, rule);
1133 ofproto->ofproto_class->rule_delete(rule);
1134 ofopgroup_submit(group);
1138 ofproto_flush__(struct ofproto *ofproto)
1140 struct oftable *table;
1142 if (ofproto->ofproto_class->flush) {
1143 ofproto->ofproto_class->flush(ofproto);
1146 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1147 struct rule *rule, *next_rule;
1148 struct cls_cursor cursor;
1150 if (table->flags & OFTABLE_HIDDEN) {
1154 ovs_rwlock_wrlock(&table->cls.rwlock);
1155 cls_cursor_init(&cursor, &table->cls, NULL);
1156 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1157 if (!rule->pending) {
1158 ofproto_delete_rule(ofproto, &table->cls, rule);
1161 ovs_rwlock_unlock(&table->cls.rwlock);
1165 static void delete_group(struct ofproto *ofproto, uint32_t group_id);
1168 ofproto_destroy__(struct ofproto *ofproto)
1170 struct oftable *table;
1172 ovs_assert(list_is_empty(&ofproto->pending));
1173 ovs_assert(!ofproto->n_pending);
1175 delete_group(ofproto, OFPG_ALL);
1176 ovs_rwlock_destroy(&ofproto->groups_rwlock);
1177 hmap_destroy(&ofproto->groups);
1179 connmgr_destroy(ofproto->connmgr);
1181 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1182 free(ofproto->name);
1183 free(ofproto->type);
1184 free(ofproto->mfr_desc);
1185 free(ofproto->hw_desc);
1186 free(ofproto->sw_desc);
1187 free(ofproto->serial_desc);
1188 free(ofproto->dp_desc);
1189 hmap_destroy(&ofproto->ports);
1190 shash_destroy(&ofproto->port_by_name);
1191 bitmap_free(ofproto->ofp_port_ids);
1192 simap_destroy(&ofproto->ofp_requests);
1194 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1195 oftable_destroy(table);
1197 free(ofproto->tables);
1199 hmap_destroy(&ofproto->deletions);
1201 free(ofproto->vlan_bitmap);
1203 ovs_mutex_destroy(&ofproto->expirable_mutex);
1204 ofproto->ofproto_class->dealloc(ofproto);
1208 ofproto_destroy(struct ofproto *p)
1210 struct ofport *ofport, *next_ofport;
1217 meter_delete(p, 1, p->meter_features.max_meters);
1218 p->meter_features.max_meters = 0;
1224 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1225 ofport_destroy(ofport);
1228 p->ofproto_class->destruct(p);
1229 ofproto_destroy__(p);
1232 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1233 * kernel datapath, for example, this destroys the datapath in the kernel, and
1234 * with the netdev-based datapath, it tears down the data structures that
1235 * represent the datapath.
1237 * The datapath should not be currently open as an ofproto. */
1239 ofproto_delete(const char *name, const char *type)
1241 const struct ofproto_class *class = ofproto_class_find__(type);
1242 return (!class ? EAFNOSUPPORT
1243 : !class->del ? EACCES
1244 : class->del(type, name));
1248 process_port_change(struct ofproto *ofproto, int error, char *devname)
1250 if (error == ENOBUFS) {
1251 reinit_ports(ofproto);
1252 } else if (!error) {
1253 update_port(ofproto, devname);
1259 ofproto_type_run(const char *datapath_type)
1261 const struct ofproto_class *class;
1264 datapath_type = ofproto_normalize_type(datapath_type);
1265 class = ofproto_class_find__(datapath_type);
1267 error = class->type_run ? class->type_run(datapath_type) : 0;
1268 if (error && error != EAGAIN) {
1269 VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1270 datapath_type, ovs_strerror(error));
1276 ofproto_type_run_fast(const char *datapath_type)
1278 const struct ofproto_class *class;
1281 datapath_type = ofproto_normalize_type(datapath_type);
1282 class = ofproto_class_find__(datapath_type);
1284 error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1285 if (error && error != EAGAIN) {
1286 VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1287 datapath_type, ovs_strerror(error));
1293 ofproto_type_wait(const char *datapath_type)
1295 const struct ofproto_class *class;
1297 datapath_type = ofproto_normalize_type(datapath_type);
1298 class = ofproto_class_find__(datapath_type);
1300 if (class->type_wait) {
1301 class->type_wait(datapath_type);
1306 ofproto_run(struct ofproto *p)
1308 struct sset changed_netdevs;
1309 const char *changed_netdev;
1310 struct ofport *ofport;
1313 error = p->ofproto_class->run(p);
1314 if (error && error != EAGAIN) {
1315 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1318 /* Restore the eviction group heap invariant occasionally. */
1319 if (p->eviction_group_timer < time_msec()) {
1322 p->eviction_group_timer = time_msec() + 1000;
1324 for (i = 0; i < p->n_tables; i++) {
1325 struct oftable *table = &p->tables[i];
1326 struct eviction_group *evg;
1327 struct cls_cursor cursor;
1330 if (!table->eviction_fields) {
1334 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1335 heap_rebuild(&evg->rules);
1338 ovs_rwlock_rdlock(&table->cls.rwlock);
1339 cls_cursor_init(&cursor, &table->cls, NULL);
1340 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1341 if (!rule->eviction_group
1342 && (rule->idle_timeout || rule->hard_timeout)) {
1343 eviction_group_add_rule(rule);
1346 ovs_rwlock_unlock(&table->cls.rwlock);
1350 if (p->ofproto_class->port_poll) {
1353 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1354 process_port_change(p, error, devname);
1358 /* Update OpenFlow port status for any port whose netdev has changed.
1360 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1361 * destroyed, so it's not safe to update ports directly from the
1362 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1363 * need this two-phase approach. */
1364 sset_init(&changed_netdevs);
1365 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1366 unsigned int change_seq = netdev_change_seq(ofport->netdev);
1367 if (ofport->change_seq != change_seq) {
1368 ofport->change_seq = change_seq;
1369 sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1372 SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1373 update_port(p, changed_netdev);
1375 sset_destroy(&changed_netdevs);
1379 connmgr_run(p->connmgr, handle_openflow);
1383 connmgr_run(p->connmgr, NULL);
1385 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1386 p->state = S_OPENFLOW;
1391 connmgr_run(p->connmgr, NULL);
1393 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1394 connmgr_flushed(p->connmgr);
1395 p->state = S_OPENFLOW;
1403 if (time_msec() >= p->next_op_report) {
1404 long long int ago = (time_msec() - p->first_op) / 1000;
1405 long long int interval = (p->last_op - p->first_op) / 1000;
1409 ds_put_format(&s, "%d flow_mods ",
1410 p->n_add + p->n_delete + p->n_modify);
1411 if (interval == ago) {
1412 ds_put_format(&s, "in the last %lld s", ago);
1413 } else if (interval) {
1414 ds_put_format(&s, "in the %lld s starting %lld s ago",
1417 ds_put_format(&s, "%lld s ago", ago);
1420 ds_put_cstr(&s, " (");
1422 ds_put_format(&s, "%d adds, ", p->n_add);
1425 ds_put_format(&s, "%d deletes, ", p->n_delete);
1428 ds_put_format(&s, "%d modifications, ", p->n_modify);
1431 ds_put_char(&s, ')');
1433 VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1436 p->n_add = p->n_delete = p->n_modify = 0;
1437 p->next_op_report = LLONG_MAX;
1443 /* Performs periodic activity required by 'ofproto' that needs to be done
1444 * with the least possible latency.
1446 * It makes sense to call this function a couple of times per poll loop, to
1447 * provide a significant performance boost on some benchmarks with the
1448 * ofproto-dpif implementation. */
1450 ofproto_run_fast(struct ofproto *p)
1454 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1455 if (error && error != EAGAIN) {
1456 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1457 p->name, ovs_strerror(error));
1463 ofproto_wait(struct ofproto *p)
1465 struct ofport *ofport;
1467 p->ofproto_class->wait(p);
1468 if (p->ofproto_class->port_poll_wait) {
1469 p->ofproto_class->port_poll_wait(p);
1472 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1473 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1474 poll_immediate_wake();
1480 connmgr_wait(p->connmgr, true);
1485 connmgr_wait(p->connmgr, false);
1486 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1487 poll_immediate_wake();
1494 ofproto_is_alive(const struct ofproto *p)
1496 return connmgr_has_controllers(p->connmgr);
1499 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1500 * memory_report(). */
1502 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1504 const struct oftable *table;
1505 unsigned int n_rules;
1507 simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1508 simap_increase(usage, "ops",
1509 ofproto->n_pending + hmap_count(&ofproto->deletions));
1512 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1513 ovs_rwlock_rdlock(&table->cls.rwlock);
1514 n_rules += classifier_count(&table->cls);
1515 ovs_rwlock_unlock(&table->cls.rwlock);
1517 simap_increase(usage, "rules", n_rules);
1519 if (ofproto->ofproto_class->get_memory_usage) {
1520 ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1523 connmgr_get_memory_usage(ofproto->connmgr, usage);
1527 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1530 connmgr_get_controller_info(ofproto->connmgr, info);
1534 ofproto_free_ofproto_controller_info(struct shash *info)
1536 connmgr_free_controller_info(info);
1539 /* Makes a deep copy of 'old' into 'port'. */
1541 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1543 port->name = xstrdup(old->name);
1544 port->type = xstrdup(old->type);
1545 port->ofp_port = old->ofp_port;
1548 /* Frees memory allocated to members of 'ofproto_port'.
1550 * Do not call this function on an ofproto_port obtained from
1551 * ofproto_port_dump_next(): that function retains ownership of the data in the
1554 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1556 free(ofproto_port->name);
1557 free(ofproto_port->type);
1560 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1562 * This function provides no status indication. An error status for the entire
1563 * dump operation is provided when it is completed by calling
1564 * ofproto_port_dump_done().
1567 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1568 const struct ofproto *ofproto)
1570 dump->ofproto = ofproto;
1571 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1575 /* Attempts to retrieve another port from 'dump', which must have been created
1576 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1577 * 'port' and returns true. On failure, returns false.
1579 * Failure might indicate an actual error or merely that the last port has been
1580 * dumped. An error status for the entire dump operation is provided when it
1581 * is completed by calling ofproto_port_dump_done().
1583 * The ofproto owns the data stored in 'port'. It will remain valid until at
1584 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1585 * ofproto_port_dump_done(). */
1587 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1588 struct ofproto_port *port)
1590 const struct ofproto *ofproto = dump->ofproto;
1596 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1599 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1605 /* Completes port table dump operation 'dump', which must have been created
1606 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1607 * error-free, otherwise a positive errno value describing the problem. */
1609 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1611 const struct ofproto *ofproto = dump->ofproto;
1613 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1616 return dump->error == EOF ? 0 : dump->error;
1619 /* Returns the type to pass to netdev_open() when a datapath of type
1620 * 'datapath_type' has a port of type 'port_type', for a few special
1621 * cases when a netdev type differs from a port type. For example, when
1622 * using the userspace datapath, a port of type "internal" needs to be
1625 * Returns either 'type' itself or a string literal, which must not be
1628 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1630 const struct ofproto_class *class;
1632 datapath_type = ofproto_normalize_type(datapath_type);
1633 class = ofproto_class_find__(datapath_type);
1638 return (class->port_open_type
1639 ? class->port_open_type(datapath_type, port_type)
1643 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1644 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1645 * the port's OpenFlow port number.
1647 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1648 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1649 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1650 * 'ofp_portp' is non-null). */
1652 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1653 ofp_port_t *ofp_portp)
1655 ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1658 error = ofproto->ofproto_class->port_add(ofproto, netdev);
1660 const char *netdev_name = netdev_get_name(netdev);
1662 simap_put(&ofproto->ofp_requests, netdev_name,
1663 ofp_to_u16(ofp_port));
1664 update_port(ofproto, netdev_name);
1667 struct ofproto_port ofproto_port;
1669 ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1671 *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1672 ofproto_port_destroy(&ofproto_port);
1677 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1678 * initializes '*port' appropriately; on failure, returns a positive errno
1681 * The caller owns the data in 'ofproto_port' and must free it with
1682 * ofproto_port_destroy() when it is no longer needed. */
1684 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1685 struct ofproto_port *port)
1689 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1691 memset(port, 0, sizeof *port);
1696 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1697 * Returns 0 if successful, otherwise a positive errno. */
1699 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1701 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1702 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1703 struct simap_node *ofp_request_node;
1706 ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1707 if (ofp_request_node) {
1708 simap_delete(&ofproto->ofp_requests, ofp_request_node);
1711 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1712 if (!error && ofport) {
1713 /* 'name' is the netdev's name and update_port() is going to close the
1714 * netdev. Just in case update_port() refers to 'name' after it
1715 * destroys 'ofport', make a copy of it around the update_port()
1717 char *devname = xstrdup(name);
1718 update_port(ofproto, devname);
1724 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1725 * performs the 'n_actions' actions in 'actions'. The new flow will not
1728 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1729 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1730 * controllers; otherwise, it will be hidden.
1732 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1734 * This is a helper function for in-band control and fail-open. */
1736 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1737 unsigned int priority,
1738 const struct ofpact *ofpacts, size_t ofpacts_len)
1740 const struct rule *rule;
1742 ovs_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1743 rule = rule_from_cls_rule(classifier_find_match_exactly(
1744 &ofproto->tables[0].cls, match, priority));
1745 ovs_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1746 if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1747 ofpacts, ofpacts_len)) {
1748 struct ofputil_flow_mod fm;
1750 memset(&fm, 0, sizeof fm);
1752 fm.priority = priority;
1753 fm.buffer_id = UINT32_MAX;
1754 fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1755 fm.ofpacts_len = ofpacts_len;
1756 add_flow(ofproto, NULL, &fm, NULL);
1761 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1762 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1763 * operation cannot be initiated now but may be retried later.
1765 * This is a helper function for in-band control and fail-open. */
1767 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1769 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1772 /* Searches for a rule with matching criteria exactly equal to 'target' in
1773 * ofproto's table 0 and, if it finds one, deletes it.
1775 * This is a helper function for in-band control and fail-open. */
1777 ofproto_delete_flow(struct ofproto *ofproto,
1778 const struct match *target, unsigned int priority)
1780 struct classifier *cls = &ofproto->tables[0].cls;
1783 ovs_rwlock_rdlock(&cls->rwlock);
1784 rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
1786 ovs_rwlock_unlock(&cls->rwlock);
1788 /* No such rule -> success. */
1790 } else if (rule->pending) {
1791 /* An operation on the rule is already pending -> failure.
1792 * Caller must retry later if it's important. */
1795 /* Initiate deletion -> success. */
1796 ovs_rwlock_wrlock(&cls->rwlock);
1797 ofproto_delete_rule(ofproto, cls, rule);
1798 ovs_rwlock_unlock(&cls->rwlock);
1805 /* Starts the process of deleting all of the flows from all of ofproto's flow
1806 * tables and then reintroducing the flows required by in-band control and
1807 * fail-open. The process will complete in a later call to ofproto_run(). */
1809 ofproto_flush_flows(struct ofproto *ofproto)
1811 COVERAGE_INC(ofproto_flush);
1812 ofproto->state = S_FLUSH;
1816 reinit_ports(struct ofproto *p)
1818 struct ofproto_port_dump dump;
1819 struct sset devnames;
1820 struct ofport *ofport;
1821 struct ofproto_port ofproto_port;
1822 const char *devname;
1824 COVERAGE_INC(ofproto_reinit_ports);
1826 sset_init(&devnames);
1827 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1828 sset_add(&devnames, netdev_get_name(ofport->netdev));
1830 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1831 sset_add(&devnames, ofproto_port.name);
1834 SSET_FOR_EACH (devname, &devnames) {
1835 update_port(p, devname);
1837 sset_destroy(&devnames);
1841 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1845 port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
1846 port_idx = port_idx ? port_idx : UINT16_MAX;
1848 if (port_idx >= ofproto->max_ports
1849 || bitmap_is_set(ofproto->ofp_port_ids, port_idx)) {
1850 uint16_t end_port_no = ofproto->alloc_port_no;
1852 /* Search for a free OpenFlow port number. We try not to
1853 * immediately reuse them to prevent problems due to old
1856 if (++ofproto->alloc_port_no >= ofproto->max_ports) {
1857 ofproto->alloc_port_no = 0;
1859 if (!bitmap_is_set(ofproto->ofp_port_ids,
1860 ofproto->alloc_port_no)) {
1861 port_idx = ofproto->alloc_port_no;
1864 if (ofproto->alloc_port_no == end_port_no) {
1869 bitmap_set1(ofproto->ofp_port_ids, port_idx);
1870 return u16_to_ofp(port_idx);
1874 dealloc_ofp_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1876 if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
1877 bitmap_set0(ofproto->ofp_port_ids, ofp_to_u16(ofp_port));
1881 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1882 * pointer if the netdev cannot be opened. On success, also fills in
1884 static struct netdev *
1885 ofport_open(struct ofproto *ofproto,
1886 struct ofproto_port *ofproto_port,
1887 struct ofputil_phy_port *pp)
1889 enum netdev_flags flags;
1890 struct netdev *netdev;
1893 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1895 VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1896 "cannot be opened (%s)",
1898 ofproto_port->name, ofproto_port->ofp_port,
1899 ofproto_port->name, ovs_strerror(error));
1903 if (ofproto_port->ofp_port == OFPP_NONE) {
1904 if (!strcmp(ofproto->name, ofproto_port->name)) {
1905 ofproto_port->ofp_port = OFPP_LOCAL;
1907 ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1908 ofproto_port->name);
1911 pp->port_no = ofproto_port->ofp_port;
1912 netdev_get_etheraddr(netdev, pp->hw_addr);
1913 ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1914 netdev_get_flags(netdev, &flags);
1915 pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1916 pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1917 netdev_get_features(netdev, &pp->curr, &pp->advertised,
1918 &pp->supported, &pp->peer);
1919 pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
1920 pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
1925 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1926 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1929 ofport_equal(const struct ofputil_phy_port *a,
1930 const struct ofputil_phy_port *b)
1932 return (eth_addr_equals(a->hw_addr, b->hw_addr)
1933 && a->state == b->state
1934 && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1935 && a->curr == b->curr
1936 && a->advertised == b->advertised
1937 && a->supported == b->supported
1938 && a->peer == b->peer
1939 && a->curr_speed == b->curr_speed
1940 && a->max_speed == b->max_speed);
1943 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1944 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1945 * one with the same name or port number). */
1947 ofport_install(struct ofproto *p,
1948 struct netdev *netdev, const struct ofputil_phy_port *pp)
1950 const char *netdev_name = netdev_get_name(netdev);
1951 struct ofport *ofport;
1954 /* Create ofport. */
1955 ofport = p->ofproto_class->port_alloc();
1960 ofport->ofproto = p;
1961 ofport->netdev = netdev;
1962 ofport->change_seq = netdev_change_seq(netdev);
1964 ofport->ofp_port = pp->port_no;
1965 ofport->created = time_msec();
1967 /* Add port to 'p'. */
1968 hmap_insert(&p->ports, &ofport->hmap_node,
1969 hash_ofp_port(ofport->ofp_port));
1970 shash_add(&p->port_by_name, netdev_name, ofport);
1972 update_mtu(p, ofport);
1974 /* Let the ofproto_class initialize its private data. */
1975 error = p->ofproto_class->port_construct(ofport);
1979 connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1983 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1984 p->name, netdev_name, ovs_strerror(error));
1986 ofport_destroy__(ofport);
1988 netdev_close(netdev);
1992 /* Removes 'ofport' from 'p' and destroys it. */
1994 ofport_remove(struct ofport *ofport)
1996 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1998 ofport_destroy(ofport);
2001 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2004 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2006 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2008 ofport_remove(port);
2012 /* Updates 'port' with new 'pp' description.
2014 * Does not handle a name or port number change. The caller must implement
2015 * such a change as a delete followed by an add. */
2017 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2019 memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2020 port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2021 | (pp->config & OFPUTIL_PC_PORT_DOWN));
2022 port->pp.state = pp->state;
2023 port->pp.curr = pp->curr;
2024 port->pp.advertised = pp->advertised;
2025 port->pp.supported = pp->supported;
2026 port->pp.peer = pp->peer;
2027 port->pp.curr_speed = pp->curr_speed;
2028 port->pp.max_speed = pp->max_speed;
2030 connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
2033 /* Update OpenFlow 'state' in 'port' and notify controller. */
2035 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2037 if (port->pp.state != state) {
2038 port->pp.state = state;
2039 connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
2045 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2047 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2049 if (port->ofproto->ofproto_class->set_realdev) {
2050 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2052 if (port->ofproto->ofproto_class->set_stp_port) {
2053 port->ofproto->ofproto_class->set_stp_port(port, NULL);
2055 if (port->ofproto->ofproto_class->set_cfm) {
2056 port->ofproto->ofproto_class->set_cfm(port, NULL);
2058 if (port->ofproto->ofproto_class->bundle_remove) {
2059 port->ofproto->ofproto_class->bundle_remove(port);
2065 ofport_destroy__(struct ofport *port)
2067 struct ofproto *ofproto = port->ofproto;
2068 const char *name = netdev_get_name(port->netdev);
2070 hmap_remove(&ofproto->ports, &port->hmap_node);
2071 shash_delete(&ofproto->port_by_name,
2072 shash_find(&ofproto->port_by_name, name));
2074 netdev_close(port->netdev);
2075 ofproto->ofproto_class->port_dealloc(port);
2079 ofport_destroy(struct ofport *port)
2082 dealloc_ofp_port(port->ofproto, port->ofp_port);
2083 port->ofproto->ofproto_class->port_destruct(port);
2084 ofport_destroy__(port);
2089 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2091 struct ofport *port;
2093 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2095 if (port->ofp_port == ofp_port) {
2103 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2105 struct ofproto *ofproto = port->ofproto;
2108 if (ofproto->ofproto_class->port_get_stats) {
2109 error = ofproto->ofproto_class->port_get_stats(port, stats);
2118 update_port(struct ofproto *ofproto, const char *name)
2120 struct ofproto_port ofproto_port;
2121 struct ofputil_phy_port pp;
2122 struct netdev *netdev;
2123 struct ofport *port;
2125 COVERAGE_INC(ofproto_update_port);
2127 /* Fetch 'name''s location and properties from the datapath. */
2128 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2129 ? ofport_open(ofproto, &ofproto_port, &pp)
2133 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2134 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2135 struct netdev *old_netdev = port->netdev;
2137 /* 'name' hasn't changed location. Any properties changed? */
2138 if (!ofport_equal(&port->pp, &pp)) {
2139 ofport_modified(port, &pp);
2142 update_mtu(ofproto, port);
2144 /* Install the newly opened netdev in case it has changed.
2145 * Don't close the old netdev yet in case port_modified has to
2146 * remove a retained reference to it.*/
2147 port->netdev = netdev;
2148 port->change_seq = netdev_change_seq(netdev);
2150 if (port->ofproto->ofproto_class->port_modified) {
2151 port->ofproto->ofproto_class->port_modified(port);
2154 netdev_close(old_netdev);
2156 /* If 'port' is nonnull then its name differs from 'name' and thus
2157 * we should delete it. If we think there's a port named 'name'
2158 * then its port number must be wrong now so delete it too. */
2160 ofport_remove(port);
2162 ofport_remove_with_name(ofproto, name);
2163 ofport_install(ofproto, netdev, &pp);
2166 /* Any port named 'name' is gone now. */
2167 ofport_remove_with_name(ofproto, name);
2169 ofproto_port_destroy(&ofproto_port);
2173 init_ports(struct ofproto *p)
2175 struct ofproto_port_dump dump;
2176 struct ofproto_port ofproto_port;
2177 struct shash_node *node, *next;
2179 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2180 const char *name = ofproto_port.name;
2182 if (shash_find(&p->port_by_name, name)) {
2183 VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2186 struct ofputil_phy_port pp;
2187 struct netdev *netdev;
2189 /* Check if an OpenFlow port number had been requested. */
2190 node = shash_find(&init_ofp_ports, name);
2192 const struct iface_hint *iface_hint = node->data;
2193 simap_put(&p->ofp_requests, name,
2194 ofp_to_u16(iface_hint->ofp_port));
2197 netdev = ofport_open(p, &ofproto_port, &pp);
2199 ofport_install(p, netdev, &pp);
2200 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2201 p->alloc_port_no = MAX(p->alloc_port_no,
2202 ofp_to_u16(ofproto_port.ofp_port));
2208 SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2209 struct iface_hint *iface_hint = node->data;
2211 if (!strcmp(iface_hint->br_name, p->name)) {
2212 free(iface_hint->br_name);
2213 free(iface_hint->br_type);
2215 shash_delete(&init_ofp_ports, node);
2222 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2223 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2225 find_min_mtu(struct ofproto *p)
2227 struct ofport *ofport;
2230 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2231 struct netdev *netdev = ofport->netdev;
2234 /* Skip any internal ports, since that's what we're trying to
2236 if (!strcmp(netdev_get_type(netdev), "internal")) {
2240 if (netdev_get_mtu(netdev, &dev_mtu)) {
2243 if (!mtu || dev_mtu < mtu) {
2248 return mtu ? mtu: ETH_PAYLOAD_MAX;
2251 /* Update MTU of all datapath devices on 'p' to the minimum of the
2252 * non-datapath ports in event of 'port' added or changed. */
2254 update_mtu(struct ofproto *p, struct ofport *port)
2256 struct ofport *ofport;
2257 struct netdev *netdev = port->netdev;
2258 int dev_mtu, old_min;
2260 if (netdev_get_mtu(netdev, &dev_mtu)) {
2264 if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2265 if (dev_mtu > p->min_mtu) {
2266 if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2267 dev_mtu = p->min_mtu;
2270 port->mtu = dev_mtu;
2274 /* For non-internal port find new min mtu. */
2275 old_min = p->min_mtu;
2276 port->mtu = dev_mtu;
2277 p->min_mtu = find_min_mtu(p);
2278 if (p->min_mtu == old_min) {
2282 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2283 struct netdev *netdev = ofport->netdev;
2285 if (!strcmp(netdev_get_type(netdev), "internal")) {
2286 if (!netdev_set_mtu(netdev, p->min_mtu)) {
2287 ofport->mtu = p->min_mtu;
2294 ofproto_rule_destroy(struct rule *rule)
2297 rule->ofproto->ofproto_class->rule_destruct(rule);
2298 ofproto_rule_destroy__(rule);
2303 ofproto_rule_destroy__(struct rule *rule)
2305 cls_rule_destroy(&rule->cr);
2306 free(rule->ofpacts);
2307 ovs_mutex_destroy(&rule->timeout_mutex);
2308 ovs_rwlock_destroy(&rule->rwlock);
2309 rule->ofproto->ofproto_class->rule_dealloc(rule);
2312 /* This function allows an ofproto implementation to destroy any rules that
2313 * remain when its ->destruct() function is called.. This function implements
2314 * steps 4.4 and 4.5 in the section titled "Rule Life Cycle" in
2315 * ofproto-provider.h.
2317 * This function should only be called from an ofproto implementation's
2318 * ->destruct() function. It is not suitable elsewhere. */
2320 ofproto_rule_delete(struct ofproto *ofproto, struct classifier *cls,
2322 OVS_REQ_WRLOCK(cls->rwlock)
2324 ofproto_delete_rule(ofproto, cls, rule);
2327 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2328 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2330 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2332 return (port == OFPP_ANY
2333 || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2336 /* Returns true if 'rule' has group and equals group_id. */
2338 ofproto_rule_has_out_group(const struct rule *rule, uint32_t group_id)
2340 return (group_id == OFPG11_ANY
2341 || ofpacts_output_to_group(rule->ofpacts, rule->ofpacts_len, group_id));
2344 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2345 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2347 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2349 if (ofproto_rule_has_out_port(op->rule, out_port)) {
2354 case OFOPERATION_ADD:
2355 case OFOPERATION_DELETE:
2358 case OFOPERATION_MODIFY:
2359 case OFOPERATION_REPLACE:
2360 return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2366 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2367 * statistics appropriately.
2369 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2370 * with statistics for 'packet' either way.
2372 * Takes ownership of 'packet'. */
2374 rule_execute(struct rule *rule, ofp_port_t in_port, struct ofpbuf *packet)
2377 union flow_in_port in_port_;
2379 in_port_.ofp_port = in_port;
2380 flow_extract(packet, 0, 0, NULL, &in_port_, &flow);
2381 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2384 /* Returns true if 'rule' should be hidden from the controller.
2386 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2387 * (e.g. by in-band control) and are intentionally hidden from the
2390 ofproto_rule_is_hidden(const struct rule *rule)
2392 return rule->cr.priority > UINT16_MAX;
2395 static enum oftable_flags
2396 rule_get_flags(const struct rule *rule)
2398 return rule->ofproto->tables[rule->table_id].flags;
2402 rule_is_modifiable(const struct rule *rule)
2404 return !(rule_get_flags(rule) & OFTABLE_READONLY);
2408 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2410 ofconn_send_reply(ofconn, make_echo_reply(oh));
2415 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2417 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2418 struct ofputil_switch_features features;
2419 struct ofport *port;
2425 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2427 ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2429 /* Count only non-hidden tables in the number of tables. (Hidden tables,
2430 * if present, are always at the end.) */
2431 n_tables = ofproto->n_tables;
2432 for (i = 0; i < ofproto->n_tables; i++) {
2433 if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2439 features.datapath_id = ofproto->datapath_id;
2440 features.n_buffers = pktbuf_capacity();
2441 features.n_tables = n_tables;
2442 features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2443 OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2445 features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2447 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2448 features.auxiliary_id = 0;
2449 b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2451 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2452 ofputil_put_switch_features_port(&port->pp, b);
2455 ofconn_send_reply(ofconn, b);
2460 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2462 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2463 struct ofp_switch_config *osc;
2464 enum ofp_config_flags flags;
2468 buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2469 osc = ofpbuf_put_uninit(buf, sizeof *osc);
2470 flags = ofproto->frag_handling;
2471 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2472 if (oh->version < OFP13_VERSION
2473 && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2474 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2476 osc->flags = htons(flags);
2477 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2478 ofconn_send_reply(ofconn, buf);
2484 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2486 const struct ofp_switch_config *osc = ofpmsg_body(oh);
2487 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2488 uint16_t flags = ntohs(osc->flags);
2490 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2491 || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2492 enum ofp_config_flags cur = ofproto->frag_handling;
2493 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2495 ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2497 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2498 ofproto->frag_handling = next;
2500 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2502 ofputil_frag_handling_to_string(next));
2506 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2507 ofconn_set_invalid_ttl_to_controller(ofconn,
2508 (oh->version < OFP13_VERSION
2509 && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2511 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2516 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2517 * error message code for the caller to propagate upward. Otherwise, returns
2520 * The log message mentions 'msg_type'. */
2522 reject_slave_controller(struct ofconn *ofconn)
2524 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2525 && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2526 return OFPERR_OFPBRC_EPERM;
2532 /* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
2533 * 'ofpacts'. If found, returns its meter ID; if not, returns 0.
2535 * This function relies on the order of 'ofpacts' being correct (as checked by
2536 * ofpacts_verify()). */
2538 find_meter(const struct ofpact ofpacts[], size_t ofpacts_len)
2540 const struct ofpact *a;
2542 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2543 enum ovs_instruction_type inst;
2545 inst = ovs_instruction_type_from_ofpact_type(a->type);
2546 if (a->type == OFPACT_METER) {
2547 return ofpact_get_METER(a)->meter_id;
2548 } else if (inst > OVSINST_OFPIT13_METER) {
2556 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are appropriate
2557 * for a packet with the prerequisites satisfied by 'flow' in table 'table_id'.
2558 * 'flow' may be temporarily modified, but is restored at return.
2561 ofproto_check_ofpacts(struct ofproto *ofproto,
2562 const struct ofpact ofpacts[], size_t ofpacts_len,
2563 struct flow *flow, uint8_t table_id)
2568 error = ofpacts_check(ofpacts, ofpacts_len, flow,
2569 u16_to_ofp(ofproto->max_ports), table_id);
2574 mid = find_meter(ofpacts, ofpacts_len);
2575 if (mid && ofproto_get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2576 return OFPERR_OFPMMFC_INVALID_METER;
2582 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2584 struct ofproto *p = ofconn_get_ofproto(ofconn);
2585 struct ofputil_packet_out po;
2586 struct ofpbuf *payload;
2587 uint64_t ofpacts_stub[1024 / 8];
2588 struct ofpbuf ofpacts;
2590 union flow_in_port in_port_;
2593 COVERAGE_INC(ofproto_packet_out);
2595 error = reject_slave_controller(ofconn);
2600 /* Decode message. */
2601 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2602 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2604 goto exit_free_ofpacts;
2606 if (ofp_to_u16(po.in_port) >= p->max_ports
2607 && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2608 error = OFPERR_OFPBRC_BAD_PORT;
2609 goto exit_free_ofpacts;
2614 if (po.buffer_id != UINT32_MAX) {
2615 error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2616 if (error || !payload) {
2617 goto exit_free_ofpacts;
2620 /* Ensure that the L3 header is 32-bit aligned. */
2621 payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2624 /* Verify actions against packet, then send packet if successful. */
2625 in_port_.ofp_port = po.in_port;
2626 flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2627 error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len, &flow, 0);
2629 error = p->ofproto_class->packet_out(p, payload, &flow,
2630 po.ofpacts, po.ofpacts_len);
2632 ofpbuf_delete(payload);
2635 ofpbuf_uninit(&ofpacts);
2641 update_port_config(struct ofport *port,
2642 enum ofputil_port_config config,
2643 enum ofputil_port_config mask)
2645 enum ofputil_port_config old_config = port->pp.config;
2646 enum ofputil_port_config toggle;
2648 toggle = (config ^ port->pp.config) & mask;
2649 if (toggle & OFPUTIL_PC_PORT_DOWN) {
2650 if (config & OFPUTIL_PC_PORT_DOWN) {
2651 netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2653 netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2655 toggle &= ~OFPUTIL_PC_PORT_DOWN;
2658 port->pp.config ^= toggle;
2659 if (port->pp.config != old_config) {
2660 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2665 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2667 struct ofproto *p = ofconn_get_ofproto(ofconn);
2668 struct ofputil_port_mod pm;
2669 struct ofport *port;
2672 error = reject_slave_controller(ofconn);
2677 error = ofputil_decode_port_mod(oh, &pm);
2682 port = ofproto_get_port(p, pm.port_no);
2684 return OFPERR_OFPPMFC_BAD_PORT;
2685 } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2686 return OFPERR_OFPPMFC_BAD_HW_ADDR;
2688 update_port_config(port, pm.config, pm.mask);
2690 netdev_set_advertisements(port->netdev, pm.advertise);
2697 handle_desc_stats_request(struct ofconn *ofconn,
2698 const struct ofp_header *request)
2700 static const char *default_mfr_desc = "Nicira, Inc.";
2701 static const char *default_hw_desc = "Open vSwitch";
2702 static const char *default_sw_desc = VERSION;
2703 static const char *default_serial_desc = "None";
2704 static const char *default_dp_desc = "None";
2706 struct ofproto *p = ofconn_get_ofproto(ofconn);
2707 struct ofp_desc_stats *ods;
2710 msg = ofpraw_alloc_stats_reply(request, 0);
2711 ods = ofpbuf_put_zeros(msg, sizeof *ods);
2712 ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2713 sizeof ods->mfr_desc);
2714 ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2715 sizeof ods->hw_desc);
2716 ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2717 sizeof ods->sw_desc);
2718 ovs_strlcpy(ods->serial_num,
2719 p->serial_desc ? p->serial_desc : default_serial_desc,
2720 sizeof ods->serial_num);
2721 ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2722 sizeof ods->dp_desc);
2723 ofconn_send_reply(ofconn, msg);
2729 handle_table_stats_request(struct ofconn *ofconn,
2730 const struct ofp_header *request)
2732 struct ofproto *p = ofconn_get_ofproto(ofconn);
2733 struct ofp12_table_stats *ots;
2738 /* Set up default values.
2740 * ofp12_table_stats is used as a generic structure as
2741 * it is able to hold all the fields for ofp10_table_stats
2742 * and ofp11_table_stats (and of course itself).
2744 ots = xcalloc(p->n_tables, sizeof *ots);
2745 for (i = 0; i < p->n_tables; i++) {
2746 ots[i].table_id = i;
2747 sprintf(ots[i].name, "table%zu", i);
2748 ots[i].match = htonll(OFPXMT12_MASK);
2749 ots[i].wildcards = htonll(OFPXMT12_MASK);
2750 ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2751 ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2752 ots[i].write_setfields = htonll(OFPXMT12_MASK);
2753 ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2754 ots[i].metadata_match = htonll(UINT64_MAX);
2755 ots[i].metadata_write = htonll(UINT64_MAX);
2756 ots[i].instructions = htonl(OFPIT11_ALL);
2757 ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2758 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2759 ovs_rwlock_rdlock(&p->tables[i].cls.rwlock);
2760 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2761 ovs_rwlock_unlock(&p->tables[i].cls.rwlock);
2764 p->ofproto_class->get_tables(p, ots);
2766 /* Post-process the tables, dropping hidden tables. */
2767 n_tables = p->n_tables;
2768 for (i = 0; i < p->n_tables; i++) {
2769 const struct oftable *table = &p->tables[i];
2771 if (table->flags & OFTABLE_HIDDEN) {
2777 ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2780 if (table->max_flows < ntohl(ots[i].max_entries)) {
2781 ots[i].max_entries = htonl(table->max_flows);
2785 msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2786 ofconn_send_reply(ofconn, msg);
2794 append_port_stat(struct ofport *port, struct list *replies)
2796 struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2798 calc_duration(port->created, time_msec(),
2799 &ops.duration_sec, &ops.duration_nsec);
2801 /* Intentionally ignore return value, since errors will set
2802 * 'stats' to all-1s, which is correct for OpenFlow, and
2803 * netdev_get_stats() will log errors. */
2804 ofproto_port_get_stats(port, &ops.stats);
2806 ofputil_append_port_stat(replies, &ops);
2810 handle_port_stats_request(struct ofconn *ofconn,
2811 const struct ofp_header *request)
2813 struct ofproto *p = ofconn_get_ofproto(ofconn);
2814 struct ofport *port;
2815 struct list replies;
2819 error = ofputil_decode_port_stats_request(request, &port_no);
2824 ofpmp_init(&replies, request);
2825 if (port_no != OFPP_ANY) {
2826 port = ofproto_get_port(p, port_no);
2828 append_port_stat(port, &replies);
2831 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2832 append_port_stat(port, &replies);
2836 ofconn_send_replies(ofconn, &replies);
2841 handle_port_desc_stats_request(struct ofconn *ofconn,
2842 const struct ofp_header *request)
2844 struct ofproto *p = ofconn_get_ofproto(ofconn);
2845 enum ofp_version version;
2846 struct ofport *port;
2847 struct list replies;
2849 ofpmp_init(&replies, request);
2851 version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2852 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2853 ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2856 ofconn_send_replies(ofconn, &replies);
2861 hash_cookie(ovs_be64 cookie)
2863 return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
2864 (OVS_FORCE uint64_t)cookie);
2868 cookies_insert(struct ofproto *ofproto, struct rule *rule)
2870 hindex_insert(&ofproto->cookies, &rule->cookie_node,
2871 hash_cookie(rule->flow_cookie));
2875 cookies_remove(struct ofproto *ofproto, struct rule *rule)
2877 hindex_remove(&ofproto->cookies, &rule->cookie_node);
2881 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
2882 ovs_be64 new_cookie)
2884 if (new_cookie != rule->flow_cookie) {
2885 cookies_remove(ofproto, rule);
2887 ovs_rwlock_wrlock(&rule->rwlock);
2888 rule->flow_cookie = new_cookie;
2889 ovs_rwlock_unlock(&rule->rwlock);
2891 cookies_insert(ofproto, rule);
2896 calc_duration(long long int start, long long int now,
2897 uint32_t *sec, uint32_t *nsec)
2899 long long int msecs = now - start;
2900 *sec = msecs / 1000;
2901 *nsec = (msecs % 1000) * (1000 * 1000);
2904 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2905 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2907 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2909 return (table_id == 0xff || table_id < ofproto->n_tables
2911 : OFPERR_OFPBRC_BAD_TABLE_ID);
2915 static struct oftable *
2916 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2918 struct oftable *table;
2920 for (table = &ofproto->tables[table_id];
2921 table < &ofproto->tables[ofproto->n_tables];
2923 if (!(table->flags & OFTABLE_HIDDEN)) {
2931 static struct oftable *
2932 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2934 if (table_id == 0xff) {
2935 return next_visible_table(ofproto, 0);
2936 } else if (table_id < ofproto->n_tables) {
2937 return &ofproto->tables[table_id];
2943 static struct oftable *
2944 next_matching_table(const struct ofproto *ofproto,
2945 const struct oftable *table, uint8_t table_id)
2947 return (table_id == 0xff
2948 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2952 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2954 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2955 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2957 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2958 * only once, for that table. (This can be used to access tables marked
2961 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2962 * entered at all. (Perhaps you should have validated TABLE_ID with
2963 * check_table_id().)
2965 * All parameters are evaluated multiple times.
2967 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2968 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2970 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2972 /* Initializes 'criteria' in a straightforward way based on the other
2975 * For "loose" matching, the 'priority' parameter is unimportant and may be
2978 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
2979 const struct match *match, unsigned int priority,
2980 ovs_be64 cookie, ovs_be64 cookie_mask,
2981 ofp_port_t out_port, uint32_t out_group)
2983 criteria->table_id = table_id;
2984 cls_rule_init(&criteria->cr, match, priority);
2985 criteria->cookie = cookie;
2986 criteria->cookie_mask = cookie_mask;
2987 criteria->out_port = out_port;
2988 criteria->out_group = out_group;
2992 rule_criteria_destroy(struct rule_criteria *criteria)
2994 cls_rule_destroy(&criteria->cr);
2998 collect_rule(struct rule *rule, const struct rule_criteria *c,
3001 if (ofproto_rule_is_hidden(rule)) {
3003 } else if (rule->pending) {
3004 return OFPROTO_POSTPONE;
3006 if ((c->table_id == rule->table_id || c->table_id == 0xff)
3007 && ofproto_rule_has_out_port(rule, c->out_port)
3008 && ofproto_rule_has_out_group(rule, c->out_group)
3009 && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3010 list_push_back(rules, &rule->ofproto_node);
3016 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3017 * on classifiers rules are done in the "loose" way required for OpenFlow
3018 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3021 * Hidden rules are always omitted.
3023 * Returns 0 on success, otherwise an OpenFlow error code. */
3025 collect_rules_loose(struct ofproto *ofproto,
3026 const struct rule_criteria *criteria, struct list *rules)
3028 struct oftable *table;
3031 error = check_table_id(ofproto, criteria->table_id);
3038 if (criteria->cookie_mask == htonll(UINT64_MAX)) {
3041 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3042 hash_cookie(criteria->cookie),
3043 &ofproto->cookies) {
3044 if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3045 error = collect_rule(rule, criteria, rules);
3052 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3053 struct cls_cursor cursor;
3056 ovs_rwlock_rdlock(&table->cls.rwlock);
3057 cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3058 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3059 error = collect_rule(rule, criteria, rules);
3064 ovs_rwlock_unlock(&table->cls.rwlock);
3071 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3072 * on classifiers rules are done in the "strict" way required for OpenFlow
3073 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3074 * rules on list 'rules'.
3076 * Hidden rules are always omitted.
3078 * Returns 0 on success, otherwise an OpenFlow error code. */
3080 collect_rules_strict(struct ofproto *ofproto,
3081 const struct rule_criteria *criteria, struct list *rules)
3083 struct oftable *table;
3086 error = check_table_id(ofproto, criteria->table_id);
3093 if (criteria->cookie_mask == htonll(UINT64_MAX)) {
3096 HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3097 hash_cookie(criteria->cookie),
3098 &ofproto->cookies) {
3099 if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3100 error = collect_rule(rule, criteria, rules);
3107 FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3110 ovs_rwlock_rdlock(&table->cls.rwlock);
3111 rule = rule_from_cls_rule(classifier_find_rule_exactly(
3112 &table->cls, &criteria->cr));
3113 ovs_rwlock_unlock(&table->cls.rwlock);
3115 error = collect_rule(rule, criteria, rules);
3126 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3127 * forced into the range of a uint16_t. */
3129 age_secs(long long int age_ms)
3131 return (age_ms < 0 ? 0
3132 : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3133 : (unsigned int) age_ms / 1000);
3137 handle_flow_stats_request(struct ofconn *ofconn,
3138 const struct ofp_header *request)
3140 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3141 struct ofputil_flow_stats_request fsr;
3142 struct rule_criteria criteria;
3143 struct list replies;
3148 error = ofputil_decode_flow_stats_request(&fsr, request);
3153 rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3154 fsr.cookie_mask, fsr.out_port, fsr.out_group);
3155 error = collect_rules_loose(ofproto, &criteria, &rules);
3156 rule_criteria_destroy(&criteria);
3161 ofpmp_init(&replies, request);
3162 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3163 long long int now = time_msec();
3164 struct ofputil_flow_stats fs;
3166 minimatch_expand(&rule->cr.match, &fs.match);
3167 fs.priority = rule->cr.priority;
3168 fs.cookie = rule->flow_cookie;
3169 fs.table_id = rule->table_id;
3170 calc_duration(rule->created, now, &fs.duration_sec, &fs.duration_nsec);
3171 fs.idle_age = age_secs(now - rule->used);
3172 fs.hard_age = age_secs(now - rule->modified);
3173 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3175 fs.ofpacts = rule->ofpacts;
3176 fs.ofpacts_len = rule->ofpacts_len;
3178 ovs_mutex_lock(&rule->timeout_mutex);
3179 fs.idle_timeout = rule->idle_timeout;
3180 fs.hard_timeout = rule->hard_timeout;
3181 ovs_mutex_unlock(&rule->timeout_mutex);
3183 fs.flags = rule->flags;
3185 ofputil_append_flow_stats_reply(&fs, &replies);
3187 ofconn_send_replies(ofconn, &replies);
3193 flow_stats_ds(struct rule *rule, struct ds *results)
3195 uint64_t packet_count, byte_count;
3197 rule->ofproto->ofproto_class->rule_get_stats(rule,
3198 &packet_count, &byte_count);
3200 if (rule->table_id != 0) {
3201 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3203 ds_put_format(results, "duration=%llds, ",
3204 (time_msec() - rule->created) / 1000);
3205 ds_put_format(results, "priority=%u, ", rule->cr.priority);
3206 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3207 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3208 cls_rule_format(&rule->cr, results);
3209 ds_put_char(results, ',');
3210 ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
3211 ds_put_cstr(results, "\n");
3214 /* Adds a pretty-printed description of all flows to 'results', including
3215 * hidden flows (e.g., set up by in-band control). */
3217 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3219 struct oftable *table;
3221 OFPROTO_FOR_EACH_TABLE (table, p) {
3222 struct cls_cursor cursor;
3225 ovs_rwlock_rdlock(&table->cls.rwlock);
3226 cls_cursor_init(&cursor, &table->cls, NULL);
3227 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3228 flow_stats_ds(rule, results);
3230 ovs_rwlock_unlock(&table->cls.rwlock);
3234 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3235 * '*engine_type' and '*engine_id', respectively. */
3237 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3238 uint8_t *engine_type, uint8_t *engine_id)
3240 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3243 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'. Returns
3244 * true if the port's CFM status was successfully stored into '*status'.
3245 * Returns false if the port did not have CFM configured, in which case
3246 * '*status' is indeterminate.
3248 * The caller must provide and owns '*status', and must free 'status->rmps'. */
3250 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3251 struct ofproto_cfm_status *status)
3253 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3255 && ofproto->ofproto_class->get_cfm_status
3256 && ofproto->ofproto_class->get_cfm_status(ofport, status));
3260 handle_aggregate_stats_request(struct ofconn *ofconn,
3261 const struct ofp_header *oh)
3263 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3264 struct ofputil_flow_stats_request request;
3265 struct ofputil_aggregate_stats stats;
3266 bool unknown_packets, unknown_bytes;
3267 struct rule_criteria criteria;
3268 struct ofpbuf *reply;
3273 error = ofputil_decode_flow_stats_request(&request, oh);
3278 rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3279 request.cookie, request.cookie_mask,
3280 request.out_port, request.out_group);
3281 error = collect_rules_loose(ofproto, &criteria, &rules);
3282 rule_criteria_destroy(&criteria);
3287 memset(&stats, 0, sizeof stats);
3288 unknown_packets = unknown_bytes = false;
3289 LIST_FOR_EACH (rule, ofproto_node, &rules) {
3290 uint64_t packet_count;
3291 uint64_t byte_count;
3293 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3296 if (packet_count == UINT64_MAX) {
3297 unknown_packets = true;
3299 stats.packet_count += packet_count;
3302 if (byte_count == UINT64_MAX) {
3303 unknown_bytes = true;
3305 stats.byte_count += byte_count;
3310 if (unknown_packets) {
3311 stats.packet_count = UINT64_MAX;
3313 if (unknown_bytes) {
3314 stats.byte_count = UINT64_MAX;
3317 reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3318 ofconn_send_reply(ofconn, reply);
3323 struct queue_stats_cbdata {
3324 struct ofport *ofport;
3325 struct list replies;
3330 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3331 const struct netdev_queue_stats *stats)
3333 struct ofputil_queue_stats oqs;
3335 oqs.port_no = cbdata->ofport->pp.port_no;
3336 oqs.queue_id = queue_id;
3337 oqs.tx_bytes = stats->tx_bytes;
3338 oqs.tx_packets = stats->tx_packets;
3339 oqs.tx_errors = stats->tx_errors;
3340 if (stats->created != LLONG_MIN) {
3341 calc_duration(stats->created, cbdata->now,
3342 &oqs.duration_sec, &oqs.duration_nsec);
3344 oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3346 ofputil_append_queue_stat(&cbdata->replies, &oqs);
3350 handle_queue_stats_dump_cb(uint32_t queue_id,
3351 struct netdev_queue_stats *stats,
3354 struct queue_stats_cbdata *cbdata = cbdata_;
3356 put_queue_stats(cbdata, queue_id, stats);
3360 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3361 struct queue_stats_cbdata *cbdata)
3363 cbdata->ofport = port;
3364 if (queue_id == OFPQ_ALL) {
3365 netdev_dump_queue_stats(port->netdev,
3366 handle_queue_stats_dump_cb, cbdata);
3368 struct netdev_queue_stats stats;
3370 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3371 put_queue_stats(cbdata, queue_id, &stats);
3373 return OFPERR_OFPQOFC_BAD_QUEUE;
3380 handle_queue_stats_request(struct ofconn *ofconn,
3381 const struct ofp_header *rq)
3383 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3384 struct queue_stats_cbdata cbdata;
3385 struct ofport *port;
3387 struct ofputil_queue_stats_request oqsr;
3389 COVERAGE_INC(ofproto_queue_req);
3391 ofpmp_init(&cbdata.replies, rq);
3392 cbdata.now = time_msec();
3394 error = ofputil_decode_queue_stats_request(rq, &oqsr);
3399 if (oqsr.port_no == OFPP_ANY) {
3400 error = OFPERR_OFPQOFC_BAD_QUEUE;
3401 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3402 if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3407 port = ofproto_get_port(ofproto, oqsr.port_no);
3409 ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3410 : OFPERR_OFPQOFC_BAD_PORT);
3413 ofconn_send_replies(ofconn, &cbdata.replies);
3415 ofpbuf_list_delete(&cbdata.replies);
3422 is_flow_deletion_pending(const struct ofproto *ofproto,
3423 const struct cls_rule *cls_rule,
3426 if (!hmap_is_empty(&ofproto->deletions)) {
3427 struct ofoperation *op;
3429 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3430 cls_rule_hash(cls_rule, table_id),
3431 &ofproto->deletions) {
3432 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3442 evict_rule_from_table(struct ofproto *ofproto, struct oftable *table)
3447 ovs_rwlock_rdlock(&table->cls.rwlock);
3448 n_rules = classifier_count(&table->cls);
3449 ovs_rwlock_unlock(&table->cls.rwlock);
3451 if (n_rules < table->max_flows) {
3453 } else if (!choose_rule_to_evict(table, &rule)) {
3454 return OFPERR_OFPFMFC_TABLE_FULL;
3455 } else if (rule->pending) {
3456 ovs_rwlock_unlock(&rule->rwlock);
3457 return OFPROTO_POSTPONE;
3459 struct ofopgroup *group;
3461 group = ofopgroup_create_unattached(ofproto);
3462 delete_flow__(rule, group, OFPRR_EVICTION);
3463 ofopgroup_submit(group);
3469 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3470 * in which no matching flow already exists in the flow table.
3472 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3473 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3474 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3475 * initiated now but may be retried later.
3477 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3478 * ownership remains with the caller.
3480 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3483 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3484 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3486 struct oftable *table;
3487 struct ofopgroup *group;
3493 error = check_table_id(ofproto, fm->table_id);
3499 if (fm->table_id == 0xff) {
3500 if (ofproto->ofproto_class->rule_choose_table) {
3501 error = ofproto->ofproto_class->rule_choose_table(ofproto,
3507 ovs_assert(table_id < ofproto->n_tables);
3511 } else if (fm->table_id < ofproto->n_tables) {
3512 table_id = fm->table_id;
3514 return OFPERR_OFPBRC_BAD_TABLE_ID;
3517 table = &ofproto->tables[table_id];
3519 if (table->flags & OFTABLE_READONLY) {
3520 return OFPERR_OFPBRC_EPERM;
3523 cls_rule_init(&cr, &fm->match, fm->priority);
3525 /* Transform "add" into "modify" if there's an existing identical flow. */
3526 ovs_rwlock_rdlock(&table->cls.rwlock);
3527 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
3528 ovs_rwlock_unlock(&table->cls.rwlock);
3530 cls_rule_destroy(&cr);
3531 if (!rule_is_modifiable(rule)) {
3532 return OFPERR_OFPBRC_EPERM;
3533 } else if (rule->pending) {
3534 return OFPROTO_POSTPONE;
3539 list_push_back(&rules, &rule->ofproto_node);
3540 fm->modify_cookie = true;
3541 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3545 /* Verify actions. */
3546 error = ofproto_check_ofpacts(ofproto, fm->ofpacts, fm->ofpacts_len,
3547 &fm->match.flow, table_id);
3549 cls_rule_destroy(&cr);
3553 /* Serialize against pending deletion. */
3554 if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
3555 cls_rule_destroy(&cr);
3556 return OFPROTO_POSTPONE;
3559 /* Check for overlap, if requested. */
3560 if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
3563 ovs_rwlock_rdlock(&table->cls.rwlock);
3564 overlaps = classifier_rule_overlaps(&table->cls, &cr);
3565 ovs_rwlock_unlock(&table->cls.rwlock);
3568 cls_rule_destroy(&cr);
3569 return OFPERR_OFPFMFC_OVERLAP;
3573 /* If necessary, evict an existing rule to clear out space. */
3574 error = evict_rule_from_table(ofproto, table);
3576 cls_rule_destroy(&cr);
3580 /* Allocate new rule. */
3581 rule = ofproto->ofproto_class->rule_alloc();
3583 cls_rule_destroy(&cr);
3584 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3585 ofproto->name, ovs_strerror(error));
3589 /* Initialize base state. */
3590 rule->ofproto = ofproto;
3591 cls_rule_move(&rule->cr, &cr);
3592 rule->pending = NULL;
3593 rule->flow_cookie = fm->new_cookie;
3594 rule->created = rule->modified = rule->used = time_msec();
3596 ovs_mutex_init(&rule->timeout_mutex);
3597 ovs_mutex_lock(&rule->timeout_mutex);
3598 rule->idle_timeout = fm->idle_timeout;
3599 rule->hard_timeout = fm->hard_timeout;
3600 ovs_mutex_unlock(&rule->timeout_mutex);
3602 rule->table_id = table - ofproto->tables;
3603 rule->flags = fm->flags & OFPUTIL_FF_STATE;
3605 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3606 rule->ofpacts_len = fm->ofpacts_len;
3607 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3608 list_init(&rule->meter_list_node);
3609 rule->eviction_group = NULL;
3610 list_init(&rule->expirable);
3611 rule->monitor_flags = 0;
3612 rule->add_seqno = 0;
3613 rule->modify_seqno = 0;
3614 ovs_rwlock_init(&rule->rwlock);
3616 /* Construct rule, initializing derived state. */
3617 error = ofproto->ofproto_class->rule_construct(rule);
3619 ofproto_rule_destroy__(rule);
3624 oftable_insert_rule(rule);
3626 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3627 ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3628 ofproto->ofproto_class->rule_insert(rule);
3629 ofopgroup_submit(group);
3634 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3636 /* Modifies the rules listed in 'rules', changing their actions to match those
3639 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3642 * Returns 0 on success, otherwise an OpenFlow error code. */
3644 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3645 struct ofputil_flow_mod *fm, const struct ofp_header *request,
3648 enum ofoperation_type type;
3649 struct ofopgroup *group;
3653 type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
3654 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3655 error = OFPERR_OFPBRC_EPERM;
3656 LIST_FOR_EACH (rule, ofproto_node, rules) {
3657 struct ofoperation *op;
3658 bool actions_changed;
3659 bool reset_counters;
3661 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
3663 if (rule_is_modifiable(rule)) {
3664 /* At least one rule is modifiable, don't report EPERM error. */
3670 /* Verify actions. */
3671 error = ofpacts_check(fm->ofpacts, fm->ofpacts_len, &fm->match.flow,
3672 u16_to_ofp(ofproto->max_ports), rule->table_id);
3677 actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3678 rule->ofpacts, rule->ofpacts_len);
3680 op = ofoperation_create(group, rule, type, 0);
3682 if (fm->modify_cookie && fm->new_cookie != htonll(UINT64_MAX)) {
3683 ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
3685 if (type == OFOPERATION_REPLACE) {
3686 ovs_mutex_lock(&rule->timeout_mutex);
3687 rule->idle_timeout = fm->idle_timeout;
3688 rule->hard_timeout = fm->hard_timeout;
3689 ovs_mutex_unlock(&rule->timeout_mutex);
3691 rule->flags = fm->flags & OFPUTIL_FF_STATE;
3692 if (fm->idle_timeout || fm->hard_timeout) {
3693 if (!rule->eviction_group) {
3694 eviction_group_add_rule(rule);
3697 eviction_group_remove_rule(rule);
3701 reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
3702 if (actions_changed || reset_counters) {
3703 op->ofpacts = rule->ofpacts;
3704 op->ofpacts_len = rule->ofpacts_len;
3705 op->meter_id = rule->meter_id;
3707 ovs_rwlock_wrlock(&rule->rwlock);
3708 rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3709 rule->ofpacts_len = fm->ofpacts_len;
3710 ovs_rwlock_unlock(&rule->rwlock);
3712 rule->meter_id = find_meter(rule->ofpacts, rule->ofpacts_len);
3713 rule->ofproto->ofproto_class->rule_modify_actions(rule,
3716 ofoperation_complete(op, 0);
3719 ofopgroup_submit(group);
3725 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3726 struct ofputil_flow_mod *fm, const struct ofp_header *request)
3728 if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3731 return add_flow(ofproto, ofconn, fm, request);
3734 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3737 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3740 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3741 struct ofputil_flow_mod *fm,
3742 const struct ofp_header *request)
3744 struct rule_criteria criteria;
3748 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
3749 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
3750 error = collect_rules_loose(ofproto, &criteria, &rules);
3751 rule_criteria_destroy(&criteria);
3755 } else if (list_is_empty(&rules)) {
3756 return modify_flows_add(ofproto, ofconn, fm, request);
3758 return modify_flows__(ofproto, ofconn, fm, request, &rules);
3762 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3765 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3768 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3769 struct ofputil_flow_mod *fm,
3770 const struct ofp_header *request)
3772 struct rule_criteria criteria;
3776 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
3777 fm->cookie, fm->cookie_mask, OFPP_ANY, OFPG11_ANY);
3778 error = collect_rules_strict(ofproto, &criteria, &rules);
3779 rule_criteria_destroy(&criteria);
3783 } else if (list_is_empty(&rules)) {
3784 return modify_flows_add(ofproto, ofconn, fm, request);
3786 return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3787 fm, request, &rules)
3792 /* OFPFC_DELETE implementation. */
3795 delete_flow__(struct rule *rule, struct ofopgroup *group,
3796 enum ofp_flow_removed_reason reason)
3798 struct ofproto *ofproto = rule->ofproto;
3800 ofproto_rule_send_removed(rule, reason);
3802 ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3803 oftable_remove_rule(rule);
3804 ofproto->ofproto_class->rule_delete(rule);
3807 /* Deletes the rules listed in 'rules'.
3809 * Returns 0 on success, otherwise an OpenFlow error code. */
3811 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3812 const struct ofp_header *request, struct list *rules,
3813 enum ofp_flow_removed_reason reason)
3815 struct rule *rule, *next;
3816 struct ofopgroup *group;
3818 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3819 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3820 ovs_rwlock_wrlock(&rule->rwlock);
3821 delete_flow__(rule, group, reason);
3823 ofopgroup_submit(group);
3828 /* Implements OFPFC_DELETE. */
3830 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3831 const struct ofputil_flow_mod *fm,
3832 const struct ofp_header *request)
3834 struct rule_criteria criteria;
3838 rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
3839 fm->cookie, fm->cookie_mask,
3840 fm->out_port, fm->out_group);
3841 error = collect_rules_loose(ofproto, &criteria, &rules);
3842 rule_criteria_destroy(&criteria);
3844 return (error ? error
3845 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3846 &rules, OFPRR_DELETE)
3850 /* Implements OFPFC_DELETE_STRICT. */
3852 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3853 const struct ofputil_flow_mod *fm,
3854 const struct ofp_header *request)
3856 struct rule_criteria criteria;
3860 rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
3861 fm->cookie, fm->cookie_mask,
3862 fm->out_port, fm->out_group);
3863 error = collect_rules_strict(ofproto, &criteria, &rules);
3864 rule_criteria_destroy(&criteria);
3866 return (error ? error
3867 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3874 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3876 struct ofputil_flow_removed fr;
3878 if (ofproto_rule_is_hidden(rule) ||
3879 !(rule->flags & OFPUTIL_FF_SEND_FLOW_REM)) {
3883 minimatch_expand(&rule->cr.match, &fr.match);
3884 fr.priority = rule->cr.priority;
3885 fr.cookie = rule->flow_cookie;
3887 fr.table_id = rule->table_id;
3888 calc_duration(rule->created, time_msec(),
3889 &fr.duration_sec, &fr.duration_nsec);
3890 ovs_mutex_lock(&rule->timeout_mutex);
3891 fr.idle_timeout = rule->idle_timeout;
3892 fr.hard_timeout = rule->hard_timeout;
3893 ovs_mutex_unlock(&rule->timeout_mutex);
3894 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3897 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3900 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3901 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3904 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3907 * ofproto implementation ->run() functions should use this function to expire
3908 * OpenFlow flows. */
3910 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3912 struct ofproto *ofproto = rule->ofproto;
3913 struct classifier *cls = &ofproto->tables[rule->table_id].cls;
3915 ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
3916 || reason == OFPRR_DELETE || reason == OFPRR_GROUP_DELETE);
3917 ofproto_rule_send_removed(rule, reason);
3919 ovs_rwlock_wrlock(&cls->rwlock);
3920 ofproto_delete_rule(ofproto, cls, rule);
3921 ovs_rwlock_unlock(&cls->rwlock);
3924 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
3925 * means "infinite". */
3927 reduce_timeout(uint16_t max, uint16_t *timeout)
3929 if (max && (!*timeout || *timeout > max)) {
3934 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
3935 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
3936 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
3938 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
3940 ofproto_rule_reduce_timeouts(struct rule *rule,
3941 uint16_t idle_timeout, uint16_t hard_timeout)
3942 OVS_EXCLUDED(rule->ofproto->expirable_mutex, rule->timeout_mutex)
3944 if (!idle_timeout && !hard_timeout) {
3948 ovs_mutex_lock(&rule->ofproto->expirable_mutex);
3949 if (list_is_empty(&rule->expirable)) {
3950 list_insert(&rule->ofproto->expirable, &rule->expirable);
3952 ovs_mutex_unlock(&rule->ofproto->expirable_mutex);
3954 ovs_mutex_lock(&rule->timeout_mutex);
3955 reduce_timeout(idle_timeout, &rule->idle_timeout);
3956 reduce_timeout(hard_timeout, &rule->hard_timeout);
3957 ovs_mutex_unlock(&rule->timeout_mutex);
3961 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3963 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3964 struct ofputil_flow_mod fm;
3965 uint64_t ofpacts_stub[1024 / 8];
3966 struct ofpbuf ofpacts;
3970 error = reject_slave_controller(ofconn);
3975 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3976 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3979 error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
3982 goto exit_free_ofpacts;
3985 /* Record the operation for logging a summary report. */
3986 switch (fm.command) {
3992 case OFPFC_MODIFY_STRICT:
3993 ofproto->n_modify++;
3997 case OFPFC_DELETE_STRICT:
3998 ofproto->n_delete++;
4003 if (ofproto->next_op_report == LLONG_MAX) {
4004 ofproto->first_op = now;
4005 ofproto->next_op_report = MAX(now + 10 * 1000,
4006 ofproto->op_backoff);
4007 ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4009 ofproto->last_op = now;
4012 ofpbuf_uninit(&ofpacts);
4018 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4019 struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4021 if (ofproto->n_pending >= 50) {
4022 ovs_assert(!list_is_empty(&ofproto->pending));
4023 return OFPROTO_POSTPONE;
4026 switch (fm->command) {
4028 return add_flow(ofproto, ofconn, fm, oh);
4031 return modify_flows_loose(ofproto, ofconn, fm, oh);
4033 case OFPFC_MODIFY_STRICT:
4034 return modify_flow_strict(ofproto, ofconn, fm, oh);
4037 return delete_flows_loose(ofproto, ofconn, fm, oh);
4039 case OFPFC_DELETE_STRICT:
4040 return delete_flow_strict(ofproto, ofconn, fm, oh);
4043 if (fm->command > 0xff) {
4044 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4045 "flow_mod_table_id extension is not enabled",
4048 return OFPERR_OFPFMFC_BAD_COMMAND;
4053 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4055 struct ofputil_role_request request;
4056 struct ofputil_role_request reply;
4060 error = ofputil_decode_role_message(oh, &request);
4065 if (request.role != OFPCR12_ROLE_NOCHANGE) {
4066 if (ofconn_get_role(ofconn) != request.role
4067 && ofconn_has_pending_opgroups(ofconn)) {
4068 return OFPROTO_POSTPONE;
4071 if (request.have_generation_id
4072 && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4073 return OFPERR_OFPRRFC_STALE;
4076 ofconn_set_role(ofconn, request.role);
4079 reply.role = ofconn_get_role(ofconn);
4080 reply.have_generation_id = ofconn_get_master_election_id(
4081 ofconn, &reply.generation_id);
4082 buf = ofputil_encode_role_reply(oh, &reply);
4083 ofconn_send_reply(ofconn, buf);
4089 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4090 const struct ofp_header *oh)
4092 const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4093 enum ofputil_protocol cur, next;
4095 cur = ofconn_get_protocol(ofconn);
4096 next = ofputil_protocol_set_tid(cur, msg->set != 0);
4097 ofconn_set_protocol(ofconn, next);
4103 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4105 const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4106 enum ofputil_protocol cur, next;
4107 enum ofputil_protocol next_base;
4109 next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4111 return OFPERR_OFPBRC_EPERM;
4114 cur = ofconn_get_protocol(ofconn);
4115 next = ofputil_protocol_set_base(cur, next_base);
4116 if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4117 /* Avoid sending async messages in surprising protocol. */
4118 return OFPROTO_POSTPONE;
4121 ofconn_set_protocol(ofconn, next);
4126 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4127 const struct ofp_header *oh)
4129 const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4132 format = ntohl(msg->format);
4133 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4134 return OFPERR_OFPBRC_EPERM;
4137 if (format != ofconn_get_packet_in_format(ofconn)
4138 && ofconn_has_pending_opgroups(ofconn)) {
4139 /* Avoid sending async message in surprsing packet in format. */
4140 return OFPROTO_POSTPONE;
4143 ofconn_set_packet_in_format(ofconn, format);
4148 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4150 const struct nx_async_config *msg = ofpmsg_body(oh);
4151 uint32_t master[OAM_N_TYPES];
4152 uint32_t slave[OAM_N_TYPES];
4154 master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4155 master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4156 master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4158 slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4159 slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4160 slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4162 ofconn_set_async_config(ofconn, master, slave);
4163 if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4164 !ofconn_get_miss_send_len(ofconn)) {
4165 ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4172 handle_nxt_get_async_request(struct ofconn *ofconn, const struct ofp_header *oh)
4175 uint32_t master[OAM_N_TYPES];
4176 uint32_t slave[OAM_N_TYPES];
4177 struct nx_async_config *msg;
4179 ofconn_get_async_config(ofconn, master, slave);
4180 buf = ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY, oh, 0);
4181 msg = ofpbuf_put_zeros(buf, sizeof *msg);
4183 msg->packet_in_mask[0] = htonl(master[OAM_PACKET_IN]);
4184 msg->port_status_mask[0] = htonl(master[OAM_PORT_STATUS]);
4185 msg->flow_removed_mask[0] = htonl(master[OAM_FLOW_REMOVED]);
4187 msg->packet_in_mask[1] = htonl(slave[OAM_PACKET_IN]);
4188 msg->port_status_mask[1] = htonl(slave[OAM_PORT_STATUS]);
4189 msg->flow_removed_mask[1] = htonl(slave[OAM_FLOW_REMOVED]);
4191 ofconn_send_reply(ofconn, buf);
4197 handle_nxt_set_controller_id(struct ofconn *ofconn,
4198 const struct ofp_header *oh)
4200 const struct nx_controller_id *nci = ofpmsg_body(oh);
4202 if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4203 return OFPERR_NXBRC_MUST_BE_ZERO;
4206 ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4211 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4215 if (ofconn_has_pending_opgroups(ofconn)) {
4216 return OFPROTO_POSTPONE;
4219 buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4220 ? OFPRAW_OFPT10_BARRIER_REPLY
4221 : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4222 ofconn_send_reply(ofconn, buf);
4227 ofproto_compose_flow_refresh_update(const struct rule *rule,
4228 enum nx_flow_monitor_flags flags,
4231 struct ofoperation *op = rule->pending;
4232 struct ofputil_flow_update fu;
4235 if (op && op->type == OFOPERATION_ADD) {
4236 /* We'll report the final flow when the operation completes. Reporting
4237 * it now would cause a duplicate report later. */
4241 fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4242 ? NXFME_ADDED : NXFME_MODIFIED);
4244 ovs_mutex_lock(&rule->timeout_mutex);
4245 fu.idle_timeout = rule->idle_timeout;
4246 fu.hard_timeout = rule->hard_timeout;
4247 ovs_mutex_unlock(&rule->timeout_mutex);
4248 fu.table_id = rule->table_id;
4249 fu.cookie = rule->flow_cookie;
4250 minimatch_expand(&rule->cr.match, &match);
4252 fu.priority = rule->cr.priority;
4253 if (!(flags & NXFMF_ACTIONS)) {
4257 fu.ofpacts = rule->ofpacts;
4258 fu.ofpacts_len = rule->ofpacts_len;
4260 /* An operation is in progress. Use the previous version of the flow's
4261 * actions, so that when the operation commits we report the change. */
4263 case OFOPERATION_ADD:
4266 case OFOPERATION_MODIFY:
4267 case OFOPERATION_REPLACE:
4269 fu.ofpacts = op->ofpacts;
4270 fu.ofpacts_len = op->ofpacts_len;
4272 fu.ofpacts = rule->ofpacts;
4273 fu.ofpacts_len = rule->ofpacts_len;
4277 case OFOPERATION_DELETE:
4278 fu.ofpacts = rule->ofpacts;
4279 fu.ofpacts_len = rule->ofpacts_len;
4287 if (list_is_empty(msgs)) {
4288 ofputil_start_flow_update(msgs);
4290 ofputil_append_flow_update(&fu, msgs);
4294 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
4298 LIST_FOR_EACH (rule, ofproto_node, rules) {
4299 enum nx_flow_monitor_flags flags = rule->monitor_flags;
4300 rule->monitor_flags = 0;
4302 ofproto_compose_flow_refresh_update(rule, flags, msgs);
4307 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4308 struct rule *rule, uint64_t seqno,
4311 enum nx_flow_monitor_flags update;
4313 if (ofproto_rule_is_hidden(rule)) {
4318 ? ofoperation_has_out_port(rule->pending, m->out_port)
4319 : ofproto_rule_has_out_port(rule, m->out_port))) {
4324 if (rule->add_seqno > seqno) {
4325 update = NXFMF_ADD | NXFMF_MODIFY;
4326 } else if (rule->modify_seqno > seqno) {
4327 update = NXFMF_MODIFY;
4332 if (!(m->flags & update)) {
4336 update = NXFMF_INITIAL;
4339 if (!rule->monitor_flags) {
4340 list_push_back(rules, &rule->ofproto_node);
4342 rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4346 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4350 const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4351 const struct ofoperation *op;
4352 const struct oftable *table;
4353 struct cls_rule target;
4355 cls_rule_init_from_minimatch(&target, &m->match, 0);
4356 FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4357 struct cls_cursor cursor;
4360 ovs_rwlock_rdlock(&table->cls.rwlock);
4361 cls_cursor_init(&cursor, &table->cls, &target);
4362 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4363 ovs_assert(!rule->pending); /* XXX */
4364 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4366 ovs_rwlock_unlock(&table->cls.rwlock);
4369 HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4370 struct rule *rule = op->rule;
4372 if (((m->table_id == 0xff
4373 ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4374 : m->table_id == rule->table_id))
4375 && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4376 ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4379 cls_rule_destroy(&target);
4383 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4386 if (m->flags & NXFMF_INITIAL) {
4387 ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4392 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4393 uint64_t seqno, struct list *rules)
4395 ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4399 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4401 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4402 struct ofmonitor **monitors;
4403 size_t n_monitors, allocated_monitors;
4404 struct list replies;
4411 ofpbuf_use_const(&b, oh, ntohs(oh->length));
4413 n_monitors = allocated_monitors = 0;
4415 struct ofputil_flow_monitor_request request;
4416 struct ofmonitor *m;
4419 retval = ofputil_decode_flow_monitor_request(&request, &b);
4420 if (retval == EOF) {
4422 } else if (retval) {
4427 if (request.table_id != 0xff
4428 && request.table_id >= ofproto->n_tables) {
4429 error = OFPERR_OFPBRC_BAD_TABLE_ID;
4433 error = ofmonitor_create(&request, ofconn, &m);
4438 if (n_monitors >= allocated_monitors) {
4439 monitors = x2nrealloc(monitors, &allocated_monitors,
4442 monitors[n_monitors++] = m;
4446 for (i = 0; i < n_monitors; i++) {
4447 ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4450 ofpmp_init(&replies, oh);
4451 ofmonitor_compose_refresh_updates(&rules, &replies);
4452 ofconn_send_replies(ofconn, &replies);
4459 for (i = 0; i < n_monitors; i++) {
4460 ofmonitor_destroy(monitors[i]);
4467 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4469 struct ofmonitor *m;
4472 id = ofputil_decode_flow_monitor_cancel(oh);
4473 m = ofmonitor_lookup(ofconn, id);
4475 return OFPERR_NXBRC_FM_BAD_ID;
4478 ofmonitor_destroy(m);
4482 /* Meters implementation.
4484 * Meter table entry, indexed by the OpenFlow meter_id.
4485 * These are always dynamically allocated to allocate enough space for
4487 * 'created' is used to compute the duration for meter stats.
4488 * 'list rules' is needed so that we can delete the dependent rules when the
4489 * meter table entry is deleted.
4490 * 'provider_meter_id' is for the provider's private use.
4493 long long int created; /* Time created. */
4494 struct list rules; /* List of "struct rule_dpif"s. */
4495 ofproto_meter_id provider_meter_id;
4496 uint16_t flags; /* Meter flags. */
4497 uint16_t n_bands; /* Number of meter bands. */
4498 struct ofputil_meter_band *bands;
4502 * This is used in instruction validation at flow set-up time,
4503 * as flows may not use non-existing meters.
4504 * This is also used by ofproto-providers to translate OpenFlow meter_ids
4505 * in METER instructions to the corresponding provider meter IDs.
4506 * Return value of UINT32_MAX signifies an invalid meter.
4509 ofproto_get_provider_meter_id(const struct ofproto * ofproto,
4510 uint32_t of_meter_id)
4512 if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
4513 const struct meter *meter = ofproto->meters[of_meter_id];
4515 return meter->provider_meter_id.uint32;
4522 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
4526 meter->flags = config->flags;
4527 meter->n_bands = config->n_bands;
4528 meter->bands = xmemdup(config->bands,
4529 config->n_bands * sizeof *meter->bands);
4532 static struct meter *
4533 meter_create(const struct ofputil_meter_config *config,
4534 ofproto_meter_id provider_meter_id)
4536 struct meter *meter;
4538 meter = xzalloc(sizeof *meter);
4539 meter->provider_meter_id = provider_meter_id;
4540 meter->created = time_msec();
4541 list_init(&meter->rules);
4543 meter_update(meter, config);
4549 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
4552 for (mid = first; mid <= last; ++mid) {
4553 struct meter *meter = ofproto->meters[mid];
4555 ofproto->meters[mid] = NULL;
4556 ofproto->ofproto_class->meter_del(ofproto,
4557 meter->provider_meter_id);
4565 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4567 ofproto_meter_id provider_meter_id = { UINT32_MAX };
4568 struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
4572 return OFPERR_OFPMMFC_METER_EXISTS;
4575 error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
4578 ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
4579 *meterp = meter_create(&mm->meter, provider_meter_id);
4585 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4587 struct meter *meter = ofproto->meters[mm->meter.meter_id];
4591 return OFPERR_OFPMMFC_UNKNOWN_METER;
4594 error = ofproto->ofproto_class->meter_set(ofproto,
4595 &meter->provider_meter_id,
4597 ovs_assert(meter->provider_meter_id.uint32 != UINT32_MAX);
4599 meter_update(meter, &mm->meter);
4605 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
4606 struct ofputil_meter_mod *mm)
4608 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4609 uint32_t meter_id = mm->meter.meter_id;
4610 uint32_t first, last;
4613 if (meter_id == OFPM13_ALL) {
4615 last = ofproto->meter_features.max_meters;
4617 if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4620 first = last = meter_id;
4623 /* First delete the rules that use this meter. If any of those rules are
4624 * currently being modified, postpone the whole operation until later. */
4626 for (meter_id = first; meter_id <= last; ++meter_id) {
4627 struct meter *meter = ofproto->meters[meter_id];
4628 if (meter && !list_is_empty(&meter->rules)) {
4631 LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
4632 if (rule->pending) {
4633 return OFPROTO_POSTPONE;
4635 list_push_back(&rules, &rule->ofproto_node);
4639 if (!list_is_empty(&rules)) {
4640 delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
4643 /* Delete the meters. */
4644 meter_delete(ofproto, first, last);
4650 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4652 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4653 struct ofputil_meter_mod mm;
4654 uint64_t bands_stub[256 / 8];
4655 struct ofpbuf bands;
4659 error = reject_slave_controller(ofconn);
4664 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4666 error = ofputil_decode_meter_mod(oh, &mm, &bands);
4668 goto exit_free_bands;
4671 meter_id = mm.meter.meter_id;
4673 if (mm.command != OFPMC13_DELETE) {
4674 /* Fails also when meters are not implemented by the provider. */
4675 if (meter_id == 0 || meter_id > OFPM13_MAX) {
4676 error = OFPERR_OFPMMFC_INVALID_METER;
4677 goto exit_free_bands;
4678 } else if (meter_id > ofproto->meter_features.max_meters) {
4679 error = OFPERR_OFPMMFC_OUT_OF_METERS;
4680 goto exit_free_bands;
4682 if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
4683 error = OFPERR_OFPMMFC_OUT_OF_BANDS;
4684 goto exit_free_bands;
4688 switch (mm.command) {
4690 error = handle_add_meter(ofproto, &mm);
4693 case OFPMC13_MODIFY:
4694 error = handle_modify_meter(ofproto, &mm);
4697 case OFPMC13_DELETE:
4698 error = handle_delete_meter(ofconn, oh, &mm);
4702 error = OFPERR_OFPMMFC_BAD_COMMAND;
4707 ofpbuf_uninit(&bands);
4712 handle_meter_features_request(struct ofconn *ofconn,
4713 const struct ofp_header *request)
4715 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4716 struct ofputil_meter_features features;
4719 if (ofproto->ofproto_class->meter_get_features) {
4720 ofproto->ofproto_class->meter_get_features(ofproto, &features);
4722 memset(&features, 0, sizeof features);
4724 b = ofputil_encode_meter_features_reply(&features, request);
4726 ofconn_send_reply(ofconn, b);
4731 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
4734 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4735 struct list replies;
4736 uint64_t bands_stub[256 / 8];
4737 struct ofpbuf bands;
4738 uint32_t meter_id, first, last;
4740 ofputil_decode_meter_request(request, &meter_id);
4742 if (meter_id == OFPM13_ALL) {
4744 last = ofproto->meter_features.max_meters;
4746 if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
4747 !ofproto->meters[meter_id]) {
4748 return OFPERR_OFPMMFC_UNKNOWN_METER;
4750 first = last = meter_id;
4753 ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4754 ofpmp_init(&replies, request);
4756 for (meter_id = first; meter_id <= last; ++meter_id) {
4757 struct meter *meter = ofproto->meters[meter_id];
4759 continue; /* Skip non-existing meters. */
4761 if (type == OFPTYPE_METER_STATS_REQUEST) {
4762 struct ofputil_meter_stats stats;
4764 stats.meter_id = meter_id;
4766 /* Provider sets the packet and byte counts, we do the rest. */
4767 stats.flow_count = list_size(&meter->rules);
4768 calc_duration(meter->created, time_msec(),
4769 &stats.duration_sec, &stats.duration_nsec);
4770 stats.n_bands = meter->n_bands;
4771 ofpbuf_clear(&bands);
4773 = ofpbuf_put_uninit(&bands,
4774 meter->n_bands * sizeof *stats.bands);
4776 if (!ofproto->ofproto_class->meter_get(ofproto,
4777 meter->provider_meter_id,
4779 ofputil_append_meter_stats(&replies, &stats);
4781 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
4782 struct ofputil_meter_config config;
4784 config.meter_id = meter_id;
4785 config.flags = meter->flags;
4786 config.n_bands = meter->n_bands;
4787 config.bands = meter->bands;
4788 ofputil_append_meter_config(&replies, &config);
4792 ofconn_send_replies(ofconn, &replies);
4793 ofpbuf_uninit(&bands);
4798 ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
4799 struct ofgroup **group)
4800 OVS_TRY_RDLOCK(true, (*group)->rwlock)
4802 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
4803 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
4804 hash_int(group_id, 0), &ofproto->groups) {
4805 if ((*group)->group_id == group_id) {
4806 ovs_rwlock_rdlock(&(*group)->rwlock);
4807 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4811 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4816 ofproto_group_release(struct ofgroup *group)
4817 OVS_RELEASES(group->rwlock)
4819 ovs_rwlock_unlock(&group->rwlock);
4823 ofproto_group_write_lookup(const struct ofproto *ofproto, uint32_t group_id,
4824 struct ofgroup **group)
4825 OVS_TRY_WRLOCK(true, ofproto->groups_rwlock)
4826 OVS_TRY_WRLOCK(true, (*group)->rwlock)
4828 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
4829 HMAP_FOR_EACH_IN_BUCKET (*group, hmap_node,
4830 hash_int(group_id, 0), &ofproto->groups) {
4831 if ((*group)->group_id == group_id) {
4832 ovs_rwlock_wrlock(&(*group)->rwlock);
4836 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4841 ofproto_group_exists(const struct ofproto *ofproto, uint32_t group_id)
4842 OVS_REQ_RDLOCK(ofproto->groups_rwlock)
4844 struct ofgroup *grp;
4846 HMAP_FOR_EACH_IN_BUCKET (grp, hmap_node,
4847 hash_int(group_id, 0), &ofproto->groups) {
4848 if (grp->group_id == group_id) {
4856 append_group_stats(struct ofgroup *group, struct list *replies)
4857 OVS_REQ_RDLOCK(group->rwlock)
4859 struct ofputil_group_stats ogs;
4860 struct ofproto *ofproto = group->ofproto;
4861 long long int now = time_msec();
4864 ogs.bucket_stats = xmalloc(group->n_buckets * sizeof *ogs.bucket_stats);
4866 error = (ofproto->ofproto_class->group_get_stats
4867 ? ofproto->ofproto_class->group_get_stats(group, &ogs)
4870 ogs.ref_count = UINT32_MAX;
4871 ogs.packet_count = UINT64_MAX;
4872 ogs.byte_count = UINT64_MAX;
4873 ogs.n_buckets = group->n_buckets;
4874 memset(ogs.bucket_stats, 0xff,
4875 ogs.n_buckets * sizeof *ogs.bucket_stats);
4878 ogs.group_id = group->group_id;
4879 calc_duration(group->created, now, &ogs.duration_sec, &ogs.duration_nsec);
4881 ofputil_append_group_stats(replies, &ogs);
4883 free(ogs.bucket_stats);
4887 handle_group_stats_request(struct ofconn *ofconn,
4888 const struct ofp_header *request)
4890 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4891 struct list replies;
4893 struct ofgroup *group;
4896 error = ofputil_decode_group_stats_request(request, &group_id);
4901 ofpmp_init(&replies, request);
4903 if (group_id == OFPG_ALL) {
4904 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
4905 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
4906 ovs_rwlock_rdlock(&group->rwlock);
4907 append_group_stats(group, &replies);
4908 ovs_rwlock_unlock(&group->rwlock);
4910 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4912 if (ofproto_group_lookup(ofproto, group_id, &group)) {
4913 append_group_stats(group, &replies);
4914 ofproto_group_release(group);
4918 ofconn_send_replies(ofconn, &replies);
4924 handle_group_desc_stats_request(struct ofconn *ofconn,
4925 const struct ofp_header *request)
4927 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4928 struct list replies;
4929 struct ofputil_group_desc gds;
4930 struct ofgroup *group;
4932 ofpmp_init(&replies, request);
4934 ovs_rwlock_rdlock(&ofproto->groups_rwlock);
4935 HMAP_FOR_EACH (group, hmap_node, &ofproto->groups) {
4936 gds.group_id = group->group_id;
4937 gds.type = group->type;
4938 ofputil_append_group_desc_reply(&gds, &group->buckets, &replies);
4940 ovs_rwlock_unlock(&ofproto->groups_rwlock);
4942 ofconn_send_replies(ofconn, &replies);
4948 handle_group_features_stats_request(struct ofconn *ofconn,
4949 const struct ofp_header *request)
4951 struct ofproto *p = ofconn_get_ofproto(ofconn);
4954 msg = ofputil_encode_group_features_reply(&p->ogf, request);
4956 ofconn_send_reply(ofconn, msg);
4962 /* Implements OFPGC11_ADD
4963 * in which no matching flow already exists in the flow table.
4965 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4966 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4967 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4968 * initiated now but may be retried later.
4970 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
4971 * ownership remains with the caller.
4973 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4976 add_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
4978 struct ofgroup *ofgroup;
4981 if (gm->group_id > OFPG_MAX) {
4982 return OFPERR_OFPGMFC_INVALID_GROUP;
4984 if (gm->type > OFPGT11_FF) {
4985 return OFPERR_OFPGMFC_BAD_TYPE;
4988 /* Allocate new group and initialize it. */
4989 ofgroup = ofproto->ofproto_class->group_alloc();
4991 VLOG_WARN_RL(&rl, "%s: failed to create group", ofproto->name);
4992 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
4995 ovs_rwlock_init(&ofgroup->rwlock);
4996 ofgroup->ofproto = ofproto;
4997 ofgroup->group_id = gm->group_id;
4998 ofgroup->type = gm->type;
4999 ofgroup->created = ofgroup->modified = time_msec();
5001 list_move(&ofgroup->buckets, &gm->buckets);
5002 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5004 /* Construct called BEFORE any locks are held. */
5005 error = ofproto->ofproto_class->group_construct(ofgroup);
5010 /* We wrlock as late as possible to minimize the time we jam any other
5011 * threads: No visible state changes before acquiring the lock. */
5012 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5014 if (ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5015 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5019 if (ofproto_group_exists(ofproto, gm->group_id)) {
5020 error = OFPERR_OFPGMFC_GROUP_EXISTS;
5025 /* Insert new group. */
5026 hmap_insert(&ofproto->groups, &ofgroup->hmap_node,
5027 hash_int(ofgroup->group_id, 0));
5028 ofproto->n_groups[ofgroup->type]++;
5030 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5035 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5036 ofproto->ofproto_class->group_destruct(ofgroup);
5038 ofputil_bucket_list_destroy(&ofgroup->buckets);
5039 ofproto->ofproto_class->group_dealloc(ofgroup);
5044 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5047 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5050 modify_group(struct ofproto *ofproto, struct ofputil_group_mod *gm)
5052 struct ofgroup *ofgroup;
5053 struct ofgroup *victim;
5056 if (gm->group_id > OFPG_MAX) {
5057 return OFPERR_OFPGMFC_INVALID_GROUP;
5060 if (gm->type > OFPGT11_FF) {
5061 return OFPERR_OFPGMFC_BAD_TYPE;
5064 victim = ofproto->ofproto_class->group_alloc();
5066 VLOG_WARN_RL(&rl, "%s: failed to allocate group", ofproto->name);
5067 return OFPERR_OFPGMFC_OUT_OF_GROUPS;
5070 if (!ofproto_group_write_lookup(ofproto, gm->group_id, &ofgroup)) {
5071 error = OFPERR_OFPGMFC_UNKNOWN_GROUP;
5074 /* Both group's and its container's write locks held now.
5075 * Also, n_groups[] is protected by ofproto->groups_rwlock. */
5076 if (ofgroup->type != gm->type
5077 && ofproto->n_groups[gm->type] >= ofproto->ogf.max_groups[gm->type]) {
5078 error = OFPERR_OFPGMFC_OUT_OF_GROUPS;
5083 list_move(&victim->buckets, &ofgroup->buckets);
5085 ofgroup->type = gm->type;
5086 list_move(&ofgroup->buckets, &gm->buckets);
5087 ofgroup->n_buckets = list_size(&ofgroup->buckets);
5089 error = ofproto->ofproto_class->group_modify(ofgroup, victim);
5091 ofputil_bucket_list_destroy(&victim->buckets);
5092 ofproto->n_groups[victim->type]--;
5093 ofproto->n_groups[ofgroup->type]++;
5094 ofgroup->modified = time_msec();
5096 ofputil_bucket_list_destroy(&ofgroup->buckets);
5099 list_move(&ofgroup->buckets, &victim->buckets);
5103 ovs_rwlock_unlock(&ofgroup->rwlock);
5104 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5106 ofproto->ofproto_class->group_dealloc(victim);
5111 delete_group__(struct ofproto *ofproto, struct ofgroup *ofgroup)
5112 OVS_RELEASES(ofproto->groups_rwlock)
5114 /* Must wait until existing readers are done,
5115 * while holding the container's write lock at the same time. */
5116 ovs_rwlock_wrlock(&ofgroup->rwlock);
5117 hmap_remove(&ofproto->groups, &ofgroup->hmap_node);
5118 /* No-one can find this group any more. */
5119 ofproto->n_groups[ofgroup->type]--;
5120 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5122 ofproto->ofproto_class->group_destruct(ofgroup);
5123 ofputil_bucket_list_destroy(&ofgroup->buckets);
5124 ovs_rwlock_unlock(&ofgroup->rwlock);
5125 ovs_rwlock_destroy(&ofgroup->rwlock);
5126 ofproto->ofproto_class->group_dealloc(ofgroup);
5129 /* Implements OFPGC_DELETE. */
5131 delete_group(struct ofproto *ofproto, uint32_t group_id)
5133 struct ofgroup *ofgroup;
5135 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5136 if (group_id == OFPG_ALL) {
5138 struct hmap_node *node = hmap_first(&ofproto->groups);
5142 ofgroup = CONTAINER_OF(node, struct ofgroup, hmap_node);
5143 delete_group__(ofproto, ofgroup);
5144 /* Lock for each node separately, so that we will not jam the
5145 * other threads for too long time. */
5146 ovs_rwlock_wrlock(&ofproto->groups_rwlock);
5149 HMAP_FOR_EACH_IN_BUCKET (ofgroup, hmap_node,
5150 hash_int(group_id, 0), &ofproto->groups) {
5151 if (ofgroup->group_id == group_id) {
5152 delete_group__(ofproto, ofgroup);
5157 ovs_rwlock_unlock(&ofproto->groups_rwlock);
5161 handle_group_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5163 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5164 struct ofputil_group_mod gm;
5167 error = reject_slave_controller(ofconn);
5172 error = ofputil_decode_group_mod(oh, &gm);
5177 switch (gm.command) {
5179 return add_group(ofproto, &gm);
5181 case OFPGC11_MODIFY:
5182 return modify_group(ofproto, &gm);
5184 case OFPGC11_DELETE:
5185 delete_group(ofproto, gm.group_id);
5189 if (gm.command > OFPGC11_DELETE) {
5190 VLOG_WARN_RL(&rl, "%s: Invalid group_mod command type %d",
5191 ofproto->name, gm.command);
5193 return OFPERR_OFPGMFC_BAD_COMMAND;
5198 handle_table_mod(struct ofconn *ofconn, const struct ofp_header *oh)
5200 struct ofputil_table_mod tm;
5203 error = reject_slave_controller(ofconn);
5208 error = ofputil_decode_table_mod(oh, &tm);
5213 /* XXX Actual table mod support is not implemented yet. */
5218 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5220 const struct ofp_header *oh = msg->data;
5224 error = ofptype_decode(&type, oh);
5230 /* OpenFlow requests. */
5231 case OFPTYPE_ECHO_REQUEST:
5232 return handle_echo_request(ofconn, oh);
5234 case OFPTYPE_FEATURES_REQUEST:
5235 return handle_features_request(ofconn, oh);
5237 case OFPTYPE_GET_CONFIG_REQUEST:
5238 return handle_get_config_request(ofconn, oh);
5240 case OFPTYPE_SET_CONFIG:
5241 return handle_set_config(ofconn, oh);
5243 case OFPTYPE_PACKET_OUT:
5244 return handle_packet_out(ofconn, oh);
5246 case OFPTYPE_PORT_MOD:
5247 return handle_port_mod(ofconn, oh);
5249 case OFPTYPE_FLOW_MOD:
5250 return handle_flow_mod(ofconn, oh);
5252 case OFPTYPE_GROUP_MOD:
5253 return handle_group_mod(ofconn, oh);
5255 case OFPTYPE_TABLE_MOD:
5256 return handle_table_mod(ofconn, oh);
5258 case OFPTYPE_METER_MOD:
5259 return handle_meter_mod(ofconn, oh);
5261 case OFPTYPE_BARRIER_REQUEST:
5262 return handle_barrier_request(ofconn, oh);
5264 case OFPTYPE_ROLE_REQUEST:
5265 return handle_role_request(ofconn, oh);
5267 /* OpenFlow replies. */
5268 case OFPTYPE_ECHO_REPLY:
5271 /* Nicira extension requests. */
5272 case OFPTYPE_FLOW_MOD_TABLE_ID:
5273 return handle_nxt_flow_mod_table_id(ofconn, oh);
5275 case OFPTYPE_SET_FLOW_FORMAT:
5276 return handle_nxt_set_flow_format(ofconn, oh);
5278 case OFPTYPE_SET_PACKET_IN_FORMAT:
5279 return handle_nxt_set_packet_in_format(ofconn, oh);
5281 case OFPTYPE_SET_CONTROLLER_ID:
5282 return handle_nxt_set_controller_id(ofconn, oh);
5284 case OFPTYPE_FLOW_AGE:
5285 /* Nothing to do. */
5288 case OFPTYPE_FLOW_MONITOR_CANCEL:
5289 return handle_flow_monitor_cancel(ofconn, oh);
5291 case OFPTYPE_SET_ASYNC_CONFIG:
5292 return handle_nxt_set_async_config(ofconn, oh);
5294 case OFPTYPE_GET_ASYNC_REQUEST:
5295 return handle_nxt_get_async_request(ofconn, oh);
5297 /* Statistics requests. */
5298 case OFPTYPE_DESC_STATS_REQUEST:
5299 return handle_desc_stats_request(ofconn, oh);
5301 case OFPTYPE_FLOW_STATS_REQUEST:
5302 return handle_flow_stats_request(ofconn, oh);
5304 case OFPTYPE_AGGREGATE_STATS_REQUEST:
5305 return handle_aggregate_stats_request(ofconn, oh);
5307 case OFPTYPE_TABLE_STATS_REQUEST:
5308 return handle_table_stats_request(ofconn, oh);
5310 case OFPTYPE_PORT_STATS_REQUEST:
5311 return handle_port_stats_request(ofconn, oh);
5313 case OFPTYPE_QUEUE_STATS_REQUEST:
5314 return handle_queue_stats_request(ofconn, oh);
5316 case OFPTYPE_PORT_DESC_STATS_REQUEST:
5317 return handle_port_desc_stats_request(ofconn, oh);
5319 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5320 return handle_flow_monitor_request(ofconn, oh);
5322 case OFPTYPE_METER_STATS_REQUEST:
5323 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5324 return handle_meter_request(ofconn, oh, type);
5326 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5327 return handle_meter_features_request(ofconn, oh);
5329 case OFPTYPE_GROUP_STATS_REQUEST:
5330 return handle_group_stats_request(ofconn, oh);
5332 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5333 return handle_group_desc_stats_request(ofconn, oh);
5335 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5336 return handle_group_features_stats_request(ofconn, oh);
5338 /* FIXME: Change the following once they are implemented: */
5339 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
5340 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
5341 return OFPERR_OFPBRC_BAD_TYPE;
5345 case OFPTYPE_FEATURES_REPLY:
5346 case OFPTYPE_GET_CONFIG_REPLY:
5347 case OFPTYPE_PACKET_IN:
5348 case OFPTYPE_FLOW_REMOVED:
5349 case OFPTYPE_PORT_STATUS:
5350 case OFPTYPE_BARRIER_REPLY:
5351 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
5352 case OFPTYPE_DESC_STATS_REPLY:
5353 case OFPTYPE_FLOW_STATS_REPLY:
5354 case OFPTYPE_QUEUE_STATS_REPLY:
5355 case OFPTYPE_PORT_STATS_REPLY:
5356 case OFPTYPE_TABLE_STATS_REPLY:
5357 case OFPTYPE_AGGREGATE_STATS_REPLY:
5358 case OFPTYPE_PORT_DESC_STATS_REPLY:
5359 case OFPTYPE_ROLE_REPLY:
5360 case OFPTYPE_FLOW_MONITOR_PAUSED:
5361 case OFPTYPE_FLOW_MONITOR_RESUMED:
5362 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
5363 case OFPTYPE_GET_ASYNC_REPLY:
5364 case OFPTYPE_GROUP_STATS_REPLY:
5365 case OFPTYPE_GROUP_DESC_STATS_REPLY:
5366 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
5367 case OFPTYPE_METER_STATS_REPLY:
5368 case OFPTYPE_METER_CONFIG_STATS_REPLY:
5369 case OFPTYPE_METER_FEATURES_STATS_REPLY:
5370 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
5372 return OFPERR_OFPBRC_BAD_TYPE;
5377 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
5379 int error = handle_openflow__(ofconn, ofp_msg);
5380 if (error && error != OFPROTO_POSTPONE) {
5381 ofconn_send_error(ofconn, ofp_msg->data, error);
5383 COVERAGE_INC(ofproto_recv_openflow);
5384 return error != OFPROTO_POSTPONE;
5387 /* Asynchronous operations. */
5389 /* Creates and returns a new ofopgroup that is not associated with any
5390 * OpenFlow connection.
5392 * The caller should add operations to the returned group with
5393 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5394 static struct ofopgroup *
5395 ofopgroup_create_unattached(struct ofproto *ofproto)
5397 struct ofopgroup *group = xzalloc(sizeof *group);
5398 group->ofproto = ofproto;
5399 list_init(&group->ofproto_node);
5400 list_init(&group->ops);
5401 list_init(&group->ofconn_node);
5405 /* Creates and returns a new ofopgroup for 'ofproto'.
5407 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
5408 * connection. The 'request' and 'buffer_id' arguments are ignored.
5410 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
5411 * If the ofopgroup eventually fails, then the error reply will include
5412 * 'request'. If the ofopgroup eventually succeeds, then the packet with
5413 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
5415 * The caller should add operations to the returned group with
5416 * ofoperation_create() and then submit it with ofopgroup_submit(). */
5417 static struct ofopgroup *
5418 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
5419 const struct ofp_header *request, uint32_t buffer_id)
5421 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
5423 size_t request_len = ntohs(request->length);
5425 ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
5427 ofconn_add_opgroup(ofconn, &group->ofconn_node);
5428 group->ofconn = ofconn;
5429 group->request = xmemdup(request, MIN(request_len, 64));
5430 group->buffer_id = buffer_id;
5435 /* Submits 'group' for processing.
5437 * If 'group' contains no operations (e.g. none were ever added, or all of the
5438 * ones that were added completed synchronously), then it is destroyed
5439 * immediately. Otherwise it is added to the ofproto's list of pending
5442 ofopgroup_submit(struct ofopgroup *group)
5444 if (!group->n_running) {
5445 ofopgroup_complete(group);
5447 list_push_back(&group->ofproto->pending, &group->ofproto_node);
5448 group->ofproto->n_pending++;
5453 ofopgroup_complete(struct ofopgroup *group)
5455 struct ofproto *ofproto = group->ofproto;
5457 struct ofconn *abbrev_ofconn;
5458 ovs_be32 abbrev_xid;
5460 struct ofoperation *op, *next_op;
5463 ovs_assert(!group->n_running);
5466 LIST_FOR_EACH (op, group_node, &group->ops) {
5473 if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
5474 LIST_FOR_EACH (op, group_node, &group->ops) {
5475 if (op->type != OFOPERATION_DELETE) {
5476 struct ofpbuf *packet;
5479 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
5483 error = rule_execute(op->rule, in_port, packet);
5490 if (!error && !list_is_empty(&group->ofconn_node)) {
5491 abbrev_ofconn = group->ofconn;
5492 abbrev_xid = group->request->xid;
5494 abbrev_ofconn = NULL;
5495 abbrev_xid = htonl(0);
5497 LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
5498 struct rule *rule = op->rule;
5500 /* We generally want to report the change to active OpenFlow flow
5501 monitors (e.g. NXST_FLOW_MONITOR). There are three exceptions:
5503 - The operation failed.
5505 - The affected rule is not visible to controllers.
5507 - The operation's only effect was to update rule->modified. */
5509 || ofproto_rule_is_hidden(rule)
5510 || (op->type == OFOPERATION_MODIFY
5512 && rule->flow_cookie == op->flow_cookie))) {
5513 /* Check that we can just cast from ofoperation_type to
5514 * nx_flow_update_event. */
5515 enum nx_flow_update_event event_type;
5518 case OFOPERATION_ADD:
5519 case OFOPERATION_REPLACE:
5520 event_type = NXFME_ADDED;
5523 case OFOPERATION_DELETE:
5524 event_type = NXFME_DELETED;
5527 case OFOPERATION_MODIFY:
5528 event_type = NXFME_MODIFIED;
5535 ofmonitor_report(ofproto->connmgr, rule, event_type,
5536 op->reason, abbrev_ofconn, abbrev_xid);
5539 rule->pending = NULL;
5542 case OFOPERATION_ADD:
5546 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
5547 if (vid_mask == VLAN_VID_MASK) {
5548 if (ofproto->vlan_bitmap) {
5549 uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
5550 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
5551 bitmap_set1(ofproto->vlan_bitmap, vid);
5552 ofproto->vlans_changed = true;
5555 ofproto->vlans_changed = true;
5559 ovs_rwlock_wrlock(&rule->rwlock);
5560 oftable_remove_rule(rule);
5561 ofproto_rule_destroy(rule);
5565 case OFOPERATION_DELETE:
5566 ovs_assert(!op->error);
5567 ofproto_rule_destroy(rule);
5571 case OFOPERATION_MODIFY:
5572 case OFOPERATION_REPLACE:
5574 long long int now = time_msec();
5576 rule->modified = now;
5577 if (op->type == OFOPERATION_REPLACE) {
5578 rule->created = rule->used = now;
5581 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
5582 ovs_mutex_lock(&rule->timeout_mutex);
5583 rule->idle_timeout = op->idle_timeout;
5584 rule->hard_timeout = op->hard_timeout;
5585 ovs_mutex_unlock(&rule->timeout_mutex);
5587 free(rule->ofpacts);
5589 ovs_rwlock_wrlock(&rule->rwlock);
5590 rule->ofpacts = op->ofpacts;
5591 rule->ofpacts_len = op->ofpacts_len;
5592 ovs_rwlock_unlock(&rule->rwlock);
5595 op->ofpacts_len = 0;
5597 rule->flags = op->flags;
5605 ofoperation_destroy(op);
5608 ofmonitor_flush(ofproto->connmgr);
5610 if (!list_is_empty(&group->ofproto_node)) {
5611 ovs_assert(ofproto->n_pending > 0);
5612 ofproto->n_pending--;
5613 list_remove(&group->ofproto_node);
5615 if (!list_is_empty(&group->ofconn_node)) {
5616 list_remove(&group->ofconn_node);
5618 ofconn_send_error(group->ofconn, group->request, error);
5620 connmgr_retry(ofproto->connmgr);
5622 free(group->request);
5626 /* Initiates a new operation on 'rule', of the specified 'type', within
5627 * 'group'. Prior to calling, 'rule' must not have any pending operation.
5629 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
5630 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
5632 * Returns the newly created ofoperation (which is also available as
5633 * rule->pending). */
5634 static struct ofoperation *
5635 ofoperation_create(struct ofopgroup *group, struct rule *rule,
5636 enum ofoperation_type type,
5637 enum ofp_flow_removed_reason reason)
5639 struct ofproto *ofproto = group->ofproto;
5640 struct ofoperation *op;
5642 ovs_assert(!rule->pending);
5644 op = rule->pending = xzalloc(sizeof *op);
5646 list_push_back(&group->ops, &op->group_node);
5649 op->reason = reason;
5650 op->flow_cookie = rule->flow_cookie;
5651 ovs_mutex_lock(&rule->timeout_mutex);
5652 op->idle_timeout = rule->idle_timeout;
5653 op->hard_timeout = rule->hard_timeout;
5654 ovs_mutex_unlock(&rule->timeout_mutex);
5655 op->flags = rule->flags;
5659 if (type == OFOPERATION_DELETE) {
5660 hmap_insert(&ofproto->deletions, &op->hmap_node,
5661 cls_rule_hash(&rule->cr, rule->table_id));
5668 ofoperation_destroy(struct ofoperation *op)
5670 struct ofopgroup *group = op->group;
5673 op->rule->pending = NULL;
5675 if (op->type == OFOPERATION_DELETE) {
5676 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
5678 list_remove(&op->group_node);
5683 /* Indicates that 'op' completed with status 'error', which is either 0 to
5684 * indicate success or an OpenFlow error code on failure.
5686 * If 'error' is 0, indicating success, the operation will be committed
5687 * permanently to the flow table.
5689 * If 'error' is nonzero, then generally the operation will be rolled back:
5691 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
5692 * restores the original rule. The caller must have uninitialized any
5693 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
5694 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
5695 * and 7 for the new rule, calling its ->rule_dealloc() function.
5697 * - If 'op' is a "modify flow" operation, ofproto restores the original
5700 * - 'op' must not be a "delete flow" operation. Removing a rule is not
5701 * allowed to fail. It must always succeed.
5703 * Please see the large comment in ofproto/ofproto-provider.h titled
5704 * "Asynchronous Operation Support" for more information. */
5706 ofoperation_complete(struct ofoperation *op, enum ofperr error)
5708 struct ofopgroup *group = op->group;
5710 ovs_assert(op->rule->pending == op);
5711 ovs_assert(group->n_running > 0);
5712 ovs_assert(!error || op->type != OFOPERATION_DELETE);
5715 if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
5716 ofopgroup_complete(group);
5721 pick_datapath_id(const struct ofproto *ofproto)
5723 const struct ofport *port;
5725 port = ofproto_get_port(ofproto, OFPP_LOCAL);
5727 uint8_t ea[ETH_ADDR_LEN];
5730 error = netdev_get_etheraddr(port->netdev, ea);
5732 return eth_addr_to_uint64(ea);
5734 VLOG_WARN("%s: could not get MAC address for %s (%s)",
5735 ofproto->name, netdev_get_name(port->netdev),
5736 ovs_strerror(error));
5738 return ofproto->fallback_dpid;
5742 pick_fallback_dpid(void)
5744 uint8_t ea[ETH_ADDR_LEN];
5745 eth_addr_nicira_random(ea);
5746 return eth_addr_to_uint64(ea);
5749 /* Table overflow policy. */
5751 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
5752 * to NULL if the table is not configured to evict rules or if the table
5753 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
5754 * or with no timeouts are not evictable.) */
5756 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
5758 struct eviction_group *evg;
5761 if (!table->eviction_fields) {
5765 /* In the common case, the outer and inner loops here will each be entered
5768 * - The inner loop normally "return"s in its first iteration. If the
5769 * eviction group has any evictable rules, then it always returns in
5772 * - The outer loop only iterates more than once if the largest eviction
5773 * group has no evictable rules.
5775 * - The outer loop can exit only if table's 'max_flows' is all filled up
5776 * by unevictable rules. */
5777 HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
5780 HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
5781 if (!ovs_rwlock_trywrlock(&rule->rwlock)) {
5791 /* Searches 'ofproto' for tables that have more flows than their configured
5792 * maximum and that have flow eviction enabled, and evicts as many flows as
5793 * necessary and currently feasible from them.
5795 * This triggers only when an OpenFlow table has N flows in it and then the
5796 * client configures a maximum number of flows less than N. */
5798 ofproto_evict(struct ofproto *ofproto)
5800 struct ofopgroup *group;
5801 struct oftable *table;
5803 group = ofopgroup_create_unattached(ofproto);
5804 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
5805 while (table->eviction_fields) {
5809 ovs_rwlock_rdlock(&table->cls.rwlock);
5810 n_rules = classifier_count(&table->cls);
5811 ovs_rwlock_unlock(&table->cls.rwlock);
5813 if (n_rules <= table->max_flows) {
5817 if (!choose_rule_to_evict(table, &rule)) {
5821 if (rule->pending) {
5822 ovs_rwlock_unlock(&rule->rwlock);
5826 ofoperation_create(group, rule,
5827 OFOPERATION_DELETE, OFPRR_EVICTION);
5828 oftable_remove_rule(rule);
5829 ofproto->ofproto_class->rule_delete(rule);
5832 ofopgroup_submit(group);
5835 /* Eviction groups. */
5837 /* Returns the priority to use for an eviction_group that contains 'n_rules'
5838 * rules. The priority contains low-order random bits to ensure that eviction
5839 * groups with the same number of rules are prioritized randomly. */
5841 eviction_group_priority(size_t n_rules)
5843 uint16_t size = MIN(UINT16_MAX, n_rules);
5844 return (size << 16) | random_uint16();
5847 /* Updates 'evg', an eviction_group within 'table', following a change that
5848 * adds or removes rules in 'evg'. */
5850 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
5852 heap_change(&table->eviction_groups_by_size, &evg->size_node,
5853 eviction_group_priority(heap_count(&evg->rules)));
5856 /* Destroys 'evg', an eviction_group within 'table':
5858 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
5859 * rules themselves, just removes them from the eviction group.)
5861 * - Removes 'evg' from 'table'.
5865 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
5867 while (!heap_is_empty(&evg->rules)) {
5870 rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
5871 rule->eviction_group = NULL;
5873 hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
5874 heap_remove(&table->eviction_groups_by_size, &evg->size_node);
5875 heap_destroy(&evg->rules);
5879 /* Removes 'rule' from its eviction group, if any. */
5881 eviction_group_remove_rule(struct rule *rule)
5883 if (rule->eviction_group) {
5884 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5885 struct eviction_group *evg = rule->eviction_group;
5887 rule->eviction_group = NULL;
5888 heap_remove(&evg->rules, &rule->evg_node);
5889 if (heap_is_empty(&evg->rules)) {
5890 eviction_group_destroy(table, evg);
5892 eviction_group_resized(table, evg);
5897 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
5898 * returns the hash value. */
5900 eviction_group_hash_rule(struct rule *rule)
5902 struct oftable *table = &rule->ofproto->tables[rule->table_id];
5903 const struct mf_subfield *sf;
5907 hash = table->eviction_group_id_basis;
5908 miniflow_expand(&rule->cr.match.flow, &flow);
5909 for (sf = table->eviction_fields;
5910 sf < &table->eviction_fields[table->n_eviction_fields];
5913 if (mf_are_prereqs_ok(sf->field, &flow)) {
5914 union mf_value value;
5916 mf_get_value(sf->field, &flow, &value);
5918 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
5920 if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
5921 unsigned int start = sf->ofs + sf->n_bits;
5922 bitwise_zero(&value, sf->field->n_bytes, start,
5923 sf->field->n_bytes * 8 - start);
5925 hash = hash_bytes(&value, sf->field->n_bytes, hash);
5927 hash = hash_int(hash, 0);
5934 /* Returns an eviction group within 'table' with the given 'id', creating one
5936 static struct eviction_group *
5937 eviction_group_find(struct oftable *table, uint32_t id)
5939 struct eviction_group *evg;
5941 HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
5945 evg = xmalloc(sizeof *evg);
5946 hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
5947 heap_insert(&table->eviction_groups_by_size, &evg->size_node,
5948 eviction_group_priority(0));
5949 heap_init(&evg->rules);
5954 /* Returns an eviction priority for 'rule'. The return value should be
5955 * interpreted so that higher priorities make a rule more attractive candidates
5958 rule_eviction_priority(struct rule *rule)
5960 long long int hard_expiration;
5961 long long int idle_expiration;
5962 long long int expiration;
5963 uint32_t expiration_offset;
5965 /* Calculate time of expiration. */
5966 ovs_mutex_lock(&rule->timeout_mutex);
5967 hard_expiration = (rule->hard_timeout
5968 ? rule->modified + rule->hard_timeout * 1000
5970 idle_expiration = (rule->idle_timeout
5971 ? rule->used + rule->idle_timeout * 1000
5973 expiration = MIN(hard_expiration, idle_expiration);
5974 ovs_mutex_unlock(&rule->timeout_mutex);
5975 if (expiration == LLONG_MAX) {
5979 /* Calculate the time of expiration as a number of (approximate) seconds
5980 * after program startup.
5982 * This should work OK for program runs that last UINT32_MAX seconds or
5983 * less. Therefore, please restart OVS at least once every 136 years. */
5984 expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
5986 /* Invert the expiration offset because we're using a max-heap. */
5987 return UINT32_MAX - expiration_offset;
5990 /* Adds 'rule' to an appropriate eviction group for its oftable's
5991 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
5992 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
5995 * The caller must ensure that 'rule' is not already in an eviction group. */
5997 eviction_group_add_rule(struct rule *rule)
5999 struct ofproto *ofproto = rule->ofproto;
6000 struct oftable *table = &ofproto->tables[rule->table_id];
6003 ovs_mutex_lock(&rule->timeout_mutex);
6004 has_timeout = rule->hard_timeout || rule->idle_timeout;
6005 ovs_mutex_unlock(&rule->timeout_mutex);
6007 if (table->eviction_fields && has_timeout) {
6008 struct eviction_group *evg;
6010 evg = eviction_group_find(table, eviction_group_hash_rule(rule));
6012 rule->eviction_group = evg;
6013 heap_insert(&evg->rules, &rule->evg_node,
6014 rule_eviction_priority(rule));
6015 eviction_group_resized(table, evg);
6021 /* Initializes 'table'. */
6023 oftable_init(struct oftable *table)
6025 memset(table, 0, sizeof *table);
6026 classifier_init(&table->cls);
6027 table->max_flows = UINT_MAX;
6030 /* Destroys 'table', including its classifier and eviction groups.
6032 * The caller is responsible for freeing 'table' itself. */
6034 oftable_destroy(struct oftable *table)
6036 ovs_rwlock_rdlock(&table->cls.rwlock);
6037 ovs_assert(classifier_is_empty(&table->cls));
6038 ovs_rwlock_unlock(&table->cls.rwlock);
6039 oftable_disable_eviction(table);
6040 classifier_destroy(&table->cls);
6044 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6045 * string, then 'table' will use its default name.
6047 * This only affects the name exposed for a table exposed through the OpenFlow
6048 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6050 oftable_set_name(struct oftable *table, const char *name)
6052 if (name && name[0]) {
6053 int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
6054 if (!table->name || strncmp(name, table->name, len)) {
6056 table->name = xmemdup0(name, len);
6064 /* oftables support a choice of two policies when adding a rule would cause the
6065 * number of flows in the table to exceed the configured maximum number: either
6066 * they can refuse to add the new flow or they can evict some existing flow.
6067 * This function configures the former policy on 'table'. */
6069 oftable_disable_eviction(struct oftable *table)
6071 if (table->eviction_fields) {
6072 struct eviction_group *evg, *next;
6074 HMAP_FOR_EACH_SAFE (evg, next, id_node,
6075 &table->eviction_groups_by_id) {
6076 eviction_group_destroy(table, evg);
6078 hmap_destroy(&table->eviction_groups_by_id);
6079 heap_destroy(&table->eviction_groups_by_size);
6081 free(table->eviction_fields);
6082 table->eviction_fields = NULL;
6083 table->n_eviction_fields = 0;
6087 /* oftables support a choice of two policies when adding a rule would cause the
6088 * number of flows in the table to exceed the configured maximum number: either
6089 * they can refuse to add the new flow or they can evict some existing flow.
6090 * This function configures the latter policy on 'table', with fairness based
6091 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6092 * 'n_fields' as 0 disables fairness.) */
6094 oftable_enable_eviction(struct oftable *table,
6095 const struct mf_subfield *fields, size_t n_fields)
6097 struct cls_cursor cursor;
6100 if (table->eviction_fields
6101 && n_fields == table->n_eviction_fields
6103 || !memcmp(fields, table->eviction_fields,
6104 n_fields * sizeof *fields))) {
6109 oftable_disable_eviction(table);
6111 table->n_eviction_fields = n_fields;
6112 table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6114 table->eviction_group_id_basis = random_uint32();
6115 hmap_init(&table->eviction_groups_by_id);
6116 heap_init(&table->eviction_groups_by_size);
6118 ovs_rwlock_rdlock(&table->cls.rwlock);
6119 cls_cursor_init(&cursor, &table->cls, NULL);
6120 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6121 eviction_group_add_rule(rule);
6123 ovs_rwlock_unlock(&table->cls.rwlock);
6126 /* Removes 'rule' from the oftable that contains it. */
6128 oftable_remove_rule__(struct ofproto *ofproto, struct classifier *cls,
6130 OVS_REQ_WRLOCK(cls->rwlock) OVS_RELEASES(rule->rwlock)
6132 classifier_remove(cls, &rule->cr);
6133 cookies_remove(ofproto, rule);
6134 eviction_group_remove_rule(rule);
6135 ovs_mutex_lock(&ofproto->expirable_mutex);
6136 if (!list_is_empty(&rule->expirable)) {
6137 list_remove(&rule->expirable);
6139 ovs_mutex_unlock(&ofproto->expirable_mutex);
6140 if (!list_is_empty(&rule->meter_list_node)) {
6141 list_remove(&rule->meter_list_node);
6142 list_init(&rule->meter_list_node);
6144 ovs_rwlock_unlock(&rule->rwlock);
6148 oftable_remove_rule(struct rule *rule)
6150 struct ofproto *ofproto = rule->ofproto;
6151 struct oftable *table = &ofproto->tables[rule->table_id];
6153 ovs_rwlock_wrlock(&table->cls.rwlock);
6154 oftable_remove_rule__(ofproto, &table->cls, rule);
6155 ovs_rwlock_unlock(&table->cls.rwlock);
6158 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6159 * the same cls_rule. */
6161 oftable_insert_rule(struct rule *rule)
6163 struct ofproto *ofproto = rule->ofproto;
6164 struct oftable *table = &ofproto->tables[rule->table_id];
6167 ovs_mutex_lock(&rule->timeout_mutex);
6168 may_expire = rule->hard_timeout || rule->idle_timeout;
6169 ovs_mutex_unlock(&rule->timeout_mutex);
6172 ovs_mutex_lock(&ofproto->expirable_mutex);
6173 list_insert(&ofproto->expirable, &rule->expirable);
6174 ovs_mutex_unlock(&ofproto->expirable_mutex);
6176 cookies_insert(ofproto, rule);
6177 if (rule->meter_id) {
6178 struct meter *meter = ofproto->meters[rule->meter_id];
6179 list_insert(&meter->rules, &rule->meter_list_node);
6181 ovs_rwlock_wrlock(&table->cls.rwlock);
6182 classifier_insert(&table->cls, &rule->cr);
6183 ovs_rwlock_unlock(&table->cls.rwlock);
6184 eviction_group_add_rule(rule);
6187 /* unixctl commands. */
6190 ofproto_lookup(const char *name)
6192 struct ofproto *ofproto;
6194 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6196 if (!strcmp(ofproto->name, name)) {
6204 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6205 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6207 struct ofproto *ofproto;
6211 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6212 ds_put_format(&results, "%s\n", ofproto->name);
6214 unixctl_command_reply(conn, ds_cstr(&results));
6215 ds_destroy(&results);
6219 ofproto_unixctl_init(void)
6221 static bool registered;
6227 unixctl_command_register("ofproto/list", "", 0, 0,
6228 ofproto_unixctl_list, NULL);
6231 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6233 * This is deprecated. It is only for compatibility with broken device drivers
6234 * in old versions of Linux that do not properly support VLANs when VLAN
6235 * devices are not used. When broken device drivers are no longer in
6236 * widespread use, we will delete these interfaces. */
6238 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6239 * (exactly) by an OpenFlow rule in 'ofproto'. */
6241 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6243 const struct oftable *oftable;
6245 free(ofproto->vlan_bitmap);
6246 ofproto->vlan_bitmap = bitmap_allocate(4096);
6247 ofproto->vlans_changed = false;
6249 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6250 const struct cls_table *table;
6252 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
6253 if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6254 const struct cls_rule *rule;
6256 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6257 uint16_t vid = miniflow_get_vid(&rule->match.flow);
6258 bitmap_set1(vlan_bitmap, vid);
6259 bitmap_set1(ofproto->vlan_bitmap, vid);
6266 /* Returns true if new VLANs have come into use by the flow table since the
6267 * last call to ofproto_get_vlan_usage().
6269 * We don't track when old VLANs stop being used. */
6271 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6273 return ofproto->vlans_changed;
6276 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6277 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6278 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6279 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6280 * then the VLAN device is un-enslaved. */
6282 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6283 ofp_port_t realdev_ofp_port, int vid)
6285 struct ofport *ofport;
6288 ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6290 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6292 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6293 ofproto->name, vlandev_ofp_port);
6297 if (!ofproto->ofproto_class->set_realdev) {
6298 if (!vlandev_ofp_port) {
6301 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6305 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6307 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6308 ofproto->name, vlandev_ofp_port,
6309 netdev_get_name(ofport->netdev), ovs_strerror(error));