ofproto: Implement Nicira Extended Match flexible flow match (NXM).
[sliver-openvswitch.git] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010 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 <sys/socket.h>
23 #include <net/if.h>
24 #include <netinet/in.h>
25 #include <stdbool.h>
26 #include <stdlib.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "coverage.h"
30 #include "discovery.h"
31 #include "dpif.h"
32 #include "dynamic-string.h"
33 #include "fail-open.h"
34 #include "hash.h"
35 #include "hmap.h"
36 #include "in-band.h"
37 #include "mac-learning.h"
38 #include "netdev.h"
39 #include "netflow.h"
40 #include "nx-match.h"
41 #include "odp-util.h"
42 #include "ofp-print.h"
43 #include "ofp-util.h"
44 #include "ofproto-sflow.h"
45 #include "ofpbuf.h"
46 #include "openflow/nicira-ext.h"
47 #include "openflow/openflow.h"
48 #include "openvswitch/datapath-protocol.h"
49 #include "packets.h"
50 #include "pinsched.h"
51 #include "pktbuf.h"
52 #include "poll-loop.h"
53 #include "rconn.h"
54 #include "shash.h"
55 #include "status.h"
56 #include "stream-ssl.h"
57 #include "svec.h"
58 #include "tag.h"
59 #include "timeval.h"
60 #include "unixctl.h"
61 #include "vconn.h"
62 #include "vlog.h"
63
64 VLOG_DEFINE_THIS_MODULE(ofproto);
65
66 #include "sflow_api.h"
67
68 struct ofport {
69     struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
70     struct netdev *netdev;
71     struct ofp_phy_port opp;    /* In host byte order. */
72     uint16_t odp_port;
73 };
74
75 static void ofport_free(struct ofport *);
76 static void hton_ofp_phy_port(struct ofp_phy_port *);
77
78 static int xlate_actions(const union ofp_action *in, size_t n_in,
79                          const struct flow *, struct ofproto *,
80                          const struct ofpbuf *packet,
81                          struct odp_actions *out, tag_type *tags,
82                          bool *may_set_up_flow, uint16_t *nf_output_iface);
83
84 struct rule {
85     struct cls_rule cr;
86
87     ovs_be64 flow_cookie;       /* Controller-issued identifier. */
88     uint16_t idle_timeout;      /* In seconds from time of last use. */
89     uint16_t hard_timeout;      /* In seconds from time of creation. */
90     bool send_flow_removed;     /* Send a flow removed message? */
91     long long int used;         /* Last-used time (0 if never used). */
92     long long int created;      /* Creation time. */
93     uint64_t packet_count;      /* Number of packets received. */
94     uint64_t byte_count;        /* Number of bytes received. */
95     uint64_t accounted_bytes;   /* Number of bytes passed to account_cb. */
96     tag_type tags;              /* Tags (set only by hooks). */
97     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
98
99     /* If 'super' is non-NULL, this rule is a subrule, that is, it is an
100      * exact-match rule (having cr.wc.wildcards of 0) generated from the
101      * wildcard rule 'super'.  In this case, 'list' is an element of the
102      * super-rule's list.
103      *
104      * If 'super' is NULL, this rule is a super-rule, and 'list' is the head of
105      * a list of subrules.  A super-rule with no wildcards (where
106      * cr.wc.wildcards is 0) will never have any subrules. */
107     struct rule *super;
108     struct list list;
109
110     /* OpenFlow actions.
111      *
112      * 'n_actions' is the number of elements in the 'actions' array.  A single
113      * action may take up more more than one element's worth of space.
114      *
115      * A subrule has no actions (it uses the super-rule's actions). */
116     int n_actions;
117     union ofp_action *actions;
118
119     /* Datapath actions.
120      *
121      * A super-rule with wildcard fields never has ODP actions (since the
122      * datapath only supports exact-match flows). */
123     bool installed;             /* Installed in datapath? */
124     bool may_install;           /* True ordinarily; false if actions must
125                                  * be reassessed for every packet. */
126     int n_odp_actions;
127     union odp_action *odp_actions;
128 };
129
130 static inline bool
131 rule_is_hidden(const struct rule *rule)
132 {
133     /* Subrules are merely an implementation detail, so hide them from the
134      * controller. */
135     if (rule->super != NULL) {
136         return true;
137     }
138
139     /* Rules with priority higher than UINT16_MAX are set up by ofproto itself
140      * (e.g. by in-band control) and are intentionally hidden from the
141      * controller. */
142     if (rule->cr.priority > UINT16_MAX) {
143         return true;
144     }
145
146     return false;
147 }
148
149 static struct rule *rule_create(struct ofproto *, struct rule *super,
150                                 const union ofp_action *, size_t n_actions,
151                                 uint16_t idle_timeout, uint16_t hard_timeout,
152                                 ovs_be64 flow_cookie, bool send_flow_removed);
153 static void rule_free(struct rule *);
154 static void rule_destroy(struct ofproto *, struct rule *);
155 static struct rule *rule_from_cls_rule(const struct cls_rule *);
156 static void rule_insert(struct ofproto *, struct rule *,
157                         struct ofpbuf *packet, uint16_t in_port);
158 static void rule_remove(struct ofproto *, struct rule *);
159 static bool rule_make_actions(struct ofproto *, struct rule *,
160                               const struct ofpbuf *packet);
161 static void rule_install(struct ofproto *, struct rule *,
162                          struct rule *displaced_rule);
163 static void rule_uninstall(struct ofproto *, struct rule *);
164 static void rule_post_uninstall(struct ofproto *, struct rule *);
165 static void send_flow_removed(struct ofproto *, struct rule *, uint8_t reason);
166
167 /* ofproto supports two kinds of OpenFlow connections:
168  *
169  *   - "Primary" connections to ordinary OpenFlow controllers.  ofproto
170  *     maintains persistent connections to these controllers and by default
171  *     sends them asynchronous messages such as packet-ins.
172  *
173  *   - "Service" connections, e.g. from ovs-ofctl.  When these connections
174  *     drop, it is the other side's responsibility to reconnect them if
175  *     necessary.  ofproto does not send them asynchronous messages by default.
176  *
177  * Currently, active (tcp, ssl, unix) connections are always "primary"
178  * connections and passive (ptcp, pssl, punix) connections are always "service"
179  * connections.  There is no inherent reason for this, but it reflects the
180  * common case.
181  */
182 enum ofconn_type {
183     OFCONN_PRIMARY,             /* An ordinary OpenFlow controller. */
184     OFCONN_SERVICE              /* A service connection, e.g. "ovs-ofctl". */
185 };
186
187 /* A listener for incoming OpenFlow "service" connections. */
188 struct ofservice {
189     struct hmap_node node;      /* In struct ofproto's "services" hmap. */
190     struct pvconn *pvconn;      /* OpenFlow connection listener. */
191
192     /* These are not used by ofservice directly.  They are settings for
193      * accepted "struct ofconn"s from the pvconn. */
194     int probe_interval;         /* Max idle time before probing, in seconds. */
195     int rate_limit;             /* Max packet-in rate in packets per second. */
196     int burst_limit;            /* Limit on accumulating packet credits. */
197 };
198
199 static struct ofservice *ofservice_lookup(struct ofproto *,
200                                           const char *target);
201 static int ofservice_create(struct ofproto *,
202                             const struct ofproto_controller *);
203 static void ofservice_reconfigure(struct ofservice *,
204                                   const struct ofproto_controller *);
205 static void ofservice_destroy(struct ofproto *, struct ofservice *);
206
207 /* An OpenFlow connection. */
208 struct ofconn {
209     struct ofproto *ofproto;    /* The ofproto that owns this connection. */
210     struct list node;           /* In struct ofproto's "all_conns" list. */
211     struct rconn *rconn;        /* OpenFlow connection. */
212     enum ofconn_type type;      /* Type. */
213     int flow_format;            /* One of NXFF_*. */
214
215     /* OFPT_PACKET_IN related data. */
216     struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
217     struct pinsched *schedulers[2]; /* Indexed by reason code; see below. */
218     struct pktbuf *pktbuf;         /* OpenFlow packet buffers. */
219     int miss_send_len;             /* Bytes to send of buffered packets. */
220
221     /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
222      * requests, and the maximum number before we stop reading OpenFlow
223      * requests.  */
224 #define OFCONN_REPLY_MAX 100
225     struct rconn_packet_counter *reply_counter;
226
227     /* type == OFCONN_PRIMARY only. */
228     enum nx_role role;           /* Role. */
229     struct hmap_node hmap_node;  /* In struct ofproto's "controllers" map. */
230     struct discovery *discovery; /* Controller discovery object, if enabled. */
231     struct status_category *ss;  /* Switch status category. */
232     enum ofproto_band band;      /* In-band or out-of-band? */
233 };
234
235 /* We use OFPR_NO_MATCH and OFPR_ACTION as indexes into struct ofconn's
236  * "schedulers" array.  Their values are 0 and 1, and their meanings and values
237  * coincide with _ODPL_MISS_NR and _ODPL_ACTION_NR, so this is convenient.  In
238  * case anything ever changes, check their values here.  */
239 #define N_SCHEDULERS 2
240 BUILD_ASSERT_DECL(OFPR_NO_MATCH == 0);
241 BUILD_ASSERT_DECL(OFPR_NO_MATCH == _ODPL_MISS_NR);
242 BUILD_ASSERT_DECL(OFPR_ACTION == 1);
243 BUILD_ASSERT_DECL(OFPR_ACTION == _ODPL_ACTION_NR);
244
245 static struct ofconn *ofconn_create(struct ofproto *, struct rconn *,
246                                     enum ofconn_type);
247 static void ofconn_destroy(struct ofconn *);
248 static void ofconn_run(struct ofconn *);
249 static void ofconn_wait(struct ofconn *);
250 static bool ofconn_receives_async_msgs(const struct ofconn *);
251 static char *ofconn_make_name(const struct ofproto *, const char *target);
252 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
253
254 static void queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
255                      struct rconn_packet_counter *counter);
256
257 static void send_packet_in(struct ofproto *, struct ofpbuf *odp_msg);
258 static void do_send_packet_in(struct ofpbuf *odp_msg, void *ofconn);
259
260 struct ofproto {
261     /* Settings. */
262     uint64_t datapath_id;       /* Datapath ID. */
263     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
264     char *mfr_desc;             /* Manufacturer. */
265     char *hw_desc;              /* Hardware. */
266     char *sw_desc;              /* Software version. */
267     char *serial_desc;          /* Serial number. */
268     char *dp_desc;              /* Datapath description. */
269
270     /* Datapath. */
271     struct dpif *dpif;
272     struct netdev_monitor *netdev_monitor;
273     struct hmap ports;          /* Contains "struct ofport"s. */
274     struct shash port_by_name;
275     uint32_t max_ports;
276
277     /* Configuration. */
278     struct switch_status *switch_status;
279     struct fail_open *fail_open;
280     struct netflow *netflow;
281     struct ofproto_sflow *sflow;
282
283     /* In-band control. */
284     struct in_band *in_band;
285     long long int next_in_band_update;
286     struct sockaddr_in *extra_in_band_remotes;
287     size_t n_extra_remotes;
288
289     /* Flow table. */
290     struct classifier cls;
291     bool need_revalidate;
292     long long int next_expiration;
293     struct tag_set revalidate_set;
294
295     /* OpenFlow connections. */
296     struct hmap controllers;   /* Controller "struct ofconn"s. */
297     struct list all_conns;     /* Contains "struct ofconn"s. */
298     enum ofproto_fail_mode fail_mode;
299
300     /* OpenFlow listeners. */
301     struct hmap services;       /* Contains "struct ofservice"s. */
302     struct pvconn **snoops;
303     size_t n_snoops;
304
305     /* Hooks for ovs-vswitchd. */
306     const struct ofhooks *ofhooks;
307     void *aux;
308
309     /* Used by default ofhooks. */
310     struct mac_learning *ml;
311 };
312
313 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
314
315 static const struct ofhooks default_ofhooks;
316
317 static uint64_t pick_datapath_id(const struct ofproto *);
318 static uint64_t pick_fallback_dpid(void);
319
320 static int ofproto_expire(struct ofproto *);
321
322 static void update_stats(struct ofproto *, struct rule *,
323                          const struct odp_flow_stats *);
324 static bool revalidate_rule(struct ofproto *p, struct rule *rule);
325 static void revalidate_cb(struct cls_rule *rule_, void *p_);
326
327 static void handle_odp_msg(struct ofproto *, struct ofpbuf *);
328
329 static void handle_openflow(struct ofconn *, struct ofpbuf *);
330
331 static struct ofport *get_port(const struct ofproto *, uint16_t odp_port);
332 static void update_port(struct ofproto *, const char *devname);
333 static int init_ports(struct ofproto *);
334 static void reinit_ports(struct ofproto *);
335
336 int
337 ofproto_create(const char *datapath, const char *datapath_type,
338                const struct ofhooks *ofhooks, void *aux,
339                struct ofproto **ofprotop)
340 {
341     struct odp_stats stats;
342     struct ofproto *p;
343     struct dpif *dpif;
344     int error;
345
346     *ofprotop = NULL;
347
348     /* Connect to datapath and start listening for messages. */
349     error = dpif_open(datapath, datapath_type, &dpif);
350     if (error) {
351         VLOG_ERR("failed to open datapath %s: %s", datapath, strerror(error));
352         return error;
353     }
354     error = dpif_get_dp_stats(dpif, &stats);
355     if (error) {
356         VLOG_ERR("failed to obtain stats for datapath %s: %s",
357                  datapath, strerror(error));
358         dpif_close(dpif);
359         return error;
360     }
361     error = dpif_recv_set_mask(dpif, ODPL_MISS | ODPL_ACTION | ODPL_SFLOW);
362     if (error) {
363         VLOG_ERR("failed to listen on datapath %s: %s",
364                  datapath, strerror(error));
365         dpif_close(dpif);
366         return error;
367     }
368     dpif_flow_flush(dpif);
369     dpif_recv_purge(dpif);
370
371     /* Initialize settings. */
372     p = xzalloc(sizeof *p);
373     p->fallback_dpid = pick_fallback_dpid();
374     p->datapath_id = p->fallback_dpid;
375     p->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
376     p->hw_desc = xstrdup(DEFAULT_HW_DESC);
377     p->sw_desc = xstrdup(DEFAULT_SW_DESC);
378     p->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
379     p->dp_desc = xstrdup(DEFAULT_DP_DESC);
380
381     /* Initialize datapath. */
382     p->dpif = dpif;
383     p->netdev_monitor = netdev_monitor_create();
384     hmap_init(&p->ports);
385     shash_init(&p->port_by_name);
386     p->max_ports = stats.max_ports;
387
388     /* Initialize submodules. */
389     p->switch_status = switch_status_create(p);
390     p->in_band = NULL;
391     p->fail_open = NULL;
392     p->netflow = NULL;
393     p->sflow = NULL;
394
395     /* Initialize flow table. */
396     classifier_init(&p->cls);
397     p->need_revalidate = false;
398     p->next_expiration = time_msec() + 1000;
399     tag_set_init(&p->revalidate_set);
400
401     /* Initialize OpenFlow connections. */
402     list_init(&p->all_conns);
403     hmap_init(&p->controllers);
404     hmap_init(&p->services);
405     p->snoops = NULL;
406     p->n_snoops = 0;
407
408     /* Initialize hooks. */
409     if (ofhooks) {
410         p->ofhooks = ofhooks;
411         p->aux = aux;
412         p->ml = NULL;
413     } else {
414         p->ofhooks = &default_ofhooks;
415         p->aux = p;
416         p->ml = mac_learning_create();
417     }
418
419     /* Pick final datapath ID. */
420     p->datapath_id = pick_datapath_id(p);
421     VLOG_INFO("using datapath ID %016"PRIx64, p->datapath_id);
422
423     *ofprotop = p;
424     return 0;
425 }
426
427 void
428 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
429 {
430     uint64_t old_dpid = p->datapath_id;
431     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
432     if (p->datapath_id != old_dpid) {
433         VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
434
435         /* Force all active connections to reconnect, since there is no way to
436          * notify a controller that the datapath ID has changed. */
437         ofproto_reconnect_controllers(p);
438     }
439 }
440
441 static bool
442 is_discovery_controller(const struct ofproto_controller *c)
443 {
444     return !strcmp(c->target, "discover");
445 }
446
447 static bool
448 is_in_band_controller(const struct ofproto_controller *c)
449 {
450     return is_discovery_controller(c) || c->band == OFPROTO_IN_BAND;
451 }
452
453 /* Creates a new controller in 'ofproto'.  Some of the settings are initially
454  * drawn from 'c', but update_controller() needs to be called later to finish
455  * the new ofconn's configuration. */
456 static void
457 add_controller(struct ofproto *ofproto, const struct ofproto_controller *c)
458 {
459     struct discovery *discovery;
460     struct ofconn *ofconn;
461
462     if (is_discovery_controller(c)) {
463         int error = discovery_create(c->accept_re, c->update_resolv_conf,
464                                      ofproto->dpif, ofproto->switch_status,
465                                      &discovery);
466         if (error) {
467             return;
468         }
469     } else {
470         discovery = NULL;
471     }
472
473     ofconn = ofconn_create(ofproto, rconn_create(5, 8), OFCONN_PRIMARY);
474     ofconn->pktbuf = pktbuf_create();
475     ofconn->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
476     if (discovery) {
477         ofconn->discovery = discovery;
478     } else {
479         char *name = ofconn_make_name(ofproto, c->target);
480         rconn_connect(ofconn->rconn, c->target, name);
481         free(name);
482     }
483     hmap_insert(&ofproto->controllers, &ofconn->hmap_node,
484                 hash_string(c->target, 0));
485 }
486
487 /* Reconfigures 'ofconn' to match 'c'.  This function cannot update an ofconn's
488  * target or turn discovery on or off (these are done by creating new ofconns
489  * and deleting old ones), but it can update the rest of an ofconn's
490  * settings. */
491 static void
492 update_controller(struct ofconn *ofconn, const struct ofproto_controller *c)
493 {
494     int probe_interval;
495
496     ofconn->band = (is_in_band_controller(c)
497                     ? OFPROTO_IN_BAND : OFPROTO_OUT_OF_BAND);
498
499     rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
500
501     probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
502     rconn_set_probe_interval(ofconn->rconn, probe_interval);
503
504     if (ofconn->discovery) {
505         discovery_set_update_resolv_conf(ofconn->discovery,
506                                          c->update_resolv_conf);
507         discovery_set_accept_controller_re(ofconn->discovery, c->accept_re);
508     }
509
510     ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
511 }
512
513 static const char *
514 ofconn_get_target(const struct ofconn *ofconn)
515 {
516     return ofconn->discovery ? "discover" : rconn_get_target(ofconn->rconn);
517 }
518
519 static struct ofconn *
520 find_controller_by_target(struct ofproto *ofproto, const char *target)
521 {
522     struct ofconn *ofconn;
523
524     HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
525                              hash_string(target, 0), &ofproto->controllers) {
526         if (!strcmp(ofconn_get_target(ofconn), target)) {
527             return ofconn;
528         }
529     }
530     return NULL;
531 }
532
533 static void
534 update_in_band_remotes(struct ofproto *ofproto)
535 {
536     const struct ofconn *ofconn;
537     struct sockaddr_in *addrs;
538     size_t max_addrs, n_addrs;
539     bool discovery;
540     size_t i;
541
542     /* Allocate enough memory for as many remotes as we could possibly have. */
543     max_addrs = ofproto->n_extra_remotes + hmap_count(&ofproto->controllers);
544     addrs = xmalloc(max_addrs * sizeof *addrs);
545     n_addrs = 0;
546
547     /* Add all the remotes. */
548     discovery = false;
549     HMAP_FOR_EACH (ofconn, hmap_node, &ofproto->controllers) {
550         struct sockaddr_in *sin = &addrs[n_addrs];
551
552         if (ofconn->band == OFPROTO_OUT_OF_BAND) {
553             continue;
554         }
555
556         sin->sin_addr.s_addr = rconn_get_remote_ip(ofconn->rconn);
557         if (sin->sin_addr.s_addr) {
558             sin->sin_port = rconn_get_remote_port(ofconn->rconn);
559             n_addrs++;
560         }
561         if (ofconn->discovery) {
562             discovery = true;
563         }
564     }
565     for (i = 0; i < ofproto->n_extra_remotes; i++) {
566         addrs[n_addrs++] = ofproto->extra_in_band_remotes[i];
567     }
568
569     /* Create or update or destroy in-band.
570      *
571      * Ordinarily we only enable in-band if there's at least one remote
572      * address, but discovery needs the in-band rules for DHCP to be installed
573      * even before we know any remote addresses. */
574     if (n_addrs || discovery) {
575         if (!ofproto->in_band) {
576             in_band_create(ofproto, ofproto->dpif, ofproto->switch_status,
577                            &ofproto->in_band);
578         }
579         if (ofproto->in_band) {
580             in_band_set_remotes(ofproto->in_band, addrs, n_addrs);
581         }
582         ofproto->next_in_band_update = time_msec() + 1000;
583     } else {
584         in_band_destroy(ofproto->in_band);
585         ofproto->in_band = NULL;
586     }
587
588     /* Clean up. */
589     free(addrs);
590 }
591
592 static void
593 update_fail_open(struct ofproto *p)
594 {
595     struct ofconn *ofconn;
596
597     if (!hmap_is_empty(&p->controllers)
598             && p->fail_mode == OFPROTO_FAIL_STANDALONE) {
599         struct rconn **rconns;
600         size_t n;
601
602         if (!p->fail_open) {
603             p->fail_open = fail_open_create(p, p->switch_status);
604         }
605
606         n = 0;
607         rconns = xmalloc(hmap_count(&p->controllers) * sizeof *rconns);
608         HMAP_FOR_EACH (ofconn, hmap_node, &p->controllers) {
609             rconns[n++] = ofconn->rconn;
610         }
611
612         fail_open_set_controllers(p->fail_open, rconns, n);
613         /* p->fail_open takes ownership of 'rconns'. */
614     } else {
615         fail_open_destroy(p->fail_open);
616         p->fail_open = NULL;
617     }
618 }
619
620 void
621 ofproto_set_controllers(struct ofproto *p,
622                         const struct ofproto_controller *controllers,
623                         size_t n_controllers)
624 {
625     struct shash new_controllers;
626     struct ofconn *ofconn, *next_ofconn;
627     struct ofservice *ofservice, *next_ofservice;
628     bool ss_exists;
629     size_t i;
630
631     /* Create newly configured controllers and services.
632      * Create a name to ofproto_controller mapping in 'new_controllers'. */
633     shash_init(&new_controllers);
634     for (i = 0; i < n_controllers; i++) {
635         const struct ofproto_controller *c = &controllers[i];
636
637         if (!vconn_verify_name(c->target) || !strcmp(c->target, "discover")) {
638             if (!find_controller_by_target(p, c->target)) {
639                 add_controller(p, c);
640             }
641         } else if (!pvconn_verify_name(c->target)) {
642             if (!ofservice_lookup(p, c->target) && ofservice_create(p, c)) {
643                 continue;
644             }
645         } else {
646             VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
647                          dpif_name(p->dpif), c->target);
648             continue;
649         }
650
651         shash_add_once(&new_controllers, c->target, &controllers[i]);
652     }
653
654     /* Delete controllers that are no longer configured.
655      * Update configuration of all now-existing controllers. */
656     ss_exists = false;
657     HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &p->controllers) {
658         struct ofproto_controller *c;
659
660         c = shash_find_data(&new_controllers, ofconn_get_target(ofconn));
661         if (!c) {
662             ofconn_destroy(ofconn);
663         } else {
664             update_controller(ofconn, c);
665             if (ofconn->ss) {
666                 ss_exists = true;
667             }
668         }
669     }
670
671     /* Delete services that are no longer configured.
672      * Update configuration of all now-existing services. */
673     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &p->services) {
674         struct ofproto_controller *c;
675
676         c = shash_find_data(&new_controllers,
677                             pvconn_get_name(ofservice->pvconn));
678         if (!c) {
679             ofservice_destroy(p, ofservice);
680         } else {
681             ofservice_reconfigure(ofservice, c);
682         }
683     }
684
685     shash_destroy(&new_controllers);
686
687     update_in_band_remotes(p);
688     update_fail_open(p);
689
690     if (!hmap_is_empty(&p->controllers) && !ss_exists) {
691         ofconn = CONTAINER_OF(hmap_first(&p->controllers),
692                               struct ofconn, hmap_node);
693         ofconn->ss = switch_status_register(p->switch_status, "remote",
694                                             rconn_status_cb, ofconn->rconn);
695     }
696 }
697
698 void
699 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
700 {
701     p->fail_mode = fail_mode;
702     update_fail_open(p);
703 }
704
705 /* Drops the connections between 'ofproto' and all of its controllers, forcing
706  * them to reconnect. */
707 void
708 ofproto_reconnect_controllers(struct ofproto *ofproto)
709 {
710     struct ofconn *ofconn;
711
712     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
713         rconn_reconnect(ofconn->rconn);
714     }
715 }
716
717 static bool
718 any_extras_changed(const struct ofproto *ofproto,
719                    const struct sockaddr_in *extras, size_t n)
720 {
721     size_t i;
722
723     if (n != ofproto->n_extra_remotes) {
724         return true;
725     }
726
727     for (i = 0; i < n; i++) {
728         const struct sockaddr_in *old = &ofproto->extra_in_band_remotes[i];
729         const struct sockaddr_in *new = &extras[i];
730
731         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
732             old->sin_port != new->sin_port) {
733             return true;
734         }
735     }
736
737     return false;
738 }
739
740 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
741  * in-band control should guarantee access, in the same way that in-band
742  * control guarantees access to OpenFlow controllers. */
743 void
744 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
745                                   const struct sockaddr_in *extras, size_t n)
746 {
747     if (!any_extras_changed(ofproto, extras, n)) {
748         return;
749     }
750
751     free(ofproto->extra_in_band_remotes);
752     ofproto->n_extra_remotes = n;
753     ofproto->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
754
755     update_in_band_remotes(ofproto);
756 }
757
758 void
759 ofproto_set_desc(struct ofproto *p,
760                  const char *mfr_desc, const char *hw_desc,
761                  const char *sw_desc, const char *serial_desc,
762                  const char *dp_desc)
763 {
764     struct ofp_desc_stats *ods;
765
766     if (mfr_desc) {
767         if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
768             VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
769                     sizeof ods->mfr_desc);
770         }
771         free(p->mfr_desc);
772         p->mfr_desc = xstrdup(mfr_desc);
773     }
774     if (hw_desc) {
775         if (strlen(hw_desc) >= sizeof ods->hw_desc) {
776             VLOG_WARN("truncating hw_desc, must be less than %zu characters",
777                     sizeof ods->hw_desc);
778         }
779         free(p->hw_desc);
780         p->hw_desc = xstrdup(hw_desc);
781     }
782     if (sw_desc) {
783         if (strlen(sw_desc) >= sizeof ods->sw_desc) {
784             VLOG_WARN("truncating sw_desc, must be less than %zu characters",
785                     sizeof ods->sw_desc);
786         }
787         free(p->sw_desc);
788         p->sw_desc = xstrdup(sw_desc);
789     }
790     if (serial_desc) {
791         if (strlen(serial_desc) >= sizeof ods->serial_num) {
792             VLOG_WARN("truncating serial_desc, must be less than %zu "
793                     "characters",
794                     sizeof ods->serial_num);
795         }
796         free(p->serial_desc);
797         p->serial_desc = xstrdup(serial_desc);
798     }
799     if (dp_desc) {
800         if (strlen(dp_desc) >= sizeof ods->dp_desc) {
801             VLOG_WARN("truncating dp_desc, must be less than %zu characters",
802                     sizeof ods->dp_desc);
803         }
804         free(p->dp_desc);
805         p->dp_desc = xstrdup(dp_desc);
806     }
807 }
808
809 static int
810 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
811             const struct svec *svec)
812 {
813     struct pvconn **pvconns = *pvconnsp;
814     size_t n_pvconns = *n_pvconnsp;
815     int retval = 0;
816     size_t i;
817
818     for (i = 0; i < n_pvconns; i++) {
819         pvconn_close(pvconns[i]);
820     }
821     free(pvconns);
822
823     pvconns = xmalloc(svec->n * sizeof *pvconns);
824     n_pvconns = 0;
825     for (i = 0; i < svec->n; i++) {
826         const char *name = svec->names[i];
827         struct pvconn *pvconn;
828         int error;
829
830         error = pvconn_open(name, &pvconn);
831         if (!error) {
832             pvconns[n_pvconns++] = pvconn;
833         } else {
834             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
835             if (!retval) {
836                 retval = error;
837             }
838         }
839     }
840
841     *pvconnsp = pvconns;
842     *n_pvconnsp = n_pvconns;
843
844     return retval;
845 }
846
847 int
848 ofproto_set_snoops(struct ofproto *ofproto, const struct svec *snoops)
849 {
850     return set_pvconns(&ofproto->snoops, &ofproto->n_snoops, snoops);
851 }
852
853 int
854 ofproto_set_netflow(struct ofproto *ofproto,
855                     const struct netflow_options *nf_options)
856 {
857     if (nf_options && nf_options->collectors.n) {
858         if (!ofproto->netflow) {
859             ofproto->netflow = netflow_create();
860         }
861         return netflow_set_options(ofproto->netflow, nf_options);
862     } else {
863         netflow_destroy(ofproto->netflow);
864         ofproto->netflow = NULL;
865         return 0;
866     }
867 }
868
869 void
870 ofproto_set_sflow(struct ofproto *ofproto,
871                   const struct ofproto_sflow_options *oso)
872 {
873     struct ofproto_sflow *os = ofproto->sflow;
874     if (oso) {
875         if (!os) {
876             struct ofport *ofport;
877
878             os = ofproto->sflow = ofproto_sflow_create(ofproto->dpif);
879             HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
880                 ofproto_sflow_add_port(os, ofport->odp_port,
881                                        netdev_get_name(ofport->netdev));
882             }
883         }
884         ofproto_sflow_set_options(os, oso);
885     } else {
886         ofproto_sflow_destroy(os);
887         ofproto->sflow = NULL;
888     }
889 }
890
891 uint64_t
892 ofproto_get_datapath_id(const struct ofproto *ofproto)
893 {
894     return ofproto->datapath_id;
895 }
896
897 bool
898 ofproto_has_primary_controller(const struct ofproto *ofproto)
899 {
900     return !hmap_is_empty(&ofproto->controllers);
901 }
902
903 enum ofproto_fail_mode
904 ofproto_get_fail_mode(const struct ofproto *p)
905 {
906     return p->fail_mode;
907 }
908
909 void
910 ofproto_get_snoops(const struct ofproto *ofproto, struct svec *snoops)
911 {
912     size_t i;
913
914     for (i = 0; i < ofproto->n_snoops; i++) {
915         svec_add(snoops, pvconn_get_name(ofproto->snoops[i]));
916     }
917 }
918
919 void
920 ofproto_destroy(struct ofproto *p)
921 {
922     struct ofservice *ofservice, *next_ofservice;
923     struct ofconn *ofconn, *next_ofconn;
924     struct ofport *ofport, *next_ofport;
925     size_t i;
926
927     if (!p) {
928         return;
929     }
930
931     /* Destroy fail-open and in-band early, since they touch the classifier. */
932     fail_open_destroy(p->fail_open);
933     p->fail_open = NULL;
934
935     in_band_destroy(p->in_band);
936     p->in_band = NULL;
937     free(p->extra_in_band_remotes);
938
939     ofproto_flush_flows(p);
940     classifier_destroy(&p->cls);
941
942     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &p->all_conns) {
943         ofconn_destroy(ofconn);
944     }
945     hmap_destroy(&p->controllers);
946
947     dpif_close(p->dpif);
948     netdev_monitor_destroy(p->netdev_monitor);
949     HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
950         hmap_remove(&p->ports, &ofport->hmap_node);
951         ofport_free(ofport);
952     }
953     shash_destroy(&p->port_by_name);
954
955     switch_status_destroy(p->switch_status);
956     netflow_destroy(p->netflow);
957     ofproto_sflow_destroy(p->sflow);
958
959     HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &p->services) {
960         ofservice_destroy(p, ofservice);
961     }
962     hmap_destroy(&p->services);
963
964     for (i = 0; i < p->n_snoops; i++) {
965         pvconn_close(p->snoops[i]);
966     }
967     free(p->snoops);
968
969     mac_learning_destroy(p->ml);
970
971     free(p->mfr_desc);
972     free(p->hw_desc);
973     free(p->sw_desc);
974     free(p->serial_desc);
975     free(p->dp_desc);
976
977     hmap_destroy(&p->ports);
978
979     free(p);
980 }
981
982 int
983 ofproto_run(struct ofproto *p)
984 {
985     int error = ofproto_run1(p);
986     if (!error) {
987         error = ofproto_run2(p, false);
988     }
989     return error;
990 }
991
992 static void
993 process_port_change(struct ofproto *ofproto, int error, char *devname)
994 {
995     if (error == ENOBUFS) {
996         reinit_ports(ofproto);
997     } else if (!error) {
998         update_port(ofproto, devname);
999         free(devname);
1000     }
1001 }
1002
1003 /* Returns a "preference level" for snooping 'ofconn'.  A higher return value
1004  * means that 'ofconn' is more interesting for monitoring than a lower return
1005  * value. */
1006 static int
1007 snoop_preference(const struct ofconn *ofconn)
1008 {
1009     switch (ofconn->role) {
1010     case NX_ROLE_MASTER:
1011         return 3;
1012     case NX_ROLE_OTHER:
1013         return 2;
1014     case NX_ROLE_SLAVE:
1015         return 1;
1016     default:
1017         /* Shouldn't happen. */
1018         return 0;
1019     }
1020 }
1021
1022 /* One of ofproto's "snoop" pvconns has accepted a new connection on 'vconn'.
1023  * Connects this vconn to a controller. */
1024 static void
1025 add_snooper(struct ofproto *ofproto, struct vconn *vconn)
1026 {
1027     struct ofconn *ofconn, *best;
1028
1029     /* Pick a controller for monitoring. */
1030     best = NULL;
1031     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
1032         if (ofconn->type == OFCONN_PRIMARY
1033             && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
1034             best = ofconn;
1035         }
1036     }
1037
1038     if (best) {
1039         rconn_add_monitor(best->rconn, vconn);
1040     } else {
1041         VLOG_INFO_RL(&rl, "no controller connection to snoop");
1042         vconn_close(vconn);
1043     }
1044 }
1045
1046 int
1047 ofproto_run1(struct ofproto *p)
1048 {
1049     struct ofconn *ofconn, *next_ofconn;
1050     struct ofservice *ofservice;
1051     char *devname;
1052     int error;
1053     int i;
1054
1055     if (shash_is_empty(&p->port_by_name)) {
1056         init_ports(p);
1057     }
1058
1059     for (i = 0; i < 50; i++) {
1060         struct ofpbuf *buf;
1061
1062         error = dpif_recv(p->dpif, &buf);
1063         if (error) {
1064             if (error == ENODEV) {
1065                 /* Someone destroyed the datapath behind our back.  The caller
1066                  * better destroy us and give up, because we're just going to
1067                  * spin from here on out. */
1068                 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
1069                 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
1070                             dpif_name(p->dpif));
1071                 return ENODEV;
1072             }
1073             break;
1074         }
1075
1076         handle_odp_msg(p, buf);
1077     }
1078
1079     while ((error = dpif_port_poll(p->dpif, &devname)) != EAGAIN) {
1080         process_port_change(p, error, devname);
1081     }
1082     while ((error = netdev_monitor_poll(p->netdev_monitor,
1083                                         &devname)) != EAGAIN) {
1084         process_port_change(p, error, devname);
1085     }
1086
1087     if (p->in_band) {
1088         if (time_msec() >= p->next_in_band_update) {
1089             update_in_band_remotes(p);
1090         }
1091         in_band_run(p->in_band);
1092     }
1093
1094     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &p->all_conns) {
1095         ofconn_run(ofconn);
1096     }
1097
1098     /* Fail-open maintenance.  Do this after processing the ofconns since
1099      * fail-open checks the status of the controller rconn. */
1100     if (p->fail_open) {
1101         fail_open_run(p->fail_open);
1102     }
1103
1104     HMAP_FOR_EACH (ofservice, node, &p->services) {
1105         struct vconn *vconn;
1106         int retval;
1107
1108         retval = pvconn_accept(ofservice->pvconn, OFP_VERSION, &vconn);
1109         if (!retval) {
1110             struct rconn *rconn;
1111             char *name;
1112
1113             rconn = rconn_create(ofservice->probe_interval, 0);
1114             name = ofconn_make_name(p, vconn_get_name(vconn));
1115             rconn_connect_unreliably(rconn, vconn, name);
1116             free(name);
1117
1118             ofconn = ofconn_create(p, rconn, OFCONN_SERVICE);
1119             ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
1120                                   ofservice->burst_limit);
1121         } else if (retval != EAGAIN) {
1122             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
1123         }
1124     }
1125
1126     for (i = 0; i < p->n_snoops; i++) {
1127         struct vconn *vconn;
1128         int retval;
1129
1130         retval = pvconn_accept(p->snoops[i], OFP_VERSION, &vconn);
1131         if (!retval) {
1132             add_snooper(p, vconn);
1133         } else if (retval != EAGAIN) {
1134             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
1135         }
1136     }
1137
1138     if (time_msec() >= p->next_expiration) {
1139         int delay = ofproto_expire(p);
1140         p->next_expiration = time_msec() + delay;
1141         COVERAGE_INC(ofproto_expiration);
1142     }
1143
1144     if (p->netflow) {
1145         netflow_run(p->netflow);
1146     }
1147     if (p->sflow) {
1148         ofproto_sflow_run(p->sflow);
1149     }
1150
1151     return 0;
1152 }
1153
1154 struct revalidate_cbdata {
1155     struct ofproto *ofproto;
1156     bool revalidate_all;        /* Revalidate all exact-match rules? */
1157     bool revalidate_subrules;   /* Revalidate all exact-match subrules? */
1158     struct tag_set revalidate_set; /* Set of tags to revalidate. */
1159 };
1160
1161 int
1162 ofproto_run2(struct ofproto *p, bool revalidate_all)
1163 {
1164     if (p->need_revalidate || revalidate_all
1165         || !tag_set_is_empty(&p->revalidate_set)) {
1166         struct revalidate_cbdata cbdata;
1167         cbdata.ofproto = p;
1168         cbdata.revalidate_all = revalidate_all;
1169         cbdata.revalidate_subrules = p->need_revalidate;
1170         cbdata.revalidate_set = p->revalidate_set;
1171         tag_set_init(&p->revalidate_set);
1172         COVERAGE_INC(ofproto_revalidate);
1173         classifier_for_each(&p->cls, CLS_INC_EXACT, revalidate_cb, &cbdata);
1174         p->need_revalidate = false;
1175     }
1176
1177     return 0;
1178 }
1179
1180 void
1181 ofproto_wait(struct ofproto *p)
1182 {
1183     struct ofservice *ofservice;
1184     struct ofconn *ofconn;
1185     size_t i;
1186
1187     dpif_recv_wait(p->dpif);
1188     dpif_port_poll_wait(p->dpif);
1189     netdev_monitor_poll_wait(p->netdev_monitor);
1190     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1191         ofconn_wait(ofconn);
1192     }
1193     if (p->in_band) {
1194         poll_timer_wait_until(p->next_in_band_update);
1195         in_band_wait(p->in_band);
1196     }
1197     if (p->fail_open) {
1198         fail_open_wait(p->fail_open);
1199     }
1200     if (p->sflow) {
1201         ofproto_sflow_wait(p->sflow);
1202     }
1203     if (!tag_set_is_empty(&p->revalidate_set)) {
1204         poll_immediate_wake();
1205     }
1206     if (p->need_revalidate) {
1207         /* Shouldn't happen, but if it does just go around again. */
1208         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1209         poll_immediate_wake();
1210     } else if (p->next_expiration != LLONG_MAX) {
1211         poll_timer_wait_until(p->next_expiration);
1212     }
1213     HMAP_FOR_EACH (ofservice, node, &p->services) {
1214         pvconn_wait(ofservice->pvconn);
1215     }
1216     for (i = 0; i < p->n_snoops; i++) {
1217         pvconn_wait(p->snoops[i]);
1218     }
1219 }
1220
1221 void
1222 ofproto_revalidate(struct ofproto *ofproto, tag_type tag)
1223 {
1224     tag_set_add(&ofproto->revalidate_set, tag);
1225 }
1226
1227 struct tag_set *
1228 ofproto_get_revalidate_set(struct ofproto *ofproto)
1229 {
1230     return &ofproto->revalidate_set;
1231 }
1232
1233 bool
1234 ofproto_is_alive(const struct ofproto *p)
1235 {
1236     return !hmap_is_empty(&p->controllers);
1237 }
1238
1239 /* Deletes port number 'odp_port' from the datapath for 'ofproto'.
1240  *
1241  * This is almost the same as calling dpif_port_del() directly on the
1242  * datapath, but it also makes 'ofproto' close its open netdev for the port
1243  * (if any).  This makes it possible to create a new netdev of a different
1244  * type under the same name, which otherwise the netdev library would refuse
1245  * to do because of the conflict.  (The netdev would eventually get closed on
1246  * the next trip through ofproto_run(), but this interface is more direct.)
1247  *
1248  * Returns 0 if successful, otherwise a positive errno. */
1249 int
1250 ofproto_port_del(struct ofproto *ofproto, uint16_t odp_port)
1251 {
1252     struct ofport *ofport = get_port(ofproto, odp_port);
1253     const char *name = ofport ? (char *) ofport->opp.name : "<unknown>";
1254     int error;
1255
1256     error = dpif_port_del(ofproto->dpif, odp_port);
1257     if (error) {
1258         VLOG_ERR("%s: failed to remove port %"PRIu16" (%s) interface (%s)",
1259                  dpif_name(ofproto->dpif), odp_port, name, strerror(error));
1260     } else if (ofport) {
1261         /* 'name' is ofport->opp.name and update_port() is going to destroy
1262          * 'ofport'.  Just in case update_port() refers to 'name' after it
1263          * destroys 'ofport', make a copy of it around the update_port()
1264          * call. */
1265         char *devname = xstrdup(name);
1266         update_port(ofproto, devname);
1267         free(devname);
1268     }
1269     return error;
1270 }
1271
1272 /* Checks if 'ofproto' thinks 'odp_port' should be included in floods.  Returns
1273  * true if 'odp_port' exists and should be included, false otherwise. */
1274 bool
1275 ofproto_port_is_floodable(struct ofproto *ofproto, uint16_t odp_port)
1276 {
1277     struct ofport *ofport = get_port(ofproto, odp_port);
1278     return ofport && !(ofport->opp.config & OFPPC_NO_FLOOD);
1279 }
1280
1281 int
1282 ofproto_send_packet(struct ofproto *p, const struct flow *flow,
1283                     const union ofp_action *actions, size_t n_actions,
1284                     const struct ofpbuf *packet)
1285 {
1286     struct odp_actions odp_actions;
1287     int error;
1288
1289     error = xlate_actions(actions, n_actions, flow, p, packet, &odp_actions,
1290                           NULL, NULL, NULL);
1291     if (error) {
1292         return error;
1293     }
1294
1295     /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
1296      * error code? */
1297     dpif_execute(p->dpif, odp_actions.actions, odp_actions.n_actions, packet);
1298     return 0;
1299 }
1300
1301 void
1302 ofproto_add_flow(struct ofproto *p, const struct cls_rule *cls_rule,
1303                  const union ofp_action *actions, size_t n_actions,
1304                  int idle_timeout)
1305 {
1306     struct rule *rule;
1307     rule = rule_create(p, NULL, actions, n_actions,
1308                        idle_timeout >= 0 ? idle_timeout : 5 /* XXX */,
1309                        0, 0, false);
1310     rule->cr = *cls_rule;
1311     rule_insert(p, rule, NULL, 0);
1312 }
1313
1314 void
1315 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1316 {
1317     struct rule *rule;
1318
1319     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
1320                                                            target));
1321     if (rule) {
1322         rule_remove(ofproto, rule);
1323     }
1324 }
1325
1326 static void
1327 destroy_rule(struct cls_rule *rule_, void *ofproto_)
1328 {
1329     struct rule *rule = rule_from_cls_rule(rule_);
1330     struct ofproto *ofproto = ofproto_;
1331
1332     /* Mark the flow as not installed, even though it might really be
1333      * installed, so that rule_remove() doesn't bother trying to uninstall it.
1334      * There is no point in uninstalling it individually since we are about to
1335      * blow away all the flows with dpif_flow_flush(). */
1336     rule->installed = false;
1337
1338     rule_remove(ofproto, rule);
1339 }
1340
1341 void
1342 ofproto_flush_flows(struct ofproto *ofproto)
1343 {
1344     COVERAGE_INC(ofproto_flush);
1345     classifier_for_each(&ofproto->cls, CLS_INC_ALL, destroy_rule, ofproto);
1346     dpif_flow_flush(ofproto->dpif);
1347     if (ofproto->in_band) {
1348         in_band_flushed(ofproto->in_band);
1349     }
1350     if (ofproto->fail_open) {
1351         fail_open_flushed(ofproto->fail_open);
1352     }
1353 }
1354 \f
1355 static void
1356 reinit_ports(struct ofproto *p)
1357 {
1358     struct svec devnames;
1359     struct ofport *ofport;
1360     struct odp_port *odp_ports;
1361     size_t n_odp_ports;
1362     size_t i;
1363
1364     COVERAGE_INC(ofproto_reinit_ports);
1365
1366     svec_init(&devnames);
1367     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1368         svec_add (&devnames, (char *) ofport->opp.name);
1369     }
1370     dpif_port_list(p->dpif, &odp_ports, &n_odp_ports);
1371     for (i = 0; i < n_odp_ports; i++) {
1372         svec_add (&devnames, odp_ports[i].devname);
1373     }
1374     free(odp_ports);
1375
1376     svec_sort_unique(&devnames);
1377     for (i = 0; i < devnames.n; i++) {
1378         update_port(p, devnames.names[i]);
1379     }
1380     svec_destroy(&devnames);
1381 }
1382
1383 static struct ofport *
1384 make_ofport(const struct odp_port *odp_port)
1385 {
1386     struct netdev_options netdev_options;
1387     enum netdev_flags flags;
1388     struct ofport *ofport;
1389     struct netdev *netdev;
1390     int error;
1391
1392     memset(&netdev_options, 0, sizeof netdev_options);
1393     netdev_options.name = odp_port->devname;
1394     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1395
1396     error = netdev_open(&netdev_options, &netdev);
1397     if (error) {
1398         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1399                      "cannot be opened (%s)",
1400                      odp_port->devname, odp_port->port,
1401                      odp_port->devname, strerror(error));
1402         return NULL;
1403     }
1404
1405     ofport = xmalloc(sizeof *ofport);
1406     ofport->netdev = netdev;
1407     ofport->odp_port = odp_port->port;
1408     ofport->opp.port_no = odp_port_to_ofp_port(odp_port->port);
1409     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1410     memcpy(ofport->opp.name, odp_port->devname,
1411            MIN(sizeof ofport->opp.name, sizeof odp_port->devname));
1412     ofport->opp.name[sizeof ofport->opp.name - 1] = '\0';
1413
1414     netdev_get_flags(netdev, &flags);
1415     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1416
1417     ofport->opp.state = netdev_get_carrier(netdev) ? 0 : OFPPS_LINK_DOWN;
1418
1419     netdev_get_features(netdev,
1420                         &ofport->opp.curr, &ofport->opp.advertised,
1421                         &ofport->opp.supported, &ofport->opp.peer);
1422     return ofport;
1423 }
1424
1425 static bool
1426 ofport_conflicts(const struct ofproto *p, const struct odp_port *odp_port)
1427 {
1428     if (get_port(p, odp_port->port)) {
1429         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1430                      odp_port->port);
1431         return true;
1432     } else if (shash_find(&p->port_by_name, odp_port->devname)) {
1433         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1434                      odp_port->devname);
1435         return true;
1436     } else {
1437         return false;
1438     }
1439 }
1440
1441 static int
1442 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1443 {
1444     const struct ofp_phy_port *a = &a_->opp;
1445     const struct ofp_phy_port *b = &b_->opp;
1446
1447     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1448     return (a->port_no == b->port_no
1449             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1450             && !strcmp((char *) a->name, (char *) b->name)
1451             && a->state == b->state
1452             && a->config == b->config
1453             && a->curr == b->curr
1454             && a->advertised == b->advertised
1455             && a->supported == b->supported
1456             && a->peer == b->peer);
1457 }
1458
1459 static void
1460 send_port_status(struct ofproto *p, const struct ofport *ofport,
1461                  uint8_t reason)
1462 {
1463     /* XXX Should limit the number of queued port status change messages. */
1464     struct ofconn *ofconn;
1465     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1466         struct ofp_port_status *ops;
1467         struct ofpbuf *b;
1468
1469         if (!ofconn_receives_async_msgs(ofconn)) {
1470             continue;
1471         }
1472
1473         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1474         ops->reason = reason;
1475         ops->desc = ofport->opp;
1476         hton_ofp_phy_port(&ops->desc);
1477         queue_tx(b, ofconn, NULL);
1478     }
1479 }
1480
1481 static void
1482 ofport_install(struct ofproto *p, struct ofport *ofport)
1483 {
1484     const char *netdev_name = (const char *) ofport->opp.name;
1485
1486     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1487     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->odp_port, 0));
1488     shash_add(&p->port_by_name, netdev_name, ofport);
1489     if (p->sflow) {
1490         ofproto_sflow_add_port(p->sflow, ofport->odp_port, netdev_name);
1491     }
1492 }
1493
1494 static void
1495 ofport_remove(struct ofproto *p, struct ofport *ofport)
1496 {
1497     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1498     hmap_remove(&p->ports, &ofport->hmap_node);
1499     shash_delete(&p->port_by_name,
1500                  shash_find(&p->port_by_name, (char *) ofport->opp.name));
1501     if (p->sflow) {
1502         ofproto_sflow_del_port(p->sflow, ofport->odp_port);
1503     }
1504 }
1505
1506 static void
1507 ofport_free(struct ofport *ofport)
1508 {
1509     if (ofport) {
1510         netdev_close(ofport->netdev);
1511         free(ofport);
1512     }
1513 }
1514
1515 static struct ofport *
1516 get_port(const struct ofproto *ofproto, uint16_t odp_port)
1517 {
1518     struct ofport *port;
1519
1520     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1521                              hash_int(odp_port, 0), &ofproto->ports) {
1522         if (port->odp_port == odp_port) {
1523             return port;
1524         }
1525     }
1526     return NULL;
1527 }
1528
1529 static void
1530 update_port(struct ofproto *p, const char *devname)
1531 {
1532     struct odp_port odp_port;
1533     struct ofport *old_ofport;
1534     struct ofport *new_ofport;
1535     int error;
1536
1537     COVERAGE_INC(ofproto_update_port);
1538
1539     /* Query the datapath for port information. */
1540     error = dpif_port_query_by_name(p->dpif, devname, &odp_port);
1541
1542     /* Find the old ofport. */
1543     old_ofport = shash_find_data(&p->port_by_name, devname);
1544     if (!error) {
1545         if (!old_ofport) {
1546             /* There's no port named 'devname' but there might be a port with
1547              * the same port number.  This could happen if a port is deleted
1548              * and then a new one added in its place very quickly, or if a port
1549              * is renamed.  In the former case we want to send an OFPPR_DELETE
1550              * and an OFPPR_ADD, and in the latter case we want to send a
1551              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1552              * the old port's ifindex against the new port, or perhaps less
1553              * reliably but more portably by comparing the old port's MAC
1554              * against the new port's MAC.  However, this code isn't that smart
1555              * and always sends an OFPPR_MODIFY (XXX). */
1556             old_ofport = get_port(p, odp_port.port);
1557         }
1558     } else if (error != ENOENT && error != ENODEV) {
1559         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1560                      "%s", strerror(error));
1561         return;
1562     }
1563
1564     /* Create a new ofport. */
1565     new_ofport = !error ? make_ofport(&odp_port) : NULL;
1566
1567     /* Eliminate a few pathological cases. */
1568     if (!old_ofport && !new_ofport) {
1569         return;
1570     } else if (old_ofport && new_ofport) {
1571         /* Most of the 'config' bits are OpenFlow soft state, but
1572          * OFPPC_PORT_DOWN is maintained the kernel.  So transfer the OpenFlow
1573          * bits from old_ofport.  (make_ofport() only sets OFPPC_PORT_DOWN and
1574          * leaves the other bits 0.)  */
1575         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1576
1577         if (ofport_equal(old_ofport, new_ofport)) {
1578             /* False alarm--no change. */
1579             ofport_free(new_ofport);
1580             return;
1581         }
1582     }
1583
1584     /* Now deal with the normal cases. */
1585     if (old_ofport) {
1586         ofport_remove(p, old_ofport);
1587     }
1588     if (new_ofport) {
1589         ofport_install(p, new_ofport);
1590     }
1591     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1592                      (!old_ofport ? OFPPR_ADD
1593                       : !new_ofport ? OFPPR_DELETE
1594                       : OFPPR_MODIFY));
1595     ofport_free(old_ofport);
1596 }
1597
1598 static int
1599 init_ports(struct ofproto *p)
1600 {
1601     struct odp_port *ports;
1602     size_t n_ports;
1603     size_t i;
1604     int error;
1605
1606     error = dpif_port_list(p->dpif, &ports, &n_ports);
1607     if (error) {
1608         return error;
1609     }
1610
1611     for (i = 0; i < n_ports; i++) {
1612         const struct odp_port *odp_port = &ports[i];
1613         if (!ofport_conflicts(p, odp_port)) {
1614             struct ofport *ofport = make_ofport(odp_port);
1615             if (ofport) {
1616                 ofport_install(p, ofport);
1617             }
1618         }
1619     }
1620     free(ports);
1621     return 0;
1622 }
1623 \f
1624 static struct ofconn *
1625 ofconn_create(struct ofproto *p, struct rconn *rconn, enum ofconn_type type)
1626 {
1627     struct ofconn *ofconn = xzalloc(sizeof *ofconn);
1628     ofconn->ofproto = p;
1629     list_push_back(&p->all_conns, &ofconn->node);
1630     ofconn->rconn = rconn;
1631     ofconn->type = type;
1632     ofconn->flow_format = NXFF_OPENFLOW10;
1633     ofconn->role = NX_ROLE_OTHER;
1634     ofconn->packet_in_counter = rconn_packet_counter_create ();
1635     ofconn->pktbuf = NULL;
1636     ofconn->miss_send_len = 0;
1637     ofconn->reply_counter = rconn_packet_counter_create ();
1638     return ofconn;
1639 }
1640
1641 static void
1642 ofconn_destroy(struct ofconn *ofconn)
1643 {
1644     if (ofconn->type == OFCONN_PRIMARY) {
1645         hmap_remove(&ofconn->ofproto->controllers, &ofconn->hmap_node);
1646     }
1647     discovery_destroy(ofconn->discovery);
1648
1649     list_remove(&ofconn->node);
1650     switch_status_unregister(ofconn->ss);
1651     rconn_destroy(ofconn->rconn);
1652     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1653     rconn_packet_counter_destroy(ofconn->reply_counter);
1654     pktbuf_destroy(ofconn->pktbuf);
1655     free(ofconn);
1656 }
1657
1658 static void
1659 ofconn_run(struct ofconn *ofconn)
1660 {
1661     struct ofproto *p = ofconn->ofproto;
1662     int iteration;
1663     size_t i;
1664
1665     if (ofconn->discovery) {
1666         char *controller_name;
1667         if (rconn_is_connectivity_questionable(ofconn->rconn)) {
1668             discovery_question_connectivity(ofconn->discovery);
1669         }
1670         if (discovery_run(ofconn->discovery, &controller_name)) {
1671             if (controller_name) {
1672                 char *ofconn_name = ofconn_make_name(p, controller_name);
1673                 rconn_connect(ofconn->rconn, controller_name, ofconn_name);
1674                 free(ofconn_name);
1675             } else {
1676                 rconn_disconnect(ofconn->rconn);
1677             }
1678         }
1679     }
1680
1681     for (i = 0; i < N_SCHEDULERS; i++) {
1682         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1683     }
1684
1685     rconn_run(ofconn->rconn);
1686
1687     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1688         /* Limit the number of iterations to prevent other tasks from
1689          * starving. */
1690         for (iteration = 0; iteration < 50; iteration++) {
1691             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1692             if (!of_msg) {
1693                 break;
1694             }
1695             if (p->fail_open) {
1696                 fail_open_maybe_recover(p->fail_open);
1697             }
1698             handle_openflow(ofconn, of_msg);
1699             ofpbuf_delete(of_msg);
1700         }
1701     }
1702
1703     if (!ofconn->discovery && !rconn_is_alive(ofconn->rconn)) {
1704         ofconn_destroy(ofconn);
1705     }
1706 }
1707
1708 static void
1709 ofconn_wait(struct ofconn *ofconn)
1710 {
1711     int i;
1712
1713     if (ofconn->discovery) {
1714         discovery_wait(ofconn->discovery);
1715     }
1716     for (i = 0; i < N_SCHEDULERS; i++) {
1717         pinsched_wait(ofconn->schedulers[i]);
1718     }
1719     rconn_run_wait(ofconn->rconn);
1720     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1721         rconn_recv_wait(ofconn->rconn);
1722     } else {
1723         COVERAGE_INC(ofproto_ofconn_stuck);
1724     }
1725 }
1726
1727 /* Returns true if 'ofconn' should receive asynchronous messages. */
1728 static bool
1729 ofconn_receives_async_msgs(const struct ofconn *ofconn)
1730 {
1731     if (ofconn->type == OFCONN_PRIMARY) {
1732         /* Primary controllers always get asynchronous messages unless they
1733          * have configured themselves as "slaves".  */
1734         return ofconn->role != NX_ROLE_SLAVE;
1735     } else {
1736         /* Service connections don't get asynchronous messages unless they have
1737          * explicitly asked for them by setting a nonzero miss send length. */
1738         return ofconn->miss_send_len > 0;
1739     }
1740 }
1741
1742 /* Returns a human-readable name for an OpenFlow connection between 'ofproto'
1743  * and 'target', suitable for use in log messages for identifying the
1744  * connection.
1745  *
1746  * The name is dynamically allocated.  The caller should free it (with free())
1747  * when it is no longer needed. */
1748 static char *
1749 ofconn_make_name(const struct ofproto *ofproto, const char *target)
1750 {
1751     return xasprintf("%s<->%s", dpif_base_name(ofproto->dpif), target);
1752 }
1753
1754 static void
1755 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1756 {
1757     int i;
1758
1759     for (i = 0; i < N_SCHEDULERS; i++) {
1760         struct pinsched **s = &ofconn->schedulers[i];
1761
1762         if (rate > 0) {
1763             if (!*s) {
1764                 *s = pinsched_create(rate, burst,
1765                                      ofconn->ofproto->switch_status);
1766             } else {
1767                 pinsched_set_limits(*s, rate, burst);
1768             }
1769         } else {
1770             pinsched_destroy(*s);
1771             *s = NULL;
1772         }
1773     }
1774 }
1775 \f
1776 static void
1777 ofservice_reconfigure(struct ofservice *ofservice,
1778                       const struct ofproto_controller *c)
1779 {
1780     ofservice->probe_interval = c->probe_interval;
1781     ofservice->rate_limit = c->rate_limit;
1782     ofservice->burst_limit = c->burst_limit;
1783 }
1784
1785 /* Creates a new ofservice in 'ofproto'.  Returns 0 if successful, otherwise a
1786  * positive errno value. */
1787 static int
1788 ofservice_create(struct ofproto *ofproto, const struct ofproto_controller *c)
1789 {
1790     struct ofservice *ofservice;
1791     struct pvconn *pvconn;
1792     int error;
1793
1794     error = pvconn_open(c->target, &pvconn);
1795     if (error) {
1796         return error;
1797     }
1798
1799     ofservice = xzalloc(sizeof *ofservice);
1800     hmap_insert(&ofproto->services, &ofservice->node,
1801                 hash_string(c->target, 0));
1802     ofservice->pvconn = pvconn;
1803
1804     ofservice_reconfigure(ofservice, c);
1805
1806     return 0;
1807 }
1808
1809 static void
1810 ofservice_destroy(struct ofproto *ofproto, struct ofservice *ofservice)
1811 {
1812     hmap_remove(&ofproto->services, &ofservice->node);
1813     pvconn_close(ofservice->pvconn);
1814     free(ofservice);
1815 }
1816
1817 /* Finds and returns the ofservice within 'ofproto' that has the given
1818  * 'target', or a null pointer if none exists. */
1819 static struct ofservice *
1820 ofservice_lookup(struct ofproto *ofproto, const char *target)
1821 {
1822     struct ofservice *ofservice;
1823
1824     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1825                              &ofproto->services) {
1826         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1827             return ofservice;
1828         }
1829     }
1830     return NULL;
1831 }
1832 \f
1833 /* Caller is responsible for initializing the 'cr' member of the returned
1834  * rule. */
1835 static struct rule *
1836 rule_create(struct ofproto *ofproto, struct rule *super,
1837             const union ofp_action *actions, size_t n_actions,
1838             uint16_t idle_timeout, uint16_t hard_timeout,
1839             ovs_be64 flow_cookie, bool send_flow_removed)
1840 {
1841     struct rule *rule = xzalloc(sizeof *rule);
1842     rule->idle_timeout = idle_timeout;
1843     rule->hard_timeout = hard_timeout;
1844     rule->flow_cookie = flow_cookie;
1845     rule->used = rule->created = time_msec();
1846     rule->send_flow_removed = send_flow_removed;
1847     rule->super = super;
1848     if (super) {
1849         list_push_back(&super->list, &rule->list);
1850     } else {
1851         list_init(&rule->list);
1852     }
1853     if (n_actions > 0) {
1854         rule->n_actions = n_actions;
1855         rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1856     }
1857     netflow_flow_clear(&rule->nf_flow);
1858     netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->created);
1859
1860     return rule;
1861 }
1862
1863 static struct rule *
1864 rule_from_cls_rule(const struct cls_rule *cls_rule)
1865 {
1866     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1867 }
1868
1869 static void
1870 rule_free(struct rule *rule)
1871 {
1872     free(rule->actions);
1873     free(rule->odp_actions);
1874     free(rule);
1875 }
1876
1877 /* Destroys 'rule'.  If 'rule' is a subrule, also removes it from its
1878  * super-rule's list of subrules.  If 'rule' is a super-rule, also iterates
1879  * through all of its subrules and revalidates them, destroying any that no
1880  * longer has a super-rule (which is probably all of them).
1881  *
1882  * Before calling this function, the caller must make have removed 'rule' from
1883  * the classifier.  If 'rule' is an exact-match rule, the caller is also
1884  * responsible for ensuring that it has been uninstalled from the datapath. */
1885 static void
1886 rule_destroy(struct ofproto *ofproto, struct rule *rule)
1887 {
1888     if (!rule->super) {
1889         struct rule *subrule, *next;
1890         LIST_FOR_EACH_SAFE (subrule, next, list, &rule->list) {
1891             revalidate_rule(ofproto, subrule);
1892         }
1893     } else {
1894         list_remove(&rule->list);
1895     }
1896     rule_free(rule);
1897 }
1898
1899 static bool
1900 rule_has_out_port(const struct rule *rule, ovs_be16 out_port)
1901 {
1902     const union ofp_action *oa;
1903     struct actions_iterator i;
1904
1905     if (out_port == htons(OFPP_NONE)) {
1906         return true;
1907     }
1908     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1909          oa = actions_next(&i)) {
1910         if (action_outputs_to_port(oa, out_port)) {
1911             return true;
1912         }
1913     }
1914     return false;
1915 }
1916
1917 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
1918  * 'packet', which arrived on 'in_port'.
1919  *
1920  * Takes ownership of 'packet'. */
1921 static bool
1922 execute_odp_actions(struct ofproto *ofproto, uint16_t in_port,
1923                     const union odp_action *actions, size_t n_actions,
1924                     struct ofpbuf *packet)
1925 {
1926     if (n_actions == 1 && actions[0].type == ODPAT_CONTROLLER) {
1927         /* As an optimization, avoid a round-trip from userspace to kernel to
1928          * userspace.  This also avoids possibly filling up kernel packet
1929          * buffers along the way. */
1930         struct odp_msg *msg;
1931
1932         msg = ofpbuf_push_uninit(packet, sizeof *msg);
1933         msg->type = _ODPL_ACTION_NR;
1934         msg->length = sizeof(struct odp_msg) + packet->size;
1935         msg->port = in_port;
1936         msg->reserved = 0;
1937         msg->arg = actions[0].controller.arg;
1938
1939         send_packet_in(ofproto, packet);
1940
1941         return true;
1942     } else {
1943         int error;
1944
1945         error = dpif_execute(ofproto->dpif, actions, n_actions, packet);
1946         ofpbuf_delete(packet);
1947         return !error;
1948     }
1949 }
1950
1951 /* Executes the actions indicated by 'rule' on 'packet', which is in flow
1952  * 'flow' and is considered to have arrived on ODP port 'in_port'.  'packet'
1953  * must have at least sizeof(struct ofp_packet_in) bytes of headroom.
1954  *
1955  * The flow that 'packet' actually contains does not need to actually match
1956  * 'rule'; the actions in 'rule' will be applied to it either way.  Likewise,
1957  * the packet and byte counters for 'rule' will be credited for the packet sent
1958  * out whether or not the packet actually matches 'rule'.
1959  *
1960  * If 'rule' is an exact-match rule and 'flow' actually equals the rule's flow,
1961  * the caller must already have accurately composed ODP actions for it given
1962  * 'packet' using rule_make_actions().  If 'rule' is a wildcard rule, or if
1963  * 'rule' is an exact-match rule but 'flow' is not the rule's flow, then this
1964  * function will compose a set of ODP actions based on 'rule''s OpenFlow
1965  * actions and apply them to 'packet'.
1966  *
1967  * Takes ownership of 'packet'. */
1968 static void
1969 rule_execute(struct ofproto *ofproto, struct rule *rule,
1970              struct ofpbuf *packet, const struct flow *flow)
1971 {
1972     const union odp_action *actions;
1973     struct odp_flow_stats stats;
1974     size_t n_actions;
1975     struct odp_actions a;
1976
1977     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1978
1979     /* Grab or compose the ODP actions.
1980      *
1981      * The special case for an exact-match 'rule' where 'flow' is not the
1982      * rule's flow is important to avoid, e.g., sending a packet out its input
1983      * port simply because the ODP actions were composed for the wrong
1984      * scenario. */
1985     if (rule->cr.wc.wildcards || !flow_equal(flow, &rule->cr.flow)) {
1986         struct rule *super = rule->super ? rule->super : rule;
1987         if (xlate_actions(super->actions, super->n_actions, flow, ofproto,
1988                           packet, &a, NULL, 0, NULL)) {
1989             ofpbuf_delete(packet);
1990             return;
1991         }
1992         actions = a.actions;
1993         n_actions = a.n_actions;
1994     } else {
1995         actions = rule->odp_actions;
1996         n_actions = rule->n_odp_actions;
1997     }
1998
1999     /* Execute the ODP actions. */
2000     flow_extract_stats(flow, packet, &stats);
2001     if (execute_odp_actions(ofproto, flow->in_port,
2002                             actions, n_actions, packet)) {
2003         update_stats(ofproto, rule, &stats);
2004         rule->used = time_msec();
2005         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->used);
2006     }
2007 }
2008
2009 /* Inserts 'rule' into 'p''s flow table.
2010  *
2011  * If 'packet' is nonnull, takes ownership of 'packet', executes 'rule''s
2012  * actions on it and credits the statistics for sending the packet to 'rule'.
2013  * 'packet' must have at least sizeof(struct ofp_packet_in) bytes of
2014  * headroom. */
2015 static void
2016 rule_insert(struct ofproto *p, struct rule *rule, struct ofpbuf *packet,
2017             uint16_t in_port)
2018 {
2019     struct rule *displaced_rule;
2020
2021     /* Insert the rule in the classifier. */
2022     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
2023     if (!rule->cr.wc.wildcards) {
2024         rule_make_actions(p, rule, packet);
2025     }
2026
2027     /* Send the packet and credit it to the rule. */
2028     if (packet) {
2029         struct flow flow;
2030         flow_extract(packet, 0, in_port, &flow);
2031         rule_execute(p, rule, packet, &flow);
2032     }
2033
2034     /* Install the rule in the datapath only after sending the packet, to
2035      * avoid packet reordering.  */
2036     if (rule->cr.wc.wildcards) {
2037         COVERAGE_INC(ofproto_add_wc_flow);
2038         p->need_revalidate = true;
2039     } else {
2040         rule_install(p, rule, displaced_rule);
2041     }
2042
2043     /* Free the rule that was displaced, if any. */
2044     if (displaced_rule) {
2045         rule_destroy(p, displaced_rule);
2046     }
2047 }
2048
2049 static struct rule *
2050 rule_create_subrule(struct ofproto *ofproto, struct rule *rule,
2051                     const struct flow *flow)
2052 {
2053     struct rule *subrule = rule_create(ofproto, rule, NULL, 0,
2054                                        rule->idle_timeout, rule->hard_timeout,
2055                                        0, false);
2056     COVERAGE_INC(ofproto_subrule_create);
2057     cls_rule_init_exact(flow, (rule->cr.priority <= UINT16_MAX ? UINT16_MAX
2058                                : rule->cr.priority),
2059                         &subrule->cr);
2060
2061     if (classifier_insert(&ofproto->cls, &subrule->cr)) {
2062         /* Can't happen,  */
2063         NOT_REACHED();
2064     }
2065
2066     return subrule;
2067 }
2068
2069 /* Remove 'rule' from 'ofproto' and free up the associated memory:
2070  *
2071  *   - If 'rule' was installed in the datapath, uninstalls it and updates
2072  *     'rule''s statistics (or its super-rule's statistics, if it is a
2073  *     subrule), via rule_uninstall().
2074  *
2075  *   - Removes 'rule' from the classifier.
2076  *
2077  *   - If 'rule' is a super-rule that has subrules, revalidates (and possibly
2078  *     uninstalls and destroys) its subrules, via rule_destroy().
2079  */
2080 static void
2081 rule_remove(struct ofproto *ofproto, struct rule *rule)
2082 {
2083     if (rule->cr.wc.wildcards) {
2084         COVERAGE_INC(ofproto_del_wc_flow);
2085         ofproto->need_revalidate = true;
2086     } else {
2087         rule_uninstall(ofproto, rule);
2088     }
2089     classifier_remove(&ofproto->cls, &rule->cr);
2090     rule_destroy(ofproto, rule);
2091 }
2092
2093 /* Returns true if the actions changed, false otherwise. */
2094 static bool
2095 rule_make_actions(struct ofproto *p, struct rule *rule,
2096                   const struct ofpbuf *packet)
2097 {
2098     const struct rule *super;
2099     struct odp_actions a;
2100     size_t actions_len;
2101
2102     assert(!rule->cr.wc.wildcards);
2103
2104     super = rule->super ? rule->super : rule;
2105     rule->tags = 0;
2106     xlate_actions(super->actions, super->n_actions, &rule->cr.flow, p,
2107                   packet, &a, &rule->tags, &rule->may_install,
2108                   &rule->nf_flow.output_iface);
2109
2110     actions_len = a.n_actions * sizeof *a.actions;
2111     if (rule->n_odp_actions != a.n_actions
2112         || memcmp(rule->odp_actions, a.actions, actions_len)) {
2113         COVERAGE_INC(ofproto_odp_unchanged);
2114         free(rule->odp_actions);
2115         rule->n_odp_actions = a.n_actions;
2116         rule->odp_actions = xmemdup(a.actions, actions_len);
2117         return true;
2118     } else {
2119         return false;
2120     }
2121 }
2122
2123 static int
2124 do_put_flow(struct ofproto *ofproto, struct rule *rule, int flags,
2125             struct odp_flow_put *put)
2126 {
2127     memset(&put->flow.stats, 0, sizeof put->flow.stats);
2128     odp_flow_key_from_flow(&put->flow.key, &rule->cr.flow);
2129     put->flow.actions = rule->odp_actions;
2130     put->flow.n_actions = rule->n_odp_actions;
2131     put->flow.flags = 0;
2132     put->flags = flags;
2133     return dpif_flow_put(ofproto->dpif, put);
2134 }
2135
2136 static void
2137 rule_install(struct ofproto *p, struct rule *rule, struct rule *displaced_rule)
2138 {
2139     assert(!rule->cr.wc.wildcards);
2140
2141     if (rule->may_install) {
2142         struct odp_flow_put put;
2143         if (!do_put_flow(p, rule,
2144                          ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS,
2145                          &put)) {
2146             rule->installed = true;
2147             if (displaced_rule) {
2148                 update_stats(p, displaced_rule, &put.flow.stats);
2149                 rule_post_uninstall(p, displaced_rule);
2150             }
2151         }
2152     } else if (displaced_rule) {
2153         rule_uninstall(p, displaced_rule);
2154     }
2155 }
2156
2157 static void
2158 rule_reinstall(struct ofproto *ofproto, struct rule *rule)
2159 {
2160     if (rule->installed) {
2161         struct odp_flow_put put;
2162         COVERAGE_INC(ofproto_dp_missed);
2163         do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY, &put);
2164     } else {
2165         rule_install(ofproto, rule, NULL);
2166     }
2167 }
2168
2169 static void
2170 rule_update_actions(struct ofproto *ofproto, struct rule *rule)
2171 {
2172     bool actions_changed;
2173     uint16_t new_out_iface, old_out_iface;
2174
2175     old_out_iface = rule->nf_flow.output_iface;
2176     actions_changed = rule_make_actions(ofproto, rule, NULL);
2177
2178     if (rule->may_install) {
2179         if (rule->installed) {
2180             if (actions_changed) {
2181                 struct odp_flow_put put;
2182                 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY
2183                                            | ODPPF_ZERO_STATS, &put);
2184                 update_stats(ofproto, rule, &put.flow.stats);
2185
2186                 /* Temporarily set the old output iface so that NetFlow
2187                  * messages have the correct output interface for the old
2188                  * stats. */
2189                 new_out_iface = rule->nf_flow.output_iface;
2190                 rule->nf_flow.output_iface = old_out_iface;
2191                 rule_post_uninstall(ofproto, rule);
2192                 rule->nf_flow.output_iface = new_out_iface;
2193             }
2194         } else {
2195             rule_install(ofproto, rule, NULL);
2196         }
2197     } else {
2198         rule_uninstall(ofproto, rule);
2199     }
2200 }
2201
2202 static void
2203 rule_account(struct ofproto *ofproto, struct rule *rule, uint64_t extra_bytes)
2204 {
2205     uint64_t total_bytes = rule->byte_count + extra_bytes;
2206
2207     if (ofproto->ofhooks->account_flow_cb
2208         && total_bytes > rule->accounted_bytes)
2209     {
2210         ofproto->ofhooks->account_flow_cb(
2211             &rule->cr.flow, rule->tags, rule->odp_actions, rule->n_odp_actions,
2212             total_bytes - rule->accounted_bytes, ofproto->aux);
2213         rule->accounted_bytes = total_bytes;
2214     }
2215 }
2216
2217 /* 'rule' must be an exact-match rule in 'p'.
2218  *
2219  * If 'rule' is installed in the datapath, uninstalls it and updates's
2220  * statistics.  If 'rule' is a subrule, the statistics that are updated are
2221  * actually its super-rule's statistics; otherwise 'rule''s own statistics are
2222  * updated.
2223  *
2224  * If 'rule' is not installed, this function has no effect. */
2225 static void
2226 rule_uninstall(struct ofproto *p, struct rule *rule)
2227 {
2228     assert(!rule->cr.wc.wildcards);
2229     if (rule->installed) {
2230         struct odp_flow odp_flow;
2231
2232         odp_flow_key_from_flow(&odp_flow.key, &rule->cr.flow);
2233         odp_flow.actions = NULL;
2234         odp_flow.n_actions = 0;
2235         odp_flow.flags = 0;
2236         if (!dpif_flow_del(p->dpif, &odp_flow)) {
2237             update_stats(p, rule, &odp_flow.stats);
2238         }
2239         rule->installed = false;
2240
2241         rule_post_uninstall(p, rule);
2242     }
2243 }
2244
2245 static bool
2246 is_controller_rule(struct rule *rule)
2247 {
2248     /* If the only action is send to the controller then don't report
2249      * NetFlow expiration messages since it is just part of the control
2250      * logic for the network and not real traffic. */
2251
2252     return (rule
2253             && rule->super
2254             && rule->super->n_actions == 1
2255             && action_outputs_to_port(&rule->super->actions[0],
2256                                       htons(OFPP_CONTROLLER)));
2257 }
2258
2259 static void
2260 rule_post_uninstall(struct ofproto *ofproto, struct rule *rule)
2261 {
2262     struct rule *super = rule->super;
2263
2264     rule_account(ofproto, rule, 0);
2265
2266     if (ofproto->netflow && !is_controller_rule(rule)) {
2267         struct ofexpired expired;
2268         expired.flow = rule->cr.flow;
2269         expired.packet_count = rule->packet_count;
2270         expired.byte_count = rule->byte_count;
2271         expired.used = rule->used;
2272         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
2273     }
2274     if (super) {
2275         super->packet_count += rule->packet_count;
2276         super->byte_count += rule->byte_count;
2277
2278         /* Reset counters to prevent double counting if the rule ever gets
2279          * reinstalled. */
2280         rule->packet_count = 0;
2281         rule->byte_count = 0;
2282         rule->accounted_bytes = 0;
2283
2284         netflow_flow_clear(&rule->nf_flow);
2285     }
2286 }
2287 \f
2288 static void
2289 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
2290          struct rconn_packet_counter *counter)
2291 {
2292     update_openflow_length(msg);
2293     if (rconn_send(ofconn->rconn, msg, counter)) {
2294         ofpbuf_delete(msg);
2295     }
2296 }
2297
2298 static void
2299 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
2300               int error)
2301 {
2302     struct ofpbuf *buf = make_ofp_error_msg(error, oh);
2303     if (buf) {
2304         COVERAGE_INC(ofproto_error);
2305         queue_tx(buf, ofconn, ofconn->reply_counter);
2306     }
2307 }
2308
2309 static void
2310 hton_ofp_phy_port(struct ofp_phy_port *opp)
2311 {
2312     opp->port_no = htons(opp->port_no);
2313     opp->config = htonl(opp->config);
2314     opp->state = htonl(opp->state);
2315     opp->curr = htonl(opp->curr);
2316     opp->advertised = htonl(opp->advertised);
2317     opp->supported = htonl(opp->supported);
2318     opp->peer = htonl(opp->peer);
2319 }
2320
2321 static int
2322 handle_echo_request(struct ofconn *ofconn, struct ofp_header *oh)
2323 {
2324     struct ofp_header *rq = oh;
2325     queue_tx(make_echo_reply(rq), ofconn, ofconn->reply_counter);
2326     return 0;
2327 }
2328
2329 static int
2330 handle_features_request(struct ofconn *ofconn, struct ofp_header *oh)
2331 {
2332     struct ofp_switch_features *osf;
2333     struct ofpbuf *buf;
2334     struct ofport *port;
2335
2336     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
2337     osf->datapath_id = htonll(ofconn->ofproto->datapath_id);
2338     osf->n_buffers = htonl(pktbuf_capacity());
2339     osf->n_tables = 2;
2340     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
2341                               OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
2342     osf->actions = htonl((1u << OFPAT_OUTPUT) |
2343                          (1u << OFPAT_SET_VLAN_VID) |
2344                          (1u << OFPAT_SET_VLAN_PCP) |
2345                          (1u << OFPAT_STRIP_VLAN) |
2346                          (1u << OFPAT_SET_DL_SRC) |
2347                          (1u << OFPAT_SET_DL_DST) |
2348                          (1u << OFPAT_SET_NW_SRC) |
2349                          (1u << OFPAT_SET_NW_DST) |
2350                          (1u << OFPAT_SET_NW_TOS) |
2351                          (1u << OFPAT_SET_TP_SRC) |
2352                          (1u << OFPAT_SET_TP_DST) |
2353                          (1u << OFPAT_ENQUEUE));
2354
2355     HMAP_FOR_EACH (port, hmap_node, &ofconn->ofproto->ports) {
2356         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
2357     }
2358
2359     queue_tx(buf, ofconn, ofconn->reply_counter);
2360     return 0;
2361 }
2362
2363 static int
2364 handle_get_config_request(struct ofconn *ofconn, struct ofp_header *oh)
2365 {
2366     struct ofpbuf *buf;
2367     struct ofp_switch_config *osc;
2368     uint16_t flags;
2369     bool drop_frags;
2370
2371     /* Figure out flags. */
2372     dpif_get_drop_frags(ofconn->ofproto->dpif, &drop_frags);
2373     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
2374
2375     /* Send reply. */
2376     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
2377     osc->flags = htons(flags);
2378     osc->miss_send_len = htons(ofconn->miss_send_len);
2379     queue_tx(buf, ofconn, ofconn->reply_counter);
2380
2381     return 0;
2382 }
2383
2384 static int
2385 handle_set_config(struct ofconn *ofconn, struct ofp_switch_config *osc)
2386 {
2387     uint16_t flags;
2388     int error;
2389
2390     error = check_ofp_message(&osc->header, OFPT_SET_CONFIG, sizeof *osc);
2391     if (error) {
2392         return error;
2393     }
2394     flags = ntohs(osc->flags);
2395
2396     if (ofconn->type == OFCONN_PRIMARY && ofconn->role != NX_ROLE_SLAVE) {
2397         switch (flags & OFPC_FRAG_MASK) {
2398         case OFPC_FRAG_NORMAL:
2399             dpif_set_drop_frags(ofconn->ofproto->dpif, false);
2400             break;
2401         case OFPC_FRAG_DROP:
2402             dpif_set_drop_frags(ofconn->ofproto->dpif, true);
2403             break;
2404         default:
2405             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
2406                          osc->flags);
2407             break;
2408         }
2409     }
2410
2411     ofconn->miss_send_len = ntohs(osc->miss_send_len);
2412
2413     return 0;
2414 }
2415
2416 static void
2417 add_controller_action(struct odp_actions *actions, uint16_t max_len)
2418 {
2419     union odp_action *a = odp_actions_add(actions, ODPAT_CONTROLLER);
2420     a->controller.arg = max_len;
2421 }
2422
2423 struct action_xlate_ctx {
2424     /* Input. */
2425     struct flow flow;           /* Flow to which these actions correspond. */
2426     int recurse;                /* Recursion level, via xlate_table_action. */
2427     struct ofproto *ofproto;
2428     const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
2429                                   * null pointer if we are revalidating
2430                                   * without a packet to refer to. */
2431
2432     /* Output. */
2433     struct odp_actions *out;    /* Datapath actions. */
2434     tag_type *tags;             /* Tags associated with OFPP_NORMAL actions. */
2435     bool may_set_up_flow;       /* True ordinarily; false if the actions must
2436                                  * be reassessed for every packet. */
2437     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
2438 };
2439
2440 /* Maximum depth of flow table recursion (due to NXAST_RESUBMIT actions) in a
2441  * flow translation. */
2442 #define MAX_RESUBMIT_RECURSION 8
2443
2444 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2445                              struct action_xlate_ctx *ctx);
2446
2447 static void
2448 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
2449 {
2450     const struct ofport *ofport = get_port(ctx->ofproto, port);
2451
2452     if (ofport) {
2453         if (ofport->opp.config & OFPPC_NO_FWD) {
2454             /* Forwarding disabled on port. */
2455             return;
2456         }
2457     } else {
2458         /*
2459          * We don't have an ofport record for this port, but it doesn't hurt to
2460          * allow forwarding to it anyhow.  Maybe such a port will appear later
2461          * and we're pre-populating the flow table.
2462          */
2463     }
2464
2465     odp_actions_add(ctx->out, ODPAT_OUTPUT)->output.port = port;
2466     ctx->nf_output_iface = port;
2467 }
2468
2469 static struct rule *
2470 lookup_valid_rule(struct ofproto *ofproto, const struct flow *flow)
2471 {
2472     struct rule *rule;
2473     rule = rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow,
2474                                                 CLS_INC_ALL));
2475
2476     /* The rule we found might not be valid, since we could be in need of
2477      * revalidation.  If it is not valid, don't return it. */
2478     if (rule
2479         && rule->super
2480         && ofproto->need_revalidate
2481         && !revalidate_rule(ofproto, rule)) {
2482         COVERAGE_INC(ofproto_invalidated);
2483         return NULL;
2484     }
2485
2486     return rule;
2487 }
2488
2489 static void
2490 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2491 {
2492     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2493         uint16_t old_in_port;
2494         struct rule *rule;
2495
2496         /* Look up a flow with 'in_port' as the input port.  Then restore the
2497          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2498          * have surprising behavior). */
2499         old_in_port = ctx->flow.in_port;
2500         ctx->flow.in_port = in_port;
2501         rule = lookup_valid_rule(ctx->ofproto, &ctx->flow);
2502         ctx->flow.in_port = old_in_port;
2503
2504         if (rule) {
2505             if (rule->super) {
2506                 rule = rule->super;
2507             }
2508
2509             ctx->recurse++;
2510             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2511             ctx->recurse--;
2512         }
2513     } else {
2514         struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2515
2516         VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2517                     MAX_RESUBMIT_RECURSION);
2518     }
2519 }
2520
2521 static void
2522 flood_packets(struct ofproto *ofproto, uint16_t odp_in_port, uint32_t mask,
2523               uint16_t *nf_output_iface, struct odp_actions *actions)
2524 {
2525     struct ofport *ofport;
2526
2527     HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
2528         uint16_t odp_port = ofport->odp_port;
2529         if (odp_port != odp_in_port && !(ofport->opp.config & mask)) {
2530             odp_actions_add(actions, ODPAT_OUTPUT)->output.port = odp_port;
2531         }
2532     }
2533     *nf_output_iface = NF_OUT_FLOOD;
2534 }
2535
2536 static void
2537 xlate_output_action__(struct action_xlate_ctx *ctx,
2538                       uint16_t port, uint16_t max_len)
2539 {
2540     uint16_t odp_port;
2541     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2542
2543     ctx->nf_output_iface = NF_OUT_DROP;
2544
2545     switch (port) {
2546     case OFPP_IN_PORT:
2547         add_output_action(ctx, ctx->flow.in_port);
2548         break;
2549     case OFPP_TABLE:
2550         xlate_table_action(ctx, ctx->flow.in_port);
2551         break;
2552     case OFPP_NORMAL:
2553         if (!ctx->ofproto->ofhooks->normal_cb(&ctx->flow, ctx->packet,
2554                                               ctx->out, ctx->tags,
2555                                               &ctx->nf_output_iface,
2556                                               ctx->ofproto->aux)) {
2557             COVERAGE_INC(ofproto_uninstallable);
2558             ctx->may_set_up_flow = false;
2559         }
2560         break;
2561     case OFPP_FLOOD:
2562         flood_packets(ctx->ofproto, ctx->flow.in_port, OFPPC_NO_FLOOD,
2563                       &ctx->nf_output_iface, ctx->out);
2564         break;
2565     case OFPP_ALL:
2566         flood_packets(ctx->ofproto, ctx->flow.in_port, 0,
2567                       &ctx->nf_output_iface, ctx->out);
2568         break;
2569     case OFPP_CONTROLLER:
2570         add_controller_action(ctx->out, max_len);
2571         break;
2572     case OFPP_LOCAL:
2573         add_output_action(ctx, ODPP_LOCAL);
2574         break;
2575     default:
2576         odp_port = ofp_port_to_odp_port(port);
2577         if (odp_port != ctx->flow.in_port) {
2578             add_output_action(ctx, odp_port);
2579         }
2580         break;
2581     }
2582
2583     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2584         ctx->nf_output_iface = NF_OUT_FLOOD;
2585     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2586         ctx->nf_output_iface = prev_nf_output_iface;
2587     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2588                ctx->nf_output_iface != NF_OUT_FLOOD) {
2589         ctx->nf_output_iface = NF_OUT_MULTI;
2590     }
2591 }
2592
2593 static void
2594 xlate_output_action(struct action_xlate_ctx *ctx,
2595                     const struct ofp_action_output *oao)
2596 {
2597     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2598 }
2599
2600 /* If the final ODP action in 'ctx' is "pop priority", drop it, as an
2601  * optimization, because we're going to add another action that sets the
2602  * priority immediately after, or because there are no actions following the
2603  * pop.  */
2604 static void
2605 remove_pop_action(struct action_xlate_ctx *ctx)
2606 {
2607     size_t n = ctx->out->n_actions;
2608     if (n > 0 && ctx->out->actions[n - 1].type == ODPAT_POP_PRIORITY) {
2609         ctx->out->n_actions--;
2610     }
2611 }
2612
2613 static void
2614 xlate_enqueue_action(struct action_xlate_ctx *ctx,
2615                      const struct ofp_action_enqueue *oae)
2616 {
2617     uint16_t ofp_port, odp_port;
2618     uint32_t priority;
2619     int error;
2620
2621     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
2622                                    &priority);
2623     if (error) {
2624         /* Fall back to ordinary output action. */
2625         xlate_output_action__(ctx, ntohs(oae->port), 0);
2626         return;
2627     }
2628
2629     /* Figure out ODP output port. */
2630     ofp_port = ntohs(oae->port);
2631     if (ofp_port != OFPP_IN_PORT) {
2632         odp_port = ofp_port_to_odp_port(ofp_port);
2633     } else {
2634         odp_port = ctx->flow.in_port;
2635     }
2636
2637     /* Add ODP actions. */
2638     remove_pop_action(ctx);
2639     odp_actions_add(ctx->out, ODPAT_SET_PRIORITY)->priority.priority
2640         = priority;
2641     add_output_action(ctx, odp_port);
2642     odp_actions_add(ctx->out, ODPAT_POP_PRIORITY);
2643
2644     /* Update NetFlow output port. */
2645     if (ctx->nf_output_iface == NF_OUT_DROP) {
2646         ctx->nf_output_iface = odp_port;
2647     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
2648         ctx->nf_output_iface = NF_OUT_MULTI;
2649     }
2650 }
2651
2652 static void
2653 xlate_set_queue_action(struct action_xlate_ctx *ctx,
2654                        const struct nx_action_set_queue *nasq)
2655 {
2656     uint32_t priority;
2657     int error;
2658
2659     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
2660                                    &priority);
2661     if (error) {
2662         /* Couldn't translate queue to a priority, so ignore.  A warning
2663          * has already been logged. */
2664         return;
2665     }
2666
2667     remove_pop_action(ctx);
2668     odp_actions_add(ctx->out, ODPAT_SET_PRIORITY)->priority.priority
2669         = priority;
2670 }
2671
2672 static void
2673 xlate_nicira_action(struct action_xlate_ctx *ctx,
2674                     const struct nx_action_header *nah)
2675 {
2676     const struct nx_action_resubmit *nar;
2677     const struct nx_action_set_tunnel *nast;
2678     const struct nx_action_set_queue *nasq;
2679     union odp_action *oa;
2680     int subtype = ntohs(nah->subtype);
2681
2682     assert(nah->vendor == htonl(NX_VENDOR_ID));
2683     switch (subtype) {
2684     case NXAST_RESUBMIT:
2685         nar = (const struct nx_action_resubmit *) nah;
2686         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2687         break;
2688
2689     case NXAST_SET_TUNNEL:
2690         nast = (const struct nx_action_set_tunnel *) nah;
2691         oa = odp_actions_add(ctx->out, ODPAT_SET_TUNNEL);
2692         ctx->flow.tun_id = oa->tunnel.tun_id = nast->tun_id;
2693         break;
2694
2695     case NXAST_DROP_SPOOFED_ARP:
2696         if (ctx->flow.dl_type == htons(ETH_TYPE_ARP)) {
2697             odp_actions_add(ctx->out, ODPAT_DROP_SPOOFED_ARP);
2698         }
2699         break;
2700
2701     case NXAST_SET_QUEUE:
2702         nasq = (const struct nx_action_set_queue *) nah;
2703         xlate_set_queue_action(ctx, nasq);
2704         break;
2705
2706     case NXAST_POP_QUEUE:
2707         odp_actions_add(ctx->out, ODPAT_POP_PRIORITY);
2708         break;
2709
2710     /* If you add a new action here that modifies flow data, don't forget to
2711      * update the flow key in ctx->flow at the same time. */
2712
2713     default:
2714         VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
2715         break;
2716     }
2717 }
2718
2719 static void
2720 do_xlate_actions(const union ofp_action *in, size_t n_in,
2721                  struct action_xlate_ctx *ctx)
2722 {
2723     struct actions_iterator iter;
2724     const union ofp_action *ia;
2725     const struct ofport *port;
2726
2727     port = get_port(ctx->ofproto, ctx->flow.in_port);
2728     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2729         port->opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
2730                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2731         /* Drop this flow. */
2732         return;
2733     }
2734
2735     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2736         uint16_t type = ntohs(ia->type);
2737         union odp_action *oa;
2738
2739         switch (type) {
2740         case OFPAT_OUTPUT:
2741             xlate_output_action(ctx, &ia->output);
2742             break;
2743
2744         case OFPAT_SET_VLAN_VID:
2745             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_TCI);
2746             oa->dl_tci.tci = ia->vlan_vid.vlan_vid;
2747             oa->dl_tci.tci |= htons(ctx->flow.dl_vlan_pcp << VLAN_PCP_SHIFT);
2748             ctx->flow.dl_vlan = ia->vlan_vid.vlan_vid;
2749             break;
2750
2751         case OFPAT_SET_VLAN_PCP:
2752             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_TCI);
2753             oa->dl_tci.tci = htons(ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT);
2754             oa->dl_tci.tci |= ctx->flow.dl_vlan;
2755             ctx->flow.dl_vlan_pcp = ia->vlan_pcp.vlan_pcp;
2756             break;
2757
2758         case OFPAT_STRIP_VLAN:
2759             odp_actions_add(ctx->out, ODPAT_STRIP_VLAN);
2760             ctx->flow.dl_vlan = htons(OFP_VLAN_NONE);
2761             ctx->flow.dl_vlan_pcp = 0;
2762             break;
2763
2764         case OFPAT_SET_DL_SRC:
2765             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_SRC);
2766             memcpy(oa->dl_addr.dl_addr,
2767                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2768             memcpy(ctx->flow.dl_src,
2769                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2770             break;
2771
2772         case OFPAT_SET_DL_DST:
2773             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_DST);
2774             memcpy(oa->dl_addr.dl_addr,
2775                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2776             memcpy(ctx->flow.dl_dst,
2777                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2778             break;
2779
2780         case OFPAT_SET_NW_SRC:
2781             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_SRC);
2782             ctx->flow.nw_src = oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2783             break;
2784
2785         case OFPAT_SET_NW_DST:
2786             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_DST);
2787             ctx->flow.nw_dst = oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2788             break;
2789
2790         case OFPAT_SET_NW_TOS:
2791             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_TOS);
2792             ctx->flow.nw_tos = oa->nw_tos.nw_tos = ia->nw_tos.nw_tos;
2793             break;
2794
2795         case OFPAT_SET_TP_SRC:
2796             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_SRC);
2797             ctx->flow.tp_src = oa->tp_port.tp_port = ia->tp_port.tp_port;
2798             break;
2799
2800         case OFPAT_SET_TP_DST:
2801             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_DST);
2802             ctx->flow.tp_dst = oa->tp_port.tp_port = ia->tp_port.tp_port;
2803             break;
2804
2805         case OFPAT_VENDOR:
2806             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
2807             break;
2808
2809         case OFPAT_ENQUEUE:
2810             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
2811             break;
2812
2813         default:
2814             VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
2815             break;
2816         }
2817     }
2818 }
2819
2820 static int
2821 xlate_actions(const union ofp_action *in, size_t n_in,
2822               const struct flow *flow, struct ofproto *ofproto,
2823               const struct ofpbuf *packet,
2824               struct odp_actions *out, tag_type *tags, bool *may_set_up_flow,
2825               uint16_t *nf_output_iface)
2826 {
2827     tag_type no_tags = 0;
2828     struct action_xlate_ctx ctx;
2829     COVERAGE_INC(ofproto_ofp2odp);
2830     odp_actions_init(out);
2831     ctx.flow = *flow;
2832     ctx.recurse = 0;
2833     ctx.ofproto = ofproto;
2834     ctx.packet = packet;
2835     ctx.out = out;
2836     ctx.tags = tags ? tags : &no_tags;
2837     ctx.may_set_up_flow = true;
2838     ctx.nf_output_iface = NF_OUT_DROP;
2839     do_xlate_actions(in, n_in, &ctx);
2840     remove_pop_action(&ctx);
2841
2842     /* Check with in-band control to see if we're allowed to set up this
2843      * flow. */
2844     if (!in_band_rule_check(ofproto->in_band, flow, out)) {
2845         ctx.may_set_up_flow = false;
2846     }
2847
2848     if (may_set_up_flow) {
2849         *may_set_up_flow = ctx.may_set_up_flow;
2850     }
2851     if (nf_output_iface) {
2852         *nf_output_iface = ctx.nf_output_iface;
2853     }
2854     if (odp_actions_overflow(out)) {
2855         COVERAGE_INC(odp_overflow);
2856         odp_actions_init(out);
2857         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
2858     }
2859     return 0;
2860 }
2861
2862 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
2863  * error message code (composed with ofp_mkerr()) for the caller to propagate
2864  * upward.  Otherwise, returns 0.
2865  *
2866  * The log message mentions 'msg_type'. */
2867 static int
2868 reject_slave_controller(struct ofconn *ofconn, const const char *msg_type)
2869 {
2870     if (ofconn->type == OFCONN_PRIMARY && ofconn->role == NX_ROLE_SLAVE) {
2871         static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
2872         VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
2873                      msg_type);
2874
2875         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2876     } else {
2877         return 0;
2878     }
2879 }
2880
2881 static int
2882 handle_packet_out(struct ofconn *ofconn, struct ofp_header *oh)
2883 {
2884     struct ofproto *p = ofconn->ofproto;
2885     struct ofp_packet_out *opo;
2886     struct ofpbuf payload, *buffer;
2887     struct odp_actions actions;
2888     struct flow flow;
2889     int n_actions;
2890     uint16_t in_port;
2891     int error;
2892
2893     error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
2894     if (error) {
2895         return error;
2896     }
2897
2898     error = check_ofp_packet_out(oh, &payload, &n_actions, p->max_ports);
2899     if (error) {
2900         return error;
2901     }
2902     opo = (struct ofp_packet_out *) oh;
2903
2904     COVERAGE_INC(ofproto_packet_out);
2905     if (opo->buffer_id != htonl(UINT32_MAX)) {
2906         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
2907                                 &buffer, &in_port);
2908         if (error || !buffer) {
2909             return error;
2910         }
2911         payload = *buffer;
2912     } else {
2913         buffer = NULL;
2914     }
2915
2916     flow_extract(&payload, 0, ofp_port_to_odp_port(ntohs(opo->in_port)), &flow);
2917     error = xlate_actions((const union ofp_action *) opo->actions, n_actions,
2918                           &flow, p, &payload, &actions, NULL, NULL, NULL);
2919     if (!error) {
2920         dpif_execute(p->dpif, actions.actions, actions.n_actions, &payload);
2921     }
2922     ofpbuf_delete(buffer);
2923
2924     return error;
2925 }
2926
2927 static void
2928 update_port_config(struct ofproto *p, struct ofport *port,
2929                    uint32_t config, uint32_t mask)
2930 {
2931     mask &= config ^ port->opp.config;
2932     if (mask & OFPPC_PORT_DOWN) {
2933         if (config & OFPPC_PORT_DOWN) {
2934             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2935         } else {
2936             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2937         }
2938     }
2939 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP |    \
2940                          OFPPC_NO_FWD | OFPPC_NO_FLOOD)
2941     if (mask & REVALIDATE_BITS) {
2942         COVERAGE_INC(ofproto_costly_flags);
2943         port->opp.config ^= mask & REVALIDATE_BITS;
2944         p->need_revalidate = true;
2945     }
2946 #undef REVALIDATE_BITS
2947     if (mask & OFPPC_NO_PACKET_IN) {
2948         port->opp.config ^= OFPPC_NO_PACKET_IN;
2949     }
2950 }
2951
2952 static int
2953 handle_port_mod(struct ofconn *ofconn, struct ofp_header *oh)
2954 {
2955     struct ofproto *p = ofconn->ofproto;
2956     const struct ofp_port_mod *opm;
2957     struct ofport *port;
2958     int error;
2959
2960     error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
2961     if (error) {
2962         return error;
2963     }
2964     error = check_ofp_message(oh, OFPT_PORT_MOD, sizeof *opm);
2965     if (error) {
2966         return error;
2967     }
2968     opm = (struct ofp_port_mod *) oh;
2969
2970     port = get_port(p, ofp_port_to_odp_port(ntohs(opm->port_no)));
2971     if (!port) {
2972         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
2973     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
2974         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
2975     } else {
2976         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
2977         if (opm->advertise) {
2978             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
2979         }
2980     }
2981     return 0;
2982 }
2983
2984 static struct ofpbuf *
2985 make_ofp_stats_reply(ovs_be32 xid, ovs_be16 type, size_t body_len)
2986 {
2987     struct ofp_stats_reply *osr;
2988     struct ofpbuf *msg;
2989
2990     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
2991     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
2992     osr->type = type;
2993     osr->flags = htons(0);
2994     return msg;
2995 }
2996
2997 static struct ofpbuf *
2998 start_ofp_stats_reply(const struct ofp_stats_request *request, size_t body_len)
2999 {
3000     return make_ofp_stats_reply(request->header.xid, request->type, body_len);
3001 }
3002
3003 static void *
3004 append_ofp_stats_reply(size_t nbytes, struct ofconn *ofconn,
3005                        struct ofpbuf **msgp)
3006 {
3007     struct ofpbuf *msg = *msgp;
3008     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
3009     if (nbytes + msg->size > UINT16_MAX) {
3010         struct ofp_stats_reply *reply = msg->data;
3011         reply->flags = htons(OFPSF_REPLY_MORE);
3012         *msgp = make_ofp_stats_reply(reply->header.xid, reply->type, nbytes);
3013         queue_tx(msg, ofconn, ofconn->reply_counter);
3014     }
3015     return ofpbuf_put_uninit(*msgp, nbytes);
3016 }
3017
3018 static struct ofpbuf *
3019 make_nxstats_reply(ovs_be32 xid, ovs_be32 subtype, size_t body_len)
3020 {
3021     struct nicira_stats_msg *nsm;
3022     struct ofpbuf *msg;
3023
3024     msg = ofpbuf_new(MIN(sizeof *nsm + body_len, UINT16_MAX));
3025     nsm = put_openflow_xid(sizeof *nsm, OFPT_STATS_REPLY, xid, msg);
3026     nsm->type = htons(OFPST_VENDOR);
3027     nsm->flags = htons(0);
3028     nsm->vendor = htonl(NX_VENDOR_ID);
3029     nsm->subtype = htonl(subtype);
3030     return msg;
3031 }
3032
3033 static struct ofpbuf *
3034 start_nxstats_reply(const struct nicira_stats_msg *request, size_t body_len)
3035 {
3036     return make_nxstats_reply(request->header.xid, request->subtype, body_len);
3037 }
3038
3039 static void
3040 append_nxstats_reply(size_t nbytes, struct ofconn *ofconn,
3041                      struct ofpbuf **msgp)
3042 {
3043     struct ofpbuf *msg = *msgp;
3044     assert(nbytes <= UINT16_MAX - sizeof(struct nicira_stats_msg));
3045     if (nbytes + msg->size > UINT16_MAX) {
3046         struct nicira_stats_msg *reply = msg->data;
3047         reply->flags = htons(OFPSF_REPLY_MORE);
3048         *msgp = make_nxstats_reply(reply->header.xid, reply->subtype, nbytes);
3049         queue_tx(msg, ofconn, ofconn->reply_counter);
3050     }
3051     ofpbuf_prealloc_tailroom(*msgp, nbytes);
3052 }
3053
3054 static int
3055 handle_desc_stats_request(struct ofconn *ofconn,
3056                           struct ofp_stats_request *request)
3057 {
3058     struct ofproto *p = ofconn->ofproto;
3059     struct ofp_desc_stats *ods;
3060     struct ofpbuf *msg;
3061
3062     msg = start_ofp_stats_reply(request, sizeof *ods);
3063     ods = append_ofp_stats_reply(sizeof *ods, ofconn, &msg);
3064     memset(ods, 0, sizeof *ods);
3065     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
3066     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
3067     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
3068     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
3069     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
3070     queue_tx(msg, ofconn, ofconn->reply_counter);
3071
3072     return 0;
3073 }
3074
3075 static int
3076 handle_table_stats_request(struct ofconn *ofconn,
3077                            struct ofp_stats_request *request)
3078 {
3079     struct ofproto *p = ofconn->ofproto;
3080     struct ofp_table_stats *ots;
3081     struct ofpbuf *msg;
3082     struct rule *rule;
3083     int n_rules;
3084
3085     msg = start_ofp_stats_reply(request, sizeof *ots * 2);
3086
3087     /* Count rules other than subrules. */
3088     n_rules = classifier_count(&p->cls);
3089     CLASSIFIER_FOR_EACH_EXACT_RULE (rule, cr, &p->cls) {
3090         if (rule->super) {
3091             n_rules--;
3092         }
3093     }
3094
3095     /* Classifier table. */
3096     ots = append_ofp_stats_reply(sizeof *ots, ofconn, &msg);
3097     memset(ots, 0, sizeof *ots);
3098     strcpy(ots->name, "classifier");
3099     ots->wildcards = (ofconn->flow_format == NXFF_OPENFLOW10
3100                       ? htonl(OFPFW_ALL) : htonl(OVSFW_ALL));
3101     ots->max_entries = htonl(1024 * 1024); /* An arbitrary big number. */
3102     ots->active_count = htonl(n_rules);
3103     ots->lookup_count = htonll(0);              /* XXX */
3104     ots->matched_count = htonll(0);             /* XXX */
3105
3106     queue_tx(msg, ofconn, ofconn->reply_counter);
3107     return 0;
3108 }
3109
3110 static void
3111 append_port_stat(struct ofport *port, struct ofconn *ofconn,
3112                  struct ofpbuf **msgp)
3113 {
3114     struct netdev_stats stats;
3115     struct ofp_port_stats *ops;
3116
3117     /* Intentionally ignore return value, since errors will set
3118      * 'stats' to all-1s, which is correct for OpenFlow, and
3119      * netdev_get_stats() will log errors. */
3120     netdev_get_stats(port->netdev, &stats);
3121
3122     ops = append_ofp_stats_reply(sizeof *ops, ofconn, msgp);
3123     ops->port_no = htons(port->opp.port_no);
3124     memset(ops->pad, 0, sizeof ops->pad);
3125     ops->rx_packets = htonll(stats.rx_packets);
3126     ops->tx_packets = htonll(stats.tx_packets);
3127     ops->rx_bytes = htonll(stats.rx_bytes);
3128     ops->tx_bytes = htonll(stats.tx_bytes);
3129     ops->rx_dropped = htonll(stats.rx_dropped);
3130     ops->tx_dropped = htonll(stats.tx_dropped);
3131     ops->rx_errors = htonll(stats.rx_errors);
3132     ops->tx_errors = htonll(stats.tx_errors);
3133     ops->rx_frame_err = htonll(stats.rx_frame_errors);
3134     ops->rx_over_err = htonll(stats.rx_over_errors);
3135     ops->rx_crc_err = htonll(stats.rx_crc_errors);
3136     ops->collisions = htonll(stats.collisions);
3137 }
3138
3139 static int
3140 handle_port_stats_request(struct ofconn *ofconn, struct ofp_stats_request *osr,
3141                           size_t arg_size)
3142 {
3143     struct ofproto *p = ofconn->ofproto;
3144     struct ofp_port_stats_request *psr;
3145     struct ofp_port_stats *ops;
3146     struct ofpbuf *msg;
3147     struct ofport *port;
3148
3149     if (arg_size != sizeof *psr) {
3150         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3151     }
3152     psr = (struct ofp_port_stats_request *) osr->body;
3153
3154     msg = start_ofp_stats_reply(osr, sizeof *ops * 16);
3155     if (psr->port_no != htons(OFPP_NONE)) {
3156         port = get_port(p, ofp_port_to_odp_port(ntohs(psr->port_no)));
3157         if (port) {
3158             append_port_stat(port, ofconn, &msg);
3159         }
3160     } else {
3161         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3162             append_port_stat(port, ofconn, &msg);
3163         }
3164     }
3165
3166     queue_tx(msg, ofconn, ofconn->reply_counter);
3167     return 0;
3168 }
3169
3170 struct flow_stats_cbdata {
3171     struct ofconn *ofconn;
3172     ovs_be16 out_port;
3173     struct ofpbuf *msg;
3174 };
3175
3176 /* Obtains statistic counters for 'rule' within 'p' and stores them into
3177  * '*packet_countp' and '*byte_countp'.  If 'rule' is a wildcarded rule, the
3178  * returned statistic include statistics for all of 'rule''s subrules. */
3179 static void
3180 query_stats(struct ofproto *p, struct rule *rule,
3181             uint64_t *packet_countp, uint64_t *byte_countp)
3182 {
3183     uint64_t packet_count, byte_count;
3184     struct rule *subrule;
3185     struct odp_flow *odp_flows;
3186     size_t n_odp_flows;
3187
3188     /* Start from historical data for 'rule' itself that are no longer tracked
3189      * by the datapath.  This counts, for example, subrules that have
3190      * expired. */
3191     packet_count = rule->packet_count;
3192     byte_count = rule->byte_count;
3193
3194     /* Prepare to ask the datapath for statistics on 'rule', or if it is
3195      * wildcarded then on all of its subrules.
3196      *
3197      * Also, add any statistics that are not tracked by the datapath for each
3198      * subrule.  This includes, for example, statistics for packets that were
3199      * executed "by hand" by ofproto via dpif_execute() but must be accounted
3200      * to a flow. */
3201     n_odp_flows = rule->cr.wc.wildcards ? list_size(&rule->list) : 1;
3202     odp_flows = xzalloc(n_odp_flows * sizeof *odp_flows);
3203     if (rule->cr.wc.wildcards) {
3204         size_t i = 0;
3205         LIST_FOR_EACH (subrule, list, &rule->list) {
3206             odp_flow_key_from_flow(&odp_flows[i++].key, &subrule->cr.flow);
3207             packet_count += subrule->packet_count;
3208             byte_count += subrule->byte_count;
3209         }
3210     } else {
3211         odp_flow_key_from_flow(&odp_flows[0].key, &rule->cr.flow);
3212     }
3213
3214     /* Fetch up-to-date statistics from the datapath and add them in. */
3215     if (!dpif_flow_get_multiple(p->dpif, odp_flows, n_odp_flows)) {
3216         size_t i;
3217         for (i = 0; i < n_odp_flows; i++) {
3218             struct odp_flow *odp_flow = &odp_flows[i];
3219             packet_count += odp_flow->stats.n_packets;
3220             byte_count += odp_flow->stats.n_bytes;
3221         }
3222     }
3223     free(odp_flows);
3224
3225     /* Return the stats to the caller. */
3226     *packet_countp = packet_count;
3227     *byte_countp = byte_count;
3228 }
3229
3230 static void
3231 calc_flow_duration(long long int start, ovs_be32 *sec, ovs_be32 *nsec)
3232 {
3233     long long int msecs = time_msec() - start;
3234     *sec = htonl(msecs / 1000);
3235     *nsec = htonl((msecs % 1000) * (1000 * 1000));
3236 }
3237
3238 static void
3239 flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
3240 {
3241     struct rule *rule = rule_from_cls_rule(rule_);
3242     struct flow_stats_cbdata *cbdata = cbdata_;
3243     struct ofp_flow_stats *ofs;
3244     uint64_t packet_count, byte_count;
3245     size_t act_len, len;
3246
3247     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
3248         return;
3249     }
3250
3251     act_len = sizeof *rule->actions * rule->n_actions;
3252     len = offsetof(struct ofp_flow_stats, actions) + act_len;
3253
3254     query_stats(cbdata->ofconn->ofproto, rule, &packet_count, &byte_count);
3255
3256     ofs = append_ofp_stats_reply(len, cbdata->ofconn, &cbdata->msg);
3257     ofs->length = htons(len);
3258     ofs->table_id = 0;
3259     ofs->pad = 0;
3260     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards,
3261                   cbdata->ofconn->flow_format, &ofs->match);
3262     calc_flow_duration(rule->created, &ofs->duration_sec, &ofs->duration_nsec);
3263     ofs->cookie = rule->flow_cookie;
3264     ofs->priority = htons(rule->cr.priority);
3265     ofs->idle_timeout = htons(rule->idle_timeout);
3266     ofs->hard_timeout = htons(rule->hard_timeout);
3267     memset(ofs->pad2, 0, sizeof ofs->pad2);
3268     ofs->packet_count = htonll(packet_count);
3269     ofs->byte_count = htonll(byte_count);
3270     if (rule->n_actions > 0) {
3271         memcpy(ofs->actions, rule->actions, act_len);
3272     }
3273 }
3274
3275 static int
3276 table_id_to_include(uint8_t table_id)
3277 {
3278     return table_id == 0 || table_id == 0xff ? CLS_INC_ALL : 0;
3279 }
3280
3281 static int
3282 handle_flow_stats_request(struct ofconn *ofconn,
3283                           const struct ofp_stats_request *osr, size_t arg_size)
3284 {
3285     struct ofp_flow_stats_request *fsr;
3286     struct flow_stats_cbdata cbdata;
3287     struct cls_rule target;
3288
3289     if (arg_size != sizeof *fsr) {
3290         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3291     }
3292     fsr = (struct ofp_flow_stats_request *) osr->body;
3293
3294     COVERAGE_INC(ofproto_flows_req);
3295     cbdata.ofconn = ofconn;
3296     cbdata.out_port = fsr->out_port;
3297     cbdata.msg = start_ofp_stats_reply(osr, 1024);
3298     cls_rule_from_match(&fsr->match, 0, NXFF_OPENFLOW10, 0, &target);
3299     classifier_for_each_match(&ofconn->ofproto->cls, &target,
3300                               table_id_to_include(fsr->table_id),
3301                               flow_stats_cb, &cbdata);
3302     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3303     return 0;
3304 }
3305
3306 static void
3307 nx_flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
3308 {
3309     struct rule *rule = rule_from_cls_rule(rule_);
3310     struct flow_stats_cbdata *cbdata = cbdata_;
3311     struct nx_flow_stats *nfs;
3312     uint64_t packet_count, byte_count;
3313     size_t act_len, start_len;
3314
3315     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
3316         return;
3317     }
3318
3319     query_stats(cbdata->ofconn->ofproto, rule, &packet_count, &byte_count);
3320
3321     act_len = sizeof *rule->actions * rule->n_actions;
3322
3323     start_len = cbdata->msg->size;
3324     append_nxstats_reply(sizeof *nfs + NXM_MAX_LEN + act_len,
3325                          cbdata->ofconn, &cbdata->msg);
3326     nfs = ofpbuf_put_uninit(cbdata->msg, sizeof *nfs);
3327     nfs->table_id = 0;
3328     nfs->pad = 0;
3329     calc_flow_duration(rule->created, &nfs->duration_sec, &nfs->duration_nsec);
3330     nfs->cookie = rule->flow_cookie;
3331     nfs->priority = htons(rule->cr.priority);
3332     nfs->idle_timeout = htons(rule->idle_timeout);
3333     nfs->hard_timeout = htons(rule->hard_timeout);
3334     nfs->match_len = htons(nx_put_match(cbdata->msg, &rule->cr));
3335     memset(nfs->pad2, 0, sizeof nfs->pad2);
3336     nfs->packet_count = htonll(packet_count);
3337     nfs->byte_count = htonll(byte_count);
3338     if (rule->n_actions > 0) {
3339         ofpbuf_put(cbdata->msg, rule->actions, act_len);
3340     }
3341     nfs->length = htons(cbdata->msg->size - start_len);
3342 }
3343
3344 static int
3345 handle_nxst_flow(struct ofconn *ofconn, struct ofpbuf *b)
3346 {
3347     struct nx_flow_stats_request *nfsr;
3348     struct flow_stats_cbdata cbdata;
3349     struct cls_rule target;
3350     int error;
3351
3352     /* Dissect the message. */
3353     nfsr = ofpbuf_try_pull(b, sizeof *nfsr);
3354     if (!nfsr) {
3355         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3356     }
3357     error = nx_pull_match(b, ntohs(nfsr->match_len), 0, &target);
3358     if (error) {
3359         return error;
3360     }
3361
3362     COVERAGE_INC(ofproto_flows_req);
3363     cbdata.ofconn = ofconn;
3364     cbdata.out_port = nfsr->out_port;
3365     cbdata.msg = start_nxstats_reply(&nfsr->nsm, 1024);
3366     classifier_for_each_match(&ofconn->ofproto->cls, &target,
3367                               table_id_to_include(nfsr->table_id),
3368                               nx_flow_stats_cb, &cbdata);
3369     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3370     return 0;
3371 }
3372
3373 struct flow_stats_ds_cbdata {
3374     struct ofproto *ofproto;
3375     struct ds *results;
3376 };
3377
3378 static void
3379 flow_stats_ds_cb(struct cls_rule *rule_, void *cbdata_)
3380 {
3381     struct rule *rule = rule_from_cls_rule(rule_);
3382     struct flow_stats_ds_cbdata *cbdata = cbdata_;
3383     struct ds *results = cbdata->results;
3384     struct ofp_match match;
3385     uint64_t packet_count, byte_count;
3386     size_t act_len = sizeof *rule->actions * rule->n_actions;
3387
3388     /* Don't report on subrules. */
3389     if (rule->super != NULL) {
3390         return;
3391     }
3392
3393     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
3394     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards,
3395                   NXFF_OPENFLOW10, &match);
3396
3397     ds_put_format(results, "duration=%llds, ",
3398                   (time_msec() - rule->created) / 1000);
3399     ds_put_format(results, "priority=%u, ", rule->cr.priority);
3400     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3401     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3402     ofp_print_match(results, &match, true);
3403     if (act_len > 0) {
3404         ofp_print_actions(results, &rule->actions->header, act_len);
3405     } else {
3406         ds_put_cstr(results, "drop");
3407     }
3408     ds_put_cstr(results, "\n");
3409 }
3410
3411 /* Adds a pretty-printed description of all flows to 'results', including
3412  * those marked hidden by secchan (e.g., by in-band control). */
3413 void
3414 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3415 {
3416     struct ofp_match match;
3417     struct cls_rule target;
3418     struct flow_stats_ds_cbdata cbdata;
3419
3420     memset(&match, 0, sizeof match);
3421     match.wildcards = htonl(OVSFW_ALL);
3422
3423     cbdata.ofproto = p;
3424     cbdata.results = results;
3425
3426     cls_rule_from_match(&match, 0, NXFF_OPENFLOW10, 0, &target);
3427     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
3428                               flow_stats_ds_cb, &cbdata);
3429 }
3430
3431 struct aggregate_stats_cbdata {
3432     struct ofproto *ofproto;
3433     ovs_be16 out_port;
3434     uint64_t packet_count;
3435     uint64_t byte_count;
3436     uint32_t n_flows;
3437 };
3438
3439 static void
3440 aggregate_stats_cb(struct cls_rule *rule_, void *cbdata_)
3441 {
3442     struct rule *rule = rule_from_cls_rule(rule_);
3443     struct aggregate_stats_cbdata *cbdata = cbdata_;
3444     uint64_t packet_count, byte_count;
3445
3446     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
3447         return;
3448     }
3449
3450     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
3451
3452     cbdata->packet_count += packet_count;
3453     cbdata->byte_count += byte_count;
3454     cbdata->n_flows++;
3455 }
3456
3457 static void
3458 query_aggregate_stats(struct ofproto *ofproto, struct cls_rule *target,
3459                       ovs_be16 out_port, uint8_t table_id,
3460                       struct ofp_aggregate_stats_reply *oasr)
3461 {
3462     struct aggregate_stats_cbdata cbdata;
3463
3464     COVERAGE_INC(ofproto_agg_request);
3465     cbdata.ofproto = ofproto;
3466     cbdata.out_port = out_port;
3467     cbdata.packet_count = 0;
3468     cbdata.byte_count = 0;
3469     cbdata.n_flows = 0;
3470     classifier_for_each_match(&ofproto->cls, target,
3471                               table_id_to_include(table_id),
3472                               aggregate_stats_cb, &cbdata);
3473
3474     oasr->flow_count = htonl(cbdata.n_flows);
3475     oasr->packet_count = htonll(cbdata.packet_count);
3476     oasr->byte_count = htonll(cbdata.byte_count);
3477     memset(oasr->pad, 0, sizeof oasr->pad);
3478 }
3479
3480 static int
3481 handle_aggregate_stats_request(struct ofconn *ofconn,
3482                                const struct ofp_stats_request *osr,
3483                                size_t arg_size)
3484 {
3485     struct ofp_aggregate_stats_request *request;
3486     struct ofp_aggregate_stats_reply *reply;
3487     struct cls_rule target;
3488     struct ofpbuf *msg;
3489
3490     if (arg_size != sizeof *request) {
3491         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3492     }
3493     request = (struct ofp_aggregate_stats_request *) osr->body;
3494
3495     cls_rule_from_match(&request->match, 0, NXFF_OPENFLOW10, 0, &target);
3496
3497     msg = start_ofp_stats_reply(osr, sizeof *reply);
3498     reply = append_ofp_stats_reply(sizeof *reply, ofconn, &msg);
3499     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3500                           request->table_id, reply);
3501     queue_tx(msg, ofconn, ofconn->reply_counter);
3502     return 0;
3503 }
3504
3505 static int
3506 handle_nxst_aggregate(struct ofconn *ofconn, struct ofpbuf *b)
3507 {
3508     struct nx_aggregate_stats_request *request;
3509     struct ofp_aggregate_stats_reply *reply;
3510     struct cls_rule target;
3511     struct ofpbuf *buf;
3512     int error;
3513
3514     /* Dissect the message. */
3515     request = ofpbuf_try_pull(b, sizeof *request);
3516     if (!request) {
3517         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3518     }
3519     error = nx_pull_match(b, ntohs(request->match_len), 0, &target);
3520     if (error) {
3521         return error;
3522     }
3523
3524     /* Reply. */
3525     COVERAGE_INC(ofproto_flows_req);
3526     buf = start_nxstats_reply(&request->nsm, sizeof *reply);
3527     reply = ofpbuf_put_uninit(buf, sizeof *reply);
3528     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3529                           request->table_id, reply);
3530     queue_tx(buf, ofconn, ofconn->reply_counter);
3531
3532     return 0;
3533 }
3534
3535 struct queue_stats_cbdata {
3536     struct ofconn *ofconn;
3537     struct ofport *ofport;
3538     struct ofpbuf *msg;
3539 };
3540
3541 static void
3542 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3543                 const struct netdev_queue_stats *stats)
3544 {
3545     struct ofp_queue_stats *reply;
3546
3547     reply = append_ofp_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
3548     reply->port_no = htons(cbdata->ofport->opp.port_no);
3549     memset(reply->pad, 0, sizeof reply->pad);
3550     reply->queue_id = htonl(queue_id);
3551     reply->tx_bytes = htonll(stats->tx_bytes);
3552     reply->tx_packets = htonll(stats->tx_packets);
3553     reply->tx_errors = htonll(stats->tx_errors);
3554 }
3555
3556 static void
3557 handle_queue_stats_dump_cb(uint32_t queue_id,
3558                            struct netdev_queue_stats *stats,
3559                            void *cbdata_)
3560 {
3561     struct queue_stats_cbdata *cbdata = cbdata_;
3562
3563     put_queue_stats(cbdata, queue_id, stats);
3564 }
3565
3566 static void
3567 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3568                             struct queue_stats_cbdata *cbdata)
3569 {
3570     cbdata->ofport = port;
3571     if (queue_id == OFPQ_ALL) {
3572         netdev_dump_queue_stats(port->netdev,
3573                                 handle_queue_stats_dump_cb, cbdata);
3574     } else {
3575         struct netdev_queue_stats stats;
3576
3577         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3578             put_queue_stats(cbdata, queue_id, &stats);
3579         }
3580     }
3581 }
3582
3583 static int
3584 handle_queue_stats_request(struct ofconn *ofconn,
3585                            const struct ofp_stats_request *osr,
3586                            size_t arg_size)
3587 {
3588     struct ofproto *ofproto = ofconn->ofproto;
3589     struct ofp_queue_stats_request *qsr;
3590     struct queue_stats_cbdata cbdata;
3591     struct ofport *port;
3592     unsigned int port_no;
3593     uint32_t queue_id;
3594
3595     if (arg_size != sizeof *qsr) {
3596         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3597     }
3598     qsr = (struct ofp_queue_stats_request *) osr->body;
3599
3600     COVERAGE_INC(ofproto_queue_req);
3601
3602     cbdata.ofconn = ofconn;
3603     cbdata.msg = start_ofp_stats_reply(osr, 128);
3604
3605     port_no = ntohs(qsr->port_no);
3606     queue_id = ntohl(qsr->queue_id);
3607     if (port_no == OFPP_ALL) {
3608         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3609             handle_queue_stats_for_port(port, queue_id, &cbdata);
3610         }
3611     } else if (port_no < ofproto->max_ports) {
3612         port = get_port(ofproto, ofp_port_to_odp_port(port_no));
3613         if (port) {
3614             handle_queue_stats_for_port(port, queue_id, &cbdata);
3615         }
3616     } else {
3617         ofpbuf_delete(cbdata.msg);
3618         return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
3619     }
3620     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3621
3622     return 0;
3623 }
3624
3625 static int
3626 handle_vendor_stats_request(struct ofconn *ofconn,
3627                             struct ofp_stats_request *osr, size_t arg_size)
3628 {
3629     struct nicira_stats_msg *nsm;
3630     struct ofpbuf b;
3631     ovs_be32 vendor;
3632
3633     if (arg_size < 4) {
3634         VLOG_WARN_RL(&rl, "truncated vendor stats request body");
3635         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3636     }
3637
3638     memcpy(&vendor, osr->body, sizeof vendor);
3639     if (vendor != htonl(NX_VENDOR_ID)) {
3640         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
3641     }
3642
3643     if (ntohs(nsm->header.length) < sizeof(struct nicira_stats_msg)) {
3644         VLOG_WARN_RL(&rl, "truncated Nicira stats request");
3645         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3646     }
3647
3648     nsm = (struct nicira_stats_msg *) osr;
3649     b.data = nsm;
3650     b.size = ntohs(nsm->header.length);
3651     switch (ntohl(nsm->subtype)) {
3652     case NXST_FLOW:
3653         return handle_nxst_flow(ofconn, &b);
3654
3655     case NXST_AGGREGATE:
3656         return handle_nxst_aggregate(ofconn, &b);
3657
3658     default:
3659         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
3660     }
3661 }
3662
3663 static int
3664 handle_stats_request(struct ofconn *ofconn, struct ofp_header *oh)
3665 {
3666     struct ofp_stats_request *osr;
3667     size_t arg_size;
3668     int error;
3669
3670     error = check_ofp_message_array(oh, OFPT_STATS_REQUEST, sizeof *osr,
3671                                     1, &arg_size);
3672     if (error) {
3673         return error;
3674     }
3675     osr = (struct ofp_stats_request *) oh;
3676
3677     switch (ntohs(osr->type)) {
3678     case OFPST_DESC:
3679         return handle_desc_stats_request(ofconn, osr);
3680
3681     case OFPST_FLOW:
3682         return handle_flow_stats_request(ofconn, osr, arg_size);
3683
3684     case OFPST_AGGREGATE:
3685         return handle_aggregate_stats_request(ofconn, osr, arg_size);
3686
3687     case OFPST_TABLE:
3688         return handle_table_stats_request(ofconn, osr);
3689
3690     case OFPST_PORT:
3691         return handle_port_stats_request(ofconn, osr, arg_size);
3692
3693     case OFPST_QUEUE:
3694         return handle_queue_stats_request(ofconn, osr, arg_size);
3695
3696     case OFPST_VENDOR:
3697         return handle_vendor_stats_request(ofconn, osr, arg_size);
3698
3699     default:
3700         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
3701     }
3702 }
3703
3704 static long long int
3705 msec_from_nsec(uint64_t sec, uint32_t nsec)
3706 {
3707     return !sec ? 0 : sec * 1000 + nsec / 1000000;
3708 }
3709
3710 static void
3711 update_time(struct ofproto *ofproto, struct rule *rule,
3712             const struct odp_flow_stats *stats)
3713 {
3714     long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
3715     if (used > rule->used) {
3716         rule->used = used;
3717         if (rule->super && used > rule->super->used) {
3718             rule->super->used = used;
3719         }
3720         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
3721     }
3722 }
3723
3724 static void
3725 update_stats(struct ofproto *ofproto, struct rule *rule,
3726              const struct odp_flow_stats *stats)
3727 {
3728     if (stats->n_packets) {
3729         update_time(ofproto, rule, stats);
3730         rule->packet_count += stats->n_packets;
3731         rule->byte_count += stats->n_bytes;
3732         netflow_flow_update_flags(&rule->nf_flow, stats->tcp_flags);
3733     }
3734 }
3735
3736 struct flow_mod {
3737     struct cls_rule cr;
3738     ovs_be64 cookie;
3739     uint16_t command;
3740     uint16_t idle_timeout;
3741     uint16_t hard_timeout;
3742     uint32_t buffer_id;
3743     uint16_t out_port;
3744     uint16_t flags;
3745     union ofp_action *actions;
3746     size_t n_actions;
3747 };
3748
3749 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3750  * in which no matching flow already exists in the flow table.
3751  *
3752  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3753  * ofp_actions, to ofconn->ofproto's flow table.  Returns 0 on success or an
3754  * OpenFlow error code as encoded by ofp_mkerr() on failure.
3755  *
3756  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3757  * if any. */
3758 static int
3759 add_flow(struct ofconn *ofconn, struct flow_mod *fm)
3760 {
3761     struct ofproto *p = ofconn->ofproto;
3762     struct ofpbuf *packet;
3763     struct rule *rule;
3764     uint16_t in_port;
3765     int error;
3766
3767     if (fm->flags & OFPFF_CHECK_OVERLAP
3768         && classifier_rule_overlaps(&p->cls, &fm->cr)) {
3769         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
3770     }
3771
3772     rule = rule_create(p, NULL, fm->actions, fm->n_actions,
3773                        fm->idle_timeout, fm->hard_timeout, fm->cookie,
3774                        fm->flags & OFPFF_SEND_FLOW_REM);
3775     rule->cr = fm->cr;
3776
3777     error = 0;
3778     if (fm->buffer_id != UINT32_MAX) {
3779         error = pktbuf_retrieve(ofconn->pktbuf, fm->buffer_id,
3780                                 &packet, &in_port);
3781     } else {
3782         packet = NULL;
3783         in_port = UINT16_MAX;
3784     }
3785
3786     rule_insert(p, rule, packet, in_port);
3787     return error;
3788 }
3789
3790 static struct rule *
3791 find_flow_strict(struct ofproto *p, const struct flow_mod *fm)
3792 {
3793     return rule_from_cls_rule(classifier_find_rule_exactly(&p->cls, &fm->cr));
3794 }
3795
3796 static int
3797 send_buffered_packet(struct ofconn *ofconn,
3798                      struct rule *rule, uint32_t buffer_id)
3799 {
3800     struct ofpbuf *packet;
3801     uint16_t in_port;
3802     struct flow flow;
3803     int error;
3804
3805     if (buffer_id == UINT32_MAX) {
3806         return 0;
3807     }
3808
3809     error = pktbuf_retrieve(ofconn->pktbuf, buffer_id, &packet, &in_port);
3810     if (error) {
3811         return error;
3812     }
3813
3814     flow_extract(packet, 0, in_port, &flow);
3815     rule_execute(ofconn->ofproto, rule, packet, &flow);
3816
3817     return 0;
3818 }
3819 \f
3820 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3821
3822 struct modify_flows_cbdata {
3823     struct ofproto *ofproto;
3824     const struct flow_mod *fm;
3825     struct rule *match;
3826 };
3827
3828 static int modify_flow(struct ofproto *, const struct flow_mod *,
3829                        struct rule *);
3830 static void modify_flows_cb(struct cls_rule *, void *cbdata_);
3831
3832 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code as
3833  * encoded by ofp_mkerr() on failure.
3834  *
3835  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3836  * if any. */
3837 static int
3838 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm)
3839 {
3840     struct modify_flows_cbdata cbdata;
3841
3842     cbdata.ofproto = ofconn->ofproto;
3843     cbdata.fm = fm;
3844     cbdata.match = NULL;
3845
3846     classifier_for_each_match(&ofconn->ofproto->cls, &fm->cr, CLS_INC_ALL,
3847                               modify_flows_cb, &cbdata);
3848     if (cbdata.match) {
3849         /* This credits the packet to whichever flow happened to happened to
3850          * match last.  That's weird.  Maybe we should do a lookup for the
3851          * flow that actually matches the packet?  Who knows. */
3852         send_buffered_packet(ofconn, cbdata.match, fm->buffer_id);
3853         return 0;
3854     } else {
3855         return add_flow(ofconn, fm);
3856     }
3857 }
3858
3859 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
3860  * code as encoded by ofp_mkerr() on failure.
3861  *
3862  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3863  * if any. */
3864 static int
3865 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm)
3866 {
3867     struct ofproto *p = ofconn->ofproto;
3868     struct rule *rule = find_flow_strict(p, fm);
3869     if (rule && !rule_is_hidden(rule)) {
3870         modify_flow(p, fm, rule);
3871         return send_buffered_packet(ofconn, rule, fm->buffer_id);
3872     } else {
3873         return add_flow(ofconn, fm);
3874     }
3875 }
3876
3877 /* Callback for modify_flows_loose(). */
3878 static void
3879 modify_flows_cb(struct cls_rule *rule_, void *cbdata_)
3880 {
3881     struct rule *rule = rule_from_cls_rule(rule_);
3882     struct modify_flows_cbdata *cbdata = cbdata_;
3883
3884     if (!rule_is_hidden(rule)) {
3885         cbdata->match = rule;
3886         modify_flow(cbdata->ofproto, cbdata->fm, rule);
3887     }
3888 }
3889
3890 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
3891  * been identified as a flow in 'p''s flow table to be modified, by changing
3892  * the rule's actions to match those in 'ofm' (which is followed by 'n_actions'
3893  * ofp_action[] structures). */
3894 static int
3895 modify_flow(struct ofproto *p, const struct flow_mod *fm, struct rule *rule)
3896 {
3897     size_t actions_len = fm->n_actions * sizeof *rule->actions;
3898
3899     rule->flow_cookie = fm->cookie;
3900
3901     /* If the actions are the same, do nothing. */
3902     if (fm->n_actions == rule->n_actions
3903         && (!fm->n_actions
3904             || !memcmp(fm->actions, rule->actions, actions_len))) {
3905         return 0;
3906     }
3907
3908     /* Replace actions. */
3909     free(rule->actions);
3910     rule->actions = fm->n_actions ? xmemdup(fm->actions, actions_len) : NULL;
3911     rule->n_actions = fm->n_actions;
3912
3913     /* Make sure that the datapath gets updated properly. */
3914     if (rule->cr.wc.wildcards) {
3915         COVERAGE_INC(ofproto_mod_wc_flow);
3916         p->need_revalidate = true;
3917     } else {
3918         rule_update_actions(p, rule);
3919     }
3920
3921     return 0;
3922 }
3923 \f
3924 /* OFPFC_DELETE implementation. */
3925
3926 struct delete_flows_cbdata {
3927     struct ofproto *ofproto;
3928     ovs_be16 out_port;
3929 };
3930
3931 static void delete_flows_cb(struct cls_rule *, void *cbdata_);
3932 static void delete_flow(struct ofproto *, struct rule *, ovs_be16 out_port);
3933
3934 /* Implements OFPFC_DELETE. */
3935 static void
3936 delete_flows_loose(struct ofproto *p, const struct flow_mod *fm)
3937 {
3938     struct delete_flows_cbdata cbdata;
3939
3940     cbdata.ofproto = p;
3941     cbdata.out_port = htons(fm->out_port);
3942
3943     classifier_for_each_match(&p->cls, &fm->cr, CLS_INC_ALL,
3944                               delete_flows_cb, &cbdata);
3945 }
3946
3947 /* Implements OFPFC_DELETE_STRICT. */
3948 static void
3949 delete_flow_strict(struct ofproto *p, struct flow_mod *fm)
3950 {
3951     struct rule *rule = find_flow_strict(p, fm);
3952     if (rule) {
3953         delete_flow(p, rule, htons(fm->out_port));
3954     }
3955 }
3956
3957 /* Callback for delete_flows_loose(). */
3958 static void
3959 delete_flows_cb(struct cls_rule *rule_, void *cbdata_)
3960 {
3961     struct rule *rule = rule_from_cls_rule(rule_);
3962     struct delete_flows_cbdata *cbdata = cbdata_;
3963
3964     delete_flow(cbdata->ofproto, rule, cbdata->out_port);
3965 }
3966
3967 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
3968  * been identified as a flow to delete from 'p''s flow table, by deleting the
3969  * flow and sending out a OFPT_FLOW_REMOVED message to any interested
3970  * controller.
3971  *
3972  * Will not delete 'rule' if it is hidden.  Will delete 'rule' only if
3973  * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
3974  * specified 'out_port'. */
3975 static void
3976 delete_flow(struct ofproto *p, struct rule *rule, ovs_be16 out_port)
3977 {
3978     if (rule_is_hidden(rule)) {
3979         return;
3980     }
3981
3982     if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
3983         return;
3984     }
3985
3986     send_flow_removed(p, rule, OFPRR_DELETE);
3987     rule_remove(p, rule);
3988 }
3989 \f
3990 static int
3991 flow_mod_core(struct ofconn *ofconn, struct flow_mod *fm)
3992 {
3993     struct ofproto *p = ofconn->ofproto;
3994     int error;
3995
3996     error = reject_slave_controller(ofconn, "flow_mod");
3997     if (error) {
3998         return error;
3999     }
4000
4001     error = validate_actions(fm->actions, fm->n_actions, p->max_ports);
4002     if (error) {
4003         return error;
4004     }
4005
4006     /* We do not support the emergency flow cache.  It will hopefully
4007      * get dropped from OpenFlow in the near future. */
4008     if (fm->flags & OFPFF_EMERG) {
4009         /* There isn't a good fit for an error code, so just state that the
4010          * flow table is full. */
4011         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
4012     }
4013
4014     switch (fm->command) {
4015     case OFPFC_ADD:
4016         return add_flow(ofconn, fm);
4017
4018     case OFPFC_MODIFY:
4019         return modify_flows_loose(ofconn, fm);
4020
4021     case OFPFC_MODIFY_STRICT:
4022         return modify_flow_strict(ofconn, fm);
4023
4024     case OFPFC_DELETE:
4025         delete_flows_loose(p, fm);
4026         return 0;
4027
4028     case OFPFC_DELETE_STRICT:
4029         delete_flow_strict(p, fm);
4030         return 0;
4031
4032     default:
4033         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
4034     }
4035 }
4036
4037 static int
4038 handle_ofpt_flow_mod(struct ofconn *ofconn, struct ofp_header *oh)
4039 {
4040     struct ofp_match orig_match;
4041     struct ofp_flow_mod *ofm;
4042     struct flow_mod fm;
4043     struct ofpbuf b;
4044     int error;
4045
4046     b.data = oh;
4047     b.size = ntohs(oh->length);
4048
4049     /* Dissect the message. */
4050     ofm = ofpbuf_try_pull(&b, sizeof *ofm);
4051     if (!ofm) {
4052         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4053     }
4054     error = ofputil_pull_actions(&b, b.size, &fm.actions, &fm.n_actions);
4055     if (error) {
4056         return error;
4057     }
4058
4059     /* Normalize ofm->match.  If normalization actually changes anything, then
4060      * log the differences. */
4061     ofm->match.pad1[0] = ofm->match.pad2[0] = 0;
4062     orig_match = ofm->match;
4063     normalize_match(&ofm->match);
4064     if (memcmp(&ofm->match, &orig_match, sizeof orig_match)) {
4065         static struct vlog_rate_limit normal_rl = VLOG_RATE_LIMIT_INIT(1, 1);
4066         if (!VLOG_DROP_INFO(&normal_rl)) {
4067             char *old = ofp_match_to_literal_string(&orig_match);
4068             char *new = ofp_match_to_literal_string(&ofm->match);
4069             VLOG_INFO("%s: normalization changed ofp_match, details:",
4070                       rconn_get_name(ofconn->rconn));
4071             VLOG_INFO(" pre: %s", old);
4072             VLOG_INFO("post: %s", new);
4073             free(old);
4074             free(new);
4075         }
4076     }
4077
4078     /* Translate the message. */
4079     cls_rule_from_match(&ofm->match, ntohs(ofm->priority), ofconn->flow_format,
4080                         ofm->cookie, &fm.cr);
4081     fm.cookie = ofm->cookie;
4082     fm.command = ntohs(ofm->command);
4083     fm.idle_timeout = ntohs(ofm->idle_timeout);
4084     fm.hard_timeout = ntohs(ofm->hard_timeout);
4085     fm.buffer_id = ntohl(ofm->buffer_id);
4086     fm.out_port = ntohs(ofm->out_port);
4087     fm.flags = ntohs(ofm->flags);
4088
4089     /* Execute the command. */
4090     return flow_mod_core(ofconn, &fm);
4091 }
4092
4093 static int
4094 handle_nxt_flow_mod(struct ofconn *ofconn, struct ofp_header *oh)
4095 {
4096     struct nx_flow_mod *nfm;
4097     struct flow_mod fm;
4098     struct ofpbuf b;
4099     int error;
4100
4101     b.data = oh;
4102     b.size = ntohs(oh->length);
4103
4104     /* Dissect the message. */
4105     nfm = ofpbuf_try_pull(&b, sizeof *nfm);
4106     if (!nfm) {
4107         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4108     }
4109     error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
4110                           &fm.cr);
4111     if (error) {
4112         return error;
4113     }
4114     error = ofputil_pull_actions(&b, b.size, &fm.actions, &fm.n_actions);
4115     if (error) {
4116         return error;
4117     }
4118
4119     /* Translate the message. */
4120     fm.cookie = nfm->cookie;
4121     fm.command = ntohs(nfm->command);
4122     fm.idle_timeout = ntohs(nfm->idle_timeout);
4123     fm.hard_timeout = ntohs(nfm->hard_timeout);
4124     fm.buffer_id = ntohl(nfm->buffer_id);
4125     fm.out_port = ntohs(nfm->out_port);
4126     fm.flags = ntohs(nfm->flags);
4127
4128     /* Execute the command. */
4129     return flow_mod_core(ofconn, &fm);
4130 }
4131
4132 static int
4133 handle_tun_id_from_cookie(struct ofconn *ofconn, struct nxt_tun_id_cookie *msg)
4134 {
4135     int error;
4136
4137     error = check_ofp_message(&msg->header, OFPT_VENDOR, sizeof *msg);
4138     if (error) {
4139         return error;
4140     }
4141
4142     ofconn->flow_format = msg->set ? NXFF_TUN_ID_FROM_COOKIE : NXFF_OPENFLOW10;
4143     return 0;
4144 }
4145
4146 static int
4147 handle_role_request(struct ofconn *ofconn, struct nicira_header *msg)
4148 {
4149     struct nx_role_request *nrr;
4150     struct nx_role_request *reply;
4151     struct ofpbuf *buf;
4152     uint32_t role;
4153
4154     if (ntohs(msg->header.length) != sizeof *nrr) {
4155         VLOG_WARN_RL(&rl, "received role request of length %u (expected %zu)",
4156                      ntohs(msg->header.length), sizeof *nrr);
4157         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4158     }
4159     nrr = (struct nx_role_request *) msg;
4160
4161     if (ofconn->type != OFCONN_PRIMARY) {
4162         VLOG_WARN_RL(&rl, "ignoring role request on non-controller "
4163                      "connection");
4164         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4165     }
4166
4167     role = ntohl(nrr->role);
4168     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
4169         && role != NX_ROLE_SLAVE) {
4170         VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
4171
4172         /* There's no good error code for this. */
4173         return ofp_mkerr(OFPET_BAD_REQUEST, -1);
4174     }
4175
4176     if (role == NX_ROLE_MASTER) {
4177         struct ofconn *other;
4178
4179         HMAP_FOR_EACH (other, hmap_node, &ofconn->ofproto->controllers) {
4180             if (other->role == NX_ROLE_MASTER) {
4181                 other->role = NX_ROLE_SLAVE;
4182             }
4183         }
4184     }
4185     ofconn->role = role;
4186
4187     reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, msg->header.xid,
4188                            &buf);
4189     reply->role = htonl(role);
4190     queue_tx(buf, ofconn, ofconn->reply_counter);
4191
4192     return 0;
4193 }
4194
4195 static int
4196 handle_nxt_set_flow_format(struct ofconn *ofconn,
4197                            struct nxt_set_flow_format *msg)
4198 {
4199     uint32_t format;
4200     int error;
4201
4202     error = check_ofp_message(&msg->header, OFPT_VENDOR, sizeof *msg);
4203     if (error) {
4204         return error;
4205     }
4206
4207     format = ntohl(msg->format);
4208     if (format == NXFF_OPENFLOW10
4209         || format == NXFF_TUN_ID_FROM_COOKIE
4210         || format == NXFF_NXM) {
4211         ofconn->flow_format = format;
4212         return 0;
4213     } else {
4214         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4215     }
4216 }
4217
4218 static int
4219 handle_vendor(struct ofconn *ofconn, void *msg)
4220 {
4221     struct ofproto *p = ofconn->ofproto;
4222     struct ofp_vendor_header *ovh = msg;
4223     struct nicira_header *nh;
4224
4225     if (ntohs(ovh->header.length) < sizeof(struct ofp_vendor_header)) {
4226         VLOG_WARN_RL(&rl, "received vendor message of length %u "
4227                           "(expected at least %zu)",
4228                    ntohs(ovh->header.length), sizeof(struct ofp_vendor_header));
4229         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4230     }
4231     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
4232         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
4233     }
4234     if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
4235         VLOG_WARN_RL(&rl, "received Nicira vendor message of length %u "
4236                           "(expected at least %zu)",
4237                      ntohs(ovh->header.length), sizeof(struct nicira_header));
4238         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
4239     }
4240
4241     nh = msg;
4242     switch (ntohl(nh->subtype)) {
4243     case NXT_STATUS_REQUEST:
4244         return switch_status_handle_request(p->switch_status, ofconn->rconn,
4245                                             msg);
4246
4247     case NXT_TUN_ID_FROM_COOKIE:
4248         return handle_tun_id_from_cookie(ofconn, msg);
4249
4250     case NXT_ROLE_REQUEST:
4251         return handle_role_request(ofconn, msg);
4252
4253     case NXT_SET_FLOW_FORMAT:
4254         return handle_nxt_set_flow_format(ofconn, msg);
4255
4256     case NXT_FLOW_MOD:
4257         return handle_nxt_flow_mod(ofconn, &ovh->header);
4258     }
4259
4260     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
4261 }
4262
4263 static int
4264 handle_barrier_request(struct ofconn *ofconn, struct ofp_header *oh)
4265 {
4266     struct ofp_header *ob;
4267     struct ofpbuf *buf;
4268
4269     /* Currently, everything executes synchronously, so we can just
4270      * immediately send the barrier reply. */
4271     ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
4272     queue_tx(buf, ofconn, ofconn->reply_counter);
4273     return 0;
4274 }
4275
4276 static void
4277 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4278 {
4279     struct ofp_header *oh = ofp_msg->data;
4280     int error;
4281
4282     COVERAGE_INC(ofproto_recv_openflow);
4283     switch (oh->type) {
4284     case OFPT_ECHO_REQUEST:
4285         error = handle_echo_request(ofconn, oh);
4286         break;
4287
4288     case OFPT_ECHO_REPLY:
4289         error = 0;
4290         break;
4291
4292     case OFPT_FEATURES_REQUEST:
4293         error = handle_features_request(ofconn, oh);
4294         break;
4295
4296     case OFPT_GET_CONFIG_REQUEST:
4297         error = handle_get_config_request(ofconn, oh);
4298         break;
4299
4300     case OFPT_SET_CONFIG:
4301         error = handle_set_config(ofconn, ofp_msg->data);
4302         break;
4303
4304     case OFPT_PACKET_OUT:
4305         error = handle_packet_out(ofconn, ofp_msg->data);
4306         break;
4307
4308     case OFPT_PORT_MOD:
4309         error = handle_port_mod(ofconn, oh);
4310         break;
4311
4312     case OFPT_FLOW_MOD:
4313         error = handle_ofpt_flow_mod(ofconn, ofp_msg->data);
4314         break;
4315
4316     case OFPT_STATS_REQUEST:
4317         error = handle_stats_request(ofconn, oh);
4318         break;
4319
4320     case OFPT_VENDOR:
4321         error = handle_vendor(ofconn, ofp_msg->data);
4322         break;
4323
4324     case OFPT_BARRIER_REQUEST:
4325         error = handle_barrier_request(ofconn, oh);
4326         break;
4327
4328     default:
4329         if (VLOG_IS_WARN_ENABLED()) {
4330             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
4331             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
4332             free(s);
4333         }
4334         error = ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
4335         break;
4336     }
4337
4338     if (error) {
4339         send_error_oh(ofconn, ofp_msg->data, error);
4340     }
4341 }
4342 \f
4343 static void
4344 handle_odp_miss_msg(struct ofproto *p, struct ofpbuf *packet)
4345 {
4346     struct odp_msg *msg = packet->data;
4347     struct rule *rule;
4348     struct ofpbuf payload;
4349     struct flow flow;
4350
4351     payload.data = msg + 1;
4352     payload.size = msg->length - sizeof *msg;
4353     flow_extract(&payload, msg->arg, msg->port, &flow);
4354
4355     /* Check with in-band control to see if this packet should be sent
4356      * to the local port regardless of the flow table. */
4357     if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
4358         union odp_action action;
4359
4360         memset(&action, 0, sizeof(action));
4361         action.output.type = ODPAT_OUTPUT;
4362         action.output.port = ODPP_LOCAL;
4363         dpif_execute(p->dpif, &action, 1, &payload);
4364     }
4365
4366     rule = lookup_valid_rule(p, &flow);
4367     if (!rule) {
4368         /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
4369         struct ofport *port = get_port(p, msg->port);
4370         if (port) {
4371             if (port->opp.config & OFPPC_NO_PACKET_IN) {
4372                 COVERAGE_INC(ofproto_no_packet_in);
4373                 /* XXX install 'drop' flow entry */
4374                 ofpbuf_delete(packet);
4375                 return;
4376             }
4377         } else {
4378             VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, msg->port);
4379         }
4380
4381         COVERAGE_INC(ofproto_packet_in);
4382         send_packet_in(p, packet);
4383         return;
4384     }
4385
4386     if (rule->cr.wc.wildcards) {
4387         rule = rule_create_subrule(p, rule, &flow);
4388         rule_make_actions(p, rule, packet);
4389     } else {
4390         if (!rule->may_install) {
4391             /* The rule is not installable, that is, we need to process every
4392              * packet, so process the current packet and set its actions into
4393              * 'subrule'. */
4394             rule_make_actions(p, rule, packet);
4395         } else {
4396             /* XXX revalidate rule if it needs it */
4397         }
4398     }
4399
4400     if (rule->super && rule->super->cr.priority == FAIL_OPEN_PRIORITY) {
4401         /*
4402          * Extra-special case for fail-open mode.
4403          *
4404          * We are in fail-open mode and the packet matched the fail-open rule,
4405          * but we are connected to a controller too.  We should send the packet
4406          * up to the controller in the hope that it will try to set up a flow
4407          * and thereby allow us to exit fail-open.
4408          *
4409          * See the top-level comment in fail-open.c for more information.
4410          */
4411         send_packet_in(p, ofpbuf_clone_with_headroom(packet,
4412                                                      DPIF_RECV_MSG_PADDING));
4413     }
4414
4415     ofpbuf_pull(packet, sizeof *msg);
4416     rule_execute(p, rule, packet, &flow);
4417     rule_reinstall(p, rule);
4418 }
4419
4420 static void
4421 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
4422 {
4423     struct odp_msg *msg = packet->data;
4424
4425     switch (msg->type) {
4426     case _ODPL_ACTION_NR:
4427         COVERAGE_INC(ofproto_ctlr_action);
4428         send_packet_in(p, packet);
4429         break;
4430
4431     case _ODPL_SFLOW_NR:
4432         if (p->sflow) {
4433             ofproto_sflow_received(p->sflow, msg);
4434         }
4435         ofpbuf_delete(packet);
4436         break;
4437
4438     case _ODPL_MISS_NR:
4439         handle_odp_miss_msg(p, packet);
4440         break;
4441
4442     default:
4443         VLOG_WARN_RL(&rl, "received ODP message of unexpected type %"PRIu32,
4444                      msg->type);
4445         break;
4446     }
4447 }
4448 \f
4449 /* Flow expiration. */
4450
4451 struct expire_cbdata {
4452     struct ofproto *ofproto;
4453     int dp_max_idle;
4454 };
4455
4456 static int ofproto_dp_max_idle(const struct ofproto *);
4457 static void ofproto_update_used(struct ofproto *);
4458 static void rule_expire(struct cls_rule *, void *cbdata);
4459
4460 /* This function is called periodically by ofproto_run().  Its job is to
4461  * collect updates for the flows that have been installed into the datapath,
4462  * most importantly when they last were used, and then use that information to
4463  * expire flows that have not been used recently.
4464  *
4465  * Returns the number of milliseconds after which it should be called again. */
4466 static int
4467 ofproto_expire(struct ofproto *ofproto)
4468 {
4469     struct expire_cbdata cbdata;
4470
4471     /* Update 'used' for each flow in the datapath. */
4472     ofproto_update_used(ofproto);
4473
4474     /* Expire idle flows.
4475      *
4476      * A wildcarded flow is idle only when all of its subrules have expired due
4477      * to becoming idle, so iterate through the exact-match flows first. */
4478     cbdata.ofproto = ofproto;
4479     cbdata.dp_max_idle = ofproto_dp_max_idle(ofproto);
4480     classifier_for_each(&ofproto->cls, CLS_INC_EXACT, rule_expire, &cbdata);
4481     classifier_for_each(&ofproto->cls, CLS_INC_WILD, rule_expire, &cbdata);
4482
4483     /* Let the hook know that we're at a stable point: all outstanding data
4484      * in existing flows has been accounted to the account_cb.  Thus, the
4485      * hook can now reasonably do operations that depend on having accurate
4486      * flow volume accounting (currently, that's just bond rebalancing). */
4487     if (ofproto->ofhooks->account_checkpoint_cb) {
4488         ofproto->ofhooks->account_checkpoint_cb(ofproto->aux);
4489     }
4490
4491     return MIN(cbdata.dp_max_idle, 1000);
4492 }
4493
4494 /* Update 'used' member of each flow currently installed into the datapath. */
4495 static void
4496 ofproto_update_used(struct ofproto *p)
4497 {
4498     struct odp_flow *flows;
4499     size_t n_flows;
4500     size_t i;
4501     int error;
4502
4503     error = dpif_flow_list_all(p->dpif, &flows, &n_flows);
4504     if (error) {
4505         return;
4506     }
4507
4508     for (i = 0; i < n_flows; i++) {
4509         struct odp_flow *f = &flows[i];
4510         struct cls_rule target;
4511         struct rule *rule;
4512         struct flow flow;
4513
4514         odp_flow_key_to_flow(&f->key, &flow);
4515         cls_rule_init_exact(&flow, UINT16_MAX, &target);
4516
4517         rule = rule_from_cls_rule(classifier_find_rule_exactly(&p->cls,
4518                                                                &target));
4519
4520         if (rule && rule->installed) {
4521             update_time(p, rule, &f->stats);
4522             rule_account(p, rule, f->stats.n_bytes);
4523         } else {
4524             /* There's a flow in the datapath that we know nothing about.
4525              * Delete it. */
4526             COVERAGE_INC(ofproto_unexpected_rule);
4527             dpif_flow_del(p->dpif, f);
4528         }
4529
4530     }
4531     free(flows);
4532 }
4533
4534 /* Calculates and returns the number of milliseconds of idle time after which
4535  * flows should expire from the datapath and we should fold their statistics
4536  * into their parent rules in userspace. */
4537 static int
4538 ofproto_dp_max_idle(const struct ofproto *ofproto)
4539 {
4540     /*
4541      * Idle time histogram.
4542      *
4543      * Most of the time a switch has a relatively small number of flows.  When
4544      * this is the case we might as well keep statistics for all of them in
4545      * userspace and to cache them in the kernel datapath for performance as
4546      * well.
4547      *
4548      * As the number of flows increases, the memory required to maintain
4549      * statistics about them in userspace and in the kernel becomes
4550      * significant.  However, with a large number of flows it is likely that
4551      * only a few of them are "heavy hitters" that consume a large amount of
4552      * bandwidth.  At this point, only heavy hitters are worth caching in the
4553      * kernel and maintaining in userspaces; other flows we can discard.
4554      *
4555      * The technique used to compute the idle time is to build a histogram with
4556      * N_BUCKETS bucket whose width is BUCKET_WIDTH msecs each.  Each flow that
4557      * is installed in the kernel gets dropped in the appropriate bucket.
4558      * After the histogram has been built, we compute the cutoff so that only
4559      * the most-recently-used 1% of flows (but at least 1000 flows) are kept
4560      * cached.  At least the most-recently-used bucket of flows is kept, so
4561      * actually an arbitrary number of flows can be kept in any given
4562      * expiration run (though the next run will delete most of those unless
4563      * they receive additional data).
4564      *
4565      * This requires a second pass through the exact-match flows, in addition
4566      * to the pass made by ofproto_update_used(), because the former function
4567      * never looks at uninstallable flows.
4568      */
4569     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4570     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4571     int buckets[N_BUCKETS] = { 0 };
4572     int total, bucket;
4573     struct rule *rule;
4574     long long int now;
4575     int i;
4576
4577     total = classifier_count_exact(&ofproto->cls);
4578     if (total <= 1000) {
4579         return N_BUCKETS * BUCKET_WIDTH;
4580     }
4581
4582     /* Build histogram. */
4583     now = time_msec();
4584     CLASSIFIER_FOR_EACH_EXACT_RULE (rule, cr, &ofproto->cls) {
4585         long long int idle = now - rule->used;
4586         int bucket = (idle <= 0 ? 0
4587                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4588                       : (unsigned int) idle / BUCKET_WIDTH);
4589         buckets[bucket]++;
4590     }
4591
4592     /* Find the first bucket whose flows should be expired. */
4593     for (bucket = 0; bucket < N_BUCKETS; bucket++) {
4594         if (buckets[bucket]) {
4595             int subtotal = 0;
4596             do {
4597                 subtotal += buckets[bucket++];
4598             } while (bucket < N_BUCKETS && subtotal < MAX(1000, total / 100));
4599             break;
4600         }
4601     }
4602
4603     if (VLOG_IS_DBG_ENABLED()) {
4604         struct ds s;
4605
4606         ds_init(&s);
4607         ds_put_cstr(&s, "keep");
4608         for (i = 0; i < N_BUCKETS; i++) {
4609             if (i == bucket) {
4610                 ds_put_cstr(&s, ", drop");
4611             }
4612             if (buckets[i]) {
4613                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4614             }
4615         }
4616         VLOG_INFO("%s: %s (msec:count)",
4617                   dpif_name(ofproto->dpif), ds_cstr(&s));
4618         ds_destroy(&s);
4619     }
4620
4621     return bucket * BUCKET_WIDTH;
4622 }
4623
4624 static void
4625 rule_active_timeout(struct ofproto *ofproto, struct rule *rule)
4626 {
4627     if (ofproto->netflow && !is_controller_rule(rule) &&
4628         netflow_active_timeout_expired(ofproto->netflow, &rule->nf_flow)) {
4629         struct ofexpired expired;
4630         struct odp_flow odp_flow;
4631
4632         /* Get updated flow stats.
4633          *
4634          * XXX We could avoid this call entirely if (1) ofproto_update_used()
4635          * updated TCP flags and (2) the dpif_flow_list_all() in
4636          * ofproto_update_used() zeroed TCP flags. */
4637         memset(&odp_flow, 0, sizeof odp_flow);
4638         if (rule->installed) {
4639             odp_flow_key_from_flow(&odp_flow.key, &rule->cr.flow);
4640             odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
4641             dpif_flow_get(ofproto->dpif, &odp_flow);
4642
4643             if (odp_flow.stats.n_packets) {
4644                 update_time(ofproto, rule, &odp_flow.stats);
4645                 netflow_flow_update_flags(&rule->nf_flow,
4646                                           odp_flow.stats.tcp_flags);
4647             }
4648         }
4649
4650         expired.flow = rule->cr.flow;
4651         expired.packet_count = rule->packet_count +
4652                                odp_flow.stats.n_packets;
4653         expired.byte_count = rule->byte_count + odp_flow.stats.n_bytes;
4654         expired.used = rule->used;
4655
4656         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
4657     }
4658 }
4659
4660 /* If 'cls_rule' is an OpenFlow rule, that has expired according to OpenFlow
4661  * rules, then delete it entirely.
4662  *
4663  * If 'cls_rule' is a subrule, that has not been used recently, remove it from
4664  * the datapath and fold its statistics back into its super-rule.
4665  *
4666  * (This is a callback function for classifier_for_each().) */
4667 static void
4668 rule_expire(struct cls_rule *cls_rule, void *cbdata_)
4669 {
4670     struct expire_cbdata *cbdata = cbdata_;
4671     struct ofproto *ofproto = cbdata->ofproto;
4672     struct rule *rule = rule_from_cls_rule(cls_rule);
4673     long long int hard_expire, idle_expire, expire, now;
4674
4675     /* Calculate OpenFlow expiration times for 'rule'. */
4676     hard_expire = (rule->hard_timeout
4677                    ? rule->created + rule->hard_timeout * 1000
4678                    : LLONG_MAX);
4679     idle_expire = (rule->idle_timeout
4680                    && (rule->super || list_is_empty(&rule->list))
4681                    ? rule->used + rule->idle_timeout * 1000
4682                    : LLONG_MAX);
4683     expire = MIN(hard_expire, idle_expire);
4684
4685     now = time_msec();
4686     if (now < expire) {
4687         /* 'rule' has not expired according to OpenFlow rules. */
4688         if (!rule->cr.wc.wildcards) {
4689             if (now >= rule->used + cbdata->dp_max_idle) {
4690                 /* This rule is idle, so drop it to free up resources. */
4691                 if (rule->super) {
4692                     /* It's not part of the OpenFlow flow table, so we can
4693                      * delete it entirely and fold its statistics into its
4694                      * super-rule. */
4695                     rule_remove(ofproto, rule);
4696                 } else {
4697                     /* It is part of the OpenFlow flow table, so we have to
4698                      * keep the rule but we can at least uninstall it from the
4699                      * datapath. */
4700                     rule_uninstall(ofproto, rule);
4701                 }
4702             } else {
4703                 /* Send NetFlow active timeout if appropriate. */
4704                 rule_active_timeout(cbdata->ofproto, rule);
4705             }
4706         }
4707     } else {
4708         /* 'rule' has expired according to OpenFlow rules. */
4709         COVERAGE_INC(ofproto_expired);
4710
4711         /* Update stats.  (This is a no-op if the rule expired due to an idle
4712          * timeout, because that only happens when the rule has no subrules
4713          * left.) */
4714         if (rule->cr.wc.wildcards) {
4715             struct rule *subrule, *next;
4716             LIST_FOR_EACH_SAFE (subrule, next, list, &rule->list) {
4717                 rule_remove(cbdata->ofproto, subrule);
4718             }
4719         } else {
4720             rule_uninstall(cbdata->ofproto, rule);
4721         }
4722
4723         /* Get rid of the rule. */
4724         if (!rule_is_hidden(rule)) {
4725             send_flow_removed(cbdata->ofproto, rule,
4726                               (now >= hard_expire
4727                                ? OFPRR_HARD_TIMEOUT : OFPRR_IDLE_TIMEOUT));
4728         }
4729         rule_remove(cbdata->ofproto, rule);
4730     }
4731 }
4732 \f
4733 static void
4734 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
4735 {
4736     struct rule *sub = rule_from_cls_rule(sub_);
4737     struct revalidate_cbdata *cbdata = cbdata_;
4738
4739     if (cbdata->revalidate_all
4740         || (cbdata->revalidate_subrules && sub->super)
4741         || (tag_set_intersects(&cbdata->revalidate_set, sub->tags))) {
4742         revalidate_rule(cbdata->ofproto, sub);
4743     }
4744 }
4745
4746 static bool
4747 revalidate_rule(struct ofproto *p, struct rule *rule)
4748 {
4749     const struct flow *flow = &rule->cr.flow;
4750
4751     COVERAGE_INC(ofproto_revalidate_rule);
4752     if (rule->super) {
4753         struct rule *super;
4754         super = rule_from_cls_rule(classifier_lookup(&p->cls, flow,
4755                                                      CLS_INC_WILD));
4756         if (!super) {
4757             rule_remove(p, rule);
4758             return false;
4759         } else if (super != rule->super) {
4760             COVERAGE_INC(ofproto_revalidate_moved);
4761             list_remove(&rule->list);
4762             list_push_back(&super->list, &rule->list);
4763             rule->super = super;
4764             rule->hard_timeout = super->hard_timeout;
4765             rule->idle_timeout = super->idle_timeout;
4766             rule->created = super->created;
4767             rule->used = 0;
4768         }
4769     }
4770
4771     rule_update_actions(p, rule);
4772     return true;
4773 }
4774
4775 static struct ofpbuf *
4776 compose_ofp_flow_removed(struct ofconn *ofconn, const struct rule *rule,
4777                          uint8_t reason)
4778 {
4779     struct ofp_flow_removed *ofr;
4780     struct ofpbuf *buf;
4781
4782     ofr = make_openflow(sizeof *ofr, OFPT_FLOW_REMOVED, &buf);
4783     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, ofconn->flow_format,
4784                   &ofr->match);
4785     ofr->cookie = rule->flow_cookie;
4786     ofr->priority = htons(rule->cr.priority);
4787     ofr->reason = reason;
4788     calc_flow_duration(rule->created, &ofr->duration_sec, &ofr->duration_nsec);
4789     ofr->idle_timeout = htons(rule->idle_timeout);
4790     ofr->packet_count = htonll(rule->packet_count);
4791     ofr->byte_count = htonll(rule->byte_count);
4792
4793     return buf;
4794 }
4795
4796 static struct ofpbuf *
4797 compose_nx_flow_removed(const struct rule *rule, uint8_t reason)
4798 {
4799     struct nx_flow_removed *nfr;
4800     struct ofpbuf *buf;
4801     int match_len;
4802
4803     nfr = make_nxmsg(sizeof *nfr, NXT_FLOW_REMOVED, &buf);
4804
4805     match_len = nx_put_match(buf, &rule->cr);
4806
4807     nfr->cookie = rule->flow_cookie;
4808     nfr->priority = htons(rule->cr.priority);
4809     nfr->reason = reason;
4810     calc_flow_duration(rule->created, &nfr->duration_sec, &nfr->duration_nsec);
4811     nfr->idle_timeout = htons(rule->idle_timeout);
4812     nfr->match_len = htons(match_len);
4813     nfr->packet_count = htonll(rule->packet_count);
4814     nfr->byte_count = htonll(rule->byte_count);
4815
4816     return buf;
4817 }
4818
4819 static void
4820 send_flow_removed(struct ofproto *p, struct rule *rule, uint8_t reason)
4821 {
4822     struct ofconn *ofconn;
4823
4824     if (!rule->send_flow_removed) {
4825         return;
4826     }
4827
4828     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
4829         struct ofpbuf *msg;
4830
4831         if (!rconn_is_connected(ofconn->rconn)
4832             || !ofconn_receives_async_msgs(ofconn)) {
4833             continue;
4834         }
4835
4836         msg = (ofconn->flow_format == NXFF_NXM
4837                ? compose_nx_flow_removed(rule, reason)
4838                : compose_ofp_flow_removed(ofconn, rule, reason));
4839
4840         /* Account flow expirations under ofconn->reply_counter, the counter
4841          * for replies to OpenFlow requests.  That works because preventing
4842          * OpenFlow requests from being processed also prevents new flows from
4843          * being added (and expiring).  (It also prevents processing OpenFlow
4844          * requests that would not add new flows, so it is imperfect.) */
4845         queue_tx(msg, ofconn, ofconn->reply_counter);
4846     }
4847 }
4848
4849 /* pinsched callback for sending 'packet' on 'ofconn'. */
4850 static void
4851 do_send_packet_in(struct ofpbuf *packet, void *ofconn_)
4852 {
4853     struct ofconn *ofconn = ofconn_;
4854
4855     rconn_send_with_limit(ofconn->rconn, packet,
4856                           ofconn->packet_in_counter, 100);
4857 }
4858
4859 /* Takes 'packet', which has been converted with do_convert_to_packet_in(), and
4860  * finalizes its content for sending on 'ofconn', and passes it to 'ofconn''s
4861  * packet scheduler for sending.
4862  *
4863  * 'max_len' specifies the maximum number of bytes of the packet to send on
4864  * 'ofconn' (INT_MAX specifies no limit).
4865  *
4866  * If 'clone' is true, the caller retains ownership of 'packet'.  Otherwise,
4867  * ownership is transferred to this function. */
4868 static void
4869 schedule_packet_in(struct ofconn *ofconn, struct ofpbuf *packet, int max_len,
4870                    bool clone)
4871 {
4872     struct ofproto *ofproto = ofconn->ofproto;
4873     struct ofp_packet_in *opi = packet->data;
4874     uint16_t in_port = ofp_port_to_odp_port(ntohs(opi->in_port));
4875     int send_len, trim_size;
4876     uint32_t buffer_id;
4877
4878     /* Get buffer. */
4879     if (opi->reason == OFPR_ACTION) {
4880         buffer_id = UINT32_MAX;
4881     } else if (ofproto->fail_open && fail_open_is_active(ofproto->fail_open)) {
4882         buffer_id = pktbuf_get_null();
4883     } else if (!ofconn->pktbuf) {
4884         buffer_id = UINT32_MAX;
4885     } else {
4886         struct ofpbuf payload;
4887         payload.data = opi->data;
4888         payload.size = packet->size - offsetof(struct ofp_packet_in, data);
4889         buffer_id = pktbuf_save(ofconn->pktbuf, &payload, in_port);
4890     }
4891
4892     /* Figure out how much of the packet to send. */
4893     send_len = ntohs(opi->total_len);
4894     if (buffer_id != UINT32_MAX) {
4895         send_len = MIN(send_len, ofconn->miss_send_len);
4896     }
4897     send_len = MIN(send_len, max_len);
4898
4899     /* Adjust packet length and clone if necessary. */
4900     trim_size = offsetof(struct ofp_packet_in, data) + send_len;
4901     if (clone) {
4902         packet = ofpbuf_clone_data(packet->data, trim_size);
4903         opi = packet->data;
4904     } else {
4905         packet->size = trim_size;
4906     }
4907
4908     /* Update packet headers. */
4909     opi->buffer_id = htonl(buffer_id);
4910     update_openflow_length(packet);
4911
4912     /* Hand over to packet scheduler.  It might immediately call into
4913      * do_send_packet_in() or it might buffer it for a while (until a later
4914      * call to pinsched_run()). */
4915     pinsched_send(ofconn->schedulers[opi->reason], in_port,
4916                   packet, do_send_packet_in, ofconn);
4917 }
4918
4919 /* Replace struct odp_msg header in 'packet' by equivalent struct
4920  * ofp_packet_in.  The odp_msg must have sufficient headroom to do so (e.g. as
4921  * returned by dpif_recv()).
4922  *
4923  * The conversion is not complete: the caller still needs to trim any unneeded
4924  * payload off the end of the buffer, set the length in the OpenFlow header,
4925  * and set buffer_id.  Those require us to know the controller settings and so
4926  * must be done on a per-controller basis.
4927  *
4928  * Returns the maximum number of bytes of the packet that should be sent to
4929  * the controller (INT_MAX if no limit). */
4930 static int
4931 do_convert_to_packet_in(struct ofpbuf *packet)
4932 {
4933     struct odp_msg *msg = packet->data;
4934     struct ofp_packet_in *opi;
4935     uint8_t reason;
4936     uint16_t total_len;
4937     uint16_t in_port;
4938     int max_len;
4939
4940     /* Extract relevant header fields */
4941     if (msg->type == _ODPL_ACTION_NR) {
4942         reason = OFPR_ACTION;
4943         max_len = msg->arg;
4944     } else {
4945         reason = OFPR_NO_MATCH;
4946         max_len = INT_MAX;
4947     }
4948     total_len = msg->length - sizeof *msg;
4949     in_port = odp_port_to_ofp_port(msg->port);
4950
4951     /* Repurpose packet buffer by overwriting header. */
4952     ofpbuf_pull(packet, sizeof(struct odp_msg));
4953     opi = ofpbuf_push_zeros(packet, offsetof(struct ofp_packet_in, data));
4954     opi->header.version = OFP_VERSION;
4955     opi->header.type = OFPT_PACKET_IN;
4956     opi->total_len = htons(total_len);
4957     opi->in_port = htons(in_port);
4958     opi->reason = reason;
4959
4960     return max_len;
4961 }
4962
4963 /* Given 'packet' containing an odp_msg of type _ODPL_ACTION_NR or
4964  * _ODPL_MISS_NR, sends an OFPT_PACKET_IN message to each OpenFlow controller
4965  * as necessary according to their individual configurations.
4966  *
4967  * 'packet' must have sufficient headroom to convert it into a struct
4968  * ofp_packet_in (e.g. as returned by dpif_recv()).
4969  *
4970  * Takes ownership of 'packet'. */
4971 static void
4972 send_packet_in(struct ofproto *ofproto, struct ofpbuf *packet)
4973 {
4974     struct ofconn *ofconn, *prev;
4975     int max_len;
4976
4977     max_len = do_convert_to_packet_in(packet);
4978
4979     prev = NULL;
4980     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
4981         if (ofconn_receives_async_msgs(ofconn)) {
4982             if (prev) {
4983                 schedule_packet_in(prev, packet, max_len, true);
4984             }
4985             prev = ofconn;
4986         }
4987     }
4988     if (prev) {
4989         schedule_packet_in(prev, packet, max_len, false);
4990     } else {
4991         ofpbuf_delete(packet);
4992     }
4993 }
4994
4995 static uint64_t
4996 pick_datapath_id(const struct ofproto *ofproto)
4997 {
4998     const struct ofport *port;
4999
5000     port = get_port(ofproto, ODPP_LOCAL);
5001     if (port) {
5002         uint8_t ea[ETH_ADDR_LEN];
5003         int error;
5004
5005         error = netdev_get_etheraddr(port->netdev, ea);
5006         if (!error) {
5007             return eth_addr_to_uint64(ea);
5008         }
5009         VLOG_WARN("could not get MAC address for %s (%s)",
5010                   netdev_get_name(port->netdev), strerror(error));
5011     }
5012     return ofproto->fallback_dpid;
5013 }
5014
5015 static uint64_t
5016 pick_fallback_dpid(void)
5017 {
5018     uint8_t ea[ETH_ADDR_LEN];
5019     eth_addr_nicira_random(ea);
5020     return eth_addr_to_uint64(ea);
5021 }
5022 \f
5023 static bool
5024 default_normal_ofhook_cb(const struct flow *flow, const struct ofpbuf *packet,
5025                          struct odp_actions *actions, tag_type *tags,
5026                          uint16_t *nf_output_iface, void *ofproto_)
5027 {
5028     struct ofproto *ofproto = ofproto_;
5029     int out_port;
5030
5031     /* Drop frames for reserved multicast addresses. */
5032     if (eth_addr_is_reserved(flow->dl_dst)) {
5033         return true;
5034     }
5035
5036     /* Learn source MAC (but don't try to learn from revalidation). */
5037     if (packet != NULL) {
5038         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
5039                                               0, flow->in_port,
5040                                               GRAT_ARP_LOCK_NONE);
5041         if (rev_tag) {
5042             /* The log messages here could actually be useful in debugging,
5043              * so keep the rate limit relatively high. */
5044             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5045             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
5046                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
5047             ofproto_revalidate(ofproto, rev_tag);
5048         }
5049     }
5050
5051     /* Determine output port. */
5052     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags,
5053                                        NULL);
5054     if (out_port < 0) {
5055         flood_packets(ofproto, flow->in_port, OFPPC_NO_FLOOD,
5056                       nf_output_iface, actions);
5057     } else if (out_port != flow->in_port) {
5058         odp_actions_add(actions, ODPAT_OUTPUT)->output.port = out_port;
5059         *nf_output_iface = out_port;
5060     } else {
5061         /* Drop. */
5062     }
5063
5064     return true;
5065 }
5066
5067 static const struct ofhooks default_ofhooks = {
5068     default_normal_ofhook_cb,
5069     NULL,
5070     NULL
5071 };