Merge branch 'master' into next
[sliver-openvswitch.git] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "ofproto.h"
19 #include <errno.h>
20 #include <inttypes.h>
21 #include <net/if.h>
22 #include <netinet/in.h>
23 #include <stdbool.h>
24 #include <stdlib.h>
25 #include "classifier.h"
26 #include "coverage.h"
27 #include "discovery.h"
28 #include "dpif.h"
29 #include "dynamic-string.h"
30 #include "fail-open.h"
31 #include "in-band.h"
32 #include "mac-learning.h"
33 #include "netdev.h"
34 #include "netflow.h"
35 #include "odp-util.h"
36 #include "ofp-print.h"
37 #include "ofproto-sflow.h"
38 #include "ofpbuf.h"
39 #include "openflow/nicira-ext.h"
40 #include "openflow/openflow.h"
41 #include "openvswitch/datapath-protocol.h"
42 #include "packets.h"
43 #include "pinsched.h"
44 #include "pktbuf.h"
45 #include "poll-loop.h"
46 #include "port-array.h"
47 #include "rconn.h"
48 #include "shash.h"
49 #include "status.h"
50 #include "stp.h"
51 #include "stream-ssl.h"
52 #include "svec.h"
53 #include "tag.h"
54 #include "timeval.h"
55 #include "unixctl.h"
56 #include "vconn.h"
57 #include "xtoxll.h"
58
59 #define THIS_MODULE VLM_ofproto
60 #include "vlog.h"
61
62 #include "sflow_api.h"
63
64 enum {
65     TABLEID_HASH = 0,
66     TABLEID_CLASSIFIER = 1
67 };
68
69 struct ofport {
70     struct netdev *netdev;
71     struct ofp_phy_port opp;    /* In host byte order. */
72 };
73
74 static void ofport_free(struct ofport *);
75 static void hton_ofp_phy_port(struct ofp_phy_port *);
76
77 static int xlate_actions(const union ofp_action *in, size_t n_in,
78                          const flow_t *flow, struct ofproto *ofproto,
79                          const struct ofpbuf *packet,
80                          struct odp_actions *out, tag_type *tags,
81                          bool *may_set_up_flow, uint16_t *nf_output_iface);
82
83 struct rule {
84     struct cls_rule cr;
85
86     uint16_t idle_timeout;      /* In seconds from time of last use. */
87     uint16_t hard_timeout;      /* In seconds from time of creation. */
88     long long int used;         /* Last-used time (0 if never used). */
89     long long int created;      /* Creation time. */
90     uint64_t packet_count;      /* Number of packets received. */
91     uint64_t byte_count;        /* Number of bytes received. */
92     uint64_t accounted_bytes;   /* Number of bytes passed to account_cb. */
93     tag_type tags;              /* Tags (set only by hooks). */
94     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
95
96     /* If 'super' is non-NULL, this rule is a subrule, that is, it is an
97      * exact-match rule (having cr.wc.wildcards of 0) generated from the
98      * wildcard rule 'super'.  In this case, 'list' is an element of the
99      * super-rule's list.
100      *
101      * If 'super' is NULL, this rule is a super-rule, and 'list' is the head of
102      * a list of subrules.  A super-rule with no wildcards (where
103      * cr.wc.wildcards is 0) will never have any subrules. */
104     struct rule *super;
105     struct list list;
106
107     /* OpenFlow actions.
108      *
109      * A subrule has no actions (it uses the super-rule's actions). */
110     int n_actions;
111     union ofp_action *actions;
112
113     /* Datapath actions.
114      *
115      * A super-rule with wildcard fields never has ODP actions (since the
116      * datapath only supports exact-match flows). */
117     bool installed;             /* Installed in datapath? */
118     bool may_install;           /* True ordinarily; false if actions must
119                                  * be reassessed for every packet. */
120     int n_odp_actions;
121     union odp_action *odp_actions;
122 };
123
124 static inline bool
125 rule_is_hidden(const struct rule *rule)
126 {
127     /* Subrules are merely an implementation detail, so hide them from the
128      * controller. */
129     if (rule->super != NULL) {
130         return true;
131     }
132
133     /* Rules with priority higher than UINT16_MAX are set up by ofproto itself
134      * (e.g. by in-band control) and are intentionally hidden from the
135      * controller. */
136     if (rule->cr.priority > UINT16_MAX) {
137         return true;
138     }
139
140     return false;
141 }
142
143 static struct rule *rule_create(struct ofproto *, struct rule *super,
144                                 const union ofp_action *, size_t n_actions,
145                                 uint16_t idle_timeout, uint16_t hard_timeout);
146 static void rule_free(struct rule *);
147 static void rule_destroy(struct ofproto *, struct rule *);
148 static struct rule *rule_from_cls_rule(const struct cls_rule *);
149 static void rule_insert(struct ofproto *, struct rule *,
150                         struct ofpbuf *packet, uint16_t in_port);
151 static void rule_remove(struct ofproto *, struct rule *);
152 static bool rule_make_actions(struct ofproto *, struct rule *,
153                               const struct ofpbuf *packet);
154 static void rule_install(struct ofproto *, struct rule *,
155                          struct rule *displaced_rule);
156 static void rule_uninstall(struct ofproto *, struct rule *);
157 static void rule_post_uninstall(struct ofproto *, struct rule *);
158
159 struct ofconn {
160     struct list node;
161     struct rconn *rconn;
162     struct pktbuf *pktbuf;
163     bool send_flow_exp;
164     int miss_send_len;
165
166     struct rconn_packet_counter *packet_in_counter;
167
168     /* Number of OpenFlow messages queued as replies to OpenFlow requests, and
169      * the maximum number before we stop reading OpenFlow requests.  */
170 #define OFCONN_REPLY_MAX 100
171     struct rconn_packet_counter *reply_counter;
172 };
173
174 static struct ofconn *ofconn_create(struct ofproto *, struct rconn *);
175 static void ofconn_destroy(struct ofconn *);
176 static void ofconn_run(struct ofconn *, struct ofproto *);
177 static void ofconn_wait(struct ofconn *);
178 static void queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
179                      struct rconn_packet_counter *counter);
180
181 struct ofproto {
182     /* Settings. */
183     uint64_t datapath_id;       /* Datapath ID. */
184     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
185     char *manufacturer;         /* Manufacturer. */
186     char *hardware;             /* Hardware. */
187     char *software;             /* Software version. */
188     char *serial;               /* Serial number. */
189
190     /* Datapath. */
191     struct dpif *dpif;
192     struct netdev_monitor *netdev_monitor;
193     struct port_array ports;    /* Index is ODP port nr; ofport->opp.port_no is
194                                  * OFP port nr. */
195     struct shash port_by_name;
196     uint32_t max_ports;
197
198     /* Configuration. */
199     struct switch_status *switch_status;
200     struct status_category *ss_cat;
201     struct in_band *in_band;
202     struct discovery *discovery;
203     struct fail_open *fail_open;
204     struct pinsched *miss_sched, *action_sched;
205     struct netflow *netflow;
206     struct ofproto_sflow *sflow;
207
208     /* Flow table. */
209     struct classifier cls;
210     bool need_revalidate;
211     long long int next_expiration;
212     struct tag_set revalidate_set;
213
214     /* OpenFlow connections. */
215     struct list all_conns;
216     struct ofconn *controller;
217     struct pvconn **listeners;
218     size_t n_listeners;
219     struct pvconn **snoops;
220     size_t n_snoops;
221
222     /* Hooks for ovs-vswitchd. */
223     const struct ofhooks *ofhooks;
224     void *aux;
225
226     /* Used by default ofhooks. */
227     struct mac_learning *ml;
228 };
229
230 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
231
232 static const struct ofhooks default_ofhooks;
233
234 static uint64_t pick_datapath_id(const struct ofproto *);
235 static uint64_t pick_fallback_dpid(void);
236 static void send_packet_in_miss(struct ofpbuf *, void *ofproto);
237 static void send_packet_in_action(struct ofpbuf *, void *ofproto);
238 static void update_used(struct ofproto *);
239 static void update_stats(struct ofproto *, struct rule *,
240                          const struct odp_flow_stats *);
241 static void expire_rule(struct cls_rule *, void *ofproto);
242 static void active_timeout(struct ofproto *ofproto, struct rule *rule);
243 static bool revalidate_rule(struct ofproto *p, struct rule *rule);
244 static void revalidate_cb(struct cls_rule *rule_, void *p_);
245
246 static void handle_odp_msg(struct ofproto *, struct ofpbuf *);
247
248 static void handle_openflow(struct ofconn *, struct ofproto *,
249                             struct ofpbuf *);
250
251 static void refresh_port_groups(struct ofproto *);
252
253 static void update_port(struct ofproto *, const char *devname);
254 static int init_ports(struct ofproto *);
255 static void reinit_ports(struct ofproto *);
256
257 int
258 ofproto_create(const char *datapath, const char *datapath_type,
259                const struct ofhooks *ofhooks, void *aux,
260                struct ofproto **ofprotop)
261 {
262     struct odp_stats stats;
263     struct ofproto *p;
264     struct dpif *dpif;
265     int error;
266
267     *ofprotop = NULL;
268
269     /* Connect to datapath and start listening for messages. */
270     error = dpif_open(datapath, datapath_type, &dpif);
271     if (error) {
272         VLOG_ERR("failed to open datapath %s: %s", datapath, strerror(error));
273         return error;
274     }
275     error = dpif_get_dp_stats(dpif, &stats);
276     if (error) {
277         VLOG_ERR("failed to obtain stats for datapath %s: %s",
278                  datapath, strerror(error));
279         dpif_close(dpif);
280         return error;
281     }
282     error = dpif_recv_set_mask(dpif, ODPL_MISS | ODPL_ACTION | ODPL_SFLOW);
283     if (error) {
284         VLOG_ERR("failed to listen on datapath %s: %s",
285                  datapath, strerror(error));
286         dpif_close(dpif);
287         return error;
288     }
289     dpif_flow_flush(dpif);
290     dpif_recv_purge(dpif);
291
292     /* Initialize settings. */
293     p = xzalloc(sizeof *p);
294     p->fallback_dpid = pick_fallback_dpid();
295     p->datapath_id = p->fallback_dpid;
296     p->manufacturer = xstrdup("Nicira Networks, Inc.");
297     p->hardware = xstrdup("Reference Implementation");
298     p->software = xstrdup(VERSION BUILDNR);
299     p->serial = xstrdup("None");
300
301     /* Initialize datapath. */
302     p->dpif = dpif;
303     p->netdev_monitor = netdev_monitor_create();
304     port_array_init(&p->ports);
305     shash_init(&p->port_by_name);
306     p->max_ports = stats.max_ports;
307
308     /* Initialize submodules. */
309     p->switch_status = switch_status_create(p);
310     p->in_band = NULL;
311     p->discovery = NULL;
312     p->fail_open = NULL;
313     p->miss_sched = p->action_sched = NULL;
314     p->netflow = NULL;
315     p->sflow = NULL;
316
317     /* Initialize flow table. */
318     classifier_init(&p->cls);
319     p->need_revalidate = false;
320     p->next_expiration = time_msec() + 1000;
321     tag_set_init(&p->revalidate_set);
322
323     /* Initialize OpenFlow connections. */
324     list_init(&p->all_conns);
325     p->controller = ofconn_create(p, rconn_create(5, 8));
326     p->controller->pktbuf = pktbuf_create();
327     p->controller->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
328     p->listeners = NULL;
329     p->n_listeners = 0;
330     p->snoops = NULL;
331     p->n_snoops = 0;
332
333     /* Initialize hooks. */
334     if (ofhooks) {
335         p->ofhooks = ofhooks;
336         p->aux = aux;
337         p->ml = NULL;
338     } else {
339         p->ofhooks = &default_ofhooks;
340         p->aux = p;
341         p->ml = mac_learning_create();
342     }
343
344     /* Register switch status category. */
345     p->ss_cat = switch_status_register(p->switch_status, "remote",
346                                        rconn_status_cb, p->controller->rconn);
347
348     /* Pick final datapath ID. */
349     p->datapath_id = pick_datapath_id(p);
350     VLOG_INFO("using datapath ID %012"PRIx64, p->datapath_id);
351
352     *ofprotop = p;
353     return 0;
354 }
355
356 void
357 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
358 {
359     uint64_t old_dpid = p->datapath_id;
360     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
361     if (p->datapath_id != old_dpid) {
362         VLOG_INFO("datapath ID changed to %012"PRIx64, p->datapath_id);
363         rconn_reconnect(p->controller->rconn);
364     }
365 }
366
367 void
368 ofproto_set_probe_interval(struct ofproto *p, int probe_interval)
369 {
370     probe_interval = probe_interval ? MAX(probe_interval, 5) : 0;
371     rconn_set_probe_interval(p->controller->rconn, probe_interval);
372     if (p->fail_open) {
373         int trigger_duration = probe_interval ? probe_interval * 3 : 15;
374         fail_open_set_trigger_duration(p->fail_open, trigger_duration);
375     }
376 }
377
378 void
379 ofproto_set_max_backoff(struct ofproto *p, int max_backoff)
380 {
381     rconn_set_max_backoff(p->controller->rconn, max_backoff);
382 }
383
384 void
385 ofproto_set_desc(struct ofproto *p,
386                  const char *manufacturer, const char *hardware,
387                  const char *software, const char *serial)
388 {
389     if (manufacturer) {
390         free(p->manufacturer);
391         p->manufacturer = xstrdup(manufacturer);
392     }
393     if (hardware) {
394         free(p->hardware);
395         p->hardware = xstrdup(hardware);
396     }
397     if (software) {
398         free(p->software);
399         p->software = xstrdup(software);
400     }
401     if (serial) {
402         free(p->serial);
403         p->serial = xstrdup(serial);
404     }
405 }
406
407 int
408 ofproto_set_in_band(struct ofproto *p, bool in_band)
409 {
410     if (in_band != (p->in_band != NULL)) {
411         if (in_band) {
412             return in_band_create(p, p->dpif, p->switch_status,
413                                   p->controller->rconn, &p->in_band);
414         } else {
415             ofproto_set_discovery(p, false, NULL, true);
416             in_band_destroy(p->in_band);
417             p->in_band = NULL;
418         }
419         rconn_reconnect(p->controller->rconn);
420     }
421     return 0;
422 }
423
424 int
425 ofproto_set_discovery(struct ofproto *p, bool discovery,
426                       const char *re, bool update_resolv_conf)
427 {
428     if (discovery != (p->discovery != NULL)) {
429         if (discovery) {
430             int error = ofproto_set_in_band(p, true);
431             if (error) {
432                 return error;
433             }
434             error = discovery_create(re, update_resolv_conf,
435                                      p->dpif, p->switch_status,
436                                      &p->discovery);
437             if (error) {
438                 return error;
439             }
440         } else {
441             discovery_destroy(p->discovery);
442             p->discovery = NULL;
443         }
444         rconn_disconnect(p->controller->rconn);
445     } else if (discovery) {
446         discovery_set_update_resolv_conf(p->discovery, update_resolv_conf);
447         return discovery_set_accept_controller_re(p->discovery, re);
448     }
449     return 0;
450 }
451
452 int
453 ofproto_set_controller(struct ofproto *ofproto, const char *controller)
454 {
455     if (ofproto->discovery) {
456         return EINVAL;
457     } else if (controller) {
458         if (strcmp(rconn_get_name(ofproto->controller->rconn), controller)) {
459             return rconn_connect(ofproto->controller->rconn, controller);
460         } else {
461             return 0;
462         }
463     } else {
464         rconn_disconnect(ofproto->controller->rconn);
465         return 0;
466     }
467 }
468
469 static int
470 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
471             const struct svec *svec)
472 {
473     struct pvconn **pvconns = *pvconnsp;
474     size_t n_pvconns = *n_pvconnsp;
475     int retval = 0;
476     size_t i;
477
478     for (i = 0; i < n_pvconns; i++) {
479         pvconn_close(pvconns[i]);
480     }
481     free(pvconns);
482
483     pvconns = xmalloc(svec->n * sizeof *pvconns);
484     n_pvconns = 0;
485     for (i = 0; i < svec->n; i++) {
486         const char *name = svec->names[i];
487         struct pvconn *pvconn;
488         int error;
489
490         error = pvconn_open(name, &pvconn);
491         if (!error) {
492             pvconns[n_pvconns++] = pvconn;
493         } else {
494             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
495             if (!retval) {
496                 retval = error;
497             }
498         }
499     }
500
501     *pvconnsp = pvconns;
502     *n_pvconnsp = n_pvconns;
503
504     return retval;
505 }
506
507 int
508 ofproto_set_listeners(struct ofproto *ofproto, const struct svec *listeners)
509 {
510     return set_pvconns(&ofproto->listeners, &ofproto->n_listeners, listeners);
511 }
512
513 int
514 ofproto_set_snoops(struct ofproto *ofproto, const struct svec *snoops)
515 {
516     return set_pvconns(&ofproto->snoops, &ofproto->n_snoops, snoops);
517 }
518
519 int
520 ofproto_set_netflow(struct ofproto *ofproto,
521                     const struct netflow_options *nf_options)
522 {
523     if (nf_options && nf_options->collectors.n) {
524         if (!ofproto->netflow) {
525             ofproto->netflow = netflow_create();
526         }
527         return netflow_set_options(ofproto->netflow, nf_options);
528     } else {
529         netflow_destroy(ofproto->netflow);
530         ofproto->netflow = NULL;
531         return 0;
532     }
533 }
534
535 void
536 ofproto_set_sflow(struct ofproto *ofproto,
537                   const struct ofproto_sflow_options *oso)
538 {
539     struct ofproto_sflow *os = ofproto->sflow;
540     if (oso) {
541         if (!os) {
542             struct ofport *ofport;
543             unsigned int odp_port;
544
545             os = ofproto->sflow = ofproto_sflow_create(ofproto->dpif);
546             refresh_port_groups(ofproto);
547             PORT_ARRAY_FOR_EACH (ofport, &ofproto->ports, odp_port) {
548                 ofproto_sflow_add_port(os, odp_port,
549                                        netdev_get_name(ofport->netdev));
550             }
551         }
552         ofproto_sflow_set_options(os, oso);
553     } else {
554         ofproto_sflow_destroy(os);
555         ofproto->sflow = NULL;
556     }
557 }
558
559 void
560 ofproto_set_failure(struct ofproto *ofproto, bool fail_open)
561 {
562     if (fail_open) {
563         struct rconn *rconn = ofproto->controller->rconn;
564         int trigger_duration = rconn_get_probe_interval(rconn) * 3;
565         if (!ofproto->fail_open) {
566             ofproto->fail_open = fail_open_create(ofproto, trigger_duration,
567                                                   ofproto->switch_status,
568                                                   rconn);
569         } else {
570             fail_open_set_trigger_duration(ofproto->fail_open,
571                                            trigger_duration);
572         }
573     } else {
574         fail_open_destroy(ofproto->fail_open);
575         ofproto->fail_open = NULL;
576     }
577 }
578
579 void
580 ofproto_set_rate_limit(struct ofproto *ofproto,
581                        int rate_limit, int burst_limit)
582 {
583     if (rate_limit > 0) {
584         if (!ofproto->miss_sched) {
585             ofproto->miss_sched = pinsched_create(rate_limit, burst_limit,
586                                                   ofproto->switch_status);
587             ofproto->action_sched = pinsched_create(rate_limit, burst_limit,
588                                                     NULL);
589         } else {
590             pinsched_set_limits(ofproto->miss_sched, rate_limit, burst_limit);
591             pinsched_set_limits(ofproto->action_sched,
592                                 rate_limit, burst_limit);
593         }
594     } else {
595         pinsched_destroy(ofproto->miss_sched);
596         ofproto->miss_sched = NULL;
597         pinsched_destroy(ofproto->action_sched);
598         ofproto->action_sched = NULL;
599     }
600 }
601
602 int
603 ofproto_set_stp(struct ofproto *ofproto UNUSED, bool enable_stp)
604 {
605     /* XXX */
606     if (enable_stp) {
607         VLOG_WARN("STP is not yet implemented");
608         return EINVAL;
609     } else {
610         return 0;
611     }
612 }
613
614 uint64_t
615 ofproto_get_datapath_id(const struct ofproto *ofproto)
616 {
617     return ofproto->datapath_id;
618 }
619
620 int
621 ofproto_get_probe_interval(const struct ofproto *ofproto)
622 {
623     return rconn_get_probe_interval(ofproto->controller->rconn);
624 }
625
626 int
627 ofproto_get_max_backoff(const struct ofproto *ofproto)
628 {
629     return rconn_get_max_backoff(ofproto->controller->rconn);
630 }
631
632 bool
633 ofproto_get_in_band(const struct ofproto *ofproto)
634 {
635     return ofproto->in_band != NULL;
636 }
637
638 bool
639 ofproto_get_discovery(const struct ofproto *ofproto)
640 {
641     return ofproto->discovery != NULL;
642 }
643
644 const char *
645 ofproto_get_controller(const struct ofproto *ofproto)
646 {
647     return rconn_get_name(ofproto->controller->rconn);
648 }
649
650 void
651 ofproto_get_listeners(const struct ofproto *ofproto, struct svec *listeners)
652 {
653     size_t i;
654
655     for (i = 0; i < ofproto->n_listeners; i++) {
656         svec_add(listeners, pvconn_get_name(ofproto->listeners[i]));
657     }
658 }
659
660 void
661 ofproto_get_snoops(const struct ofproto *ofproto, struct svec *snoops)
662 {
663     size_t i;
664
665     for (i = 0; i < ofproto->n_snoops; i++) {
666         svec_add(snoops, pvconn_get_name(ofproto->snoops[i]));
667     }
668 }
669
670 void
671 ofproto_destroy(struct ofproto *p)
672 {
673     struct ofconn *ofconn, *next_ofconn;
674     struct ofport *ofport;
675     unsigned int port_no;
676     size_t i;
677
678     if (!p) {
679         return;
680     }
681
682     ofproto_flush_flows(p);
683     classifier_destroy(&p->cls);
684
685     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, struct ofconn, node,
686                         &p->all_conns) {
687         ofconn_destroy(ofconn);
688     }
689
690     dpif_close(p->dpif);
691     netdev_monitor_destroy(p->netdev_monitor);
692     PORT_ARRAY_FOR_EACH (ofport, &p->ports, port_no) {
693         ofport_free(ofport);
694     }
695     shash_destroy(&p->port_by_name);
696
697     switch_status_destroy(p->switch_status);
698     in_band_destroy(p->in_band);
699     discovery_destroy(p->discovery);
700     fail_open_destroy(p->fail_open);
701     pinsched_destroy(p->miss_sched);
702     pinsched_destroy(p->action_sched);
703     netflow_destroy(p->netflow);
704     ofproto_sflow_destroy(p->sflow);
705
706     switch_status_unregister(p->ss_cat);
707
708     for (i = 0; i < p->n_listeners; i++) {
709         pvconn_close(p->listeners[i]);
710     }
711     free(p->listeners);
712
713     for (i = 0; i < p->n_snoops; i++) {
714         pvconn_close(p->snoops[i]);
715     }
716     free(p->snoops);
717
718     mac_learning_destroy(p->ml);
719
720     free(p);
721 }
722
723 int
724 ofproto_run(struct ofproto *p)
725 {
726     int error = ofproto_run1(p);
727     if (!error) {
728         error = ofproto_run2(p, false);
729     }
730     return error;
731 }
732
733 static void
734 process_port_change(struct ofproto *ofproto, int error, char *devname)
735 {
736     if (error == ENOBUFS) {
737         reinit_ports(ofproto);
738     } else if (!error) {
739         update_port(ofproto, devname);
740         free(devname);
741     }
742 }
743
744 int
745 ofproto_run1(struct ofproto *p)
746 {
747     struct ofconn *ofconn, *next_ofconn;
748     char *devname;
749     int error;
750     int i;
751
752     if (shash_is_empty(&p->port_by_name)) {
753         init_ports(p);
754     }
755
756     for (i = 0; i < 50; i++) {
757         struct ofpbuf *buf;
758         int error;
759
760         error = dpif_recv(p->dpif, &buf);
761         if (error) {
762             if (error == ENODEV) {
763                 /* Someone destroyed the datapath behind our back.  The caller
764                  * better destroy us and give up, because we're just going to
765                  * spin from here on out. */
766                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
767                 VLOG_ERR_RL(&rl, "%s: datapath was destroyed externally",
768                             dpif_name(p->dpif));
769                 return ENODEV;
770             }
771             break;
772         }
773
774         handle_odp_msg(p, buf);
775     }
776
777     while ((error = dpif_port_poll(p->dpif, &devname)) != EAGAIN) {
778         process_port_change(p, error, devname);
779     }
780     while ((error = netdev_monitor_poll(p->netdev_monitor,
781                                         &devname)) != EAGAIN) {
782         process_port_change(p, error, devname);
783     }
784
785     if (p->in_band) {
786         in_band_run(p->in_band);
787     }
788     if (p->discovery) {
789         char *controller_name;
790         if (rconn_is_connectivity_questionable(p->controller->rconn)) {
791             discovery_question_connectivity(p->discovery);
792         }
793         if (discovery_run(p->discovery, &controller_name)) {
794             if (controller_name) {
795                 rconn_connect(p->controller->rconn, controller_name);
796             } else {
797                 rconn_disconnect(p->controller->rconn);
798             }
799         }
800     }
801     pinsched_run(p->miss_sched, send_packet_in_miss, p);
802     pinsched_run(p->action_sched, send_packet_in_action, p);
803
804     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, struct ofconn, node,
805                         &p->all_conns) {
806         ofconn_run(ofconn, p);
807     }
808
809     /* Fail-open maintenance.  Do this after processing the ofconns since
810      * fail-open checks the status of the controller rconn. */
811     if (p->fail_open) {
812         fail_open_run(p->fail_open);
813     }
814
815     for (i = 0; i < p->n_listeners; i++) {
816         struct vconn *vconn;
817         int retval;
818
819         retval = pvconn_accept(p->listeners[i], OFP_VERSION, &vconn);
820         if (!retval) {
821             ofconn_create(p, rconn_new_from_vconn("passive", vconn));
822         } else if (retval != EAGAIN) {
823             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
824         }
825     }
826
827     for (i = 0; i < p->n_snoops; i++) {
828         struct vconn *vconn;
829         int retval;
830
831         retval = pvconn_accept(p->snoops[i], OFP_VERSION, &vconn);
832         if (!retval) {
833             rconn_add_monitor(p->controller->rconn, vconn);
834         } else if (retval != EAGAIN) {
835             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
836         }
837     }
838
839     if (time_msec() >= p->next_expiration) {
840         COVERAGE_INC(ofproto_expiration);
841         p->next_expiration = time_msec() + 1000;
842         update_used(p);
843
844         classifier_for_each(&p->cls, CLS_INC_ALL, expire_rule, p);
845
846         /* Let the hook know that we're at a stable point: all outstanding data
847          * in existing flows has been accounted to the account_cb.  Thus, the
848          * hook can now reasonably do operations that depend on having accurate
849          * flow volume accounting (currently, that's just bond rebalancing). */
850         if (p->ofhooks->account_checkpoint_cb) {
851             p->ofhooks->account_checkpoint_cb(p->aux);
852         }
853     }
854
855     if (p->netflow) {
856         netflow_run(p->netflow);
857     }
858     if (p->sflow) {
859         ofproto_sflow_run(p->sflow);
860     }
861
862     return 0;
863 }
864
865 struct revalidate_cbdata {
866     struct ofproto *ofproto;
867     bool revalidate_all;        /* Revalidate all exact-match rules? */
868     bool revalidate_subrules;   /* Revalidate all exact-match subrules? */
869     struct tag_set revalidate_set; /* Set of tags to revalidate. */
870 };
871
872 int
873 ofproto_run2(struct ofproto *p, bool revalidate_all)
874 {
875     if (p->need_revalidate || revalidate_all
876         || !tag_set_is_empty(&p->revalidate_set)) {
877         struct revalidate_cbdata cbdata;
878         cbdata.ofproto = p;
879         cbdata.revalidate_all = revalidate_all;
880         cbdata.revalidate_subrules = p->need_revalidate;
881         cbdata.revalidate_set = p->revalidate_set;
882         tag_set_init(&p->revalidate_set);
883         COVERAGE_INC(ofproto_revalidate);
884         classifier_for_each(&p->cls, CLS_INC_EXACT, revalidate_cb, &cbdata);
885         p->need_revalidate = false;
886     }
887
888     return 0;
889 }
890
891 void
892 ofproto_wait(struct ofproto *p)
893 {
894     struct ofconn *ofconn;
895     size_t i;
896
897     dpif_recv_wait(p->dpif);
898     dpif_port_poll_wait(p->dpif);
899     netdev_monitor_poll_wait(p->netdev_monitor);
900     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
901         ofconn_wait(ofconn);
902     }
903     if (p->in_band) {
904         in_band_wait(p->in_band);
905     }
906     if (p->discovery) {
907         discovery_wait(p->discovery);
908     }
909     if (p->fail_open) {
910         fail_open_wait(p->fail_open);
911     }
912     pinsched_wait(p->miss_sched);
913     pinsched_wait(p->action_sched);
914     if (p->sflow) {
915         ofproto_sflow_wait(p->sflow);
916     }
917     if (!tag_set_is_empty(&p->revalidate_set)) {
918         poll_immediate_wake();
919     }
920     if (p->need_revalidate) {
921         /* Shouldn't happen, but if it does just go around again. */
922         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
923         poll_immediate_wake();
924     } else if (p->next_expiration != LLONG_MAX) {
925         poll_timer_wait(p->next_expiration - time_msec());
926     }
927     for (i = 0; i < p->n_listeners; i++) {
928         pvconn_wait(p->listeners[i]);
929     }
930     for (i = 0; i < p->n_snoops; i++) {
931         pvconn_wait(p->snoops[i]);
932     }
933 }
934
935 void
936 ofproto_revalidate(struct ofproto *ofproto, tag_type tag)
937 {
938     tag_set_add(&ofproto->revalidate_set, tag);
939 }
940
941 struct tag_set *
942 ofproto_get_revalidate_set(struct ofproto *ofproto)
943 {
944     return &ofproto->revalidate_set;
945 }
946
947 bool
948 ofproto_is_alive(const struct ofproto *p)
949 {
950     return p->discovery || rconn_is_alive(p->controller->rconn);
951 }
952
953 int
954 ofproto_send_packet(struct ofproto *p, const flow_t *flow,
955                     const union ofp_action *actions, size_t n_actions,
956                     const struct ofpbuf *packet)
957 {
958     struct odp_actions odp_actions;
959     int error;
960
961     error = xlate_actions(actions, n_actions, flow, p, packet, &odp_actions,
962                           NULL, NULL, NULL);
963     if (error) {
964         return error;
965     }
966
967     /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
968      * error code? */
969     dpif_execute(p->dpif, flow->in_port, odp_actions.actions,
970                  odp_actions.n_actions, packet);
971     return 0;
972 }
973
974 void
975 ofproto_add_flow(struct ofproto *p,
976                  const flow_t *flow, uint32_t wildcards, unsigned int priority,
977                  const union ofp_action *actions, size_t n_actions,
978                  int idle_timeout)
979 {
980     struct rule *rule;
981     rule = rule_create(p, NULL, actions, n_actions,
982                        idle_timeout >= 0 ? idle_timeout : 5 /* XXX */, 0);
983     cls_rule_from_flow(&rule->cr, flow, wildcards, priority);
984     rule_insert(p, rule, NULL, 0);
985 }
986
987 void
988 ofproto_delete_flow(struct ofproto *ofproto, const flow_t *flow,
989                     uint32_t wildcards, unsigned int priority)
990 {
991     struct rule *rule;
992
993     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
994                                                            flow, wildcards,
995                                                            priority));
996     if (rule) {
997         rule_remove(ofproto, rule);
998     }
999 }
1000
1001 static void
1002 destroy_rule(struct cls_rule *rule_, void *ofproto_)
1003 {
1004     struct rule *rule = rule_from_cls_rule(rule_);
1005     struct ofproto *ofproto = ofproto_;
1006
1007     /* Mark the flow as not installed, even though it might really be
1008      * installed, so that rule_remove() doesn't bother trying to uninstall it.
1009      * There is no point in uninstalling it individually since we are about to
1010      * blow away all the flows with dpif_flow_flush(). */
1011     rule->installed = false;
1012
1013     rule_remove(ofproto, rule);
1014 }
1015
1016 void
1017 ofproto_flush_flows(struct ofproto *ofproto)
1018 {
1019     COVERAGE_INC(ofproto_flush);
1020     classifier_for_each(&ofproto->cls, CLS_INC_ALL, destroy_rule, ofproto);
1021     dpif_flow_flush(ofproto->dpif);
1022     if (ofproto->in_band) {
1023         in_band_flushed(ofproto->in_band);
1024     }
1025     if (ofproto->fail_open) {
1026         fail_open_flushed(ofproto->fail_open);
1027     }
1028 }
1029 \f
1030 static void
1031 reinit_ports(struct ofproto *p)
1032 {
1033     struct svec devnames;
1034     struct ofport *ofport;
1035     unsigned int port_no;
1036     struct odp_port *odp_ports;
1037     size_t n_odp_ports;
1038     size_t i;
1039
1040     svec_init(&devnames);
1041     PORT_ARRAY_FOR_EACH (ofport, &p->ports, port_no) {
1042         svec_add (&devnames, (char *) ofport->opp.name);
1043     }
1044     dpif_port_list(p->dpif, &odp_ports, &n_odp_ports);
1045     for (i = 0; i < n_odp_ports; i++) {
1046         svec_add (&devnames, odp_ports[i].devname);
1047     }
1048     free(odp_ports);
1049
1050     svec_sort_unique(&devnames);
1051     for (i = 0; i < devnames.n; i++) {
1052         update_port(p, devnames.names[i]);
1053     }
1054     svec_destroy(&devnames);
1055 }
1056
1057 static size_t
1058 refresh_port_group(struct ofproto *p, unsigned int group)
1059 {
1060     uint16_t *ports;
1061     size_t n_ports;
1062     struct ofport *port;
1063     unsigned int port_no;
1064
1065     assert(group == DP_GROUP_ALL || group == DP_GROUP_FLOOD);
1066
1067     ports = xmalloc(port_array_count(&p->ports) * sizeof *ports);
1068     n_ports = 0;
1069     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1070         if (group == DP_GROUP_ALL || !(port->opp.config & OFPPC_NO_FLOOD)) {
1071             ports[n_ports++] = port_no;
1072         }
1073     }
1074     dpif_port_group_set(p->dpif, group, ports, n_ports);
1075     free(ports);
1076
1077     return n_ports;
1078 }
1079
1080 static void
1081 refresh_port_groups(struct ofproto *p)
1082 {
1083     size_t n_flood = refresh_port_group(p, DP_GROUP_FLOOD);
1084     size_t n_all = refresh_port_group(p, DP_GROUP_ALL);
1085     if (p->sflow) {
1086         ofproto_sflow_set_group_sizes(p->sflow, n_flood, n_all);
1087     }
1088 }
1089
1090 static struct ofport *
1091 make_ofport(const struct odp_port *odp_port)
1092 {
1093     struct netdev_options netdev_options;
1094     enum netdev_flags flags;
1095     struct ofport *ofport;
1096     struct netdev *netdev;
1097     bool carrier;
1098     int error;
1099
1100     memset(&netdev_options, 0, sizeof netdev_options);
1101     netdev_options.name = odp_port->devname;
1102     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1103     netdev_options.may_open = true;
1104
1105     error = netdev_open(&netdev_options, &netdev);
1106     if (error) {
1107         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1108                      "cannot be opened (%s)",
1109                      odp_port->devname, odp_port->port,
1110                      odp_port->devname, strerror(error));
1111         return NULL;
1112     }
1113
1114     ofport = xmalloc(sizeof *ofport);
1115     ofport->netdev = netdev;
1116     ofport->opp.port_no = odp_port_to_ofp_port(odp_port->port);
1117     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1118     memcpy(ofport->opp.name, odp_port->devname,
1119            MIN(sizeof ofport->opp.name, sizeof odp_port->devname));
1120     ofport->opp.name[sizeof ofport->opp.name - 1] = '\0';
1121
1122     netdev_get_flags(netdev, &flags);
1123     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1124
1125     netdev_get_carrier(netdev, &carrier);
1126     ofport->opp.state = carrier ? 0 : OFPPS_LINK_DOWN;
1127
1128     netdev_get_features(netdev,
1129                         &ofport->opp.curr, &ofport->opp.advertised,
1130                         &ofport->opp.supported, &ofport->opp.peer);
1131     return ofport;
1132 }
1133
1134 static bool
1135 ofport_conflicts(const struct ofproto *p, const struct odp_port *odp_port)
1136 {
1137     if (port_array_get(&p->ports, odp_port->port)) {
1138         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1139                      odp_port->port);
1140         return true;
1141     } else if (shash_find(&p->port_by_name, odp_port->devname)) {
1142         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1143                      odp_port->devname);
1144         return true;
1145     } else {
1146         return false;
1147     }
1148 }
1149
1150 static int
1151 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1152 {
1153     const struct ofp_phy_port *a = &a_->opp;
1154     const struct ofp_phy_port *b = &b_->opp;
1155
1156     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1157     return (a->port_no == b->port_no
1158             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1159             && !strcmp((char *) a->name, (char *) b->name)
1160             && a->state == b->state
1161             && a->config == b->config
1162             && a->curr == b->curr
1163             && a->advertised == b->advertised
1164             && a->supported == b->supported
1165             && a->peer == b->peer);
1166 }
1167
1168 static void
1169 send_port_status(struct ofproto *p, const struct ofport *ofport,
1170                  uint8_t reason)
1171 {
1172     /* XXX Should limit the number of queued port status change messages. */
1173     struct ofconn *ofconn;
1174     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
1175         struct ofp_port_status *ops;
1176         struct ofpbuf *b;
1177
1178         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1179         ops->reason = reason;
1180         ops->desc = ofport->opp;
1181         hton_ofp_phy_port(&ops->desc);
1182         queue_tx(b, ofconn, NULL);
1183     }
1184     if (p->ofhooks->port_changed_cb) {
1185         p->ofhooks->port_changed_cb(reason, &ofport->opp, p->aux);
1186     }
1187 }
1188
1189 static void
1190 ofport_install(struct ofproto *p, struct ofport *ofport)
1191 {
1192     uint16_t odp_port = ofp_port_to_odp_port(ofport->opp.port_no);
1193     const char *netdev_name = (const char *) ofport->opp.name;
1194
1195     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1196     port_array_set(&p->ports, odp_port, ofport);
1197     shash_add(&p->port_by_name, netdev_name, ofport);
1198     if (p->sflow) {
1199         ofproto_sflow_add_port(p->sflow, odp_port, netdev_name);
1200     }
1201 }
1202
1203 static void
1204 ofport_remove(struct ofproto *p, struct ofport *ofport)
1205 {
1206     uint16_t odp_port = ofp_port_to_odp_port(ofport->opp.port_no);
1207
1208     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1209     port_array_set(&p->ports, odp_port, NULL);
1210     shash_delete(&p->port_by_name,
1211                  shash_find(&p->port_by_name, (char *) ofport->opp.name));
1212     if (p->sflow) {
1213         ofproto_sflow_del_port(p->sflow, odp_port);
1214     }
1215 }
1216
1217 static void
1218 ofport_free(struct ofport *ofport)
1219 {
1220     if (ofport) {
1221         netdev_close(ofport->netdev);
1222         free(ofport);
1223     }
1224 }
1225
1226 static void
1227 update_port(struct ofproto *p, const char *devname)
1228 {
1229     struct odp_port odp_port;
1230     struct ofport *old_ofport;
1231     struct ofport *new_ofport;
1232     int error;
1233
1234     COVERAGE_INC(ofproto_update_port);
1235
1236     /* Query the datapath for port information. */
1237     error = dpif_port_query_by_name(p->dpif, devname, &odp_port);
1238
1239     /* Find the old ofport. */
1240     old_ofport = shash_find_data(&p->port_by_name, devname);
1241     if (!error) {
1242         if (!old_ofport) {
1243             /* There's no port named 'devname' but there might be a port with
1244              * the same port number.  This could happen if a port is deleted
1245              * and then a new one added in its place very quickly, or if a port
1246              * is renamed.  In the former case we want to send an OFPPR_DELETE
1247              * and an OFPPR_ADD, and in the latter case we want to send a
1248              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1249              * the old port's ifindex against the new port, or perhaps less
1250              * reliably but more portably by comparing the old port's MAC
1251              * against the new port's MAC.  However, this code isn't that smart
1252              * and always sends an OFPPR_MODIFY (XXX). */
1253             old_ofport = port_array_get(&p->ports, odp_port.port);
1254         }
1255     } else if (error != ENOENT && error != ENODEV) {
1256         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1257                      "%s", strerror(error));
1258         return;
1259     }
1260
1261     /* Create a new ofport. */
1262     new_ofport = !error ? make_ofport(&odp_port) : NULL;
1263
1264     /* Eliminate a few pathological cases. */
1265     if (!old_ofport && !new_ofport) {
1266         return;
1267     } else if (old_ofport && new_ofport) {
1268         /* Most of the 'config' bits are OpenFlow soft state, but
1269          * OFPPC_PORT_DOWN is maintained the kernel.  So transfer the OpenFlow
1270          * bits from old_ofport.  (make_ofport() only sets OFPPC_PORT_DOWN and
1271          * leaves the other bits 0.)  */
1272         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1273
1274         if (ofport_equal(old_ofport, new_ofport)) {
1275             /* False alarm--no change. */
1276             ofport_free(new_ofport);
1277             return;
1278         }
1279     }
1280
1281     /* Now deal with the normal cases. */
1282     if (old_ofport) {
1283         ofport_remove(p, old_ofport);
1284     }
1285     if (new_ofport) {
1286         ofport_install(p, new_ofport);
1287     }
1288     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1289                      (!old_ofport ? OFPPR_ADD
1290                       : !new_ofport ? OFPPR_DELETE
1291                       : OFPPR_MODIFY));
1292     ofport_free(old_ofport);
1293
1294     /* Update port groups. */
1295     refresh_port_groups(p);
1296 }
1297
1298 static int
1299 init_ports(struct ofproto *p)
1300 {
1301     struct odp_port *ports;
1302     size_t n_ports;
1303     size_t i;
1304     int error;
1305
1306     error = dpif_port_list(p->dpif, &ports, &n_ports);
1307     if (error) {
1308         return error;
1309     }
1310
1311     for (i = 0; i < n_ports; i++) {
1312         const struct odp_port *odp_port = &ports[i];
1313         if (!ofport_conflicts(p, odp_port)) {
1314             struct ofport *ofport = make_ofport(odp_port);
1315             if (ofport) {
1316                 ofport_install(p, ofport);
1317             }
1318         }
1319     }
1320     free(ports);
1321     refresh_port_groups(p);
1322     return 0;
1323 }
1324 \f
1325 static struct ofconn *
1326 ofconn_create(struct ofproto *p, struct rconn *rconn)
1327 {
1328     struct ofconn *ofconn = xmalloc(sizeof *ofconn);
1329     list_push_back(&p->all_conns, &ofconn->node);
1330     ofconn->rconn = rconn;
1331     ofconn->pktbuf = NULL;
1332     ofconn->send_flow_exp = false;
1333     ofconn->miss_send_len = 0;
1334     ofconn->packet_in_counter = rconn_packet_counter_create ();
1335     ofconn->reply_counter = rconn_packet_counter_create ();
1336     return ofconn;
1337 }
1338
1339 static void
1340 ofconn_destroy(struct ofconn *ofconn)
1341 {
1342     list_remove(&ofconn->node);
1343     rconn_destroy(ofconn->rconn);
1344     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1345     rconn_packet_counter_destroy(ofconn->reply_counter);
1346     pktbuf_destroy(ofconn->pktbuf);
1347     free(ofconn);
1348 }
1349
1350 static void
1351 ofconn_run(struct ofconn *ofconn, struct ofproto *p)
1352 {
1353     int iteration;
1354
1355     rconn_run(ofconn->rconn);
1356
1357     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1358         /* Limit the number of iterations to prevent other tasks from
1359          * starving. */
1360         for (iteration = 0; iteration < 50; iteration++) {
1361             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1362             if (!of_msg) {
1363                 break;
1364             }
1365             if (p->fail_open) {
1366                 fail_open_maybe_recover(p->fail_open);
1367             }
1368             handle_openflow(ofconn, p, of_msg);
1369             ofpbuf_delete(of_msg);
1370         }
1371     }
1372
1373     if (ofconn != p->controller && !rconn_is_alive(ofconn->rconn)) {
1374         ofconn_destroy(ofconn);
1375     }
1376 }
1377
1378 static void
1379 ofconn_wait(struct ofconn *ofconn)
1380 {
1381     rconn_run_wait(ofconn->rconn);
1382     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1383         rconn_recv_wait(ofconn->rconn);
1384     } else {
1385         COVERAGE_INC(ofproto_ofconn_stuck);
1386     }
1387 }
1388 \f
1389 /* Caller is responsible for initializing the 'cr' member of the returned
1390  * rule. */
1391 static struct rule *
1392 rule_create(struct ofproto *ofproto, struct rule *super,
1393             const union ofp_action *actions, size_t n_actions,
1394             uint16_t idle_timeout, uint16_t hard_timeout)
1395 {
1396     struct rule *rule = xzalloc(sizeof *rule);
1397     rule->idle_timeout = idle_timeout;
1398     rule->hard_timeout = hard_timeout;
1399     rule->used = rule->created = time_msec();
1400     rule->super = super;
1401     if (super) {
1402         list_push_back(&super->list, &rule->list);
1403     } else {
1404         list_init(&rule->list);
1405     }
1406     rule->n_actions = n_actions;
1407     rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1408     netflow_flow_clear(&rule->nf_flow);
1409     netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->created);
1410
1411     return rule;
1412 }
1413
1414 static struct rule *
1415 rule_from_cls_rule(const struct cls_rule *cls_rule)
1416 {
1417     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1418 }
1419
1420 static void
1421 rule_free(struct rule *rule)
1422 {
1423     free(rule->actions);
1424     free(rule->odp_actions);
1425     free(rule);
1426 }
1427
1428 /* Destroys 'rule'.  If 'rule' is a subrule, also removes it from its
1429  * super-rule's list of subrules.  If 'rule' is a super-rule, also iterates
1430  * through all of its subrules and revalidates them, destroying any that no
1431  * longer has a super-rule (which is probably all of them).
1432  *
1433  * Before calling this function, the caller must make have removed 'rule' from
1434  * the classifier.  If 'rule' is an exact-match rule, the caller is also
1435  * responsible for ensuring that it has been uninstalled from the datapath. */
1436 static void
1437 rule_destroy(struct ofproto *ofproto, struct rule *rule)
1438 {
1439     if (!rule->super) {
1440         struct rule *subrule, *next;
1441         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
1442             revalidate_rule(ofproto, subrule);
1443         }
1444     } else {
1445         list_remove(&rule->list);
1446     }
1447     rule_free(rule);
1448 }
1449
1450 static bool
1451 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1452 {
1453     const union ofp_action *oa;
1454     struct actions_iterator i;
1455
1456     if (out_port == htons(OFPP_NONE)) {
1457         return true;
1458     }
1459     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1460          oa = actions_next(&i)) {
1461         if (oa->type == htons(OFPAT_OUTPUT) && oa->output.port == out_port) {
1462             return true;
1463         }
1464     }
1465     return false;
1466 }
1467
1468 /* Executes the actions indicated by 'rule' on 'packet', which is in flow
1469  * 'flow' and is considered to have arrived on ODP port 'in_port'.
1470  *
1471  * The flow that 'packet' actually contains does not need to actually match
1472  * 'rule'; the actions in 'rule' will be applied to it either way.  Likewise,
1473  * the packet and byte counters for 'rule' will be credited for the packet sent
1474  * out whether or not the packet actually matches 'rule'.
1475  *
1476  * If 'rule' is an exact-match rule and 'flow' actually equals the rule's flow,
1477  * the caller must already have accurately composed ODP actions for it given
1478  * 'packet' using rule_make_actions().  If 'rule' is a wildcard rule, or if
1479  * 'rule' is an exact-match rule but 'flow' is not the rule's flow, then this
1480  * function will compose a set of ODP actions based on 'rule''s OpenFlow
1481  * actions and apply them to 'packet'. */
1482 static void
1483 rule_execute(struct ofproto *ofproto, struct rule *rule,
1484              struct ofpbuf *packet, const flow_t *flow)
1485 {
1486     const union odp_action *actions;
1487     size_t n_actions;
1488     struct odp_actions a;
1489
1490     /* Grab or compose the ODP actions.
1491      *
1492      * The special case for an exact-match 'rule' where 'flow' is not the
1493      * rule's flow is important to avoid, e.g., sending a packet out its input
1494      * port simply because the ODP actions were composed for the wrong
1495      * scenario. */
1496     if (rule->cr.wc.wildcards || !flow_equal(flow, &rule->cr.flow)) {
1497         struct rule *super = rule->super ? rule->super : rule;
1498         if (xlate_actions(super->actions, super->n_actions, flow, ofproto,
1499                           packet, &a, NULL, 0, NULL)) {
1500             return;
1501         }
1502         actions = a.actions;
1503         n_actions = a.n_actions;
1504     } else {
1505         actions = rule->odp_actions;
1506         n_actions = rule->n_odp_actions;
1507     }
1508
1509     /* Execute the ODP actions. */
1510     if (!dpif_execute(ofproto->dpif, flow->in_port,
1511                       actions, n_actions, packet)) {
1512         struct odp_flow_stats stats;
1513         flow_extract_stats(flow, packet, &stats);
1514         update_stats(ofproto, rule, &stats);
1515         rule->used = time_msec();
1516         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->used);
1517     }
1518 }
1519
1520 static void
1521 rule_insert(struct ofproto *p, struct rule *rule, struct ofpbuf *packet,
1522             uint16_t in_port)
1523 {
1524     struct rule *displaced_rule;
1525
1526     /* Insert the rule in the classifier. */
1527     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
1528     if (!rule->cr.wc.wildcards) {
1529         rule_make_actions(p, rule, packet);
1530     }
1531
1532     /* Send the packet and credit it to the rule. */
1533     if (packet) {
1534         flow_t flow;
1535         flow_extract(packet, in_port, &flow);
1536         rule_execute(p, rule, packet, &flow);
1537     }
1538
1539     /* Install the rule in the datapath only after sending the packet, to
1540      * avoid packet reordering.  */
1541     if (rule->cr.wc.wildcards) {
1542         COVERAGE_INC(ofproto_add_wc_flow);
1543         p->need_revalidate = true;
1544     } else {
1545         rule_install(p, rule, displaced_rule);
1546     }
1547
1548     /* Free the rule that was displaced, if any. */
1549     if (displaced_rule) {
1550         rule_destroy(p, displaced_rule);
1551     }
1552 }
1553
1554 static struct rule *
1555 rule_create_subrule(struct ofproto *ofproto, struct rule *rule,
1556                     const flow_t *flow)
1557 {
1558     struct rule *subrule = rule_create(ofproto, rule, NULL, 0,
1559                                        rule->idle_timeout, rule->hard_timeout);
1560     COVERAGE_INC(ofproto_subrule_create);
1561     cls_rule_from_flow(&subrule->cr, flow, 0,
1562                        (rule->cr.priority <= UINT16_MAX ? UINT16_MAX
1563                         : rule->cr.priority));
1564     classifier_insert_exact(&ofproto->cls, &subrule->cr);
1565
1566     return subrule;
1567 }
1568
1569 static void
1570 rule_remove(struct ofproto *ofproto, struct rule *rule)
1571 {
1572     if (rule->cr.wc.wildcards) {
1573         COVERAGE_INC(ofproto_del_wc_flow);
1574         ofproto->need_revalidate = true;
1575     } else {
1576         rule_uninstall(ofproto, rule);
1577     }
1578     classifier_remove(&ofproto->cls, &rule->cr);
1579     rule_destroy(ofproto, rule);
1580 }
1581
1582 /* Returns true if the actions changed, false otherwise. */
1583 static bool
1584 rule_make_actions(struct ofproto *p, struct rule *rule,
1585                   const struct ofpbuf *packet)
1586 {
1587     const struct rule *super;
1588     struct odp_actions a;
1589     size_t actions_len;
1590
1591     assert(!rule->cr.wc.wildcards);
1592
1593     super = rule->super ? rule->super : rule;
1594     rule->tags = 0;
1595     xlate_actions(super->actions, super->n_actions, &rule->cr.flow, p,
1596                   packet, &a, &rule->tags, &rule->may_install,
1597                   &rule->nf_flow.output_iface);
1598
1599     actions_len = a.n_actions * sizeof *a.actions;
1600     if (rule->n_odp_actions != a.n_actions
1601         || memcmp(rule->odp_actions, a.actions, actions_len)) {
1602         COVERAGE_INC(ofproto_odp_unchanged);
1603         free(rule->odp_actions);
1604         rule->n_odp_actions = a.n_actions;
1605         rule->odp_actions = xmemdup(a.actions, actions_len);
1606         return true;
1607     } else {
1608         return false;
1609     }
1610 }
1611
1612 static int
1613 do_put_flow(struct ofproto *ofproto, struct rule *rule, int flags,
1614             struct odp_flow_put *put)
1615 {
1616     memset(&put->flow.stats, 0, sizeof put->flow.stats);
1617     put->flow.key = rule->cr.flow;
1618     put->flow.actions = rule->odp_actions;
1619     put->flow.n_actions = rule->n_odp_actions;
1620     put->flags = flags;
1621     return dpif_flow_put(ofproto->dpif, put);
1622 }
1623
1624 static void
1625 rule_install(struct ofproto *p, struct rule *rule, struct rule *displaced_rule)
1626 {
1627     assert(!rule->cr.wc.wildcards);
1628
1629     if (rule->may_install) {
1630         struct odp_flow_put put;
1631         if (!do_put_flow(p, rule,
1632                          ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS,
1633                          &put)) {
1634             rule->installed = true;
1635             if (displaced_rule) {
1636                 update_stats(p, displaced_rule, &put.flow.stats);
1637                 rule_post_uninstall(p, displaced_rule);
1638             }
1639         }
1640     } else if (displaced_rule) {
1641         rule_uninstall(p, displaced_rule);
1642     }
1643 }
1644
1645 static void
1646 rule_reinstall(struct ofproto *ofproto, struct rule *rule)
1647 {
1648     if (rule->installed) {
1649         struct odp_flow_put put;
1650         COVERAGE_INC(ofproto_dp_missed);
1651         do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY, &put);
1652     } else {
1653         rule_install(ofproto, rule, NULL);
1654     }
1655 }
1656
1657 static void
1658 rule_update_actions(struct ofproto *ofproto, struct rule *rule)
1659 {
1660     bool actions_changed;
1661     uint16_t new_out_iface, old_out_iface;
1662
1663     old_out_iface = rule->nf_flow.output_iface;
1664     actions_changed = rule_make_actions(ofproto, rule, NULL);
1665
1666     if (rule->may_install) {
1667         if (rule->installed) {
1668             if (actions_changed) {
1669                 struct odp_flow_put put;
1670                 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY
1671                                            | ODPPF_ZERO_STATS, &put);
1672                 update_stats(ofproto, rule, &put.flow.stats);
1673
1674                 /* Temporarily set the old output iface so that NetFlow
1675                  * messages have the correct output interface for the old
1676                  * stats. */
1677                 new_out_iface = rule->nf_flow.output_iface;
1678                 rule->nf_flow.output_iface = old_out_iface;
1679                 rule_post_uninstall(ofproto, rule);
1680                 rule->nf_flow.output_iface = new_out_iface;
1681             }
1682         } else {
1683             rule_install(ofproto, rule, NULL);
1684         }
1685     } else {
1686         rule_uninstall(ofproto, rule);
1687     }
1688 }
1689
1690 static void
1691 rule_account(struct ofproto *ofproto, struct rule *rule, uint64_t extra_bytes)
1692 {
1693     uint64_t total_bytes = rule->byte_count + extra_bytes;
1694
1695     if (ofproto->ofhooks->account_flow_cb
1696         && total_bytes > rule->accounted_bytes)
1697     {
1698         ofproto->ofhooks->account_flow_cb(
1699             &rule->cr.flow, rule->odp_actions, rule->n_odp_actions,
1700             total_bytes - rule->accounted_bytes, ofproto->aux);
1701         rule->accounted_bytes = total_bytes;
1702     }
1703 }
1704
1705 static void
1706 rule_uninstall(struct ofproto *p, struct rule *rule)
1707 {
1708     assert(!rule->cr.wc.wildcards);
1709     if (rule->installed) {
1710         struct odp_flow odp_flow;
1711
1712         odp_flow.key = rule->cr.flow;
1713         odp_flow.actions = NULL;
1714         odp_flow.n_actions = 0;
1715         if (!dpif_flow_del(p->dpif, &odp_flow)) {
1716             update_stats(p, rule, &odp_flow.stats);
1717         }
1718         rule->installed = false;
1719
1720         rule_post_uninstall(p, rule);
1721     }
1722 }
1723
1724 static bool
1725 is_controller_rule(struct rule *rule)
1726 {
1727     /* If the only action is send to the controller then don't report
1728      * NetFlow expiration messages since it is just part of the control
1729      * logic for the network and not real traffic. */
1730
1731     if (rule && rule->super) {
1732         struct rule *super = rule->super;
1733
1734         return super->n_actions == 1 &&
1735                super->actions[0].type == htons(OFPAT_OUTPUT) &&
1736                super->actions[0].output.port == htons(OFPP_CONTROLLER);
1737     }
1738
1739     return false;
1740 }
1741
1742 static void
1743 rule_post_uninstall(struct ofproto *ofproto, struct rule *rule)
1744 {
1745     struct rule *super = rule->super;
1746
1747     rule_account(ofproto, rule, 0);
1748
1749     if (ofproto->netflow && !is_controller_rule(rule)) {
1750         struct ofexpired expired;
1751         expired.flow = rule->cr.flow;
1752         expired.packet_count = rule->packet_count;
1753         expired.byte_count = rule->byte_count;
1754         expired.used = rule->used;
1755         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
1756     }
1757     if (super) {
1758         super->packet_count += rule->packet_count;
1759         super->byte_count += rule->byte_count;
1760
1761         /* Reset counters to prevent double counting if the rule ever gets
1762          * reinstalled. */
1763         rule->packet_count = 0;
1764         rule->byte_count = 0;
1765         rule->accounted_bytes = 0;
1766
1767         netflow_flow_clear(&rule->nf_flow);
1768     }
1769 }
1770 \f
1771 static void
1772 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
1773          struct rconn_packet_counter *counter)
1774 {
1775     update_openflow_length(msg);
1776     if (rconn_send(ofconn->rconn, msg, counter)) {
1777         ofpbuf_delete(msg);
1778     }
1779 }
1780
1781 static void
1782 send_error(const struct ofconn *ofconn, const struct ofp_header *oh,
1783            int error, const void *data, size_t len)
1784 {
1785     struct ofpbuf *buf;
1786     struct ofp_error_msg *oem;
1787
1788     if (!(error >> 16)) {
1789         VLOG_WARN_RL(&rl, "not sending bad error code %d to controller",
1790                      error);
1791         return;
1792     }
1793
1794     COVERAGE_INC(ofproto_error);
1795     oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR,
1796                             oh ? oh->xid : 0, &buf);
1797     oem->type = htons((unsigned int) error >> 16);
1798     oem->code = htons(error & 0xffff);
1799     memcpy(oem->data, data, len);
1800     queue_tx(buf, ofconn, ofconn->reply_counter);
1801 }
1802
1803 static void
1804 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
1805               int error)
1806 {
1807     size_t oh_length = ntohs(oh->length);
1808     send_error(ofconn, oh, error, oh, MIN(oh_length, 64));
1809 }
1810
1811 static void
1812 hton_ofp_phy_port(struct ofp_phy_port *opp)
1813 {
1814     opp->port_no = htons(opp->port_no);
1815     opp->config = htonl(opp->config);
1816     opp->state = htonl(opp->state);
1817     opp->curr = htonl(opp->curr);
1818     opp->advertised = htonl(opp->advertised);
1819     opp->supported = htonl(opp->supported);
1820     opp->peer = htonl(opp->peer);
1821 }
1822
1823 static int
1824 handle_echo_request(struct ofconn *ofconn, struct ofp_header *oh)
1825 {
1826     struct ofp_header *rq = oh;
1827     queue_tx(make_echo_reply(rq), ofconn, ofconn->reply_counter);
1828     return 0;
1829 }
1830
1831 static int
1832 handle_features_request(struct ofproto *p, struct ofconn *ofconn,
1833                         struct ofp_header *oh)
1834 {
1835     struct ofp_switch_features *osf;
1836     struct ofpbuf *buf;
1837     unsigned int port_no;
1838     struct ofport *port;
1839
1840     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1841     osf->datapath_id = htonll(p->datapath_id);
1842     osf->n_buffers = htonl(pktbuf_capacity());
1843     osf->n_tables = 2;
1844     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1845                               OFPC_PORT_STATS | OFPC_MULTI_PHY_TX);
1846     osf->actions = htonl((1u << OFPAT_OUTPUT) |
1847                          (1u << OFPAT_SET_VLAN_VID) |
1848                          (1u << OFPAT_SET_VLAN_PCP) |
1849                          (1u << OFPAT_STRIP_VLAN) |
1850                          (1u << OFPAT_SET_DL_SRC) |
1851                          (1u << OFPAT_SET_DL_DST) |
1852                          (1u << OFPAT_SET_NW_SRC) |
1853                          (1u << OFPAT_SET_NW_DST) |
1854                          (1u << OFPAT_SET_TP_SRC) |
1855                          (1u << OFPAT_SET_TP_DST));
1856
1857     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1858         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
1859     }
1860
1861     queue_tx(buf, ofconn, ofconn->reply_counter);
1862     return 0;
1863 }
1864
1865 static int
1866 handle_get_config_request(struct ofproto *p, struct ofconn *ofconn,
1867                           struct ofp_header *oh)
1868 {
1869     struct ofpbuf *buf;
1870     struct ofp_switch_config *osc;
1871     uint16_t flags;
1872     bool drop_frags;
1873
1874     /* Figure out flags. */
1875     dpif_get_drop_frags(p->dpif, &drop_frags);
1876     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1877     if (ofconn->send_flow_exp) {
1878         flags |= OFPC_SEND_FLOW_EXP;
1879     }
1880
1881     /* Send reply. */
1882     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1883     osc->flags = htons(flags);
1884     osc->miss_send_len = htons(ofconn->miss_send_len);
1885     queue_tx(buf, ofconn, ofconn->reply_counter);
1886
1887     return 0;
1888 }
1889
1890 static int
1891 handle_set_config(struct ofproto *p, struct ofconn *ofconn,
1892                   struct ofp_switch_config *osc)
1893 {
1894     uint16_t flags;
1895     int error;
1896
1897     error = check_ofp_message(&osc->header, OFPT_SET_CONFIG, sizeof *osc);
1898     if (error) {
1899         return error;
1900     }
1901     flags = ntohs(osc->flags);
1902
1903     ofconn->send_flow_exp = (flags & OFPC_SEND_FLOW_EXP) != 0;
1904
1905     if (ofconn == p->controller) {
1906         switch (flags & OFPC_FRAG_MASK) {
1907         case OFPC_FRAG_NORMAL:
1908             dpif_set_drop_frags(p->dpif, false);
1909             break;
1910         case OFPC_FRAG_DROP:
1911             dpif_set_drop_frags(p->dpif, true);
1912             break;
1913         default:
1914             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1915                          osc->flags);
1916             break;
1917         }
1918     }
1919
1920     if ((ntohs(osc->miss_send_len) != 0) != (ofconn->miss_send_len != 0)) {
1921         if (ntohs(osc->miss_send_len) != 0) {
1922             ofconn->pktbuf = pktbuf_create();
1923         } else {
1924             pktbuf_destroy(ofconn->pktbuf);
1925         }
1926     }
1927
1928     ofconn->miss_send_len = ntohs(osc->miss_send_len);
1929
1930     return 0;
1931 }
1932
1933 static void
1934 add_output_group_action(struct odp_actions *actions, uint16_t group,
1935                         uint16_t *nf_output_iface)
1936 {
1937     odp_actions_add(actions, ODPAT_OUTPUT_GROUP)->output_group.group = group;
1938
1939     if (group == DP_GROUP_ALL || group == DP_GROUP_FLOOD) {
1940         *nf_output_iface = NF_OUT_FLOOD;
1941     }
1942 }
1943
1944 static void
1945 add_controller_action(struct odp_actions *actions,
1946                       const struct ofp_action_output *oao)
1947 {
1948     union odp_action *a = odp_actions_add(actions, ODPAT_CONTROLLER);
1949     a->controller.arg = oao->max_len ? ntohs(oao->max_len) : UINT32_MAX;
1950 }
1951
1952 struct action_xlate_ctx {
1953     /* Input. */
1954     const flow_t *flow;         /* Flow to which these actions correspond. */
1955     int recurse;                /* Recursion level, via xlate_table_action. */
1956     struct ofproto *ofproto;
1957     const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
1958                                   * null pointer if we are revalidating
1959                                   * without a packet to refer to. */
1960
1961     /* Output. */
1962     struct odp_actions *out;    /* Datapath actions. */
1963     tag_type *tags;             /* Tags associated with OFPP_NORMAL actions. */
1964     bool may_set_up_flow;       /* True ordinarily; false if the actions must
1965                                  * be reassessed for every packet. */
1966     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
1967 };
1968
1969 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
1970                              struct action_xlate_ctx *ctx);
1971
1972 static void
1973 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
1974 {
1975     const struct ofport *ofport = port_array_get(&ctx->ofproto->ports, port);
1976
1977     if (ofport) {
1978         if (ofport->opp.config & OFPPC_NO_FWD) {
1979             /* Forwarding disabled on port. */
1980             return;
1981         }
1982     } else {
1983         /*
1984          * We don't have an ofport record for this port, but it doesn't hurt to
1985          * allow forwarding to it anyhow.  Maybe such a port will appear later
1986          * and we're pre-populating the flow table.
1987          */
1988     }
1989
1990     odp_actions_add(ctx->out, ODPAT_OUTPUT)->output.port = port;
1991     ctx->nf_output_iface = port;
1992 }
1993
1994 static struct rule *
1995 lookup_valid_rule(struct ofproto *ofproto, const flow_t *flow)
1996 {
1997     struct rule *rule;
1998     rule = rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
1999
2000     /* The rule we found might not be valid, since we could be in need of
2001      * revalidation.  If it is not valid, don't return it. */
2002     if (rule
2003         && rule->super
2004         && ofproto->need_revalidate
2005         && !revalidate_rule(ofproto, rule)) {
2006         COVERAGE_INC(ofproto_invalidated);
2007         return NULL;
2008     }
2009
2010     return rule;
2011 }
2012
2013 static void
2014 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2015 {
2016     if (!ctx->recurse) {
2017         struct rule *rule;
2018         flow_t flow;
2019
2020         flow = *ctx->flow;
2021         flow.in_port = in_port;
2022
2023         rule = lookup_valid_rule(ctx->ofproto, &flow);
2024         if (rule) {
2025             if (rule->super) {
2026                 rule = rule->super;
2027             }
2028
2029             ctx->recurse++;
2030             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2031             ctx->recurse--;
2032         }
2033     }
2034 }
2035
2036 static void
2037 xlate_output_action(struct action_xlate_ctx *ctx,
2038                     const struct ofp_action_output *oao)
2039 {
2040     uint16_t odp_port;
2041     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2042
2043     ctx->nf_output_iface = NF_OUT_DROP;
2044
2045     switch (ntohs(oao->port)) {
2046     case OFPP_IN_PORT:
2047         add_output_action(ctx, ctx->flow->in_port);
2048         break;
2049     case OFPP_TABLE:
2050         xlate_table_action(ctx, ctx->flow->in_port);
2051         break;
2052     case OFPP_NORMAL:
2053         if (!ctx->ofproto->ofhooks->normal_cb(ctx->flow, ctx->packet,
2054                                               ctx->out, ctx->tags,
2055                                               &ctx->nf_output_iface,
2056                                               ctx->ofproto->aux)) {
2057             COVERAGE_INC(ofproto_uninstallable);
2058             ctx->may_set_up_flow = false;
2059         }
2060         break;
2061     case OFPP_FLOOD:
2062         add_output_group_action(ctx->out, DP_GROUP_FLOOD,
2063                                 &ctx->nf_output_iface);
2064         break;
2065     case OFPP_ALL:
2066         add_output_group_action(ctx->out, DP_GROUP_ALL, &ctx->nf_output_iface);
2067         break;
2068     case OFPP_CONTROLLER:
2069         add_controller_action(ctx->out, oao);
2070         break;
2071     case OFPP_LOCAL:
2072         add_output_action(ctx, ODPP_LOCAL);
2073         break;
2074     default:
2075         odp_port = ofp_port_to_odp_port(ntohs(oao->port));
2076         if (odp_port != ctx->flow->in_port) {
2077             add_output_action(ctx, odp_port);
2078         }
2079         break;
2080     }
2081
2082     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2083         ctx->nf_output_iface = NF_OUT_FLOOD;
2084     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2085         ctx->nf_output_iface = prev_nf_output_iface;
2086     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2087                ctx->nf_output_iface != NF_OUT_FLOOD) {
2088         ctx->nf_output_iface = NF_OUT_MULTI;
2089     }
2090 }
2091
2092 static void
2093 xlate_nicira_action(struct action_xlate_ctx *ctx,
2094                     const struct nx_action_header *nah)
2095 {
2096     const struct nx_action_resubmit *nar;
2097     int subtype = ntohs(nah->subtype);
2098
2099     assert(nah->vendor == htonl(NX_VENDOR_ID));
2100     switch (subtype) {
2101     case NXAST_RESUBMIT:
2102         nar = (const struct nx_action_resubmit *) nah;
2103         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2104         break;
2105
2106     default:
2107         VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
2108         break;
2109     }
2110 }
2111
2112 static void
2113 do_xlate_actions(const union ofp_action *in, size_t n_in,
2114                  struct action_xlate_ctx *ctx)
2115 {
2116     struct actions_iterator iter;
2117     const union ofp_action *ia;
2118     const struct ofport *port;
2119
2120     port = port_array_get(&ctx->ofproto->ports, ctx->flow->in_port);
2121     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2122         port->opp.config & (eth_addr_equals(ctx->flow->dl_dst, stp_eth_addr)
2123                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2124         /* Drop this flow. */
2125         return;
2126     }
2127
2128     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2129         uint16_t type = ntohs(ia->type);
2130         union odp_action *oa;
2131
2132         switch (type) {
2133         case OFPAT_OUTPUT:
2134             xlate_output_action(ctx, &ia->output);
2135             break;
2136
2137         case OFPAT_SET_VLAN_VID:
2138             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_VID);
2139             oa->vlan_vid.vlan_vid = ia->vlan_vid.vlan_vid;
2140             break;
2141
2142         case OFPAT_SET_VLAN_PCP:
2143             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_PCP);
2144             oa->vlan_pcp.vlan_pcp = ia->vlan_pcp.vlan_pcp;
2145             break;
2146
2147         case OFPAT_STRIP_VLAN:
2148             odp_actions_add(ctx->out, ODPAT_STRIP_VLAN);
2149             break;
2150
2151         case OFPAT_SET_DL_SRC:
2152             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_SRC);
2153             memcpy(oa->dl_addr.dl_addr,
2154                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2155             break;
2156
2157         case OFPAT_SET_DL_DST:
2158             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_DST);
2159             memcpy(oa->dl_addr.dl_addr,
2160                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2161             break;
2162
2163         case OFPAT_SET_NW_SRC:
2164             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_SRC);
2165             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2166             break;
2167
2168         case OFPAT_SET_NW_DST:
2169             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_DST);
2170             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2171             break;
2172
2173         case OFPAT_SET_TP_SRC:
2174             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_SRC);
2175             oa->tp_port.tp_port = ia->tp_port.tp_port;
2176             break;
2177
2178         case OFPAT_SET_TP_DST:
2179             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_DST);
2180             oa->tp_port.tp_port = ia->tp_port.tp_port;
2181             break;
2182
2183         case OFPAT_VENDOR:
2184             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
2185             break;
2186
2187         default:
2188             VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
2189             break;
2190         }
2191     }
2192 }
2193
2194 static int
2195 xlate_actions(const union ofp_action *in, size_t n_in,
2196               const flow_t *flow, struct ofproto *ofproto,
2197               const struct ofpbuf *packet,
2198               struct odp_actions *out, tag_type *tags, bool *may_set_up_flow,
2199               uint16_t *nf_output_iface)
2200 {
2201     tag_type no_tags = 0;
2202     struct action_xlate_ctx ctx;
2203     COVERAGE_INC(ofproto_ofp2odp);
2204     odp_actions_init(out);
2205     ctx.flow = flow;
2206     ctx.recurse = 0;
2207     ctx.ofproto = ofproto;
2208     ctx.packet = packet;
2209     ctx.out = out;
2210     ctx.tags = tags ? tags : &no_tags;
2211     ctx.may_set_up_flow = true;
2212     ctx.nf_output_iface = NF_OUT_DROP;
2213     do_xlate_actions(in, n_in, &ctx);
2214
2215     /* Check with in-band control to see if we're allowed to set up this
2216      * flow. */
2217     if (!in_band_rule_check(ofproto->in_band, flow, out)) {
2218         ctx.may_set_up_flow = false;
2219     }
2220
2221     if (may_set_up_flow) {
2222         *may_set_up_flow = ctx.may_set_up_flow;
2223     }
2224     if (nf_output_iface) {
2225         *nf_output_iface = ctx.nf_output_iface;
2226     }
2227     if (odp_actions_overflow(out)) {
2228         odp_actions_init(out);
2229         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
2230     }
2231     return 0;
2232 }
2233
2234 static int
2235 handle_packet_out(struct ofproto *p, struct ofconn *ofconn,
2236                   struct ofp_header *oh)
2237 {
2238     struct ofp_packet_out *opo;
2239     struct ofpbuf payload, *buffer;
2240     struct odp_actions actions;
2241     int n_actions;
2242     uint16_t in_port;
2243     flow_t flow;
2244     int error;
2245
2246     error = check_ofp_packet_out(oh, &payload, &n_actions, p->max_ports);
2247     if (error) {
2248         return error;
2249     }
2250     opo = (struct ofp_packet_out *) oh;
2251
2252     COVERAGE_INC(ofproto_packet_out);
2253     if (opo->buffer_id != htonl(UINT32_MAX)) {
2254         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
2255                                 &buffer, &in_port);
2256         if (error || !buffer) {
2257             return error;
2258         }
2259         payload = *buffer;
2260     } else {
2261         buffer = NULL;
2262     }
2263
2264     flow_extract(&payload, ofp_port_to_odp_port(ntohs(opo->in_port)), &flow);
2265     error = xlate_actions((const union ofp_action *) opo->actions, n_actions,
2266                           &flow, p, &payload, &actions, NULL, NULL, NULL);
2267     if (error) {
2268         return error;
2269     }
2270
2271     dpif_execute(p->dpif, flow.in_port, actions.actions, actions.n_actions,
2272                  &payload);
2273     ofpbuf_delete(buffer);
2274
2275     return 0;
2276 }
2277
2278 static void
2279 update_port_config(struct ofproto *p, struct ofport *port,
2280                    uint32_t config, uint32_t mask)
2281 {
2282     mask &= config ^ port->opp.config;
2283     if (mask & OFPPC_PORT_DOWN) {
2284         if (config & OFPPC_PORT_DOWN) {
2285             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2286         } else {
2287             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2288         }
2289     }
2290 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP | OFPPC_NO_FWD)
2291     if (mask & REVALIDATE_BITS) {
2292         COVERAGE_INC(ofproto_costly_flags);
2293         port->opp.config ^= mask & REVALIDATE_BITS;
2294         p->need_revalidate = true;
2295     }
2296 #undef REVALIDATE_BITS
2297     if (mask & OFPPC_NO_FLOOD) {
2298         port->opp.config ^= OFPPC_NO_FLOOD;
2299         refresh_port_groups(p);
2300     }
2301     if (mask & OFPPC_NO_PACKET_IN) {
2302         port->opp.config ^= OFPPC_NO_PACKET_IN;
2303     }
2304 }
2305
2306 static int
2307 handle_port_mod(struct ofproto *p, struct ofp_header *oh)
2308 {
2309     const struct ofp_port_mod *opm;
2310     struct ofport *port;
2311     int error;
2312
2313     error = check_ofp_message(oh, OFPT_PORT_MOD, sizeof *opm);
2314     if (error) {
2315         return error;
2316     }
2317     opm = (struct ofp_port_mod *) oh;
2318
2319     port = port_array_get(&p->ports,
2320                           ofp_port_to_odp_port(ntohs(opm->port_no)));
2321     if (!port) {
2322         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
2323     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
2324         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
2325     } else {
2326         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
2327         if (opm->advertise) {
2328             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
2329         }
2330     }
2331     return 0;
2332 }
2333
2334 static struct ofpbuf *
2335 make_stats_reply(uint32_t xid, uint16_t type, size_t body_len)
2336 {
2337     struct ofp_stats_reply *osr;
2338     struct ofpbuf *msg;
2339
2340     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
2341     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
2342     osr->type = type;
2343     osr->flags = htons(0);
2344     return msg;
2345 }
2346
2347 static struct ofpbuf *
2348 start_stats_reply(const struct ofp_stats_request *request, size_t body_len)
2349 {
2350     return make_stats_reply(request->header.xid, request->type, body_len);
2351 }
2352
2353 static void *
2354 append_stats_reply(size_t nbytes, struct ofconn *ofconn, struct ofpbuf **msgp)
2355 {
2356     struct ofpbuf *msg = *msgp;
2357     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
2358     if (nbytes + msg->size > UINT16_MAX) {
2359         struct ofp_stats_reply *reply = msg->data;
2360         reply->flags = htons(OFPSF_REPLY_MORE);
2361         *msgp = make_stats_reply(reply->header.xid, reply->type, nbytes);
2362         queue_tx(msg, ofconn, ofconn->reply_counter);
2363     }
2364     return ofpbuf_put_uninit(*msgp, nbytes);
2365 }
2366
2367 static int
2368 handle_desc_stats_request(struct ofproto *p, struct ofconn *ofconn,
2369                            struct ofp_stats_request *request)
2370 {
2371     struct ofp_desc_stats *ods;
2372     struct ofpbuf *msg;
2373
2374     msg = start_stats_reply(request, sizeof *ods);
2375     ods = append_stats_reply(sizeof *ods, ofconn, &msg);
2376     strncpy(ods->mfr_desc, p->manufacturer, sizeof ods->mfr_desc);
2377     strncpy(ods->hw_desc, p->hardware, sizeof ods->hw_desc);
2378     strncpy(ods->sw_desc, p->software, sizeof ods->sw_desc);
2379     strncpy(ods->serial_num, p->serial, sizeof ods->serial_num);
2380     queue_tx(msg, ofconn, ofconn->reply_counter);
2381
2382     return 0;
2383 }
2384
2385 static void
2386 count_subrules(struct cls_rule *cls_rule, void *n_subrules_)
2387 {
2388     struct rule *rule = rule_from_cls_rule(cls_rule);
2389     int *n_subrules = n_subrules_;
2390
2391     if (rule->super) {
2392         (*n_subrules)++;
2393     }
2394 }
2395
2396 static int
2397 handle_table_stats_request(struct ofproto *p, struct ofconn *ofconn,
2398                            struct ofp_stats_request *request)
2399 {
2400     struct ofp_table_stats *ots;
2401     struct ofpbuf *msg;
2402     struct odp_stats dpstats;
2403     int n_exact, n_subrules, n_wild;
2404
2405     msg = start_stats_reply(request, sizeof *ots * 2);
2406
2407     /* Count rules of various kinds. */
2408     n_subrules = 0;
2409     classifier_for_each(&p->cls, CLS_INC_EXACT, count_subrules, &n_subrules);
2410     n_exact = classifier_count_exact(&p->cls) - n_subrules;
2411     n_wild = classifier_count(&p->cls) - classifier_count_exact(&p->cls);
2412
2413     /* Hash table. */
2414     dpif_get_dp_stats(p->dpif, &dpstats);
2415     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2416     memset(ots, 0, sizeof *ots);
2417     ots->table_id = TABLEID_HASH;
2418     strcpy(ots->name, "hash");
2419     ots->wildcards = htonl(0);
2420     ots->max_entries = htonl(dpstats.max_capacity);
2421     ots->active_count = htonl(n_exact);
2422     ots->lookup_count = htonll(dpstats.n_frags + dpstats.n_hit +
2423                                dpstats.n_missed);
2424     ots->matched_count = htonll(dpstats.n_hit); /* XXX */
2425
2426     /* Classifier table. */
2427     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2428     memset(ots, 0, sizeof *ots);
2429     ots->table_id = TABLEID_CLASSIFIER;
2430     strcpy(ots->name, "classifier");
2431     ots->wildcards = htonl(OFPFW_ALL);
2432     ots->max_entries = htonl(65536);
2433     ots->active_count = htonl(n_wild);
2434     ots->lookup_count = htonll(0);              /* XXX */
2435     ots->matched_count = htonll(0);             /* XXX */
2436
2437     queue_tx(msg, ofconn, ofconn->reply_counter);
2438     return 0;
2439 }
2440
2441 static int
2442 handle_port_stats_request(struct ofproto *p, struct ofconn *ofconn,
2443                           struct ofp_stats_request *request)
2444 {
2445     struct ofp_port_stats *ops;
2446     struct ofpbuf *msg;
2447     struct ofport *port;
2448     unsigned int port_no;
2449
2450     msg = start_stats_reply(request, sizeof *ops * 16);
2451     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
2452         struct netdev_stats stats;
2453
2454         /* Intentionally ignore return value, since errors will set 'stats' to
2455          * all-1s, which is correct for OpenFlow, and netdev_get_stats() will
2456          * log errors. */
2457         netdev_get_stats(port->netdev, &stats);
2458
2459         ops = append_stats_reply(sizeof *ops, ofconn, &msg);
2460         ops->port_no = htons(odp_port_to_ofp_port(port_no));
2461         memset(ops->pad, 0, sizeof ops->pad);
2462         ops->rx_packets = htonll(stats.rx_packets);
2463         ops->tx_packets = htonll(stats.tx_packets);
2464         ops->rx_bytes = htonll(stats.rx_bytes);
2465         ops->tx_bytes = htonll(stats.tx_bytes);
2466         ops->rx_dropped = htonll(stats.rx_dropped);
2467         ops->tx_dropped = htonll(stats.tx_dropped);
2468         ops->rx_errors = htonll(stats.rx_errors);
2469         ops->tx_errors = htonll(stats.tx_errors);
2470         ops->rx_frame_err = htonll(stats.rx_frame_errors);
2471         ops->rx_over_err = htonll(stats.rx_over_errors);
2472         ops->rx_crc_err = htonll(stats.rx_crc_errors);
2473         ops->collisions = htonll(stats.collisions);
2474     }
2475
2476     queue_tx(msg, ofconn, ofconn->reply_counter);
2477     return 0;
2478 }
2479
2480 struct flow_stats_cbdata {
2481     struct ofproto *ofproto;
2482     struct ofconn *ofconn;
2483     uint16_t out_port;
2484     struct ofpbuf *msg;
2485 };
2486
2487 static void
2488 query_stats(struct ofproto *p, struct rule *rule,
2489             uint64_t *packet_countp, uint64_t *byte_countp)
2490 {
2491     uint64_t packet_count, byte_count;
2492     struct rule *subrule;
2493     struct odp_flow *odp_flows;
2494     size_t n_odp_flows;
2495
2496     packet_count = rule->packet_count;
2497     byte_count = rule->byte_count;
2498
2499     n_odp_flows = rule->cr.wc.wildcards ? list_size(&rule->list) : 1;
2500     odp_flows = xzalloc(n_odp_flows * sizeof *odp_flows);
2501     if (rule->cr.wc.wildcards) {
2502         size_t i = 0;
2503         LIST_FOR_EACH (subrule, struct rule, list, &rule->list) {
2504             odp_flows[i++].key = subrule->cr.flow;
2505             packet_count += subrule->packet_count;
2506             byte_count += subrule->byte_count;
2507         }
2508     } else {
2509         odp_flows[0].key = rule->cr.flow;
2510     }
2511
2512     packet_count = rule->packet_count;
2513     byte_count = rule->byte_count;
2514     if (!dpif_flow_get_multiple(p->dpif, odp_flows, n_odp_flows)) {
2515         size_t i;
2516         for (i = 0; i < n_odp_flows; i++) {
2517             struct odp_flow *odp_flow = &odp_flows[i];
2518             packet_count += odp_flow->stats.n_packets;
2519             byte_count += odp_flow->stats.n_bytes;
2520         }
2521     }
2522     free(odp_flows);
2523
2524     *packet_countp = packet_count;
2525     *byte_countp = byte_count;
2526 }
2527
2528 static void
2529 flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
2530 {
2531     struct rule *rule = rule_from_cls_rule(rule_);
2532     struct flow_stats_cbdata *cbdata = cbdata_;
2533     struct ofp_flow_stats *ofs;
2534     uint64_t packet_count, byte_count;
2535     size_t act_len, len;
2536
2537     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2538         return;
2539     }
2540
2541     act_len = sizeof *rule->actions * rule->n_actions;
2542     len = offsetof(struct ofp_flow_stats, actions) + act_len;
2543
2544     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2545
2546     ofs = append_stats_reply(len, cbdata->ofconn, &cbdata->msg);
2547     ofs->length = htons(len);
2548     ofs->table_id = rule->cr.wc.wildcards ? TABLEID_CLASSIFIER : TABLEID_HASH;
2549     ofs->pad = 0;
2550     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofs->match);
2551     ofs->duration = htonl((time_msec() - rule->created) / 1000);
2552     ofs->priority = htons(rule->cr.priority);
2553     ofs->idle_timeout = htons(rule->idle_timeout);
2554     ofs->hard_timeout = htons(rule->hard_timeout);
2555     memset(ofs->pad2, 0, sizeof ofs->pad2);
2556     ofs->packet_count = htonll(packet_count);
2557     ofs->byte_count = htonll(byte_count);
2558     memcpy(ofs->actions, rule->actions, act_len);
2559 }
2560
2561 static int
2562 table_id_to_include(uint8_t table_id)
2563 {
2564     return (table_id == TABLEID_HASH ? CLS_INC_EXACT
2565             : table_id == TABLEID_CLASSIFIER ? CLS_INC_WILD
2566             : table_id == 0xff ? CLS_INC_ALL
2567             : 0);
2568 }
2569
2570 static int
2571 handle_flow_stats_request(struct ofproto *p, struct ofconn *ofconn,
2572                           const struct ofp_stats_request *osr,
2573                           size_t arg_size)
2574 {
2575     struct ofp_flow_stats_request *fsr;
2576     struct flow_stats_cbdata cbdata;
2577     struct cls_rule target;
2578
2579     if (arg_size != sizeof *fsr) {
2580         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2581     }
2582     fsr = (struct ofp_flow_stats_request *) osr->body;
2583
2584     COVERAGE_INC(ofproto_flows_req);
2585     cbdata.ofproto = p;
2586     cbdata.ofconn = ofconn;
2587     cbdata.out_port = fsr->out_port;
2588     cbdata.msg = start_stats_reply(osr, 1024);
2589     cls_rule_from_match(&target, &fsr->match, 0);
2590     classifier_for_each_match(&p->cls, &target,
2591                               table_id_to_include(fsr->table_id),
2592                               flow_stats_cb, &cbdata);
2593     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
2594     return 0;
2595 }
2596
2597 struct flow_stats_ds_cbdata {
2598     struct ofproto *ofproto;
2599     struct ds *results;
2600 };
2601
2602 static void
2603 flow_stats_ds_cb(struct cls_rule *rule_, void *cbdata_)
2604 {
2605     struct rule *rule = rule_from_cls_rule(rule_);
2606     struct flow_stats_ds_cbdata *cbdata = cbdata_;
2607     struct ds *results = cbdata->results;
2608     struct ofp_match match;
2609     uint64_t packet_count, byte_count;
2610     size_t act_len = sizeof *rule->actions * rule->n_actions;
2611
2612     /* Don't report on subrules. */
2613     if (rule->super != NULL) {
2614         return;
2615     }
2616
2617     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2618     flow_to_ovs_match(&rule->cr.flow, rule->cr.wc.wildcards, &match);
2619
2620     ds_put_format(results, "duration=%llds, ",
2621                   (time_msec() - rule->created) / 1000);
2622     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2623     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2624     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2625     ofp_print_match(results, &match, true);
2626     ofp_print_actions(results, &rule->actions->header, act_len);
2627     ds_put_cstr(results, "\n");
2628 }
2629
2630 /* Adds a pretty-printed description of all flows to 'results', including 
2631  * those marked hidden by secchan (e.g., by in-band control). */
2632 void
2633 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2634 {
2635     struct ofp_match match;
2636     struct cls_rule target;
2637     struct flow_stats_ds_cbdata cbdata;
2638
2639     memset(&match, 0, sizeof match);
2640     match.wildcards = htonl(OFPFW_ALL);
2641
2642     cbdata.ofproto = p;
2643     cbdata.results = results;
2644
2645     cls_rule_from_match(&target, &match, 0);
2646     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2647                               flow_stats_ds_cb, &cbdata);
2648 }
2649
2650 struct aggregate_stats_cbdata {
2651     struct ofproto *ofproto;
2652     uint16_t out_port;
2653     uint64_t packet_count;
2654     uint64_t byte_count;
2655     uint32_t n_flows;
2656 };
2657
2658 static void
2659 aggregate_stats_cb(struct cls_rule *rule_, void *cbdata_)
2660 {
2661     struct rule *rule = rule_from_cls_rule(rule_);
2662     struct aggregate_stats_cbdata *cbdata = cbdata_;
2663     uint64_t packet_count, byte_count;
2664
2665     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2666         return;
2667     }
2668
2669     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2670
2671     cbdata->packet_count += packet_count;
2672     cbdata->byte_count += byte_count;
2673     cbdata->n_flows++;
2674 }
2675
2676 static int
2677 handle_aggregate_stats_request(struct ofproto *p, struct ofconn *ofconn,
2678                                const struct ofp_stats_request *osr,
2679                                size_t arg_size)
2680 {
2681     struct ofp_aggregate_stats_request *asr;
2682     struct ofp_aggregate_stats_reply *reply;
2683     struct aggregate_stats_cbdata cbdata;
2684     struct cls_rule target;
2685     struct ofpbuf *msg;
2686
2687     if (arg_size != sizeof *asr) {
2688         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2689     }
2690     asr = (struct ofp_aggregate_stats_request *) osr->body;
2691
2692     COVERAGE_INC(ofproto_agg_request);
2693     cbdata.ofproto = p;
2694     cbdata.out_port = asr->out_port;
2695     cbdata.packet_count = 0;
2696     cbdata.byte_count = 0;
2697     cbdata.n_flows = 0;
2698     cls_rule_from_match(&target, &asr->match, 0);
2699     classifier_for_each_match(&p->cls, &target,
2700                               table_id_to_include(asr->table_id),
2701                               aggregate_stats_cb, &cbdata);
2702
2703     msg = start_stats_reply(osr, sizeof *reply);
2704     reply = append_stats_reply(sizeof *reply, ofconn, &msg);
2705     reply->flow_count = htonl(cbdata.n_flows);
2706     reply->packet_count = htonll(cbdata.packet_count);
2707     reply->byte_count = htonll(cbdata.byte_count);
2708     queue_tx(msg, ofconn, ofconn->reply_counter);
2709     return 0;
2710 }
2711
2712 static int
2713 handle_stats_request(struct ofproto *p, struct ofconn *ofconn,
2714                      struct ofp_header *oh)
2715 {
2716     struct ofp_stats_request *osr;
2717     size_t arg_size;
2718     int error;
2719
2720     error = check_ofp_message_array(oh, OFPT_STATS_REQUEST, sizeof *osr,
2721                                     1, &arg_size);
2722     if (error) {
2723         return error;
2724     }
2725     osr = (struct ofp_stats_request *) oh;
2726
2727     switch (ntohs(osr->type)) {
2728     case OFPST_DESC:
2729         return handle_desc_stats_request(p, ofconn, osr);
2730
2731     case OFPST_FLOW:
2732         return handle_flow_stats_request(p, ofconn, osr, arg_size);
2733
2734     case OFPST_AGGREGATE:
2735         return handle_aggregate_stats_request(p, ofconn, osr, arg_size);
2736
2737     case OFPST_TABLE:
2738         return handle_table_stats_request(p, ofconn, osr);
2739
2740     case OFPST_PORT:
2741         return handle_port_stats_request(p, ofconn, osr);
2742
2743     case OFPST_VENDOR:
2744         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2745
2746     default:
2747         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2748     }
2749 }
2750
2751 static long long int
2752 msec_from_nsec(uint64_t sec, uint32_t nsec)
2753 {
2754     return !sec ? 0 : sec * 1000 + nsec / 1000000;
2755 }
2756
2757 static void
2758 update_time(struct ofproto *ofproto, struct rule *rule,
2759             const struct odp_flow_stats *stats)
2760 {
2761     long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
2762     if (used > rule->used) {
2763         rule->used = used;
2764         if (rule->super && used > rule->super->used) {
2765             rule->super->used = used;
2766         }
2767         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
2768     }
2769 }
2770
2771 static void
2772 update_stats(struct ofproto *ofproto, struct rule *rule,
2773              const struct odp_flow_stats *stats)
2774 {
2775     if (stats->n_packets) {
2776         update_time(ofproto, rule, stats);
2777         rule->packet_count += stats->n_packets;
2778         rule->byte_count += stats->n_bytes;
2779         netflow_flow_update_flags(&rule->nf_flow, stats->ip_tos,
2780                                   stats->tcp_flags);
2781     }
2782 }
2783
2784 static int
2785 add_flow(struct ofproto *p, struct ofconn *ofconn,
2786          struct ofp_flow_mod *ofm, size_t n_actions)
2787 {
2788     struct ofpbuf *packet;
2789     struct rule *rule;
2790     uint16_t in_port;
2791     int error;
2792
2793     rule = rule_create(p, NULL, (const union ofp_action *) ofm->actions,
2794                        n_actions, ntohs(ofm->idle_timeout),
2795                        ntohs(ofm->hard_timeout));
2796     cls_rule_from_match(&rule->cr, &ofm->match, ntohs(ofm->priority));
2797
2798     packet = NULL;
2799     error = 0;
2800     if (ofm->buffer_id != htonl(UINT32_MAX)) {
2801         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
2802                                 &packet, &in_port);
2803     }
2804
2805     rule_insert(p, rule, packet, in_port);
2806     ofpbuf_delete(packet);
2807     return error;
2808 }
2809
2810 static int
2811 modify_flow(struct ofproto *p, const struct ofp_flow_mod *ofm,
2812             size_t n_actions, uint16_t command, struct rule *rule)
2813 {
2814     if (rule_is_hidden(rule)) {
2815         return 0;
2816     }
2817
2818     if (command == OFPFC_DELETE) {
2819         rule_remove(p, rule);
2820     } else {
2821         size_t actions_len = n_actions * sizeof *rule->actions;
2822
2823         if (n_actions == rule->n_actions
2824             && !memcmp(ofm->actions, rule->actions, actions_len))
2825         {
2826             return 0;
2827         }
2828
2829         free(rule->actions);
2830         rule->actions = xmemdup(ofm->actions, actions_len);
2831         rule->n_actions = n_actions;
2832
2833         if (rule->cr.wc.wildcards) {
2834             COVERAGE_INC(ofproto_mod_wc_flow);
2835             p->need_revalidate = true;
2836         } else {
2837             rule_update_actions(p, rule);
2838         }
2839     }
2840
2841     return 0;
2842 }
2843
2844 static int
2845 modify_flows_strict(struct ofproto *p, const struct ofp_flow_mod *ofm,
2846                     size_t n_actions, uint16_t command)
2847 {
2848     struct rule *rule;
2849     uint32_t wildcards;
2850     flow_t flow;
2851
2852     flow_from_match(&flow, &wildcards, &ofm->match);
2853     rule = rule_from_cls_rule(classifier_find_rule_exactly(
2854                                   &p->cls, &flow, wildcards,
2855                                   ntohs(ofm->priority)));
2856
2857     if (rule) {
2858         if (command == OFPFC_DELETE
2859             && ofm->out_port != htons(OFPP_NONE)
2860             && !rule_has_out_port(rule, ofm->out_port)) {
2861             return 0;
2862         }
2863
2864         modify_flow(p, ofm, n_actions, command, rule);
2865     }
2866     return 0;
2867 }
2868
2869 struct modify_flows_cbdata {
2870     struct ofproto *ofproto;
2871     const struct ofp_flow_mod *ofm;
2872     uint16_t out_port;
2873     size_t n_actions;
2874     uint16_t command;
2875 };
2876
2877 static void
2878 modify_flows_cb(struct cls_rule *rule_, void *cbdata_)
2879 {
2880     struct rule *rule = rule_from_cls_rule(rule_);
2881     struct modify_flows_cbdata *cbdata = cbdata_;
2882
2883     if (cbdata->out_port != htons(OFPP_NONE)
2884         && !rule_has_out_port(rule, cbdata->out_port)) {
2885         return;
2886     }
2887
2888     modify_flow(cbdata->ofproto, cbdata->ofm, cbdata->n_actions,
2889                 cbdata->command, rule);
2890 }
2891
2892 static int
2893 modify_flows_loose(struct ofproto *p, const struct ofp_flow_mod *ofm,
2894                    size_t n_actions, uint16_t command)
2895 {
2896     struct modify_flows_cbdata cbdata;
2897     struct cls_rule target;
2898
2899     cbdata.ofproto = p;
2900     cbdata.ofm = ofm;
2901     cbdata.out_port = (command == OFPFC_DELETE ? ofm->out_port
2902                        : htons(OFPP_NONE));
2903     cbdata.n_actions = n_actions;
2904     cbdata.command = command;
2905
2906     cls_rule_from_match(&target, &ofm->match, 0);
2907
2908     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2909                               modify_flows_cb, &cbdata);
2910     return 0;
2911 }
2912
2913 static int
2914 handle_flow_mod(struct ofproto *p, struct ofconn *ofconn,
2915                 struct ofp_flow_mod *ofm)
2916 {
2917     size_t n_actions;
2918     int error;
2919
2920     error = check_ofp_message_array(&ofm->header, OFPT_FLOW_MOD, sizeof *ofm,
2921                                     sizeof *ofm->actions, &n_actions);
2922     if (error) {
2923         return error;
2924     }
2925
2926     normalize_match(&ofm->match);
2927     if (!ofm->match.wildcards) {
2928         ofm->priority = htons(UINT16_MAX);
2929     }
2930
2931     error = validate_actions((const union ofp_action *) ofm->actions,
2932                              n_actions, p->max_ports);
2933     if (error) {
2934         return error;
2935     }
2936
2937     switch (ntohs(ofm->command)) {
2938     case OFPFC_ADD:
2939         return add_flow(p, ofconn, ofm, n_actions);
2940
2941     case OFPFC_MODIFY:
2942         return modify_flows_loose(p, ofm, n_actions, OFPFC_MODIFY);
2943
2944     case OFPFC_MODIFY_STRICT:
2945         return modify_flows_strict(p, ofm, n_actions, OFPFC_MODIFY);
2946
2947     case OFPFC_DELETE:
2948         return modify_flows_loose(p, ofm, n_actions, OFPFC_DELETE);
2949
2950     case OFPFC_DELETE_STRICT:
2951         return modify_flows_strict(p, ofm, n_actions, OFPFC_DELETE);
2952
2953     default:
2954         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2955     }
2956 }
2957
2958 static int
2959 handle_vendor(struct ofproto *p, struct ofconn *ofconn, void *msg)
2960 {
2961     struct ofp_vendor_header *ovh = msg;
2962     struct nicira_header *nh;
2963
2964     if (ntohs(ovh->header.length) < sizeof(struct ofp_vendor_header)) {
2965         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2966     }
2967     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
2968         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2969     }
2970     if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
2971         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LENGTH);
2972     }
2973
2974     nh = msg;
2975     switch (ntohl(nh->subtype)) {
2976     case NXT_STATUS_REQUEST:
2977         return switch_status_handle_request(p->switch_status, ofconn->rconn,
2978                                             msg);
2979     }
2980
2981     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
2982 }
2983
2984 static void
2985 handle_openflow(struct ofconn *ofconn, struct ofproto *p,
2986                 struct ofpbuf *ofp_msg)
2987 {
2988     struct ofp_header *oh = ofp_msg->data;
2989     int error;
2990
2991     COVERAGE_INC(ofproto_recv_openflow);
2992     switch (oh->type) {
2993     case OFPT_ECHO_REQUEST:
2994         error = handle_echo_request(ofconn, oh);
2995         break;
2996
2997     case OFPT_ECHO_REPLY:
2998         error = 0;
2999         break;
3000
3001     case OFPT_FEATURES_REQUEST:
3002         error = handle_features_request(p, ofconn, oh);
3003         break;
3004
3005     case OFPT_GET_CONFIG_REQUEST:
3006         error = handle_get_config_request(p, ofconn, oh);
3007         break;
3008
3009     case OFPT_SET_CONFIG:
3010         error = handle_set_config(p, ofconn, ofp_msg->data);
3011         break;
3012
3013     case OFPT_PACKET_OUT:
3014         error = handle_packet_out(p, ofconn, ofp_msg->data);
3015         break;
3016
3017     case OFPT_PORT_MOD:
3018         error = handle_port_mod(p, oh);
3019         break;
3020
3021     case OFPT_FLOW_MOD:
3022         error = handle_flow_mod(p, ofconn, ofp_msg->data);
3023         break;
3024
3025     case OFPT_STATS_REQUEST:
3026         error = handle_stats_request(p, ofconn, oh);
3027         break;
3028
3029     case OFPT_VENDOR:
3030         error = handle_vendor(p, ofconn, ofp_msg->data);
3031         break;
3032
3033     default:
3034         if (VLOG_IS_WARN_ENABLED()) {
3035             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
3036             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
3037             free(s);
3038         }
3039         error = ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
3040         break;
3041     }
3042
3043     if (error) {
3044         send_error_oh(ofconn, ofp_msg->data, error);
3045     }
3046 }
3047 \f
3048 static void
3049 handle_odp_miss_msg(struct ofproto *p, struct ofpbuf *packet)
3050 {
3051     struct odp_msg *msg = packet->data;
3052     uint16_t in_port = odp_port_to_ofp_port(msg->port);
3053     struct rule *rule;
3054     struct ofpbuf payload;
3055     flow_t flow;
3056
3057     payload.data = msg + 1;
3058     payload.size = msg->length - sizeof *msg;
3059     flow_extract(&payload, msg->port, &flow);
3060
3061     /* Check with in-band control to see if this packet should be sent
3062      * to the local port regardless of the flow table. */
3063     if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
3064         union odp_action action;
3065
3066         memset(&action, 0, sizeof(action));
3067         action.output.type = ODPAT_OUTPUT;
3068         action.output.port = ODPP_LOCAL;
3069         dpif_execute(p->dpif, flow.in_port, &action, 1, &payload);
3070     }
3071
3072     rule = lookup_valid_rule(p, &flow);
3073     if (!rule) {
3074         /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
3075         struct ofport *port = port_array_get(&p->ports, msg->port);
3076         if (port) {
3077             if (port->opp.config & OFPPC_NO_PACKET_IN) {
3078                 COVERAGE_INC(ofproto_no_packet_in);
3079                 /* XXX install 'drop' flow entry */
3080                 ofpbuf_delete(packet);
3081                 return;
3082             }
3083         } else {
3084             VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, msg->port);
3085         }
3086
3087         COVERAGE_INC(ofproto_packet_in);
3088         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3089         return;
3090     }
3091
3092     if (rule->cr.wc.wildcards) {
3093         rule = rule_create_subrule(p, rule, &flow);
3094         rule_make_actions(p, rule, packet);
3095     } else {
3096         if (!rule->may_install) {
3097             /* The rule is not installable, that is, we need to process every
3098              * packet, so process the current packet and set its actions into
3099              * 'subrule'. */
3100             rule_make_actions(p, rule, packet);
3101         } else {
3102             /* XXX revalidate rule if it needs it */
3103         }
3104     }
3105
3106     rule_execute(p, rule, &payload, &flow);
3107     rule_reinstall(p, rule);
3108
3109     if (rule->super && rule->super->cr.priority == FAIL_OPEN_PRIORITY
3110         && rconn_is_connected(p->controller->rconn)) {
3111         /*
3112          * Extra-special case for fail-open mode.
3113          *
3114          * We are in fail-open mode and the packet matched the fail-open rule,
3115          * but we are connected to a controller too.  We should send the packet
3116          * up to the controller in the hope that it will try to set up a flow
3117          * and thereby allow us to exit fail-open.
3118          *
3119          * See the top-level comment in fail-open.c for more information.
3120          */
3121         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3122     } else {
3123         ofpbuf_delete(packet);
3124     }
3125 }
3126
3127 static void
3128 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
3129 {
3130     struct odp_msg *msg = packet->data;
3131
3132     switch (msg->type) {
3133     case _ODPL_ACTION_NR:
3134         COVERAGE_INC(ofproto_ctlr_action);
3135         pinsched_send(p->action_sched, odp_port_to_ofp_port(msg->port), packet,
3136                       send_packet_in_action, p);
3137         break;
3138
3139     case _ODPL_SFLOW_NR:
3140         if (p->sflow) {
3141             ofproto_sflow_received(p->sflow, msg);
3142         }
3143         ofpbuf_delete(packet);
3144         break;
3145
3146     case _ODPL_MISS_NR:
3147         handle_odp_miss_msg(p, packet);
3148         break;
3149
3150     default:
3151         VLOG_WARN_RL(&rl, "received ODP message of unexpected type %"PRIu32,
3152                      msg->type);
3153         break;
3154     }
3155 }
3156 \f
3157 static void
3158 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
3159 {
3160     struct rule *sub = rule_from_cls_rule(sub_);
3161     struct revalidate_cbdata *cbdata = cbdata_;
3162
3163     if (cbdata->revalidate_all
3164         || (cbdata->revalidate_subrules && sub->super)
3165         || (tag_set_intersects(&cbdata->revalidate_set, sub->tags))) {
3166         revalidate_rule(cbdata->ofproto, sub);
3167     }
3168 }
3169
3170 static bool
3171 revalidate_rule(struct ofproto *p, struct rule *rule)
3172 {
3173     const flow_t *flow = &rule->cr.flow;
3174
3175     COVERAGE_INC(ofproto_revalidate_rule);
3176     if (rule->super) {
3177         struct rule *super;
3178         super = rule_from_cls_rule(classifier_lookup_wild(&p->cls, flow));
3179         if (!super) {
3180             rule_remove(p, rule);
3181             return false;
3182         } else if (super != rule->super) {
3183             COVERAGE_INC(ofproto_revalidate_moved);
3184             list_remove(&rule->list);
3185             list_push_back(&super->list, &rule->list);
3186             rule->super = super;
3187             rule->hard_timeout = super->hard_timeout;
3188             rule->idle_timeout = super->idle_timeout;
3189             rule->created = super->created;
3190             rule->used = 0;
3191         }
3192     }
3193
3194     rule_update_actions(p, rule);
3195     return true;
3196 }
3197
3198 static struct ofpbuf *
3199 compose_flow_exp(const struct rule *rule, long long int now, uint8_t reason)
3200 {
3201     struct ofp_flow_expired *ofe;
3202     struct ofpbuf *buf;
3203
3204     ofe = make_openflow(sizeof *ofe, OFPT_FLOW_EXPIRED, &buf);
3205     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofe->match);
3206     ofe->priority = htons(rule->cr.priority);
3207     ofe->reason = reason;
3208     ofe->duration = htonl((now - rule->created) / 1000);
3209     ofe->packet_count = htonll(rule->packet_count);
3210     ofe->byte_count = htonll(rule->byte_count);
3211
3212     return buf;
3213 }
3214
3215 static void
3216 send_flow_exp(struct ofproto *p, struct rule *rule,
3217               long long int now, uint8_t reason)
3218 {
3219     struct ofconn *ofconn;
3220     struct ofconn *prev;
3221     struct ofpbuf *buf = NULL;
3222
3223     /* We limit the maximum number of queued flow expirations it by accounting
3224      * them under the counter for replies.  That works because preventing
3225      * OpenFlow requests from being processed also prevents new flows from
3226      * being added (and expiring).  (It also prevents processing OpenFlow
3227      * requests that would not add new flows, so it is imperfect.) */
3228
3229     prev = NULL;
3230     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3231         if (ofconn->send_flow_exp && rconn_is_connected(ofconn->rconn)) {
3232             if (prev) {
3233                 queue_tx(ofpbuf_clone(buf), prev, prev->reply_counter);
3234             } else {
3235                 buf = compose_flow_exp(rule, now, reason);
3236             }
3237             prev = ofconn;
3238         }
3239     }
3240     if (prev) {
3241         queue_tx(buf, prev, prev->reply_counter);
3242     }
3243 }
3244
3245 static void
3246 uninstall_idle_flow(struct ofproto *ofproto, struct rule *rule)
3247 {
3248     assert(rule->installed);
3249     assert(!rule->cr.wc.wildcards);
3250
3251     if (rule->super) {
3252         rule_remove(ofproto, rule);
3253     } else {
3254         rule_uninstall(ofproto, rule);
3255     }
3256 }
3257
3258 static void
3259 expire_rule(struct cls_rule *cls_rule, void *p_)
3260 {
3261     struct ofproto *p = p_;
3262     struct rule *rule = rule_from_cls_rule(cls_rule);
3263     long long int hard_expire, idle_expire, expire, now;
3264
3265     hard_expire = (rule->hard_timeout
3266                    ? rule->created + rule->hard_timeout * 1000
3267                    : LLONG_MAX);
3268     idle_expire = (rule->idle_timeout
3269                    && (rule->super || list_is_empty(&rule->list))
3270                    ? rule->used + rule->idle_timeout * 1000
3271                    : LLONG_MAX);
3272     expire = MIN(hard_expire, idle_expire);
3273
3274     now = time_msec();
3275     if (now < expire) {
3276         if (rule->installed && now >= rule->used + 5000) {
3277             uninstall_idle_flow(p, rule);
3278         } else if (!rule->cr.wc.wildcards) {
3279             active_timeout(p, rule);
3280         }
3281
3282         return;
3283     }
3284
3285     COVERAGE_INC(ofproto_expired);
3286
3287     /* Update stats.  This code will be a no-op if the rule expired
3288      * due to an idle timeout. */
3289     if (rule->cr.wc.wildcards) {
3290         struct rule *subrule, *next;
3291         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
3292             rule_remove(p, subrule);
3293         }
3294     } else {
3295         rule_uninstall(p, rule);
3296     }
3297
3298     if (!rule_is_hidden(rule)) {
3299         send_flow_exp(p, rule, now,
3300                       (now >= hard_expire
3301                        ? OFPER_HARD_TIMEOUT : OFPER_IDLE_TIMEOUT));
3302     }
3303     rule_remove(p, rule);
3304 }
3305
3306 static void
3307 active_timeout(struct ofproto *ofproto, struct rule *rule)
3308 {
3309     if (ofproto->netflow && !is_controller_rule(rule) &&
3310         netflow_active_timeout_expired(ofproto->netflow, &rule->nf_flow)) {
3311         struct ofexpired expired;
3312         struct odp_flow odp_flow;
3313
3314         /* Get updated flow stats. */
3315         memset(&odp_flow, 0, sizeof odp_flow);
3316         if (rule->installed) {
3317             odp_flow.key = rule->cr.flow;
3318             odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
3319             dpif_flow_get(ofproto->dpif, &odp_flow);
3320
3321             if (odp_flow.stats.n_packets) {
3322                 update_time(ofproto, rule, &odp_flow.stats);
3323                 netflow_flow_update_flags(&rule->nf_flow, odp_flow.stats.ip_tos,
3324                                           odp_flow.stats.tcp_flags);
3325             }
3326         }
3327
3328         expired.flow = rule->cr.flow;
3329         expired.packet_count = rule->packet_count +
3330                                odp_flow.stats.n_packets;
3331         expired.byte_count = rule->byte_count + odp_flow.stats.n_bytes;
3332         expired.used = rule->used;
3333
3334         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
3335
3336         /* Schedule us to send the accumulated records once we have
3337          * collected all of them. */
3338         poll_immediate_wake();
3339     }
3340 }
3341
3342 static void
3343 update_used(struct ofproto *p)
3344 {
3345     struct odp_flow *flows;
3346     size_t n_flows;
3347     size_t i;
3348     int error;
3349
3350     error = dpif_flow_list_all(p->dpif, &flows, &n_flows);
3351     if (error) {
3352         return;
3353     }
3354
3355     for (i = 0; i < n_flows; i++) {
3356         struct odp_flow *f = &flows[i];
3357         struct rule *rule;
3358
3359         rule = rule_from_cls_rule(
3360             classifier_find_rule_exactly(&p->cls, &f->key, 0, UINT16_MAX));
3361         if (!rule || !rule->installed) {
3362             COVERAGE_INC(ofproto_unexpected_rule);
3363             dpif_flow_del(p->dpif, f);
3364             continue;
3365         }
3366
3367         update_time(p, rule, &f->stats);
3368         rule_account(p, rule, f->stats.n_bytes);
3369     }
3370     free(flows);
3371 }
3372
3373 static void
3374 do_send_packet_in(struct ofconn *ofconn, uint32_t buffer_id,
3375                   const struct ofpbuf *packet, int send_len)
3376 {
3377     struct odp_msg *msg = packet->data;
3378     struct ofpbuf payload;
3379     struct ofpbuf *opi;
3380     uint8_t reason;
3381
3382     /* Extract packet payload from 'msg'. */
3383     payload.data = msg + 1;
3384     payload.size = msg->length - sizeof *msg;
3385
3386     /* Construct ofp_packet_in message. */
3387     reason = msg->type == _ODPL_ACTION_NR ? OFPR_ACTION : OFPR_NO_MATCH;
3388     opi = make_packet_in(buffer_id, odp_port_to_ofp_port(msg->port), reason,
3389                          &payload, send_len);
3390
3391     /* Send. */
3392     rconn_send_with_limit(ofconn->rconn, opi, ofconn->packet_in_counter, 100);
3393 }
3394
3395 static void
3396 send_packet_in_action(struct ofpbuf *packet, void *p_)
3397 {
3398     struct ofproto *p = p_;
3399     struct ofconn *ofconn;
3400     struct odp_msg *msg;
3401
3402     msg = packet->data;
3403     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3404         if (ofconn == p->controller || ofconn->miss_send_len) {
3405             do_send_packet_in(ofconn, UINT32_MAX, packet, msg->arg);
3406         }
3407     }
3408     ofpbuf_delete(packet);
3409 }
3410
3411 static void
3412 send_packet_in_miss(struct ofpbuf *packet, void *p_)
3413 {
3414     struct ofproto *p = p_;
3415     bool in_fail_open = p->fail_open && fail_open_is_active(p->fail_open);
3416     struct ofconn *ofconn;
3417     struct ofpbuf payload;
3418     struct odp_msg *msg;
3419
3420     msg = packet->data;
3421     payload.data = msg + 1;
3422     payload.size = msg->length - sizeof *msg;
3423     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3424         if (ofconn->miss_send_len) {
3425             struct pktbuf *pb = ofconn->pktbuf;
3426             uint32_t buffer_id = (in_fail_open
3427                                   ? pktbuf_get_null()
3428                                   : pktbuf_save(pb, &payload, msg->port));
3429             int send_len = (buffer_id != UINT32_MAX ? ofconn->miss_send_len
3430                             : UINT32_MAX);
3431             do_send_packet_in(ofconn, buffer_id, packet, send_len);
3432         }
3433     }
3434     ofpbuf_delete(packet);
3435 }
3436
3437 static uint64_t
3438 pick_datapath_id(const struct ofproto *ofproto)
3439 {
3440     const struct ofport *port;
3441
3442     port = port_array_get(&ofproto->ports, ODPP_LOCAL);
3443     if (port) {
3444         uint8_t ea[ETH_ADDR_LEN];
3445         int error;
3446
3447         error = netdev_get_etheraddr(port->netdev, ea);
3448         if (!error) {
3449             return eth_addr_to_uint64(ea);
3450         }
3451         VLOG_WARN("could not get MAC address for %s (%s)",
3452                   netdev_get_name(port->netdev), strerror(error));
3453     }
3454     return ofproto->fallback_dpid;
3455 }
3456
3457 static uint64_t
3458 pick_fallback_dpid(void)
3459 {
3460     uint8_t ea[ETH_ADDR_LEN];
3461     eth_addr_random(ea);
3462     ea[0] = 0x00;               /* Set Nicira OUI. */
3463     ea[1] = 0x23;
3464     ea[2] = 0x20;
3465     return eth_addr_to_uint64(ea);
3466 }
3467 \f
3468 static bool
3469 default_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
3470                          struct odp_actions *actions, tag_type *tags,
3471                          uint16_t *nf_output_iface, void *ofproto_)
3472 {
3473     struct ofproto *ofproto = ofproto_;
3474     int out_port;
3475
3476     /* Drop frames for reserved multicast addresses. */
3477     if (eth_addr_is_reserved(flow->dl_dst)) {
3478         return true;
3479     }
3480
3481     /* Learn source MAC (but don't try to learn from revalidation). */
3482     if (packet != NULL) {
3483         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
3484                                               0, flow->in_port);
3485         if (rev_tag) {
3486             /* The log messages here could actually be useful in debugging,
3487              * so keep the rate limit relatively high. */
3488             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
3489             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
3490                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
3491             ofproto_revalidate(ofproto, rev_tag);
3492         }
3493     }
3494
3495     /* Determine output port. */
3496     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags);
3497     if (out_port < 0) {
3498         add_output_group_action(actions, DP_GROUP_FLOOD, nf_output_iface);
3499     } else if (out_port != flow->in_port) {
3500         odp_actions_add(actions, ODPAT_OUTPUT)->output.port = out_port;
3501         *nf_output_iface = out_port;
3502     } else {
3503         /* Drop. */
3504     }
3505
3506     return true;
3507 }
3508
3509 static const struct ofhooks default_ofhooks = {
3510     NULL,
3511     default_normal_ofhook_cb,
3512     NULL,
3513     NULL
3514 };