ofproto: Fix internal port mtu setting.
[openvswitch] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
3  * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
4  *
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:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #include <config.h>
19 #include "ofproto.h"
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <stdbool.h>
23 #include <stdlib.h>
24 #include "bitmap.h"
25 #include "byte-order.h"
26 #include "classifier.h"
27 #include "connmgr.h"
28 #include "coverage.h"
29 #include "dynamic-string.h"
30 #include "hash.h"
31 #include "hmap.h"
32 #include "meta-flow.h"
33 #include "netdev.h"
34 #include "nx-match.h"
35 #include "ofp-errors.h"
36 #include "ofp-print.h"
37 #include "ofp-util.h"
38 #include "ofpbuf.h"
39 #include "ofproto-provider.h"
40 #include "openflow/nicira-ext.h"
41 #include "openflow/openflow.h"
42 #include "packets.h"
43 #include "pinsched.h"
44 #include "pktbuf.h"
45 #include "poll-loop.h"
46 #include "random.h"
47 #include "shash.h"
48 #include "sset.h"
49 #include "timeval.h"
50 #include "unaligned.h"
51 #include "unixctl.h"
52 #include "vlog.h"
53
54 VLOG_DEFINE_THIS_MODULE(ofproto);
55
56 COVERAGE_DEFINE(ofproto_error);
57 COVERAGE_DEFINE(ofproto_flush);
58 COVERAGE_DEFINE(ofproto_no_packet_in);
59 COVERAGE_DEFINE(ofproto_packet_out);
60 COVERAGE_DEFINE(ofproto_queue_req);
61 COVERAGE_DEFINE(ofproto_recv_openflow);
62 COVERAGE_DEFINE(ofproto_reinit_ports);
63 COVERAGE_DEFINE(ofproto_uninstallable);
64 COVERAGE_DEFINE(ofproto_update_port);
65
66 enum ofproto_state {
67     S_OPENFLOW,                 /* Processing OpenFlow commands. */
68     S_EVICT,                    /* Evicting flows from over-limit tables. */
69     S_FLUSH,                    /* Deleting all flow table rules. */
70 };
71
72 enum ofoperation_type {
73     OFOPERATION_ADD,
74     OFOPERATION_DELETE,
75     OFOPERATION_MODIFY
76 };
77
78 /* A single OpenFlow request can execute any number of operations.  The
79  * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
80  * ofconn to which an error reply should be sent if necessary.
81  *
82  * ofproto initiates some operations internally.  These operations are still
83  * assigned to groups but will not have an associated ofconn. */
84 struct ofopgroup {
85     struct ofproto *ofproto;    /* Owning ofproto. */
86     struct list ofproto_node;   /* In ofproto's "pending" list. */
87     struct list ops;            /* List of "struct ofoperation"s. */
88
89     /* Data needed to send OpenFlow reply on failure or to send a buffered
90      * packet on success.
91      *
92      * If list_is_empty(ofconn_node) then this ofopgroup never had an
93      * associated ofconn or its ofconn's connection dropped after it initiated
94      * the operation.  In the latter case 'ofconn' is a wild pointer that
95      * refers to freed memory, so the 'ofconn' member must be used only if
96      * !list_is_empty(ofconn_node).
97      */
98     struct list ofconn_node;    /* In ofconn's list of pending opgroups. */
99     struct ofconn *ofconn;      /* ofconn for reply (but see note above). */
100     struct ofp_header *request; /* Original request (truncated at 64 bytes). */
101     uint32_t buffer_id;         /* Buffer id from original request. */
102     int error;                  /* 0 if no error yet, otherwise error code. */
103 };
104
105 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
106 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
107                                           const struct ofp_header *,
108                                           uint32_t buffer_id);
109 static void ofopgroup_submit(struct ofopgroup *);
110 static void ofopgroup_destroy(struct ofopgroup *);
111
112 /* A single flow table operation. */
113 struct ofoperation {
114     struct ofopgroup *group;    /* Owning group. */
115     struct list group_node;     /* In ofopgroup's "ops" list. */
116     struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
117     struct rule *rule;          /* Rule being operated upon. */
118     enum ofoperation_type type; /* Type of operation. */
119     int status;                 /* -1 if pending, otherwise 0 or error code. */
120     struct rule *victim;        /* OFOPERATION_ADDING: Replaced rule. */
121     union ofp_action *actions;  /* OFOPERATION_MODIFYING: Replaced actions. */
122     int n_actions;              /* OFOPERATION_MODIFYING: # of old actions. */
123     ovs_be64 flow_cookie;       /* Rule's old flow cookie. */
124 };
125
126 static void ofoperation_create(struct ofopgroup *, struct rule *,
127                                enum ofoperation_type);
128 static void ofoperation_destroy(struct ofoperation *);
129
130 /* oftable. */
131 static void oftable_init(struct oftable *);
132 static void oftable_destroy(struct oftable *);
133
134 static void oftable_set_name(struct oftable *, const char *name);
135
136 static void oftable_disable_eviction(struct oftable *);
137 static void oftable_enable_eviction(struct oftable *,
138                                     const struct mf_subfield *fields,
139                                     size_t n_fields);
140
141 static void oftable_remove_rule(struct rule *);
142 static struct rule *oftable_replace_rule(struct rule *);
143 static void oftable_substitute_rule(struct rule *old, struct rule *new);
144
145 /* A set of rules within a single OpenFlow table (oftable) that have the same
146  * values for the oftable's eviction_fields.  A rule to be evicted, when one is
147  * needed, is taken from the eviction group that contains the greatest number
148  * of rules.
149  *
150  * An oftable owns any number of eviction groups, each of which contains any
151  * number of rules.
152  *
153  * Membership in an eviction group is imprecise, based on the hash of the
154  * oftable's eviction_fields (in the eviction_group's id_node.hash member).
155  * That is, if two rules have different eviction_fields, but those
156  * eviction_fields hash to the same value, then they will belong to the same
157  * eviction_group anyway.
158  *
159  * (When eviction is not enabled on an oftable, we don't track any eviction
160  * groups, to save time and space.) */
161 struct eviction_group {
162     struct hmap_node id_node;   /* In oftable's "eviction_groups_by_id". */
163     struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
164     struct heap rules;          /* Contains "struct rule"s. */
165 };
166
167 static struct rule *choose_rule_to_evict(struct oftable *);
168 static void ofproto_evict(struct ofproto *);
169 static uint32_t rule_eviction_priority(struct rule *);
170
171 /* ofport. */
172 static void ofport_destroy__(struct ofport *);
173 static void ofport_destroy(struct ofport *);
174
175 static void update_port(struct ofproto *, const char *devname);
176 static int init_ports(struct ofproto *);
177 static void reinit_ports(struct ofproto *);
178
179 /* rule. */
180 static void ofproto_rule_destroy__(struct rule *);
181 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
182 static bool rule_is_modifiable(const struct rule *);
183 static bool rule_is_hidden(const struct rule *);
184
185 /* OpenFlow. */
186 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
187                             const struct ofputil_flow_mod *,
188                             const struct ofp_header *);
189 static void delete_flow__(struct rule *, struct ofopgroup *);
190 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
191 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
192                                      const struct ofputil_flow_mod *,
193                                      const struct ofp_header *);
194
195 /* ofproto. */
196 static uint64_t pick_datapath_id(const struct ofproto *);
197 static uint64_t pick_fallback_dpid(void);
198 static void ofproto_destroy__(struct ofproto *);
199 static void set_internal_devs_mtu(struct ofproto *);
200
201 /* unixctl. */
202 static void ofproto_unixctl_init(void);
203
204 /* All registered ofproto classes, in probe order. */
205 static const struct ofproto_class **ofproto_classes;
206 static size_t n_ofproto_classes;
207 static size_t allocated_ofproto_classes;
208
209 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
210 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
211
212 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
213
214 static void
215 ofproto_initialize(void)
216 {
217     static bool inited;
218
219     if (!inited) {
220         inited = true;
221         ofproto_class_register(&ofproto_dpif_class);
222     }
223 }
224
225 /* 'type' should be a normalized datapath type, as returned by
226  * ofproto_normalize_type().  Returns the corresponding ofproto_class
227  * structure, or a null pointer if there is none registered for 'type'. */
228 static const struct ofproto_class *
229 ofproto_class_find__(const char *type)
230 {
231     size_t i;
232
233     ofproto_initialize();
234     for (i = 0; i < n_ofproto_classes; i++) {
235         const struct ofproto_class *class = ofproto_classes[i];
236         struct sset types;
237         bool found;
238
239         sset_init(&types);
240         class->enumerate_types(&types);
241         found = sset_contains(&types, type);
242         sset_destroy(&types);
243
244         if (found) {
245             return class;
246         }
247     }
248     VLOG_WARN("unknown datapath type %s", type);
249     return NULL;
250 }
251
252 /* Registers a new ofproto class.  After successful registration, new ofprotos
253  * of that type can be created using ofproto_create(). */
254 int
255 ofproto_class_register(const struct ofproto_class *new_class)
256 {
257     size_t i;
258
259     for (i = 0; i < n_ofproto_classes; i++) {
260         if (ofproto_classes[i] == new_class) {
261             return EEXIST;
262         }
263     }
264
265     if (n_ofproto_classes >= allocated_ofproto_classes) {
266         ofproto_classes = x2nrealloc(ofproto_classes,
267                                      &allocated_ofproto_classes,
268                                      sizeof *ofproto_classes);
269     }
270     ofproto_classes[n_ofproto_classes++] = new_class;
271     return 0;
272 }
273
274 /* Unregisters a datapath provider.  'type' must have been previously
275  * registered and not currently be in use by any ofprotos.  After
276  * unregistration new datapaths of that type cannot be opened using
277  * ofproto_create(). */
278 int
279 ofproto_class_unregister(const struct ofproto_class *class)
280 {
281     size_t i;
282
283     for (i = 0; i < n_ofproto_classes; i++) {
284         if (ofproto_classes[i] == class) {
285             for (i++; i < n_ofproto_classes; i++) {
286                 ofproto_classes[i - 1] = ofproto_classes[i];
287             }
288             n_ofproto_classes--;
289             return 0;
290         }
291     }
292     VLOG_WARN("attempted to unregister an ofproto class that is not "
293               "registered");
294     return EAFNOSUPPORT;
295 }
296
297 /* Clears 'types' and enumerates all registered ofproto types into it.  The
298  * caller must first initialize the sset. */
299 void
300 ofproto_enumerate_types(struct sset *types)
301 {
302     size_t i;
303
304     ofproto_initialize();
305     for (i = 0; i < n_ofproto_classes; i++) {
306         ofproto_classes[i]->enumerate_types(types);
307     }
308 }
309
310 /* Returns the fully spelled out name for the given ofproto 'type'.
311  *
312  * Normalized type string can be compared with strcmp().  Unnormalized type
313  * string might be the same even if they have different spellings. */
314 const char *
315 ofproto_normalize_type(const char *type)
316 {
317     return type && type[0] ? type : "system";
318 }
319
320 /* Clears 'names' and enumerates the names of all known created ofprotos with
321  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
322  * successful, otherwise a positive errno value.
323  *
324  * Some kinds of datapaths might not be practically enumerable.  This is not
325  * considered an error. */
326 int
327 ofproto_enumerate_names(const char *type, struct sset *names)
328 {
329     const struct ofproto_class *class = ofproto_class_find__(type);
330     return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
331  }
332
333 int
334 ofproto_create(const char *datapath_name, const char *datapath_type,
335                struct ofproto **ofprotop)
336 {
337     const struct ofproto_class *class;
338     struct ofproto *ofproto;
339     int error;
340
341     *ofprotop = NULL;
342
343     ofproto_initialize();
344     ofproto_unixctl_init();
345
346     datapath_type = ofproto_normalize_type(datapath_type);
347     class = ofproto_class_find__(datapath_type);
348     if (!class) {
349         VLOG_WARN("could not create datapath %s of unknown type %s",
350                   datapath_name, datapath_type);
351         return EAFNOSUPPORT;
352     }
353
354     ofproto = class->alloc();
355     if (!ofproto) {
356         VLOG_ERR("failed to allocate datapath %s of type %s",
357                  datapath_name, datapath_type);
358         return ENOMEM;
359     }
360
361     /* Initialize. */
362     memset(ofproto, 0, sizeof *ofproto);
363     ofproto->ofproto_class = class;
364     ofproto->name = xstrdup(datapath_name);
365     ofproto->type = xstrdup(datapath_type);
366     hmap_insert(&all_ofprotos, &ofproto->hmap_node,
367                 hash_string(ofproto->name, 0));
368     ofproto->datapath_id = 0;
369     ofproto_set_flow_eviction_threshold(ofproto,
370                                         OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
371     ofproto->forward_bpdu = false;
372     ofproto->fallback_dpid = pick_fallback_dpid();
373     ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
374     ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
375     ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
376     ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
377     ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
378     ofproto->frag_handling = OFPC_FRAG_NORMAL;
379     hmap_init(&ofproto->ports);
380     shash_init(&ofproto->port_by_name);
381     ofproto->tables = NULL;
382     ofproto->n_tables = 0;
383     ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
384     ofproto->state = S_OPENFLOW;
385     list_init(&ofproto->pending);
386     ofproto->n_pending = 0;
387     hmap_init(&ofproto->deletions);
388     ofproto->vlan_bitmap = NULL;
389     ofproto->vlans_changed = false;
390
391     error = ofproto->ofproto_class->construct(ofproto);
392     if (error) {
393         VLOG_ERR("failed to open datapath %s: %s",
394                  datapath_name, strerror(error));
395         ofproto_destroy__(ofproto);
396         return error;
397     }
398
399     assert(ofproto->n_tables);
400
401     ofproto->datapath_id = pick_datapath_id(ofproto);
402     VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
403     init_ports(ofproto);
404
405     *ofprotop = ofproto;
406     return 0;
407 }
408
409 void
410 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
411 {
412     struct oftable *table;
413
414     assert(!ofproto->n_tables);
415     assert(n_tables >= 1 && n_tables <= 255);
416
417     ofproto->n_tables = n_tables;
418     ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
419     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
420         oftable_init(table);
421     }
422 }
423
424 void
425 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
426 {
427     uint64_t old_dpid = p->datapath_id;
428     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
429     if (p->datapath_id != old_dpid) {
430         VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
431
432         /* Force all active connections to reconnect, since there is no way to
433          * notify a controller that the datapath ID has changed. */
434         ofproto_reconnect_controllers(p);
435     }
436 }
437
438 void
439 ofproto_set_controllers(struct ofproto *p,
440                         const struct ofproto_controller *controllers,
441                         size_t n_controllers)
442 {
443     connmgr_set_controllers(p->connmgr, controllers, n_controllers);
444 }
445
446 void
447 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
448 {
449     connmgr_set_fail_mode(p->connmgr, fail_mode);
450 }
451
452 /* Drops the connections between 'ofproto' and all of its controllers, forcing
453  * them to reconnect. */
454 void
455 ofproto_reconnect_controllers(struct ofproto *ofproto)
456 {
457     connmgr_reconnect(ofproto->connmgr);
458 }
459
460 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
461  * in-band control should guarantee access, in the same way that in-band
462  * control guarantees access to OpenFlow controllers. */
463 void
464 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
465                                   const struct sockaddr_in *extras, size_t n)
466 {
467     connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
468 }
469
470 /* Sets the OpenFlow queue used by flows set up by in-band control on
471  * 'ofproto' to 'queue_id'.  If 'queue_id' is negative, then in-band control
472  * flows will use the default queue. */
473 void
474 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
475 {
476     connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
477 }
478
479 /* Sets the number of flows at which eviction from the kernel flow table
480  * will occur. */
481 void
482 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
483 {
484     if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
485         ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
486     } else {
487         ofproto->flow_eviction_threshold = threshold;
488     }
489 }
490
491 /* If forward_bpdu is true, the NORMAL action will forward frames with
492  * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
493  * the NORMAL action will drop these frames. */
494 void
495 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
496 {
497     bool old_val = ofproto->forward_bpdu;
498     ofproto->forward_bpdu = forward_bpdu;
499     if (old_val != ofproto->forward_bpdu) {
500         if (ofproto->ofproto_class->forward_bpdu_changed) {
501             ofproto->ofproto_class->forward_bpdu_changed(ofproto);
502         }
503     }
504 }
505
506 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
507  * 'idle_time', in seconds. */
508 void
509 ofproto_set_mac_idle_time(struct ofproto *ofproto, unsigned idle_time)
510 {
511     if (ofproto->ofproto_class->set_mac_idle_time) {
512         ofproto->ofproto_class->set_mac_idle_time(ofproto, idle_time);
513     }
514 }
515
516 void
517 ofproto_set_desc(struct ofproto *p,
518                  const char *mfr_desc, const char *hw_desc,
519                  const char *sw_desc, const char *serial_desc,
520                  const char *dp_desc)
521 {
522     struct ofp_desc_stats *ods;
523
524     if (mfr_desc) {
525         if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
526             VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
527                     sizeof ods->mfr_desc);
528         }
529         free(p->mfr_desc);
530         p->mfr_desc = xstrdup(mfr_desc);
531     }
532     if (hw_desc) {
533         if (strlen(hw_desc) >= sizeof ods->hw_desc) {
534             VLOG_WARN("truncating hw_desc, must be less than %zu characters",
535                     sizeof ods->hw_desc);
536         }
537         free(p->hw_desc);
538         p->hw_desc = xstrdup(hw_desc);
539     }
540     if (sw_desc) {
541         if (strlen(sw_desc) >= sizeof ods->sw_desc) {
542             VLOG_WARN("truncating sw_desc, must be less than %zu characters",
543                     sizeof ods->sw_desc);
544         }
545         free(p->sw_desc);
546         p->sw_desc = xstrdup(sw_desc);
547     }
548     if (serial_desc) {
549         if (strlen(serial_desc) >= sizeof ods->serial_num) {
550             VLOG_WARN("truncating serial_desc, must be less than %zu "
551                     "characters",
552                     sizeof ods->serial_num);
553         }
554         free(p->serial_desc);
555         p->serial_desc = xstrdup(serial_desc);
556     }
557     if (dp_desc) {
558         if (strlen(dp_desc) >= sizeof ods->dp_desc) {
559             VLOG_WARN("truncating dp_desc, must be less than %zu characters",
560                     sizeof ods->dp_desc);
561         }
562         free(p->dp_desc);
563         p->dp_desc = xstrdup(dp_desc);
564     }
565 }
566
567 int
568 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
569 {
570     return connmgr_set_snoops(ofproto->connmgr, snoops);
571 }
572
573 int
574 ofproto_set_netflow(struct ofproto *ofproto,
575                     const struct netflow_options *nf_options)
576 {
577     if (nf_options && sset_is_empty(&nf_options->collectors)) {
578         nf_options = NULL;
579     }
580
581     if (ofproto->ofproto_class->set_netflow) {
582         return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
583     } else {
584         return nf_options ? EOPNOTSUPP : 0;
585     }
586 }
587
588 int
589 ofproto_set_sflow(struct ofproto *ofproto,
590                   const struct ofproto_sflow_options *oso)
591 {
592     if (oso && sset_is_empty(&oso->targets)) {
593         oso = NULL;
594     }
595
596     if (ofproto->ofproto_class->set_sflow) {
597         return ofproto->ofproto_class->set_sflow(ofproto, oso);
598     } else {
599         return oso ? EOPNOTSUPP : 0;
600     }
601 }
602 \f
603 /* Spanning Tree Protocol (STP) configuration. */
604
605 /* Configures STP on 'ofproto' using the settings defined in 's'.  If
606  * 's' is NULL, disables STP.
607  *
608  * Returns 0 if successful, otherwise a positive errno value. */
609 int
610 ofproto_set_stp(struct ofproto *ofproto,
611                 const struct ofproto_stp_settings *s)
612 {
613     return (ofproto->ofproto_class->set_stp
614             ? ofproto->ofproto_class->set_stp(ofproto, s)
615             : EOPNOTSUPP);
616 }
617
618 /* Retrieves STP status of 'ofproto' and stores it in 's'.  If the
619  * 'enabled' member of 's' is false, then the other members are not
620  * meaningful.
621  *
622  * Returns 0 if successful, otherwise a positive errno value. */
623 int
624 ofproto_get_stp_status(struct ofproto *ofproto,
625                        struct ofproto_stp_status *s)
626 {
627     return (ofproto->ofproto_class->get_stp_status
628             ? ofproto->ofproto_class->get_stp_status(ofproto, s)
629             : EOPNOTSUPP);
630 }
631
632 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
633  * in 's'.  The caller is responsible for assigning STP port numbers
634  * (using the 'port_num' member in the range of 1 through 255, inclusive)
635  * and ensuring there are no duplicates.  If the 's' is NULL, then STP
636  * is disabled on the port.
637  *
638  * Returns 0 if successful, otherwise a positive errno value.*/
639 int
640 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
641                      const struct ofproto_port_stp_settings *s)
642 {
643     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
644     if (!ofport) {
645         VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
646                   ofproto->name, ofp_port);
647         return ENODEV;
648     }
649
650     return (ofproto->ofproto_class->set_stp_port
651             ? ofproto->ofproto_class->set_stp_port(ofport, s)
652             : EOPNOTSUPP);
653 }
654
655 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
656  * 's'.  If the 'enabled' member in 's' is false, then the other members
657  * are not meaningful.
658  *
659  * Returns 0 if successful, otherwise a positive errno value.*/
660 int
661 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
662                             struct ofproto_port_stp_status *s)
663 {
664     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
665     if (!ofport) {
666         VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16,
667                   ofproto->name, ofp_port);
668         return ENODEV;
669     }
670
671     return (ofproto->ofproto_class->get_stp_port_status
672             ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
673             : EOPNOTSUPP);
674 }
675 \f
676 /* Queue DSCP configuration. */
677
678 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
679  * 'queues' attached to 'ofport'.  This data is not intended to be sufficient
680  * to implement QoS.  Instead, it is used to implement features which require
681  * knowledge of what queues exist on a port, and some basic information about
682  * them.
683  *
684  * Returns 0 if successful, otherwise a positive errno value. */
685 int
686 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
687                         const struct ofproto_port_queue *queues,
688                         size_t n_queues)
689 {
690     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
691
692     if (!ofport) {
693         VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
694                   ofproto->name, ofp_port);
695         return ENODEV;
696     }
697
698     return (ofproto->ofproto_class->set_queues
699             ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
700             : EOPNOTSUPP);
701 }
702 \f
703 /* Connectivity Fault Management configuration. */
704
705 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
706 void
707 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
708 {
709     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
710     if (ofport && ofproto->ofproto_class->set_cfm) {
711         ofproto->ofproto_class->set_cfm(ofport, NULL);
712     }
713 }
714
715 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'.  Takes
716  * basic configuration from the configuration members in 'cfm', and the remote
717  * maintenance point ID from  remote_mpid.  Ignores the statistics members of
718  * 'cfm'.
719  *
720  * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
721 void
722 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
723                      const struct cfm_settings *s)
724 {
725     struct ofport *ofport;
726     int error;
727
728     ofport = ofproto_get_port(ofproto, ofp_port);
729     if (!ofport) {
730         VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
731                   ofproto->name, ofp_port);
732         return;
733     }
734
735     /* XXX: For configuration simplicity, we only support one remote_mpid
736      * outside of the CFM module.  It's not clear if this is the correct long
737      * term solution or not. */
738     error = (ofproto->ofproto_class->set_cfm
739              ? ofproto->ofproto_class->set_cfm(ofport, s)
740              : EOPNOTSUPP);
741     if (error) {
742         VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
743                   ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
744                   strerror(error));
745     }
746 }
747
748 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
749  * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
750  * 0 if LACP partner information is not current (generally indicating a
751  * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
752 int
753 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
754 {
755     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
756     return (ofport && ofproto->ofproto_class->port_is_lacp_current
757             ? ofproto->ofproto_class->port_is_lacp_current(ofport)
758             : -1);
759 }
760 \f
761 /* Bundles. */
762
763 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
764  * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
765  * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
766  * configuration plus, if there is more than one slave, a bonding
767  * configuration.
768  *
769  * If 'aux' is already registered then this function updates its configuration
770  * to 's'.  Otherwise, this function registers a new bundle.
771  *
772  * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
773  * port. */
774 int
775 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
776                         const struct ofproto_bundle_settings *s)
777 {
778     return (ofproto->ofproto_class->bundle_set
779             ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
780             : EOPNOTSUPP);
781 }
782
783 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
784  * If no such bundle has been registered, this has no effect. */
785 int
786 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
787 {
788     return ofproto_bundle_register(ofproto, aux, NULL);
789 }
790
791 \f
792 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
793  * If 'aux' is already registered then this function updates its configuration
794  * to 's'.  Otherwise, this function registers a new mirror. */
795 int
796 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
797                         const struct ofproto_mirror_settings *s)
798 {
799     return (ofproto->ofproto_class->mirror_set
800             ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
801             : EOPNOTSUPP);
802 }
803
804 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
805  * If no mirror has been registered, this has no effect. */
806 int
807 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
808 {
809     return ofproto_mirror_register(ofproto, aux, NULL);
810 }
811
812 /* Retrieves statistics from mirror associated with client data pointer
813  * 'aux' in 'ofproto'.  Stores packet and byte counts in 'packets' and
814  * 'bytes', respectively.  If a particular counters is not supported,
815  * the appropriate argument is set to UINT64_MAX. */
816 int
817 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
818                          uint64_t *packets, uint64_t *bytes)
819 {
820     if (!ofproto->ofproto_class->mirror_get_stats) {
821         *packets = *bytes = UINT64_MAX;
822         return EOPNOTSUPP;
823     }
824
825     return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
826                                                     packets, bytes);
827 }
828
829 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
830  * which all packets are flooded, instead of using MAC learning.  If
831  * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
832  *
833  * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
834  * port. */
835 int
836 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
837 {
838     return (ofproto->ofproto_class->set_flood_vlans
839             ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
840             : EOPNOTSUPP);
841 }
842
843 /* Returns true if 'aux' is a registered bundle that is currently in use as the
844  * output for a mirror. */
845 bool
846 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
847 {
848     return (ofproto->ofproto_class->is_mirror_output_bundle
849             ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
850             : false);
851 }
852 \f
853 /* Configuration of OpenFlow tables. */
854
855 /* Returns the number of OpenFlow tables in 'ofproto'. */
856 int
857 ofproto_get_n_tables(const struct ofproto *ofproto)
858 {
859     return ofproto->n_tables;
860 }
861
862 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
863  * settings from 's'.  'table_id' must be in the range 0 through the number of
864  * OpenFlow tables in 'ofproto' minus 1, inclusive.
865  *
866  * For read-only tables, only the name may be configured. */
867 void
868 ofproto_configure_table(struct ofproto *ofproto, int table_id,
869                         const struct ofproto_table_settings *s)
870 {
871     struct oftable *table;
872
873     assert(table_id >= 0 && table_id < ofproto->n_tables);
874     table = &ofproto->tables[table_id];
875
876     oftable_set_name(table, s->name);
877
878     if (table->flags & OFTABLE_READONLY) {
879         return;
880     }
881
882     if (s->groups) {
883         oftable_enable_eviction(table, s->groups, s->n_groups);
884     } else {
885         oftable_disable_eviction(table);
886     }
887
888     table->max_flows = s->max_flows;
889     if (classifier_count(&table->cls) > table->max_flows
890         && table->eviction_fields) {
891         /* 'table' contains more flows than allowed.  We might not be able to
892          * evict them right away because of the asynchronous nature of flow
893          * table changes.  Schedule eviction for later. */
894         switch (ofproto->state) {
895         case S_OPENFLOW:
896             ofproto->state = S_EVICT;
897             break;
898         case S_EVICT:
899         case S_FLUSH:
900             /* We're already deleting flows, nothing more to do. */
901             break;
902         }
903     }
904 }
905 \f
906 bool
907 ofproto_has_snoops(const struct ofproto *ofproto)
908 {
909     return connmgr_has_snoops(ofproto->connmgr);
910 }
911
912 void
913 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
914 {
915     connmgr_get_snoops(ofproto->connmgr, snoops);
916 }
917
918 static void
919 ofproto_flush__(struct ofproto *ofproto)
920 {
921     struct ofopgroup *group;
922     struct oftable *table;
923
924     if (ofproto->ofproto_class->flush) {
925         ofproto->ofproto_class->flush(ofproto);
926     }
927
928     group = ofopgroup_create_unattached(ofproto);
929     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
930         struct rule *rule, *next_rule;
931         struct cls_cursor cursor;
932
933         if (table->flags & OFTABLE_HIDDEN) {
934             continue;
935         }
936
937         cls_cursor_init(&cursor, &table->cls, NULL);
938         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
939             if (!rule->pending) {
940                 ofoperation_create(group, rule, OFOPERATION_DELETE);
941                 oftable_remove_rule(rule);
942                 ofproto->ofproto_class->rule_destruct(rule);
943             }
944         }
945     }
946     ofopgroup_submit(group);
947 }
948
949 static void
950 ofproto_destroy__(struct ofproto *ofproto)
951 {
952     struct oftable *table;
953
954     assert(list_is_empty(&ofproto->pending));
955     assert(!ofproto->n_pending);
956
957     connmgr_destroy(ofproto->connmgr);
958
959     hmap_remove(&all_ofprotos, &ofproto->hmap_node);
960     free(ofproto->name);
961     free(ofproto->type);
962     free(ofproto->mfr_desc);
963     free(ofproto->hw_desc);
964     free(ofproto->sw_desc);
965     free(ofproto->serial_desc);
966     free(ofproto->dp_desc);
967     hmap_destroy(&ofproto->ports);
968     shash_destroy(&ofproto->port_by_name);
969
970     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
971         oftable_destroy(table);
972     }
973     free(ofproto->tables);
974
975     hmap_destroy(&ofproto->deletions);
976
977     free(ofproto->vlan_bitmap);
978
979     ofproto->ofproto_class->dealloc(ofproto);
980 }
981
982 void
983 ofproto_destroy(struct ofproto *p)
984 {
985     struct ofport *ofport, *next_ofport;
986
987     if (!p) {
988         return;
989     }
990
991     ofproto_flush__(p);
992     HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
993         ofport_destroy(ofport);
994     }
995
996     p->ofproto_class->destruct(p);
997     ofproto_destroy__(p);
998 }
999
1000 /* Destroys the datapath with the respective 'name' and 'type'.  With the Linux
1001  * kernel datapath, for example, this destroys the datapath in the kernel, and
1002  * with the netdev-based datapath, it tears down the data structures that
1003  * represent the datapath.
1004  *
1005  * The datapath should not be currently open as an ofproto. */
1006 int
1007 ofproto_delete(const char *name, const char *type)
1008 {
1009     const struct ofproto_class *class = ofproto_class_find__(type);
1010     return (!class ? EAFNOSUPPORT
1011             : !class->del ? EACCES
1012             : class->del(type, name));
1013 }
1014
1015 static void
1016 process_port_change(struct ofproto *ofproto, int error, char *devname)
1017 {
1018     if (error == ENOBUFS) {
1019         reinit_ports(ofproto);
1020     } else if (!error) {
1021         update_port(ofproto, devname);
1022         free(devname);
1023     }
1024 }
1025
1026 int
1027 ofproto_run(struct ofproto *p)
1028 {
1029     struct ofport *ofport;
1030     char *devname;
1031     int error;
1032
1033     error = p->ofproto_class->run(p);
1034     if (error && error != EAGAIN) {
1035         VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
1036     }
1037
1038     if (p->ofproto_class->port_poll) {
1039         while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1040             process_port_change(p, error, devname);
1041         }
1042     }
1043
1044     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1045         unsigned int change_seq = netdev_change_seq(ofport->netdev);
1046         if (ofport->change_seq != change_seq) {
1047             ofport->change_seq = change_seq;
1048             update_port(p, netdev_get_name(ofport->netdev));
1049         }
1050     }
1051
1052     switch (p->state) {
1053     case S_OPENFLOW:
1054         connmgr_run(p->connmgr, handle_openflow);
1055         break;
1056
1057     case S_EVICT:
1058         connmgr_run(p->connmgr, NULL);
1059         ofproto_evict(p);
1060         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1061             p->state = S_OPENFLOW;
1062         }
1063         break;
1064
1065     case S_FLUSH:
1066         connmgr_run(p->connmgr, NULL);
1067         ofproto_flush__(p);
1068         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1069             connmgr_flushed(p->connmgr);
1070             p->state = S_OPENFLOW;
1071         }
1072         break;
1073
1074     default:
1075         NOT_REACHED();
1076     }
1077
1078     return error;
1079 }
1080
1081 /* Performs periodic activity required by 'ofproto' that needs to be done
1082  * with the least possible latency.
1083  *
1084  * It makes sense to call this function a couple of times per poll loop, to
1085  * provide a significant performance boost on some benchmarks with the
1086  * ofproto-dpif implementation. */
1087 int
1088 ofproto_run_fast(struct ofproto *p)
1089 {
1090     int error;
1091
1092     error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1093     if (error && error != EAGAIN) {
1094         VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1095                     p->name, strerror(error));
1096     }
1097     return error;
1098 }
1099
1100 void
1101 ofproto_wait(struct ofproto *p)
1102 {
1103     struct ofport *ofport;
1104
1105     p->ofproto_class->wait(p);
1106     if (p->ofproto_class->port_poll_wait) {
1107         p->ofproto_class->port_poll_wait(p);
1108     }
1109
1110     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1111         if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1112             poll_immediate_wake();
1113         }
1114     }
1115
1116     switch (p->state) {
1117     case S_OPENFLOW:
1118         connmgr_wait(p->connmgr, true);
1119         break;
1120
1121     case S_EVICT:
1122     case S_FLUSH:
1123         connmgr_wait(p->connmgr, false);
1124         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1125             poll_immediate_wake();
1126         }
1127         break;
1128     }
1129 }
1130
1131 bool
1132 ofproto_is_alive(const struct ofproto *p)
1133 {
1134     return connmgr_has_controllers(p->connmgr);
1135 }
1136
1137 void
1138 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1139                                     struct shash *info)
1140 {
1141     connmgr_get_controller_info(ofproto->connmgr, info);
1142 }
1143
1144 void
1145 ofproto_free_ofproto_controller_info(struct shash *info)
1146 {
1147     connmgr_free_controller_info(info);
1148 }
1149
1150 /* Makes a deep copy of 'old' into 'port'. */
1151 void
1152 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1153 {
1154     port->name = xstrdup(old->name);
1155     port->type = xstrdup(old->type);
1156     port->ofp_port = old->ofp_port;
1157 }
1158
1159 /* Frees memory allocated to members of 'ofproto_port'.
1160  *
1161  * Do not call this function on an ofproto_port obtained from
1162  * ofproto_port_dump_next(): that function retains ownership of the data in the
1163  * ofproto_port. */
1164 void
1165 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1166 {
1167     free(ofproto_port->name);
1168     free(ofproto_port->type);
1169 }
1170
1171 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1172  *
1173  * This function provides no status indication.  An error status for the entire
1174  * dump operation is provided when it is completed by calling
1175  * ofproto_port_dump_done().
1176  */
1177 void
1178 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1179                         const struct ofproto *ofproto)
1180 {
1181     dump->ofproto = ofproto;
1182     dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1183                                                           &dump->state);
1184 }
1185
1186 /* Attempts to retrieve another port from 'dump', which must have been created
1187  * with ofproto_port_dump_start().  On success, stores a new ofproto_port into
1188  * 'port' and returns true.  On failure, returns false.
1189  *
1190  * Failure might indicate an actual error or merely that the last port has been
1191  * dumped.  An error status for the entire dump operation is provided when it
1192  * is completed by calling ofproto_port_dump_done().
1193  *
1194  * The ofproto owns the data stored in 'port'.  It will remain valid until at
1195  * least the next time 'dump' is passed to ofproto_port_dump_next() or
1196  * ofproto_port_dump_done(). */
1197 bool
1198 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1199                        struct ofproto_port *port)
1200 {
1201     const struct ofproto *ofproto = dump->ofproto;
1202
1203     if (dump->error) {
1204         return false;
1205     }
1206
1207     dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1208                                                          port);
1209     if (dump->error) {
1210         ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1211         return false;
1212     }
1213     return true;
1214 }
1215
1216 /* Completes port table dump operation 'dump', which must have been created
1217  * with ofproto_port_dump_start().  Returns 0 if the dump operation was
1218  * error-free, otherwise a positive errno value describing the problem. */
1219 int
1220 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1221 {
1222     const struct ofproto *ofproto = dump->ofproto;
1223     if (!dump->error) {
1224         dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1225                                                              dump->state);
1226     }
1227     return dump->error == EOF ? 0 : dump->error;
1228 }
1229
1230 /* Attempts to add 'netdev' as a port on 'ofproto'.  If successful, returns 0
1231  * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1232  * is non-null).  On failure, returns a positive errno value and sets
1233  * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1234 int
1235 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1236                  uint16_t *ofp_portp)
1237 {
1238     uint16_t ofp_port;
1239     int error;
1240
1241     error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1242     if (!error) {
1243         update_port(ofproto, netdev_get_name(netdev));
1244     }
1245     if (ofp_portp) {
1246         *ofp_portp = error ? OFPP_NONE : ofp_port;
1247     }
1248     return error;
1249 }
1250
1251 /* Looks up a port named 'devname' in 'ofproto'.  On success, returns 0 and
1252  * initializes '*port' appropriately; on failure, returns a positive errno
1253  * value.
1254  *
1255  * The caller owns the data in 'ofproto_port' and must free it with
1256  * ofproto_port_destroy() when it is no longer needed. */
1257 int
1258 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1259                            struct ofproto_port *port)
1260 {
1261     int error;
1262
1263     error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1264     if (error) {
1265         memset(port, 0, sizeof *port);
1266     }
1267     return error;
1268 }
1269
1270 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1271  * Returns 0 if successful, otherwise a positive errno. */
1272 int
1273 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1274 {
1275     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1276     const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1277     int error;
1278
1279     error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1280     if (!error && ofport) {
1281         /* 'name' is the netdev's name and update_port() is going to close the
1282          * netdev.  Just in case update_port() refers to 'name' after it
1283          * destroys 'ofport', make a copy of it around the update_port()
1284          * call. */
1285         char *devname = xstrdup(name);
1286         update_port(ofproto, devname);
1287         free(devname);
1288     }
1289     return error;
1290 }
1291
1292 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1293  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1294  * timeout.
1295  *
1296  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1297  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1298  * controllers; otherwise, it will be hidden.
1299  *
1300  * The caller retains ownership of 'cls_rule' and 'actions'.
1301  *
1302  * This is a helper function for in-band control and fail-open. */
1303 void
1304 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1305                  const union ofp_action *actions, size_t n_actions)
1306 {
1307     const struct rule *rule;
1308
1309     rule = rule_from_cls_rule(classifier_find_rule_exactly(
1310                                     &ofproto->tables[0].cls, cls_rule));
1311     if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1312                                         actions, n_actions)) {
1313         struct ofputil_flow_mod fm;
1314
1315         memset(&fm, 0, sizeof fm);
1316         fm.cr = *cls_rule;
1317         fm.buffer_id = UINT32_MAX;
1318         fm.actions = (union ofp_action *) actions;
1319         fm.n_actions = n_actions;
1320         add_flow(ofproto, NULL, &fm, NULL);
1321     }
1322 }
1323
1324 /* Executes the flow modification specified in 'fm'.  Returns 0 on success, an
1325  * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1326  * operation cannot be initiated now but may be retried later.
1327  *
1328  * This is a helper function for in-band control and fail-open. */
1329 int
1330 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1331 {
1332     return handle_flow_mod__(ofproto, NULL, fm, NULL);
1333 }
1334
1335 /* Searches for a rule with matching criteria exactly equal to 'target' in
1336  * ofproto's table 0 and, if it finds one, deletes it.
1337  *
1338  * This is a helper function for in-band control and fail-open. */
1339 bool
1340 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1341 {
1342     struct rule *rule;
1343
1344     rule = rule_from_cls_rule(classifier_find_rule_exactly(
1345                                   &ofproto->tables[0].cls, target));
1346     if (!rule) {
1347         /* No such rule -> success. */
1348         return true;
1349     } else if (rule->pending) {
1350         /* An operation on the rule is already pending -> failure.
1351          * Caller must retry later if it's important. */
1352         return false;
1353     } else {
1354         /* Initiate deletion -> success. */
1355         struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1356         ofoperation_create(group, rule, OFOPERATION_DELETE);
1357         oftable_remove_rule(rule);
1358         ofproto->ofproto_class->rule_destruct(rule);
1359         ofopgroup_submit(group);
1360         return true;
1361     }
1362
1363 }
1364
1365 /* Starts the process of deleting all of the flows from all of ofproto's flow
1366  * tables and then reintroducing the flows required by in-band control and
1367  * fail-open.  The process will complete in a later call to ofproto_run(). */
1368 void
1369 ofproto_flush_flows(struct ofproto *ofproto)
1370 {
1371     COVERAGE_INC(ofproto_flush);
1372     ofproto->state = S_FLUSH;
1373 }
1374 \f
1375 static void
1376 reinit_ports(struct ofproto *p)
1377 {
1378     struct ofproto_port_dump dump;
1379     struct sset devnames;
1380     struct ofport *ofport;
1381     struct ofproto_port ofproto_port;
1382     const char *devname;
1383
1384     COVERAGE_INC(ofproto_reinit_ports);
1385
1386     sset_init(&devnames);
1387     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1388         sset_add(&devnames, netdev_get_name(ofport->netdev));
1389     }
1390     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1391         sset_add(&devnames, ofproto_port.name);
1392     }
1393
1394     SSET_FOR_EACH (devname, &devnames) {
1395         update_port(p, devname);
1396     }
1397     sset_destroy(&devnames);
1398 }
1399
1400 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1401  * netdev cannot be opened.  On success, also fills in 'opp'.  */
1402 static struct netdev *
1403 ofport_open(const struct ofproto_port *ofproto_port,
1404             struct ofputil_phy_port *pp)
1405 {
1406     enum netdev_flags flags;
1407     struct netdev *netdev;
1408     int error;
1409
1410     error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1411     if (error) {
1412         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1413                      "cannot be opened (%s)",
1414                      ofproto_port->name, ofproto_port->ofp_port,
1415                      ofproto_port->name, strerror(error));
1416         return NULL;
1417     }
1418
1419     pp->port_no = ofproto_port->ofp_port;
1420     netdev_get_etheraddr(netdev, pp->hw_addr);
1421     ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1422     netdev_get_flags(netdev, &flags);
1423     pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1424     pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1425     netdev_get_features(netdev, &pp->curr, &pp->advertised,
1426                         &pp->supported, &pp->peer);
1427     pp->curr_speed = netdev_features_to_bps(pp->curr);
1428     pp->max_speed = netdev_features_to_bps(pp->supported);
1429
1430     return netdev;
1431 }
1432
1433 /* Returns true if most fields of 'a' and 'b' are equal.  Differences in name,
1434  * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1435  * disregarded. */
1436 static bool
1437 ofport_equal(const struct ofputil_phy_port *a,
1438              const struct ofputil_phy_port *b)
1439 {
1440     return (eth_addr_equals(a->hw_addr, b->hw_addr)
1441             && a->state == b->state
1442             && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1443             && a->curr == b->curr
1444             && a->advertised == b->advertised
1445             && a->supported == b->supported
1446             && a->peer == b->peer
1447             && a->curr_speed == b->curr_speed
1448             && a->max_speed == b->max_speed);
1449 }
1450
1451 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1452  * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1453  * one with the same name or port number). */
1454 static void
1455 ofport_install(struct ofproto *p,
1456                struct netdev *netdev, const struct ofputil_phy_port *pp)
1457 {
1458     const char *netdev_name = netdev_get_name(netdev);
1459     struct ofport *ofport;
1460     int dev_mtu;
1461     int error;
1462
1463     /* Create ofport. */
1464     ofport = p->ofproto_class->port_alloc();
1465     if (!ofport) {
1466         error = ENOMEM;
1467         goto error;
1468     }
1469     ofport->ofproto = p;
1470     ofport->netdev = netdev;
1471     ofport->change_seq = netdev_change_seq(netdev);
1472     ofport->pp = *pp;
1473     ofport->ofp_port = pp->port_no;
1474
1475     /* Add port to 'p'. */
1476     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1477     shash_add(&p->port_by_name, netdev_name, ofport);
1478
1479     if (!netdev_get_mtu(netdev, &dev_mtu)) {
1480         ofport->mtu = dev_mtu;
1481         set_internal_devs_mtu(p);
1482     } else {
1483         ofport->mtu = 0;
1484     }
1485
1486     /* Let the ofproto_class initialize its private data. */
1487     error = p->ofproto_class->port_construct(ofport);
1488     if (error) {
1489         goto error;
1490     }
1491     connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1492     return;
1493
1494 error:
1495     VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1496                  p->name, netdev_name, strerror(error));
1497     if (ofport) {
1498         ofport_destroy__(ofport);
1499     } else {
1500         netdev_close(netdev);
1501     }
1502 }
1503
1504 /* Removes 'ofport' from 'p' and destroys it. */
1505 static void
1506 ofport_remove(struct ofport *ofport)
1507 {
1508     connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1509                              OFPPR_DELETE);
1510     ofport_destroy(ofport);
1511 }
1512
1513 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1514  * destroys it. */
1515 static void
1516 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1517 {
1518     struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1519     if (port) {
1520         ofport_remove(port);
1521     }
1522 }
1523
1524 /* Updates 'port' with new 'pp' description.
1525  *
1526  * Does not handle a name or port number change.  The caller must implement
1527  * such a change as a delete followed by an add.  */
1528 static void
1529 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1530 {
1531     memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1532     port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1533                         | (pp->config & OFPUTIL_PC_PORT_DOWN));
1534     port->pp.state = pp->state;
1535     port->pp.curr = pp->curr;
1536     port->pp.advertised = pp->advertised;
1537     port->pp.supported = pp->supported;
1538     port->pp.peer = pp->peer;
1539     port->pp.curr_speed = pp->curr_speed;
1540     port->pp.max_speed = pp->max_speed;
1541
1542     connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1543 }
1544
1545 /* Update OpenFlow 'state' in 'port' and notify controller. */
1546 void
1547 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1548 {
1549     if (port->pp.state != state) {
1550         port->pp.state = state;
1551         connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1552                                  OFPPR_MODIFY);
1553     }
1554 }
1555
1556 void
1557 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1558 {
1559     struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1560     if (port) {
1561         if (port->ofproto->ofproto_class->set_realdev) {
1562             port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1563         }
1564         if (port->ofproto->ofproto_class->set_stp_port) {
1565             port->ofproto->ofproto_class->set_stp_port(port, NULL);
1566         }
1567         if (port->ofproto->ofproto_class->set_cfm) {
1568             port->ofproto->ofproto_class->set_cfm(port, NULL);
1569         }
1570         if (port->ofproto->ofproto_class->bundle_remove) {
1571             port->ofproto->ofproto_class->bundle_remove(port);
1572         }
1573     }
1574 }
1575
1576 static void
1577 ofport_destroy__(struct ofport *port)
1578 {
1579     struct ofproto *ofproto = port->ofproto;
1580     const char *name = netdev_get_name(port->netdev);
1581
1582     hmap_remove(&ofproto->ports, &port->hmap_node);
1583     shash_delete(&ofproto->port_by_name,
1584                  shash_find(&ofproto->port_by_name, name));
1585
1586     netdev_close(port->netdev);
1587     ofproto->ofproto_class->port_dealloc(port);
1588 }
1589
1590 static void
1591 ofport_destroy(struct ofport *port)
1592 {
1593     if (port) {
1594         port->ofproto->ofproto_class->port_destruct(port);
1595         ofport_destroy__(port);
1596      }
1597 }
1598
1599 struct ofport *
1600 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1601 {
1602     struct ofport *port;
1603
1604     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1605                              hash_int(ofp_port, 0), &ofproto->ports) {
1606         if (port->ofp_port == ofp_port) {
1607             return port;
1608         }
1609     }
1610     return NULL;
1611 }
1612
1613 int
1614 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1615 {
1616     struct ofproto *ofproto = port->ofproto;
1617     int error;
1618
1619     if (ofproto->ofproto_class->port_get_stats) {
1620         error = ofproto->ofproto_class->port_get_stats(port, stats);
1621     } else {
1622         error = EOPNOTSUPP;
1623     }
1624
1625     return error;
1626 }
1627
1628 static void
1629 update_port(struct ofproto *ofproto, const char *name)
1630 {
1631     struct ofproto_port ofproto_port;
1632     struct ofputil_phy_port pp;
1633     struct netdev *netdev;
1634     struct ofport *port;
1635
1636     COVERAGE_INC(ofproto_update_port);
1637
1638     /* Fetch 'name''s location and properties from the datapath. */
1639     netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1640               ? ofport_open(&ofproto_port, &pp)
1641               : NULL);
1642     if (netdev) {
1643         port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1644         if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1645             struct netdev *old_netdev = port->netdev;
1646             int dev_mtu;
1647
1648             /* 'name' hasn't changed location.  Any properties changed? */
1649             if (!ofport_equal(&port->pp, &pp)) {
1650                 ofport_modified(port, &pp);
1651             }
1652
1653             if (!netdev_get_mtu(netdev, &dev_mtu) &&
1654                 port->mtu != dev_mtu) {
1655                 port->mtu = dev_mtu;
1656                 set_internal_devs_mtu(ofproto);
1657             }
1658
1659             /* Install the newly opened netdev in case it has changed.
1660              * Don't close the old netdev yet in case port_modified has to
1661              * remove a retained reference to it.*/
1662             port->netdev = netdev;
1663             port->change_seq = netdev_change_seq(netdev);
1664
1665             if (port->ofproto->ofproto_class->port_modified) {
1666                 port->ofproto->ofproto_class->port_modified(port);
1667             }
1668
1669             netdev_close(old_netdev);
1670         } else {
1671             /* If 'port' is nonnull then its name differs from 'name' and thus
1672              * we should delete it.  If we think there's a port named 'name'
1673              * then its port number must be wrong now so delete it too. */
1674             if (port) {
1675                 ofport_remove(port);
1676             }
1677             ofport_remove_with_name(ofproto, name);
1678             ofport_install(ofproto, netdev, &pp);
1679         }
1680     } else {
1681         /* Any port named 'name' is gone now. */
1682         ofport_remove_with_name(ofproto, name);
1683     }
1684     ofproto_port_destroy(&ofproto_port);
1685 }
1686
1687 static int
1688 init_ports(struct ofproto *p)
1689 {
1690     struct ofproto_port_dump dump;
1691     struct ofproto_port ofproto_port;
1692
1693     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1694         uint16_t ofp_port = ofproto_port.ofp_port;
1695         if (ofproto_get_port(p, ofp_port)) {
1696             VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1697                          ofp_port);
1698         } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1699             VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1700                          ofproto_port.name);
1701         } else {
1702             struct ofputil_phy_port pp;
1703             struct netdev *netdev;
1704
1705             netdev = ofport_open(&ofproto_port, &pp);
1706             if (netdev) {
1707                 ofport_install(p, netdev, &pp);
1708             }
1709         }
1710     }
1711
1712     return 0;
1713 }
1714
1715 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1716  * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1717 static int
1718 find_min_mtu(struct ofproto *p)
1719 {
1720     struct ofport *ofport;
1721     int mtu = 0;
1722
1723     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1724         struct netdev *netdev = ofport->netdev;
1725         int dev_mtu;
1726
1727         /* Skip any internal ports, since that's what we're trying to
1728          * set. */
1729         if (!strcmp(netdev_get_type(netdev), "internal")) {
1730             continue;
1731         }
1732
1733         if (netdev_get_mtu(netdev, &dev_mtu)) {
1734             continue;
1735         }
1736         if (!mtu || dev_mtu < mtu) {
1737             mtu = dev_mtu;
1738         }
1739     }
1740
1741     return mtu ? mtu: ETH_PAYLOAD_MAX;
1742 }
1743
1744 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1745  * non-datapath ports. */
1746 static void
1747 set_internal_devs_mtu(struct ofproto *p)
1748 {
1749     struct ofport *ofport;
1750     int mtu = find_min_mtu(p);
1751
1752     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1753         struct netdev *netdev = ofport->netdev;
1754
1755         if (!strcmp(netdev_get_type(netdev), "internal")) {
1756             netdev_set_mtu(netdev, mtu);
1757             ofport->mtu = mtu;
1758         }
1759     }
1760 }
1761 \f
1762 static void
1763 ofproto_rule_destroy__(struct rule *rule)
1764 {
1765     if (rule) {
1766         free(rule->actions);
1767         rule->ofproto->ofproto_class->rule_dealloc(rule);
1768     }
1769 }
1770
1771 /* This function allows an ofproto implementation to destroy any rules that
1772  * remain when its ->destruct() function is called.  The caller must have
1773  * already uninitialized any derived members of 'rule' (step 5 described in the
1774  * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1775  * This function implements steps 6 and 7.
1776  *
1777  * This function should only be called from an ofproto implementation's
1778  * ->destruct() function.  It is not suitable elsewhere. */
1779 void
1780 ofproto_rule_destroy(struct rule *rule)
1781 {
1782     assert(!rule->pending);
1783     oftable_remove_rule(rule);
1784     ofproto_rule_destroy__(rule);
1785 }
1786
1787 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1788  * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1789  * count). */
1790 static bool
1791 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1792 {
1793     const union ofp_action *oa;
1794     size_t left;
1795
1796     if (out_port == OFPP_NONE) {
1797         return true;
1798     }
1799     OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1800         if (action_outputs_to_port(oa, htons(out_port))) {
1801             return true;
1802         }
1803     }
1804     return false;
1805 }
1806
1807 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1808  * statistics appropriately.  'packet' must have at least sizeof(struct
1809  * ofp_packet_in) bytes of headroom.
1810  *
1811  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
1812  * with statistics for 'packet' either way.
1813  *
1814  * Takes ownership of 'packet'. */
1815 static int
1816 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1817 {
1818     struct flow flow;
1819
1820     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1821
1822     flow_extract(packet, 0, 0, in_port, &flow);
1823     return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1824 }
1825
1826 /* Returns true if 'rule' should be hidden from the controller.
1827  *
1828  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1829  * (e.g. by in-band control) and are intentionally hidden from the
1830  * controller. */
1831 static bool
1832 rule_is_hidden(const struct rule *rule)
1833 {
1834     return rule->cr.priority > UINT16_MAX;
1835 }
1836
1837 static enum oftable_flags
1838 rule_get_flags(const struct rule *rule)
1839 {
1840     return rule->ofproto->tables[rule->table_id].flags;
1841 }
1842
1843 static bool
1844 rule_is_modifiable(const struct rule *rule)
1845 {
1846     return !(rule_get_flags(rule) & OFTABLE_READONLY);
1847 }
1848 \f
1849 static enum ofperr
1850 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1851 {
1852     ofconn_send_reply(ofconn, make_echo_reply(oh));
1853     return 0;
1854 }
1855
1856 static enum ofperr
1857 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1858 {
1859     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1860     struct ofputil_switch_features features;
1861     struct ofport *port;
1862     bool arp_match_ip;
1863     struct ofpbuf *b;
1864
1865     ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
1866                                          &features.actions);
1867     assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
1868
1869     features.datapath_id = ofproto->datapath_id;
1870     features.n_buffers = pktbuf_capacity();
1871     features.n_tables = ofproto->n_tables;
1872     features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
1873                              OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
1874     if (arp_match_ip) {
1875         features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
1876     }
1877
1878     b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
1879                                        oh->xid);
1880     HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1881         ofputil_put_switch_features_port(&port->pp, b);
1882     }
1883
1884     ofconn_send_reply(ofconn, b);
1885     return 0;
1886 }
1887
1888 static enum ofperr
1889 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1890 {
1891     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1892     struct ofp_switch_config *osc;
1893     enum ofp_config_flags flags;
1894     struct ofpbuf *buf;
1895
1896     /* Send reply. */
1897     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1898     flags = ofproto->frag_handling;
1899     if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
1900         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1901     }
1902     osc->flags = htons(flags);
1903     osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1904     ofconn_send_reply(ofconn, buf);
1905
1906     return 0;
1907 }
1908
1909 static enum ofperr
1910 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1911 {
1912     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1913     uint16_t flags = ntohs(osc->flags);
1914
1915     if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1916         || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1917         enum ofp_config_flags cur = ofproto->frag_handling;
1918         enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1919
1920         assert((cur & OFPC_FRAG_MASK) == cur);
1921         if (cur != next) {
1922             if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1923                 ofproto->frag_handling = next;
1924             } else {
1925                 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1926                              ofproto->name,
1927                              ofputil_frag_handling_to_string(next));
1928             }
1929         }
1930     }
1931     ofconn_set_invalid_ttl_to_controller(ofconn,
1932                          (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
1933
1934     ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1935
1936     return 0;
1937 }
1938
1939 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
1940  * error message code for the caller to propagate upward.  Otherwise, returns
1941  * 0.
1942  *
1943  * The log message mentions 'msg_type'. */
1944 static enum ofperr
1945 reject_slave_controller(struct ofconn *ofconn)
1946 {
1947     if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1948         && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1949         return OFPERR_OFPBRC_EPERM;
1950     } else {
1951         return 0;
1952     }
1953 }
1954
1955 static enum ofperr
1956 handle_packet_out(struct ofconn *ofconn, const struct ofp_packet_out *opo)
1957 {
1958     struct ofproto *p = ofconn_get_ofproto(ofconn);
1959     struct ofputil_packet_out po;
1960     struct ofpbuf *payload;
1961     struct flow flow;
1962     enum ofperr error;
1963
1964     COVERAGE_INC(ofproto_packet_out);
1965
1966     error = reject_slave_controller(ofconn);
1967     if (error) {
1968         return error;
1969     }
1970
1971     /* Decode message. */
1972     error = ofputil_decode_packet_out(&po, opo);
1973     if (error) {
1974         return error;
1975     }
1976
1977     /* Get payload. */
1978     if (po.buffer_id != UINT32_MAX) {
1979         error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
1980         if (error || !payload) {
1981             return error;
1982         }
1983     } else {
1984         payload = xmalloc(sizeof *payload);
1985         ofpbuf_use_const(payload, po.packet, po.packet_len);
1986     }
1987
1988     /* Send out packet. */
1989     flow_extract(payload, 0, 0, po.in_port, &flow);
1990     error = p->ofproto_class->packet_out(p, payload, &flow,
1991                                          po.actions, po.n_actions);
1992     ofpbuf_delete(payload);
1993
1994     return error;
1995 }
1996
1997 static void
1998 update_port_config(struct ofport *port,
1999                    enum ofputil_port_config config,
2000                    enum ofputil_port_config mask)
2001 {
2002     enum ofputil_port_config old_config = port->pp.config;
2003     enum ofputil_port_config toggle;
2004
2005     toggle = (config ^ port->pp.config) & mask;
2006     if (toggle & OFPUTIL_PC_PORT_DOWN) {
2007         if (config & OFPUTIL_PC_PORT_DOWN) {
2008             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2009         } else {
2010             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2011         }
2012         toggle &= ~OFPUTIL_PC_PORT_DOWN;
2013     }
2014
2015     port->pp.config ^= toggle;
2016     if (port->pp.config != old_config) {
2017         port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2018     }
2019 }
2020
2021 static enum ofperr
2022 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2023 {
2024     struct ofproto *p = ofconn_get_ofproto(ofconn);
2025     struct ofputil_port_mod pm;
2026     struct ofport *port;
2027     enum ofperr error;
2028
2029     error = reject_slave_controller(ofconn);
2030     if (error) {
2031         return error;
2032     }
2033
2034     error = ofputil_decode_port_mod(oh, &pm);
2035     if (error) {
2036         return error;
2037     }
2038
2039     port = ofproto_get_port(p, pm.port_no);
2040     if (!port) {
2041         return OFPERR_OFPPMFC_BAD_PORT;
2042     } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2043         return OFPERR_OFPPMFC_BAD_HW_ADDR;
2044     } else {
2045         update_port_config(port, pm.config, pm.mask);
2046         if (pm.advertise) {
2047             netdev_set_advertisements(port->netdev, pm.advertise);
2048         }
2049     }
2050     return 0;
2051 }
2052
2053 static enum ofperr
2054 handle_desc_stats_request(struct ofconn *ofconn,
2055                           const struct ofp_stats_msg *request)
2056 {
2057     struct ofproto *p = ofconn_get_ofproto(ofconn);
2058     struct ofp_desc_stats *ods;
2059     struct ofpbuf *msg;
2060
2061     ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
2062     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
2063     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
2064     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
2065     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
2066     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
2067     ofconn_send_reply(ofconn, msg);
2068
2069     return 0;
2070 }
2071
2072 static enum ofperr
2073 handle_table_stats_request(struct ofconn *ofconn,
2074                            const struct ofp_stats_msg *request)
2075 {
2076     struct ofproto *p = ofconn_get_ofproto(ofconn);
2077     struct ofp_table_stats *ots;
2078     struct ofpbuf *msg;
2079     size_t i;
2080
2081     ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
2082
2083     ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
2084     for (i = 0; i < p->n_tables; i++) {
2085         ots[i].table_id = i;
2086         sprintf(ots[i].name, "table%zu", i);
2087         ots[i].wildcards = htonl(OFPFW_ALL);
2088         ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2089         ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2090     }
2091
2092     p->ofproto_class->get_tables(p, ots);
2093
2094     for (i = 0; i < p->n_tables; i++) {
2095         const struct oftable *table = &p->tables[i];
2096
2097         if (table->name) {
2098             ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2099         }
2100
2101         if (table->max_flows < ntohl(ots[i].max_entries)) {
2102             ots[i].max_entries = htonl(table->max_flows);
2103         }
2104     }
2105
2106     ofconn_send_reply(ofconn, msg);
2107     return 0;
2108 }
2109
2110 static void
2111 append_port_stat(struct ofport *port, struct list *replies)
2112 {
2113     struct netdev_stats stats;
2114     struct ofp_port_stats *ops;
2115
2116     /* Intentionally ignore return value, since errors will set
2117      * 'stats' to all-1s, which is correct for OpenFlow, and
2118      * netdev_get_stats() will log errors. */
2119     ofproto_port_get_stats(port, &stats);
2120
2121     ops = ofputil_append_stats_reply(sizeof *ops, replies);
2122     ops->port_no = htons(port->pp.port_no);
2123     memset(ops->pad, 0, sizeof ops->pad);
2124     put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
2125     put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
2126     put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
2127     put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
2128     put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
2129     put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
2130     put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
2131     put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
2132     put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
2133     put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
2134     put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
2135     put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
2136 }
2137
2138 static enum ofperr
2139 handle_port_stats_request(struct ofconn *ofconn,
2140                           const struct ofp_port_stats_request *psr)
2141 {
2142     struct ofproto *p = ofconn_get_ofproto(ofconn);
2143     struct ofport *port;
2144     struct list replies;
2145
2146     ofputil_start_stats_reply(&psr->osm, &replies);
2147     if (psr->port_no != htons(OFPP_NONE)) {
2148         port = ofproto_get_port(p, ntohs(psr->port_no));
2149         if (port) {
2150             append_port_stat(port, &replies);
2151         }
2152     } else {
2153         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2154             append_port_stat(port, &replies);
2155         }
2156     }
2157
2158     ofconn_send_replies(ofconn, &replies);
2159     return 0;
2160 }
2161
2162 static void
2163 calc_flow_duration__(long long int start, long long int now,
2164                      uint32_t *sec, uint32_t *nsec)
2165 {
2166     long long int msecs = now - start;
2167     *sec = msecs / 1000;
2168     *nsec = (msecs % 1000) * (1000 * 1000);
2169 }
2170
2171 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'.  Returns
2172  * 0 if 'table_id' is OK, otherwise an OpenFlow error code.  */
2173 static enum ofperr
2174 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2175 {
2176     return (table_id == 0xff || table_id < ofproto->n_tables
2177             ? 0
2178             : OFPERR_NXBRC_BAD_TABLE_ID);
2179
2180 }
2181
2182 static struct oftable *
2183 next_visible_table(struct ofproto *ofproto, uint8_t table_id)
2184 {
2185     struct oftable *table;
2186
2187     for (table = &ofproto->tables[table_id];
2188          table < &ofproto->tables[ofproto->n_tables];
2189          table++) {
2190         if (!(table->flags & OFTABLE_HIDDEN)) {
2191             return table;
2192         }
2193     }
2194
2195     return NULL;
2196 }
2197
2198 static struct oftable *
2199 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
2200 {
2201     if (table_id == 0xff) {
2202         return next_visible_table(ofproto, 0);
2203     } else if (table_id < ofproto->n_tables) {
2204         return &ofproto->tables[table_id];
2205     } else {
2206         return NULL;
2207     }
2208 }
2209
2210 static struct oftable *
2211 next_matching_table(struct ofproto *ofproto,
2212                     struct oftable *table, uint8_t table_id)
2213 {
2214     return (table_id == 0xff
2215             ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2216             : NULL);
2217 }
2218
2219 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2220  *
2221  *   - If TABLE_ID is 0xff, this iterates over every classifier table in
2222  *     OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2223  *
2224  *   - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2225  *     only once, for that table.  (This can be used to access tables marked
2226  *     OFTABLE_HIDDEN.)
2227  *
2228  *   - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2229  *     entered at all.  (Perhaps you should have validated TABLE_ID with
2230  *     check_table_id().)
2231  *
2232  * All parameters are evaluated multiple times.
2233  */
2234 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO)         \
2235     for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID);       \
2236          (TABLE) != NULL;                                         \
2237          (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2238
2239 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2240  * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2241  * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2242  * 'rules'.
2243  *
2244  * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2245  * to 'out_port' are included.
2246  *
2247  * Hidden rules are always omitted.
2248  *
2249  * Returns 0 on success, otherwise an OpenFlow error code. */
2250 static enum ofperr
2251 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2252                     const struct cls_rule *match,
2253                     ovs_be64 cookie, ovs_be64 cookie_mask,
2254                     uint16_t out_port, struct list *rules)
2255 {
2256     struct oftable *table;
2257     enum ofperr error;
2258
2259     error = check_table_id(ofproto, table_id);
2260     if (error) {
2261         return error;
2262     }
2263
2264     list_init(rules);
2265     FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2266         struct cls_cursor cursor;
2267         struct rule *rule;
2268
2269         cls_cursor_init(&cursor, &table->cls, match);
2270         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2271             if (rule->pending) {
2272                 return OFPROTO_POSTPONE;
2273             }
2274             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2275                     && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2276                 list_push_back(rules, &rule->ofproto_node);
2277             }
2278         }
2279     }
2280     return 0;
2281 }
2282
2283 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2284  * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2285  * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2286  * on list 'rules'.
2287  *
2288  * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2289  * to 'out_port' are included.
2290  *
2291  * Hidden rules are always omitted.
2292  *
2293  * Returns 0 on success, otherwise an OpenFlow error code. */
2294 static enum ofperr
2295 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2296                      const struct cls_rule *match,
2297                      ovs_be64 cookie, ovs_be64 cookie_mask,
2298                      uint16_t out_port, struct list *rules)
2299 {
2300     struct oftable *table;
2301     int error;
2302
2303     error = check_table_id(ofproto, table_id);
2304     if (error) {
2305         return error;
2306     }
2307
2308     list_init(rules);
2309     FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2310         struct rule *rule;
2311
2312         rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2313                                                                match));
2314         if (rule) {
2315             if (rule->pending) {
2316                 return OFPROTO_POSTPONE;
2317             }
2318             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2319                     && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2320                 list_push_back(rules, &rule->ofproto_node);
2321             }
2322         }
2323     }
2324     return 0;
2325 }
2326
2327 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2328  * forced into the range of a uint16_t. */
2329 static int
2330 age_secs(long long int age_ms)
2331 {
2332     return (age_ms < 0 ? 0
2333             : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2334             : (unsigned int) age_ms / 1000);
2335 }
2336
2337 static enum ofperr
2338 handle_flow_stats_request(struct ofconn *ofconn,
2339                           const struct ofp_stats_msg *osm)
2340 {
2341     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2342     struct ofputil_flow_stats_request fsr;
2343     struct list replies;
2344     struct list rules;
2345     struct rule *rule;
2346     enum ofperr error;
2347
2348     error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2349     if (error) {
2350         return error;
2351     }
2352
2353     error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2354                                 fsr.cookie, fsr.cookie_mask,
2355                                 fsr.out_port, &rules);
2356     if (error) {
2357         return error;
2358     }
2359
2360     ofputil_start_stats_reply(osm, &replies);
2361     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2362         long long int now = time_msec();
2363         struct ofputil_flow_stats fs;
2364
2365         fs.rule = rule->cr;
2366         fs.cookie = rule->flow_cookie;
2367         fs.table_id = rule->table_id;
2368         calc_flow_duration__(rule->created, now, &fs.duration_sec,
2369                              &fs.duration_nsec);
2370         fs.idle_timeout = rule->idle_timeout;
2371         fs.hard_timeout = rule->hard_timeout;
2372         fs.idle_age = age_secs(now - rule->used);
2373         fs.hard_age = age_secs(now - rule->modified);
2374         ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2375                                                &fs.byte_count);
2376         fs.actions = rule->actions;
2377         fs.n_actions = rule->n_actions;
2378         ofputil_append_flow_stats_reply(&fs, &replies);
2379     }
2380     ofconn_send_replies(ofconn, &replies);
2381
2382     return 0;
2383 }
2384
2385 static void
2386 flow_stats_ds(struct rule *rule, struct ds *results)
2387 {
2388     uint64_t packet_count, byte_count;
2389
2390     rule->ofproto->ofproto_class->rule_get_stats(rule,
2391                                                  &packet_count, &byte_count);
2392
2393     if (rule->table_id != 0) {
2394         ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2395     }
2396     ds_put_format(results, "duration=%llds, ",
2397                   (time_msec() - rule->created) / 1000);
2398     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2399     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2400     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2401     cls_rule_format(&rule->cr, results);
2402     ds_put_char(results, ',');
2403     if (rule->n_actions > 0) {
2404         ofp_print_actions(results, rule->actions, rule->n_actions);
2405     } else {
2406         ds_put_cstr(results, "drop");
2407     }
2408     ds_put_cstr(results, "\n");
2409 }
2410
2411 /* Adds a pretty-printed description of all flows to 'results', including
2412  * hidden flows (e.g., set up by in-band control). */
2413 void
2414 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2415 {
2416     struct oftable *table;
2417
2418     OFPROTO_FOR_EACH_TABLE (table, p) {
2419         struct cls_cursor cursor;
2420         struct rule *rule;
2421
2422         cls_cursor_init(&cursor, &table->cls, NULL);
2423         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2424             flow_stats_ds(rule, results);
2425         }
2426     }
2427 }
2428
2429 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2430  * '*engine_type' and '*engine_id', respectively. */
2431 void
2432 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2433                         uint8_t *engine_type, uint8_t *engine_id)
2434 {
2435     ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2436 }
2437
2438 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'.  Returns a
2439  * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2440  * indicating a connectivity problem).  Returns zero if CFM is not faulted,
2441  * and -1 if CFM is not enabled on 'port'. */
2442 int
2443 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2444 {
2445     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2446     return (ofport && ofproto->ofproto_class->get_cfm_fault
2447             ? ofproto->ofproto_class->get_cfm_fault(ofport)
2448             : -1);
2449 }
2450
2451 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2452  * within 'ofproto'.  Populates 'rmps' with an array of MPIDs owned by
2453  * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'.  Returns a
2454  * number less than 0 if CFM is not enabled on 'ofp_port'. */
2455 int
2456 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2457                                   uint16_t ofp_port, const uint64_t **rmps,
2458                                   size_t *n_rmps)
2459 {
2460     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2461
2462     *rmps = NULL;
2463     *n_rmps = 0;
2464     return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2465             ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2466                                                            n_rmps)
2467             : -1);
2468 }
2469
2470 static enum ofperr
2471 handle_aggregate_stats_request(struct ofconn *ofconn,
2472                                const struct ofp_stats_msg *osm)
2473 {
2474     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2475     struct ofputil_flow_stats_request request;
2476     struct ofputil_aggregate_stats stats;
2477     bool unknown_packets, unknown_bytes;
2478     struct ofpbuf *reply;
2479     struct list rules;
2480     struct rule *rule;
2481     enum ofperr error;
2482
2483     error = ofputil_decode_flow_stats_request(&request, &osm->header);
2484     if (error) {
2485         return error;
2486     }
2487
2488     error = collect_rules_loose(ofproto, request.table_id, &request.match,
2489                                 request.cookie, request.cookie_mask,
2490                                 request.out_port, &rules);
2491     if (error) {
2492         return error;
2493     }
2494
2495     memset(&stats, 0, sizeof stats);
2496     unknown_packets = unknown_bytes = false;
2497     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2498         uint64_t packet_count;
2499         uint64_t byte_count;
2500
2501         ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2502                                                &byte_count);
2503
2504         if (packet_count == UINT64_MAX) {
2505             unknown_packets = true;
2506         } else {
2507             stats.packet_count += packet_count;
2508         }
2509
2510         if (byte_count == UINT64_MAX) {
2511             unknown_bytes = true;
2512         } else {
2513             stats.byte_count += byte_count;
2514         }
2515
2516         stats.flow_count++;
2517     }
2518     if (unknown_packets) {
2519         stats.packet_count = UINT64_MAX;
2520     }
2521     if (unknown_bytes) {
2522         stats.byte_count = UINT64_MAX;
2523     }
2524
2525     reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2526     ofconn_send_reply(ofconn, reply);
2527
2528     return 0;
2529 }
2530
2531 struct queue_stats_cbdata {
2532     struct ofport *ofport;
2533     struct list replies;
2534 };
2535
2536 static void
2537 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2538                 const struct netdev_queue_stats *stats)
2539 {
2540     struct ofp_queue_stats *reply;
2541
2542     reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2543     reply->port_no = htons(cbdata->ofport->pp.port_no);
2544     memset(reply->pad, 0, sizeof reply->pad);
2545     reply->queue_id = htonl(queue_id);
2546     put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2547     put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2548     put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2549 }
2550
2551 static void
2552 handle_queue_stats_dump_cb(uint32_t queue_id,
2553                            struct netdev_queue_stats *stats,
2554                            void *cbdata_)
2555 {
2556     struct queue_stats_cbdata *cbdata = cbdata_;
2557
2558     put_queue_stats(cbdata, queue_id, stats);
2559 }
2560
2561 static void
2562 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2563                             struct queue_stats_cbdata *cbdata)
2564 {
2565     cbdata->ofport = port;
2566     if (queue_id == OFPQ_ALL) {
2567         netdev_dump_queue_stats(port->netdev,
2568                                 handle_queue_stats_dump_cb, cbdata);
2569     } else {
2570         struct netdev_queue_stats stats;
2571
2572         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2573             put_queue_stats(cbdata, queue_id, &stats);
2574         }
2575     }
2576 }
2577
2578 static enum ofperr
2579 handle_queue_stats_request(struct ofconn *ofconn,
2580                            const struct ofp_queue_stats_request *qsr)
2581 {
2582     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2583     struct queue_stats_cbdata cbdata;
2584     struct ofport *port;
2585     unsigned int port_no;
2586     uint32_t queue_id;
2587
2588     COVERAGE_INC(ofproto_queue_req);
2589
2590     ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2591
2592     port_no = ntohs(qsr->port_no);
2593     queue_id = ntohl(qsr->queue_id);
2594     if (port_no == OFPP_ALL) {
2595         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2596             handle_queue_stats_for_port(port, queue_id, &cbdata);
2597         }
2598     } else if (port_no < OFPP_MAX) {
2599         port = ofproto_get_port(ofproto, port_no);
2600         if (port) {
2601             handle_queue_stats_for_port(port, queue_id, &cbdata);
2602         }
2603     } else {
2604         ofpbuf_list_delete(&cbdata.replies);
2605         return OFPERR_OFPQOFC_BAD_PORT;
2606     }
2607     ofconn_send_replies(ofconn, &cbdata.replies);
2608
2609     return 0;
2610 }
2611
2612 static bool
2613 is_flow_deletion_pending(const struct ofproto *ofproto,
2614                          const struct cls_rule *cls_rule,
2615                          uint8_t table_id)
2616 {
2617     if (!hmap_is_empty(&ofproto->deletions)) {
2618         struct ofoperation *op;
2619
2620         HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2621                                  cls_rule_hash(cls_rule, table_id),
2622                                  &ofproto->deletions) {
2623             if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2624                 return true;
2625             }
2626         }
2627     }
2628
2629     return false;
2630 }
2631
2632 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2633  * in which no matching flow already exists in the flow table.
2634  *
2635  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2636  * ofp_actions, to the ofproto's flow table.  Returns 0 on success, an OpenFlow
2637  * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
2638  * initiated now but may be retried later.
2639  *
2640  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2641  * if any. */
2642 static enum ofperr
2643 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2644          const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2645 {
2646     struct oftable *table;
2647     struct ofopgroup *group;
2648     struct rule *victim;
2649     struct rule *rule;
2650     int error;
2651
2652     error = check_table_id(ofproto, fm->table_id);
2653     if (error) {
2654         return error;
2655     }
2656
2657     /* Pick table. */
2658     if (fm->table_id == 0xff) {
2659         uint8_t table_id;
2660         if (ofproto->ofproto_class->rule_choose_table) {
2661             error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2662                                                               &table_id);
2663             if (error) {
2664                 return error;
2665             }
2666             assert(table_id < ofproto->n_tables);
2667             table = &ofproto->tables[table_id];
2668         } else {
2669             table = &ofproto->tables[0];
2670         }
2671     } else if (fm->table_id < ofproto->n_tables) {
2672         table = &ofproto->tables[fm->table_id];
2673     } else {
2674         return OFPERR_NXFMFC_BAD_TABLE_ID;
2675     }
2676
2677     if (table->flags & OFTABLE_READONLY) {
2678         return OFPERR_OFPBRC_EPERM;
2679     }
2680
2681     /* Check for overlap, if requested. */
2682     if (fm->flags & OFPFF_CHECK_OVERLAP
2683         && classifier_rule_overlaps(&table->cls, &fm->cr)) {
2684         return OFPERR_OFPFMFC_OVERLAP;
2685     }
2686
2687     /* Serialize against pending deletion. */
2688     if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2689         return OFPROTO_POSTPONE;
2690     }
2691
2692     /* Allocate new rule. */
2693     rule = ofproto->ofproto_class->rule_alloc();
2694     if (!rule) {
2695         VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2696                      ofproto->name, strerror(error));
2697         return ENOMEM;
2698     }
2699     rule->ofproto = ofproto;
2700     rule->cr = fm->cr;
2701     rule->pending = NULL;
2702     rule->flow_cookie = fm->cookie;
2703     rule->created = rule->modified = rule->used = time_msec();
2704     rule->idle_timeout = fm->idle_timeout;
2705     rule->hard_timeout = fm->hard_timeout;
2706     rule->table_id = table - ofproto->tables;
2707     rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2708     rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2709     rule->n_actions = fm->n_actions;
2710     rule->evictable = true;
2711     rule->eviction_group = NULL;
2712
2713     /* Insert new rule. */
2714     victim = oftable_replace_rule(rule);
2715     if (victim && !rule_is_modifiable(victim)) {
2716         error = OFPERR_OFPBRC_EPERM;
2717     } else if (victim && victim->pending) {
2718         error = OFPROTO_POSTPONE;
2719     } else {
2720         struct rule *evict;
2721
2722         if (classifier_count(&table->cls) > table->max_flows) {
2723             bool was_evictable;
2724
2725             was_evictable = rule->evictable;
2726             rule->evictable = false;
2727             evict = choose_rule_to_evict(table);
2728             rule->evictable = was_evictable;
2729
2730             if (!evict) {
2731                 error = OFPERR_OFPFMFC_ALL_TABLES_FULL;
2732                 goto exit;
2733             } else if (evict->pending) {
2734                 error = OFPROTO_POSTPONE;
2735                 goto exit;
2736             }
2737         } else {
2738             evict = NULL;
2739         }
2740
2741         group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2742         ofoperation_create(group, rule, OFOPERATION_ADD);
2743         rule->pending->victim = victim;
2744
2745         error = ofproto->ofproto_class->rule_construct(rule);
2746         if (error) {
2747             ofoperation_destroy(rule->pending);
2748         } else if (evict) {
2749             delete_flow__(evict, group);
2750         }
2751         ofopgroup_submit(group);
2752     }
2753
2754 exit:
2755     /* Back out if an error occurred. */
2756     if (error) {
2757         oftable_substitute_rule(rule, victim);
2758         ofproto_rule_destroy__(rule);
2759     }
2760     return error;
2761 }
2762 \f
2763 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2764
2765 /* Modifies the rules listed in 'rules', changing their actions to match those
2766  * in 'fm'.
2767  *
2768  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2769  * if any.
2770  *
2771  * Returns 0 on success, otherwise an OpenFlow error code. */
2772 static enum ofperr
2773 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2774                const struct ofputil_flow_mod *fm,
2775                const struct ofp_header *request, struct list *rules)
2776 {
2777     struct ofopgroup *group;
2778     struct rule *rule;
2779     enum ofperr error;
2780
2781     group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2782     error = OFPERR_OFPBRC_EPERM;
2783     LIST_FOR_EACH (rule, ofproto_node, rules) {
2784         if (rule_is_modifiable(rule)) {
2785             /* At least one rule is modifiable, don't report EPERM error. */
2786             error = 0;
2787         } else {
2788             continue;
2789         }
2790
2791         if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2792                                    rule->actions, rule->n_actions)) {
2793             ofoperation_create(group, rule, OFOPERATION_MODIFY);
2794             rule->pending->actions = rule->actions;
2795             rule->pending->n_actions = rule->n_actions;
2796             rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2797             rule->n_actions = fm->n_actions;
2798             ofproto->ofproto_class->rule_modify_actions(rule);
2799         } else {
2800             rule->modified = time_msec();
2801         }
2802         rule->flow_cookie = fm->cookie;
2803     }
2804     ofopgroup_submit(group);
2805
2806     return error;
2807 }
2808
2809 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code on
2810  * failure.
2811  *
2812  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2813  * if any. */
2814 static enum ofperr
2815 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2816                    const struct ofputil_flow_mod *fm,
2817                    const struct ofp_header *request)
2818 {
2819     struct list rules;
2820     int error;
2821
2822     error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2823                                 fm->cookie, fm->cookie_mask,
2824                                 OFPP_NONE, &rules);
2825     return (error ? error
2826             : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2827             : modify_flows__(ofproto, ofconn, fm, request, &rules));
2828 }
2829
2830 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
2831  * code on failure.
2832  *
2833  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2834  * if any. */
2835 static enum ofperr
2836 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2837                    const struct ofputil_flow_mod *fm,
2838                    const struct ofp_header *request)
2839 {
2840     struct list rules;
2841     int error;
2842
2843     error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2844                                  fm->cookie, fm->cookie_mask,
2845                                  OFPP_NONE, &rules);
2846     return (error ? error
2847             : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2848             : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2849                                                          fm, request, &rules)
2850             : 0);
2851 }
2852 \f
2853 /* OFPFC_DELETE implementation. */
2854
2855 static void
2856 delete_flow__(struct rule *rule, struct ofopgroup *group)
2857 {
2858     struct ofproto *ofproto = rule->ofproto;
2859
2860     ofproto_rule_send_removed(rule, OFPRR_DELETE);
2861
2862     ofoperation_create(group, rule, OFOPERATION_DELETE);
2863     oftable_remove_rule(rule);
2864     ofproto->ofproto_class->rule_destruct(rule);
2865 }
2866
2867 /* Deletes the rules listed in 'rules'.
2868  *
2869  * Returns 0 on success, otherwise an OpenFlow error code. */
2870 static enum ofperr
2871 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2872                const struct ofp_header *request, struct list *rules)
2873 {
2874     struct rule *rule, *next;
2875     struct ofopgroup *group;
2876
2877     group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2878     LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2879         delete_flow__(rule, group);
2880     }
2881     ofopgroup_submit(group);
2882
2883     return 0;
2884 }
2885
2886 /* Implements OFPFC_DELETE. */
2887 static enum ofperr
2888 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2889                    const struct ofputil_flow_mod *fm,
2890                    const struct ofp_header *request)
2891 {
2892     struct list rules;
2893     enum ofperr error;
2894
2895     error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2896                                 fm->cookie, fm->cookie_mask,
2897                                 fm->out_port, &rules);
2898     return (error ? error
2899             : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2900                                                       &rules)
2901             : 0);
2902 }
2903
2904 /* Implements OFPFC_DELETE_STRICT. */
2905 static enum ofperr
2906 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2907                    const struct ofputil_flow_mod *fm,
2908                    const struct ofp_header *request)
2909 {
2910     struct list rules;
2911     enum ofperr error;
2912
2913     error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2914                                  fm->cookie, fm->cookie_mask,
2915                                  fm->out_port, &rules);
2916     return (error ? error
2917             : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2918                                                          request, &rules)
2919             : 0);
2920 }
2921
2922 static void
2923 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2924 {
2925     struct ofputil_flow_removed fr;
2926
2927     if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2928         return;
2929     }
2930
2931     fr.rule = rule->cr;
2932     fr.cookie = rule->flow_cookie;
2933     fr.reason = reason;
2934     calc_flow_duration__(rule->created, time_msec(),
2935                          &fr.duration_sec, &fr.duration_nsec);
2936     fr.idle_timeout = rule->idle_timeout;
2937     rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2938                                                  &fr.byte_count);
2939
2940     connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2941 }
2942
2943 void
2944 ofproto_rule_update_used(struct rule *rule, long long int used)
2945 {
2946     if (used > rule->used) {
2947         struct eviction_group *evg = rule->eviction_group;
2948
2949         rule->used = used;
2950         if (evg) {
2951             heap_change(&evg->rules, &rule->evg_node,
2952                         rule_eviction_priority(rule));
2953         }
2954     }
2955 }
2956
2957 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2958  * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2959  * ofproto.
2960  *
2961  * ofproto implementation ->run() functions should use this function to expire
2962  * OpenFlow flows. */
2963 void
2964 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2965 {
2966     struct ofproto *ofproto = rule->ofproto;
2967     struct ofopgroup *group;
2968
2969     assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2970
2971     ofproto_rule_send_removed(rule, reason);
2972
2973     group = ofopgroup_create_unattached(ofproto);
2974     ofoperation_create(group, rule, OFOPERATION_DELETE);
2975     oftable_remove_rule(rule);
2976     ofproto->ofproto_class->rule_destruct(rule);
2977     ofopgroup_submit(group);
2978 }
2979 \f
2980 static enum ofperr
2981 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2982 {
2983     struct ofputil_flow_mod fm;
2984     enum ofperr error;
2985
2986     error = reject_slave_controller(ofconn);
2987     if (error) {
2988         return error;
2989     }
2990
2991     error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn));
2992     if (error) {
2993         return error;
2994     }
2995
2996     /* We do not support the emergency flow cache.  It will hopefully get
2997      * dropped from OpenFlow in the near future. */
2998     if (fm.flags & OFPFF_EMERG) {
2999         /* There isn't a good fit for an error code, so just state that the
3000          * flow table is full. */
3001         return OFPERR_OFPFMFC_ALL_TABLES_FULL;
3002     }
3003
3004     return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
3005 }
3006
3007 static enum ofperr
3008 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3009                   const struct ofputil_flow_mod *fm,
3010                   const struct ofp_header *oh)
3011 {
3012     if (ofproto->n_pending >= 50) {
3013         assert(!list_is_empty(&ofproto->pending));
3014         return OFPROTO_POSTPONE;
3015     }
3016
3017     switch (fm->command) {
3018     case OFPFC_ADD:
3019         return add_flow(ofproto, ofconn, fm, oh);
3020
3021     case OFPFC_MODIFY:
3022         return modify_flows_loose(ofproto, ofconn, fm, oh);
3023
3024     case OFPFC_MODIFY_STRICT:
3025         return modify_flow_strict(ofproto, ofconn, fm, oh);
3026
3027     case OFPFC_DELETE:
3028         return delete_flows_loose(ofproto, ofconn, fm, oh);
3029
3030     case OFPFC_DELETE_STRICT:
3031         return delete_flow_strict(ofproto, ofconn, fm, oh);
3032
3033     default:
3034         if (fm->command > 0xff) {
3035             VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
3036                          "flow_mod_table_id extension is not enabled");
3037         }
3038         return OFPERR_OFPFMFC_BAD_COMMAND;
3039     }
3040 }
3041
3042 static enum ofperr
3043 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3044 {
3045     struct nx_role_request *nrr = (struct nx_role_request *) oh;
3046     struct nx_role_request *reply;
3047     struct ofpbuf *buf;
3048     uint32_t role;
3049
3050     role = ntohl(nrr->role);
3051     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
3052         && role != NX_ROLE_SLAVE) {
3053         return OFPERR_NXBRC_BAD_ROLE;
3054     }
3055
3056     if (ofconn_get_role(ofconn) != role
3057         && ofconn_has_pending_opgroups(ofconn)) {
3058         return OFPROTO_POSTPONE;
3059     }
3060
3061     ofconn_set_role(ofconn, role);
3062
3063     reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
3064     reply->role = htonl(role);
3065     ofconn_send_reply(ofconn, buf);
3066
3067     return 0;
3068 }
3069
3070 static enum ofperr
3071 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3072                              const struct ofp_header *oh)
3073 {
3074     const struct nx_flow_mod_table_id *msg
3075         = (const struct nx_flow_mod_table_id *) oh;
3076     enum ofputil_protocol cur, next;
3077
3078     cur = ofconn_get_protocol(ofconn);
3079     next = ofputil_protocol_set_tid(cur, msg->set != 0);
3080     ofconn_set_protocol(ofconn, next);
3081
3082     return 0;
3083 }
3084
3085 static enum ofperr
3086 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3087 {
3088     const struct nx_set_flow_format *msg
3089         = (const struct nx_set_flow_format *) oh;
3090     enum ofputil_protocol cur, next;
3091     enum ofputil_protocol next_base;
3092
3093     next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3094     if (!next_base) {
3095         return OFPERR_OFPBRC_EPERM;
3096     }
3097
3098     cur = ofconn_get_protocol(ofconn);
3099     next = ofputil_protocol_set_base(cur, next_base);
3100     if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3101         /* Avoid sending async messages in surprising protocol. */
3102         return OFPROTO_POSTPONE;
3103     }
3104
3105     ofconn_set_protocol(ofconn, next);
3106     return 0;
3107 }
3108
3109 static enum ofperr
3110 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3111                                 const struct ofp_header *oh)
3112 {
3113     const struct nx_set_packet_in_format *msg;
3114     uint32_t format;
3115
3116     msg = (const struct nx_set_packet_in_format *) oh;
3117     format = ntohl(msg->format);
3118     if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3119         return OFPERR_OFPBRC_EPERM;
3120     }
3121
3122     if (format != ofconn_get_packet_in_format(ofconn)
3123         && ofconn_has_pending_opgroups(ofconn)) {
3124         /* Avoid sending async message in surprsing packet in format. */
3125         return OFPROTO_POSTPONE;
3126     }
3127
3128     ofconn_set_packet_in_format(ofconn, format);
3129     return 0;
3130 }
3131
3132 static enum ofperr
3133 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3134 {
3135     const struct nx_async_config *msg = (const struct nx_async_config *) oh;
3136     uint32_t master[OAM_N_TYPES];
3137     uint32_t slave[OAM_N_TYPES];
3138
3139     master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3140     master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3141     master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3142
3143     slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3144     slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3145     slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3146
3147     ofconn_set_async_config(ofconn, master, slave);
3148
3149     return 0;
3150 }
3151
3152 static enum ofperr
3153 handle_nxt_set_controller_id(struct ofconn *ofconn,
3154                              const struct ofp_header *oh)
3155 {
3156     const struct nx_controller_id *nci;
3157
3158     nci = (const struct nx_controller_id *) oh;
3159     if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3160         return OFPERR_NXBRC_MUST_BE_ZERO;
3161     }
3162
3163     ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3164     return 0;
3165 }
3166
3167 static enum ofperr
3168 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3169 {
3170     struct ofp_header *ob;
3171     struct ofpbuf *buf;
3172
3173     if (ofconn_has_pending_opgroups(ofconn)) {
3174         return OFPROTO_POSTPONE;
3175     }
3176
3177     ob = make_openflow_xid(sizeof *ob, OFPT10_BARRIER_REPLY, oh->xid, &buf);
3178     ofconn_send_reply(ofconn, buf);
3179     return 0;
3180 }
3181
3182 static enum ofperr
3183 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
3184 {
3185     const struct ofp_header *oh = msg->data;
3186     const struct ofputil_msg_type *type;
3187     enum ofperr error;
3188
3189     error = ofputil_decode_msg_type(oh, &type);
3190     if (error) {
3191         return error;
3192     }
3193
3194     switch (ofputil_msg_type_code(type)) {
3195         /* OpenFlow requests. */
3196     case OFPUTIL_OFPT_ECHO_REQUEST:
3197         return handle_echo_request(ofconn, oh);
3198
3199     case OFPUTIL_OFPT_FEATURES_REQUEST:
3200         return handle_features_request(ofconn, oh);
3201
3202     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
3203         return handle_get_config_request(ofconn, oh);
3204
3205     case OFPUTIL_OFPT_SET_CONFIG:
3206         return handle_set_config(ofconn, msg->data);
3207
3208     case OFPUTIL_OFPT_PACKET_OUT:
3209         return handle_packet_out(ofconn, msg->data);
3210
3211     case OFPUTIL_OFPT_PORT_MOD:
3212         return handle_port_mod(ofconn, oh);
3213
3214     case OFPUTIL_OFPT_FLOW_MOD:
3215         return handle_flow_mod(ofconn, oh);
3216
3217     case OFPUTIL_OFPT_BARRIER_REQUEST:
3218         return handle_barrier_request(ofconn, oh);
3219
3220         /* OpenFlow replies. */
3221     case OFPUTIL_OFPT_ECHO_REPLY:
3222         return 0;
3223
3224         /* Nicira extension requests. */
3225     case OFPUTIL_NXT_ROLE_REQUEST:
3226         return handle_role_request(ofconn, oh);
3227
3228     case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
3229         return handle_nxt_flow_mod_table_id(ofconn, oh);
3230
3231     case OFPUTIL_NXT_SET_FLOW_FORMAT:
3232         return handle_nxt_set_flow_format(ofconn, oh);
3233
3234     case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
3235         return handle_nxt_set_packet_in_format(ofconn, oh);
3236
3237     case OFPUTIL_NXT_SET_CONTROLLER_ID:
3238         return handle_nxt_set_controller_id(ofconn, oh);
3239
3240     case OFPUTIL_NXT_FLOW_MOD:
3241         return handle_flow_mod(ofconn, oh);
3242
3243     case OFPUTIL_NXT_FLOW_AGE:
3244         /* Nothing to do. */
3245         return 0;
3246
3247     case OFPUTIL_NXT_SET_ASYNC_CONFIG:
3248         return handle_nxt_set_async_config(ofconn, oh);
3249
3250         /* Statistics requests. */
3251     case OFPUTIL_OFPST_DESC_REQUEST:
3252         return handle_desc_stats_request(ofconn, msg->data);
3253
3254     case OFPUTIL_OFPST_FLOW_REQUEST:
3255     case OFPUTIL_NXST_FLOW_REQUEST:
3256         return handle_flow_stats_request(ofconn, msg->data);
3257
3258     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
3259     case OFPUTIL_NXST_AGGREGATE_REQUEST:
3260         return handle_aggregate_stats_request(ofconn, msg->data);
3261
3262     case OFPUTIL_OFPST_TABLE_REQUEST:
3263         return handle_table_stats_request(ofconn, msg->data);
3264
3265     case OFPUTIL_OFPST_PORT_REQUEST:
3266         return handle_port_stats_request(ofconn, msg->data);
3267
3268     case OFPUTIL_OFPST_QUEUE_REQUEST:
3269         return handle_queue_stats_request(ofconn, msg->data);
3270
3271     case OFPUTIL_MSG_INVALID:
3272     case OFPUTIL_OFPT_HELLO:
3273     case OFPUTIL_OFPT_ERROR:
3274     case OFPUTIL_OFPT_FEATURES_REPLY:
3275     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
3276     case OFPUTIL_OFPT_PACKET_IN:
3277     case OFPUTIL_OFPT_FLOW_REMOVED:
3278     case OFPUTIL_OFPT_PORT_STATUS:
3279     case OFPUTIL_OFPT_BARRIER_REPLY:
3280     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
3281     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
3282     case OFPUTIL_OFPST_DESC_REPLY:
3283     case OFPUTIL_OFPST_FLOW_REPLY:
3284     case OFPUTIL_OFPST_QUEUE_REPLY:
3285     case OFPUTIL_OFPST_PORT_REPLY:
3286     case OFPUTIL_OFPST_TABLE_REPLY:
3287     case OFPUTIL_OFPST_AGGREGATE_REPLY:
3288     case OFPUTIL_NXT_ROLE_REPLY:
3289     case OFPUTIL_NXT_FLOW_REMOVED:
3290     case OFPUTIL_NXT_PACKET_IN:
3291     case OFPUTIL_NXST_FLOW_REPLY:
3292     case OFPUTIL_NXST_AGGREGATE_REPLY:
3293     default:
3294         return (oh->type == OFPT10_STATS_REQUEST ||
3295                 oh->type == OFPT10_STATS_REPLY
3296                 ? OFPERR_OFPBRC_BAD_STAT
3297                 : OFPERR_OFPBRC_BAD_TYPE);
3298     }
3299 }
3300
3301 static bool
3302 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
3303 {
3304     int error = handle_openflow__(ofconn, ofp_msg);
3305     if (error && error != OFPROTO_POSTPONE) {
3306         ofconn_send_error(ofconn, ofp_msg->data, error);
3307     }
3308     COVERAGE_INC(ofproto_recv_openflow);
3309     return error != OFPROTO_POSTPONE;
3310 }
3311 \f
3312 /* Asynchronous operations. */
3313
3314 /* Creates and returns a new ofopgroup that is not associated with any
3315  * OpenFlow connection.
3316  *
3317  * The caller should add operations to the returned group with
3318  * ofoperation_create() and then submit it with ofopgroup_submit(). */
3319 static struct ofopgroup *
3320 ofopgroup_create_unattached(struct ofproto *ofproto)
3321 {
3322     struct ofopgroup *group = xzalloc(sizeof *group);
3323     group->ofproto = ofproto;
3324     list_init(&group->ofproto_node);
3325     list_init(&group->ops);
3326     list_init(&group->ofconn_node);
3327     return group;
3328 }
3329
3330 /* Creates and returns a new ofopgroup for 'ofproto'.
3331  *
3332  * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3333  * connection.  The 'request' and 'buffer_id' arguments are ignored.
3334  *
3335  * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3336  * If the ofopgroup eventually fails, then the error reply will include
3337  * 'request'.  If the ofopgroup eventually succeeds, then the packet with
3338  * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3339  *
3340  * The caller should add operations to the returned group with
3341  * ofoperation_create() and then submit it with ofopgroup_submit(). */
3342 static struct ofopgroup *
3343 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
3344                  const struct ofp_header *request, uint32_t buffer_id)
3345 {
3346     struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3347     if (ofconn) {
3348         size_t request_len = ntohs(request->length);
3349
3350         assert(ofconn_get_ofproto(ofconn) == ofproto);
3351
3352         ofconn_add_opgroup(ofconn, &group->ofconn_node);
3353         group->ofconn = ofconn;
3354         group->request = xmemdup(request, MIN(request_len, 64));
3355         group->buffer_id = buffer_id;
3356     }
3357     return group;
3358 }
3359
3360 /* Submits 'group' for processing.
3361  *
3362  * If 'group' contains no operations (e.g. none were ever added, or all of the
3363  * ones that were added completed synchronously), then it is destroyed
3364  * immediately.  Otherwise it is added to the ofproto's list of pending
3365  * groups. */
3366 static void
3367 ofopgroup_submit(struct ofopgroup *group)
3368 {
3369     if (list_is_empty(&group->ops)) {
3370         ofopgroup_destroy(group);
3371     } else {
3372         list_push_back(&group->ofproto->pending, &group->ofproto_node);
3373         group->ofproto->n_pending++;
3374     }
3375 }
3376
3377 static void
3378 ofopgroup_destroy(struct ofopgroup *group)
3379 {
3380     assert(list_is_empty(&group->ops));
3381     if (!list_is_empty(&group->ofproto_node)) {
3382         assert(group->ofproto->n_pending > 0);
3383         group->ofproto->n_pending--;
3384         list_remove(&group->ofproto_node);
3385     }
3386     if (!list_is_empty(&group->ofconn_node)) {
3387         list_remove(&group->ofconn_node);
3388         if (group->error) {
3389             ofconn_send_error(group->ofconn, group->request, group->error);
3390         }
3391         connmgr_retry(group->ofproto->connmgr);
3392     }
3393     free(group->request);
3394     free(group);
3395 }
3396
3397 /* Initiates a new operation on 'rule', of the specified 'type', within
3398  * 'group'.  Prior to calling, 'rule' must not have any pending operation. */
3399 static void
3400 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3401                    enum ofoperation_type type)
3402 {
3403     struct ofoperation *op;
3404
3405     assert(!rule->pending);
3406
3407     op = rule->pending = xzalloc(sizeof *op);
3408     op->group = group;
3409     list_push_back(&group->ops, &op->group_node);
3410     op->rule = rule;
3411     op->type = type;
3412     op->status = -1;
3413     op->flow_cookie = rule->flow_cookie;
3414
3415     if (type == OFOPERATION_DELETE) {
3416         hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3417                     cls_rule_hash(&rule->cr, rule->table_id));
3418     }
3419 }
3420
3421 static void
3422 ofoperation_destroy(struct ofoperation *op)
3423 {
3424     struct ofopgroup *group = op->group;
3425
3426     if (op->rule) {
3427         op->rule->pending = NULL;
3428     }
3429     if (op->type == OFOPERATION_DELETE) {
3430         hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3431     }
3432     list_remove(&op->group_node);
3433     free(op->actions);
3434     free(op);
3435
3436     if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3437         ofopgroup_destroy(group);
3438     }
3439 }
3440
3441 /* Indicates that 'op' completed with status 'error', which is either 0 to
3442  * indicate success or an OpenFlow error code on failure.
3443  *
3444  * If 'error' is 0, indicating success, the operation will be committed
3445  * permanently to the flow table.  There is one interesting subcase:
3446  *
3447  *   - If 'op' is an "add flow" operation that is replacing an existing rule in
3448  *     the flow table (the "victim" rule) by a new one, then the caller must
3449  *     have uninitialized any derived state in the victim rule, as in step 5 in
3450  *     the "Life Cycle" in ofproto/ofproto-provider.h.  ofoperation_complete()
3451  *     performs steps 6 and 7 for the victim rule, most notably by calling its
3452  *     ->rule_dealloc() function.
3453  *
3454  * If 'error' is nonzero, then generally the operation will be rolled back:
3455  *
3456  *   - If 'op' is an "add flow" operation, ofproto removes the new rule or
3457  *     restores the original rule.  The caller must have uninitialized any
3458  *     derived state in the new rule, as in step 5 of in the "Life Cycle" in
3459  *     ofproto/ofproto-provider.h.  ofoperation_complete() performs steps 6 and
3460  *     and 7 for the new rule, calling its ->rule_dealloc() function.
3461  *
3462  *   - If 'op' is a "modify flow" operation, ofproto restores the original
3463  *     actions.
3464  *
3465  *   - 'op' must not be a "delete flow" operation.  Removing a rule is not
3466  *     allowed to fail.  It must always succeed.
3467  *
3468  * Please see the large comment in ofproto/ofproto-provider.h titled
3469  * "Asynchronous Operation Support" for more information. */
3470 void
3471 ofoperation_complete(struct ofoperation *op, enum ofperr error)
3472 {
3473     struct ofopgroup *group = op->group;
3474     struct rule *rule = op->rule;
3475     struct ofproto *ofproto = rule->ofproto;
3476
3477     assert(rule->pending == op);
3478     assert(op->status < 0);
3479
3480     if (!error
3481         && !group->error
3482         && op->type != OFOPERATION_DELETE
3483         && group->ofconn
3484         && group->buffer_id != UINT32_MAX
3485         && list_is_singleton(&op->group_node)) {
3486         struct ofpbuf *packet;
3487         uint16_t in_port;
3488
3489         error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3490                                        &packet, &in_port);
3491         if (packet) {
3492             assert(!error);
3493             error = rule_execute(rule, in_port, packet);
3494         }
3495     }
3496     if (!group->error) {
3497         group->error = error;
3498     }
3499
3500     switch (op->type) {
3501     case OFOPERATION_ADD:
3502         if (!error) {
3503             ofproto_rule_destroy__(op->victim);
3504             if ((rule->cr.wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3505                 == htons(VLAN_VID_MASK)) {
3506                 if (ofproto->vlan_bitmap) {
3507                     uint16_t vid = vlan_tci_to_vid(rule->cr.flow.vlan_tci);
3508
3509                     if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
3510                         bitmap_set1(ofproto->vlan_bitmap, vid);
3511                         ofproto->vlans_changed = true;
3512                     }
3513                 } else {
3514                     ofproto->vlans_changed = true;
3515                 }
3516             }
3517         } else {
3518             oftable_substitute_rule(rule, op->victim);
3519             ofproto_rule_destroy__(rule);
3520         }
3521         break;
3522
3523     case OFOPERATION_DELETE:
3524         assert(!error);
3525         ofproto_rule_destroy__(rule);
3526         op->rule = NULL;
3527         break;
3528
3529     case OFOPERATION_MODIFY:
3530         if (!error) {
3531             rule->modified = time_msec();
3532         } else {
3533             free(rule->actions);
3534             rule->actions = op->actions;
3535             rule->n_actions = op->n_actions;
3536             op->actions = NULL;
3537         }
3538         break;
3539
3540     default:
3541         NOT_REACHED();
3542     }
3543     ofoperation_destroy(op);
3544 }
3545
3546 struct rule *
3547 ofoperation_get_victim(struct ofoperation *op)
3548 {
3549     assert(op->type == OFOPERATION_ADD);
3550     return op->victim;
3551 }
3552 \f
3553 static uint64_t
3554 pick_datapath_id(const struct ofproto *ofproto)
3555 {
3556     const struct ofport *port;
3557
3558     port = ofproto_get_port(ofproto, OFPP_LOCAL);
3559     if (port) {
3560         uint8_t ea[ETH_ADDR_LEN];
3561         int error;
3562
3563         error = netdev_get_etheraddr(port->netdev, ea);
3564         if (!error) {
3565             return eth_addr_to_uint64(ea);
3566         }
3567         VLOG_WARN("could not get MAC address for %s (%s)",
3568                   netdev_get_name(port->netdev), strerror(error));
3569     }
3570     return ofproto->fallback_dpid;
3571 }
3572
3573 static uint64_t
3574 pick_fallback_dpid(void)
3575 {
3576     uint8_t ea[ETH_ADDR_LEN];
3577     eth_addr_nicira_random(ea);
3578     return eth_addr_to_uint64(ea);
3579 }
3580 \f
3581 /* Table overflow policy. */
3582
3583 /* Chooses and returns a rule to evict from 'table'.  Returns NULL if the table
3584  * is not configured to evict rules or if the table contains no evictable
3585  * rules.  (Rules with 'evictable' set to false or with no timeouts are not
3586  * evictable.) */
3587 static struct rule *
3588 choose_rule_to_evict(struct oftable *table)
3589 {
3590     struct eviction_group *evg;
3591
3592     if (!table->eviction_fields) {
3593         return NULL;
3594     }
3595
3596     /* In the common case, the outer and inner loops here will each be entered
3597      * exactly once:
3598      *
3599      *   - The inner loop normally "return"s in its first iteration.  If the
3600      *     eviction group has any evictable rules, then it always returns in
3601      *     some iteration.
3602      *
3603      *   - The outer loop only iterates more than once if the largest eviction
3604      *     group has no evictable rules.
3605      *
3606      *   - The outer loop can exit only if table's 'max_flows' is all filled up
3607      *     by unevictable rules'. */
3608     HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
3609         struct rule *rule;
3610
3611         HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
3612             if (rule->evictable) {
3613                 return rule;
3614             }
3615         }
3616     }
3617
3618     return NULL;
3619 }
3620
3621 /* Searches 'ofproto' for tables that have more flows than their configured
3622  * maximum and that have flow eviction enabled, and evicts as many flows as
3623  * necessary and currently feasible from them.
3624  *
3625  * This triggers only when an OpenFlow table has N flows in it and then the
3626  * client configures a maximum number of flows less than N. */
3627 static void
3628 ofproto_evict(struct ofproto *ofproto)
3629 {
3630     struct ofopgroup *group;
3631     struct oftable *table;
3632
3633     group = ofopgroup_create_unattached(ofproto);
3634     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
3635         while (classifier_count(&table->cls) > table->max_flows
3636                && table->eviction_fields) {
3637             struct rule *rule;
3638
3639             rule = choose_rule_to_evict(table);
3640             if (!rule || rule->pending) {
3641                 break;
3642             }
3643
3644             ofoperation_create(group, rule, OFOPERATION_DELETE);
3645             oftable_remove_rule(rule);
3646             ofproto->ofproto_class->rule_destruct(rule);
3647         }
3648     }
3649     ofopgroup_submit(group);
3650 }
3651 \f
3652 /* Eviction groups. */
3653
3654 /* Returns the priority to use for an eviction_group that contains 'n_rules'
3655  * rules.  The priority contains low-order random bits to ensure that eviction
3656  * groups with the same number of rules are prioritized randomly. */
3657 static uint32_t
3658 eviction_group_priority(size_t n_rules)
3659 {
3660     uint16_t size = MIN(UINT16_MAX, n_rules);
3661     return (size << 16) | random_uint16();
3662 }
3663
3664 /* Updates 'evg', an eviction_group within 'table', following a change that
3665  * adds or removes rules in 'evg'. */
3666 static void
3667 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
3668 {
3669     heap_change(&table->eviction_groups_by_size, &evg->size_node,
3670                 eviction_group_priority(heap_count(&evg->rules)));
3671 }
3672
3673 /* Destroys 'evg', an eviction_group within 'table':
3674  *
3675  *   - Removes all the rules, if any, from 'evg'.  (It doesn't destroy the
3676  *     rules themselves, just removes them from the eviction group.)
3677  *
3678  *   - Removes 'evg' from 'table'.
3679  *
3680  *   - Frees 'evg'. */
3681 static void
3682 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
3683 {
3684     while (!heap_is_empty(&evg->rules)) {
3685         struct rule *rule;
3686
3687         rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
3688         rule->eviction_group = NULL;
3689     }
3690     hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
3691     heap_remove(&table->eviction_groups_by_size, &evg->size_node);
3692     heap_destroy(&evg->rules);
3693     free(evg);
3694 }
3695
3696 /* Removes 'rule' from its eviction group, if any. */
3697 static void
3698 eviction_group_remove_rule(struct rule *rule)
3699 {
3700     if (rule->eviction_group) {
3701         struct oftable *table = &rule->ofproto->tables[rule->table_id];
3702         struct eviction_group *evg = rule->eviction_group;
3703
3704         rule->eviction_group = NULL;
3705         heap_remove(&evg->rules, &rule->evg_node);
3706         if (heap_is_empty(&evg->rules)) {
3707             eviction_group_destroy(table, evg);
3708         } else {
3709             eviction_group_resized(table, evg);
3710         }
3711     }
3712 }
3713
3714 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
3715  * returns the hash value. */
3716 static uint32_t
3717 eviction_group_hash_rule(struct rule *rule)
3718 {
3719     struct oftable *table = &rule->ofproto->tables[rule->table_id];
3720     const struct mf_subfield *sf;
3721     uint32_t hash;
3722
3723     hash = table->eviction_group_id_basis;
3724     for (sf = table->eviction_fields;
3725          sf < &table->eviction_fields[table->n_eviction_fields];
3726          sf++)
3727     {
3728         if (mf_are_prereqs_ok(sf->field, &rule->cr.flow)) {
3729             union mf_value value;
3730
3731             mf_get_value(sf->field, &rule->cr.flow, &value);
3732             if (sf->ofs) {
3733                 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
3734             }
3735             if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
3736                 unsigned int start = sf->ofs + sf->n_bits;
3737                 bitwise_zero(&value, sf->field->n_bytes, start,
3738                              sf->field->n_bytes * 8 - start);
3739             }
3740             hash = hash_bytes(&value, sf->field->n_bytes, hash);
3741         } else {
3742             hash = hash_int(hash, 0);
3743         }
3744     }
3745
3746     return hash;
3747 }
3748
3749 /* Returns an eviction group within 'table' with the given 'id', creating one
3750  * if necessary. */
3751 static struct eviction_group *
3752 eviction_group_find(struct oftable *table, uint32_t id)
3753 {
3754     struct eviction_group *evg;
3755
3756     HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
3757         return evg;
3758     }
3759
3760     evg = xmalloc(sizeof *evg);
3761     hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
3762     heap_insert(&table->eviction_groups_by_size, &evg->size_node,
3763                 eviction_group_priority(0));
3764     heap_init(&evg->rules);
3765
3766     return evg;
3767 }
3768
3769 /* Returns an eviction priority for 'rule'.  The return value should be
3770  * interpreted so that higher priorities make a rule more attractive candidates
3771  * for eviction. */
3772 static uint32_t
3773 rule_eviction_priority(struct rule *rule)
3774 {
3775     long long int hard_expiration;
3776     long long int idle_expiration;
3777     long long int expiration;
3778     uint32_t expiration_offset;
3779
3780     /* Calculate time of expiration. */
3781     hard_expiration = (rule->hard_timeout
3782                        ? rule->modified + rule->hard_timeout * 1000
3783                        : LLONG_MAX);
3784     idle_expiration = (rule->idle_timeout
3785                        ? rule->used + rule->idle_timeout * 1000
3786                        : LLONG_MAX);
3787     expiration = MIN(hard_expiration, idle_expiration);
3788     if (expiration == LLONG_MAX) {
3789         return 0;
3790     }
3791
3792     /* Calculate the time of expiration as a number of (approximate) seconds
3793      * after program startup.
3794      *
3795      * This should work OK for program runs that last UINT32_MAX seconds or
3796      * less.  Therefore, please restart OVS at least once every 136 years. */
3797     expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
3798
3799     /* Invert the expiration offset because we're using a max-heap. */
3800     return UINT32_MAX - expiration_offset;
3801 }
3802
3803 /* Adds 'rule' to an appropriate eviction group for its oftable's
3804  * configuration.  Does nothing if 'rule''s oftable doesn't have eviction
3805  * enabled, or if 'rule' is a permanent rule (one that will never expire on its
3806  * own).
3807  *
3808  * The caller must ensure that 'rule' is not already in an eviction group. */
3809 static void
3810 eviction_group_add_rule(struct rule *rule)
3811 {
3812     struct ofproto *ofproto = rule->ofproto;
3813     struct oftable *table = &ofproto->tables[rule->table_id];
3814
3815     if (table->eviction_fields
3816         && (rule->hard_timeout || rule->idle_timeout)) {
3817         struct eviction_group *evg;
3818
3819         evg = eviction_group_find(table, eviction_group_hash_rule(rule));
3820
3821         rule->eviction_group = evg;
3822         heap_insert(&evg->rules, &rule->evg_node,
3823                     rule_eviction_priority(rule));
3824         eviction_group_resized(table, evg);
3825     }
3826 }
3827 \f
3828 /* oftables. */
3829
3830 /* Initializes 'table'. */
3831 static void
3832 oftable_init(struct oftable *table)
3833 {
3834     memset(table, 0, sizeof *table);
3835     classifier_init(&table->cls);
3836 }
3837
3838 /* Destroys 'table', including its classifier and eviction groups.
3839  *
3840  * The caller is responsible for freeing 'table' itself. */
3841 static void
3842 oftable_destroy(struct oftable *table)
3843 {
3844     assert(classifier_is_empty(&table->cls));
3845     oftable_disable_eviction(table);
3846     classifier_destroy(&table->cls);
3847     free(table->name);
3848 }
3849
3850 /* Changes the name of 'table' to 'name'.  If 'name' is NULL or the empty
3851  * string, then 'table' will use its default name.
3852  *
3853  * This only affects the name exposed for a table exposed through the OpenFlow
3854  * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
3855 static void
3856 oftable_set_name(struct oftable *table, const char *name)
3857 {
3858     if (name && name[0]) {
3859         int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
3860         if (!table->name || strncmp(name, table->name, len)) {
3861             free(table->name);
3862             table->name = xmemdup0(name, len);
3863         }
3864     } else {
3865         free(table->name);
3866         table->name = NULL;
3867     }
3868 }
3869
3870 /* oftables support a choice of two policies when adding a rule would cause the
3871  * number of flows in the table to exceed the configured maximum number: either
3872  * they can refuse to add the new flow or they can evict some existing flow.
3873  * This function configures the former policy on 'table'. */
3874 static void
3875 oftable_disable_eviction(struct oftable *table)
3876 {
3877     if (table->eviction_fields) {
3878         struct eviction_group *evg, *next;
3879
3880         HMAP_FOR_EACH_SAFE (evg, next, id_node,
3881                             &table->eviction_groups_by_id) {
3882             eviction_group_destroy(table, evg);
3883         }
3884         hmap_destroy(&table->eviction_groups_by_id);
3885         heap_destroy(&table->eviction_groups_by_size);
3886
3887         free(table->eviction_fields);
3888         table->eviction_fields = NULL;
3889         table->n_eviction_fields = 0;
3890     }
3891 }
3892
3893 /* oftables support a choice of two policies when adding a rule would cause the
3894  * number of flows in the table to exceed the configured maximum number: either
3895  * they can refuse to add the new flow or they can evict some existing flow.
3896  * This function configures the latter policy on 'table', with fairness based
3897  * on the values of the 'n_fields' fields specified in 'fields'.  (Specifying
3898  * 'n_fields' as 0 disables fairness.) */
3899 static void
3900 oftable_enable_eviction(struct oftable *table,
3901                         const struct mf_subfield *fields, size_t n_fields)
3902 {
3903     struct cls_cursor cursor;
3904     struct rule *rule;
3905
3906     if (table->eviction_fields
3907         && n_fields == table->n_eviction_fields
3908         && (!n_fields
3909             || !memcmp(fields, table->eviction_fields,
3910                        n_fields * sizeof *fields))) {
3911         /* No change. */
3912         return;
3913     }
3914
3915     oftable_disable_eviction(table);
3916
3917     table->n_eviction_fields = n_fields;
3918     table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
3919
3920     table->eviction_group_id_basis = random_uint32();
3921     hmap_init(&table->eviction_groups_by_id);
3922     heap_init(&table->eviction_groups_by_size);
3923
3924     cls_cursor_init(&cursor, &table->cls, NULL);
3925     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3926         eviction_group_add_rule(rule);
3927     }
3928 }
3929
3930 /* Removes 'rule' from the oftable that contains it. */
3931 static void
3932 oftable_remove_rule(struct rule *rule)
3933 {
3934     struct ofproto *ofproto = rule->ofproto;
3935     struct oftable *table = &ofproto->tables[rule->table_id];
3936
3937     classifier_remove(&table->cls, &rule->cr);
3938     eviction_group_remove_rule(rule);
3939 }
3940
3941 /* Inserts 'rule' into its oftable.  Removes any existing rule from 'rule''s
3942  * oftable that has an identical cls_rule.  Returns the rule that was removed,
3943  * if any, and otherwise NULL. */
3944 static struct rule *
3945 oftable_replace_rule(struct rule *rule)
3946 {
3947     struct ofproto *ofproto = rule->ofproto;
3948     struct oftable *table = &ofproto->tables[rule->table_id];
3949     struct rule *victim;
3950
3951     victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
3952     if (victim) {
3953         eviction_group_remove_rule(victim);
3954     }
3955     eviction_group_add_rule(rule);
3956     return victim;
3957 }
3958
3959 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
3960 static void
3961 oftable_substitute_rule(struct rule *old, struct rule *new)
3962 {
3963     if (new) {
3964         oftable_replace_rule(new);
3965     } else {
3966         oftable_remove_rule(old);
3967     }
3968 }
3969 \f
3970 /* unixctl commands. */
3971
3972 struct ofproto *
3973 ofproto_lookup(const char *name)
3974 {
3975     struct ofproto *ofproto;
3976
3977     HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3978                              &all_ofprotos) {
3979         if (!strcmp(ofproto->name, name)) {
3980             return ofproto;
3981         }
3982     }
3983     return NULL;
3984 }
3985
3986 static void
3987 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
3988                      const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
3989 {
3990     struct ofproto *ofproto;
3991     struct ds results;
3992
3993     ds_init(&results);
3994     HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3995         ds_put_format(&results, "%s\n", ofproto->name);
3996     }
3997     unixctl_command_reply(conn, ds_cstr(&results));
3998     ds_destroy(&results);
3999 }
4000
4001 static void
4002 ofproto_unixctl_init(void)
4003 {
4004     static bool registered;
4005     if (registered) {
4006         return;
4007     }
4008     registered = true;
4009
4010     unixctl_command_register("ofproto/list", "", 0, 0,
4011                              ofproto_unixctl_list, NULL);
4012 }
4013 \f
4014 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4015  *
4016  * This is deprecated.  It is only for compatibility with broken device drivers
4017  * in old versions of Linux that do not properly support VLANs when VLAN
4018  * devices are not used.  When broken device drivers are no longer in
4019  * widespread use, we will delete these interfaces. */
4020
4021 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4022  * (exactly) by an OpenFlow rule in 'ofproto'. */
4023 void
4024 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
4025 {
4026     const struct oftable *oftable;
4027
4028     free(ofproto->vlan_bitmap);
4029     ofproto->vlan_bitmap = bitmap_allocate(4096);
4030     ofproto->vlans_changed = false;
4031
4032     OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
4033         const struct cls_table *table;
4034
4035         HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
4036             if ((table->wc.vlan_tci_mask & htons(VLAN_VID_MASK))
4037                 == htons(VLAN_VID_MASK)) {
4038                 const struct cls_rule *rule;
4039
4040                 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
4041                     uint16_t vid = vlan_tci_to_vid(rule->flow.vlan_tci);
4042                     bitmap_set1(vlan_bitmap, vid);
4043                     bitmap_set1(ofproto->vlan_bitmap, vid);
4044                 }
4045             }
4046         }
4047     }
4048 }
4049
4050 /* Returns true if new VLANs have come into use by the flow table since the
4051  * last call to ofproto_get_vlan_usage().
4052  *
4053  * We don't track when old VLANs stop being used. */
4054 bool
4055 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
4056 {
4057     return ofproto->vlans_changed;
4058 }
4059
4060 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4061  * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'.  If
4062  * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4063  * device as a VLAN splinter for VLAN ID 'vid'.  If 'realdev_ofp_port' is zero,
4064  * then the VLAN device is un-enslaved. */
4065 int
4066 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
4067                          uint16_t realdev_ofp_port, int vid)
4068 {
4069     struct ofport *ofport;
4070     int error;
4071
4072     assert(vlandev_ofp_port != realdev_ofp_port);
4073
4074     ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
4075     if (!ofport) {
4076         VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
4077                   ofproto->name, vlandev_ofp_port);
4078         return EINVAL;
4079     }
4080
4081     if (!ofproto->ofproto_class->set_realdev) {
4082         if (!vlandev_ofp_port) {
4083             return 0;
4084         }
4085         VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
4086         return EOPNOTSUPP;
4087     }
4088
4089     error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
4090     if (error) {
4091         VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
4092                   ofproto->name, vlandev_ofp_port,
4093                   netdev_get_name(ofport->netdev), strerror(error));
4094     }
4095     return error;
4096 }