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