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