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