aae85680ce72c34724586b69f29917575042cd98
[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 void
1358 ofproto_get_ofproto_controller_info(const struct ofproto * ofproto,
1359                                     struct shash *info)
1360 {
1361     const struct ofconn *ofconn;
1362
1363     shash_init(info);
1364
1365     HMAP_FOR_EACH (ofconn, hmap_node, &ofproto->controllers) {
1366         const struct rconn *rconn = ofconn->rconn;
1367         const int last_error = rconn_get_last_error(rconn);
1368         struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
1369
1370         shash_add(info, rconn_get_target(rconn), cinfo);
1371
1372         cinfo->is_connected = rconn_is_connected(rconn);
1373         cinfo->role = ofconn->role;
1374
1375         cinfo->pairs.n = 0;
1376
1377         if (last_error == EOF) {
1378             cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
1379             cinfo->pairs.values[cinfo->pairs.n++] = xstrdup("End of file");
1380         } else if (last_error > 0) {
1381             cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
1382             cinfo->pairs.values[cinfo->pairs.n++] =
1383                 xstrdup(strerror(last_error));
1384         }
1385
1386         cinfo->pairs.keys[cinfo->pairs.n] = "state";
1387         cinfo->pairs.values[cinfo->pairs.n++] =
1388             xstrdup(rconn_get_state(rconn));
1389
1390         cinfo->pairs.keys[cinfo->pairs.n] = "time_in_state";
1391         cinfo->pairs.values[cinfo->pairs.n++] =
1392             xasprintf("%u", rconn_get_state_elapsed(rconn));
1393     }
1394 }
1395
1396 void
1397 ofproto_free_ofproto_controller_info(struct shash *info)
1398 {
1399     struct shash_node *node;
1400
1401     SHASH_FOR_EACH (node, info) {
1402         struct ofproto_controller_info *cinfo = node->data;
1403         while (cinfo->pairs.n) {
1404             free((char *) cinfo->pairs.values[--cinfo->pairs.n]);
1405         }
1406         free(cinfo);
1407     }
1408     shash_destroy(info);
1409 }
1410
1411 /* Deletes port number 'odp_port' from the datapath for 'ofproto'.
1412  *
1413  * This is almost the same as calling dpif_port_del() directly on the
1414  * datapath, but it also makes 'ofproto' close its open netdev for the port
1415  * (if any).  This makes it possible to create a new netdev of a different
1416  * type under the same name, which otherwise the netdev library would refuse
1417  * to do because of the conflict.  (The netdev would eventually get closed on
1418  * the next trip through ofproto_run(), but this interface is more direct.)
1419  *
1420  * Returns 0 if successful, otherwise a positive errno. */
1421 int
1422 ofproto_port_del(struct ofproto *ofproto, uint16_t odp_port)
1423 {
1424     struct ofport *ofport = get_port(ofproto, odp_port);
1425     const char *name = ofport ? ofport->opp.name : "<unknown>";
1426     int error;
1427
1428     error = dpif_port_del(ofproto->dpif, odp_port);
1429     if (error) {
1430         VLOG_ERR("%s: failed to remove port %"PRIu16" (%s) interface (%s)",
1431                  dpif_name(ofproto->dpif), odp_port, name, strerror(error));
1432     } else if (ofport) {
1433         /* 'name' is ofport->opp.name and update_port() is going to destroy
1434          * 'ofport'.  Just in case update_port() refers to 'name' after it
1435          * destroys 'ofport', make a copy of it around the update_port()
1436          * call. */
1437         char *devname = xstrdup(name);
1438         update_port(ofproto, devname);
1439         free(devname);
1440     }
1441     return error;
1442 }
1443
1444 /* Checks if 'ofproto' thinks 'odp_port' should be included in floods.  Returns
1445  * true if 'odp_port' exists and should be included, false otherwise. */
1446 bool
1447 ofproto_port_is_floodable(struct ofproto *ofproto, uint16_t odp_port)
1448 {
1449     struct ofport *ofport = get_port(ofproto, odp_port);
1450     return ofport && !(ofport->opp.config & OFPPC_NO_FLOOD);
1451 }
1452
1453 int
1454 ofproto_send_packet(struct ofproto *p, const struct flow *flow,
1455                     const union ofp_action *actions, size_t n_actions,
1456                     const struct ofpbuf *packet)
1457 {
1458     struct action_xlate_ctx ctx;
1459     struct ofpbuf *odp_actions;
1460
1461     action_xlate_ctx_init(&ctx, p, flow, packet);
1462     odp_actions = xlate_actions(&ctx, actions, n_actions);
1463
1464     /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
1465      * error code? */
1466     dpif_execute(p->dpif, odp_actions->data, odp_actions->size, packet);
1467
1468     ofpbuf_delete(odp_actions);
1469
1470     return 0;
1471 }
1472
1473 /* Adds a flow to the OpenFlow flow table in 'p' that matches 'cls_rule' and
1474  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1475  * timeout.
1476  *
1477  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1478  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1479  * controllers; otherwise, it will be hidden.
1480  *
1481  * The caller retains ownership of 'cls_rule' and 'actions'. */
1482 void
1483 ofproto_add_flow(struct ofproto *p, const struct cls_rule *cls_rule,
1484                  const union ofp_action *actions, size_t n_actions)
1485 {
1486     struct rule *rule;
1487     rule = rule_create(cls_rule, actions, n_actions, 0, 0, 0, false);
1488     rule_insert(p, rule);
1489 }
1490
1491 void
1492 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1493 {
1494     struct rule *rule;
1495
1496     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
1497                                                            target));
1498     if (rule) {
1499         rule_remove(ofproto, rule);
1500     }
1501 }
1502
1503 void
1504 ofproto_flush_flows(struct ofproto *ofproto)
1505 {
1506     struct facet *facet, *next_facet;
1507     struct rule *rule, *next_rule;
1508     struct cls_cursor cursor;
1509
1510     COVERAGE_INC(ofproto_flush);
1511
1512     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
1513         /* Mark the facet as not installed so that facet_remove() doesn't
1514          * bother trying to uninstall it.  There is no point in uninstalling it
1515          * individually since we are about to blow away all the facets with
1516          * dpif_flow_flush(). */
1517         facet->installed = false;
1518         facet_remove(ofproto, facet);
1519     }
1520
1521     cls_cursor_init(&cursor, &ofproto->cls, NULL);
1522     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1523         rule_remove(ofproto, rule);
1524     }
1525
1526     dpif_flow_flush(ofproto->dpif);
1527     if (ofproto->in_band) {
1528         in_band_flushed(ofproto->in_band);
1529     }
1530     if (ofproto->fail_open) {
1531         fail_open_flushed(ofproto->fail_open);
1532     }
1533 }
1534 \f
1535 static void
1536 reinit_ports(struct ofproto *p)
1537 {
1538     struct shash_node *node;
1539     struct shash devnames;
1540     struct ofport *ofport;
1541     struct odp_port *odp_ports;
1542     size_t n_odp_ports;
1543     size_t i;
1544
1545     COVERAGE_INC(ofproto_reinit_ports);
1546
1547     shash_init(&devnames);
1548     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1549         shash_add_once (&devnames, ofport->opp.name, NULL);
1550     }
1551     dpif_port_list(p->dpif, &odp_ports, &n_odp_ports);
1552     for (i = 0; i < n_odp_ports; i++) {
1553         shash_add_once (&devnames, odp_ports[i].devname, NULL);
1554     }
1555     free(odp_ports);
1556
1557     SHASH_FOR_EACH (node, &devnames) {
1558         update_port(p, node->name);
1559     }
1560     shash_destroy(&devnames);
1561 }
1562
1563 static struct ofport *
1564 make_ofport(const struct odp_port *odp_port)
1565 {
1566     struct netdev_options netdev_options;
1567     enum netdev_flags flags;
1568     struct ofport *ofport;
1569     struct netdev *netdev;
1570     int error;
1571
1572     memset(&netdev_options, 0, sizeof netdev_options);
1573     netdev_options.name = odp_port->devname;
1574     netdev_options.type = odp_port->type;
1575     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1576
1577     error = netdev_open(&netdev_options, &netdev);
1578     if (error) {
1579         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1580                      "cannot be opened (%s)",
1581                      odp_port->devname, odp_port->port,
1582                      odp_port->devname, strerror(error));
1583         return NULL;
1584     }
1585
1586     ofport = xmalloc(sizeof *ofport);
1587     ofport->netdev = netdev;
1588     ofport->odp_port = odp_port->port;
1589     ofport->opp.port_no = odp_port_to_ofp_port(odp_port->port);
1590     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1591     memcpy(ofport->opp.name, odp_port->devname,
1592            MIN(sizeof ofport->opp.name, sizeof odp_port->devname));
1593     ofport->opp.name[sizeof ofport->opp.name - 1] = '\0';
1594
1595     netdev_get_flags(netdev, &flags);
1596     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1597
1598     ofport->opp.state = netdev_get_carrier(netdev) ? 0 : OFPPS_LINK_DOWN;
1599
1600     netdev_get_features(netdev,
1601                         &ofport->opp.curr, &ofport->opp.advertised,
1602                         &ofport->opp.supported, &ofport->opp.peer);
1603     return ofport;
1604 }
1605
1606 static bool
1607 ofport_conflicts(const struct ofproto *p, const struct odp_port *odp_port)
1608 {
1609     if (get_port(p, odp_port->port)) {
1610         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1611                      odp_port->port);
1612         return true;
1613     } else if (shash_find(&p->port_by_name, odp_port->devname)) {
1614         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1615                      odp_port->devname);
1616         return true;
1617     } else {
1618         return false;
1619     }
1620 }
1621
1622 static int
1623 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1624 {
1625     const struct ofp_phy_port *a = &a_->opp;
1626     const struct ofp_phy_port *b = &b_->opp;
1627
1628     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1629     return (a->port_no == b->port_no
1630             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1631             && !strcmp(a->name, b->name)
1632             && a->state == b->state
1633             && a->config == b->config
1634             && a->curr == b->curr
1635             && a->advertised == b->advertised
1636             && a->supported == b->supported
1637             && a->peer == b->peer);
1638 }
1639
1640 static void
1641 send_port_status(struct ofproto *p, const struct ofport *ofport,
1642                  uint8_t reason)
1643 {
1644     /* XXX Should limit the number of queued port status change messages. */
1645     struct ofconn *ofconn;
1646     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
1647         struct ofp_port_status *ops;
1648         struct ofpbuf *b;
1649
1650         /* Primary controllers, even slaves, should always get port status
1651            updates.  Otherwise obey ofconn_receives_async_msgs(). */
1652         if (ofconn->type != OFCONN_PRIMARY
1653             && !ofconn_receives_async_msgs(ofconn)) {
1654             continue;
1655         }
1656
1657         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1658         ops->reason = reason;
1659         ops->desc = ofport->opp;
1660         hton_ofp_phy_port(&ops->desc);
1661         queue_tx(b, ofconn, NULL);
1662     }
1663 }
1664
1665 static void
1666 ofport_install(struct ofproto *p, struct ofport *ofport)
1667 {
1668     const char *netdev_name = ofport->opp.name;
1669
1670     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1671     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->odp_port, 0));
1672     shash_add(&p->port_by_name, netdev_name, ofport);
1673     if (p->sflow) {
1674         ofproto_sflow_add_port(p->sflow, ofport->odp_port, netdev_name);
1675     }
1676 }
1677
1678 static void
1679 ofport_remove(struct ofproto *p, struct ofport *ofport)
1680 {
1681     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1682     hmap_remove(&p->ports, &ofport->hmap_node);
1683     shash_delete(&p->port_by_name,
1684                  shash_find(&p->port_by_name, ofport->opp.name));
1685     if (p->sflow) {
1686         ofproto_sflow_del_port(p->sflow, ofport->odp_port);
1687     }
1688 }
1689
1690 static void
1691 ofport_free(struct ofport *ofport)
1692 {
1693     if (ofport) {
1694         netdev_close(ofport->netdev);
1695         free(ofport);
1696     }
1697 }
1698
1699 static struct ofport *
1700 get_port(const struct ofproto *ofproto, uint16_t odp_port)
1701 {
1702     struct ofport *port;
1703
1704     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1705                              hash_int(odp_port, 0), &ofproto->ports) {
1706         if (port->odp_port == odp_port) {
1707             return port;
1708         }
1709     }
1710     return NULL;
1711 }
1712
1713 static void
1714 update_port(struct ofproto *p, const char *devname)
1715 {
1716     struct odp_port odp_port;
1717     struct ofport *old_ofport;
1718     struct ofport *new_ofport;
1719     int error;
1720
1721     COVERAGE_INC(ofproto_update_port);
1722
1723     /* Query the datapath for port information. */
1724     error = dpif_port_query_by_name(p->dpif, devname, &odp_port);
1725
1726     /* Find the old ofport. */
1727     old_ofport = shash_find_data(&p->port_by_name, devname);
1728     if (!error) {
1729         if (!old_ofport) {
1730             /* There's no port named 'devname' but there might be a port with
1731              * the same port number.  This could happen if a port is deleted
1732              * and then a new one added in its place very quickly, or if a port
1733              * is renamed.  In the former case we want to send an OFPPR_DELETE
1734              * and an OFPPR_ADD, and in the latter case we want to send a
1735              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1736              * the old port's ifindex against the new port, or perhaps less
1737              * reliably but more portably by comparing the old port's MAC
1738              * against the new port's MAC.  However, this code isn't that smart
1739              * and always sends an OFPPR_MODIFY (XXX). */
1740             old_ofport = get_port(p, odp_port.port);
1741         }
1742     } else if (error != ENOENT && error != ENODEV) {
1743         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1744                      "%s", strerror(error));
1745         return;
1746     }
1747
1748     /* Create a new ofport. */
1749     new_ofport = !error ? make_ofport(&odp_port) : NULL;
1750
1751     /* Eliminate a few pathological cases. */
1752     if (!old_ofport && !new_ofport) {
1753         return;
1754     } else if (old_ofport && new_ofport) {
1755         /* Most of the 'config' bits are OpenFlow soft state, but
1756          * OFPPC_PORT_DOWN is maintained by the kernel.  So transfer the
1757          * OpenFlow bits from old_ofport.  (make_ofport() only sets
1758          * OFPPC_PORT_DOWN and leaves the other bits 0.)  */
1759         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1760
1761         if (ofport_equal(old_ofport, new_ofport)) {
1762             /* False alarm--no change. */
1763             ofport_free(new_ofport);
1764             return;
1765         }
1766     }
1767
1768     /* Now deal with the normal cases. */
1769     if (old_ofport) {
1770         ofport_remove(p, old_ofport);
1771     }
1772     if (new_ofport) {
1773         ofport_install(p, new_ofport);
1774     }
1775     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1776                      (!old_ofport ? OFPPR_ADD
1777                       : !new_ofport ? OFPPR_DELETE
1778                       : OFPPR_MODIFY));
1779     ofport_free(old_ofport);
1780 }
1781
1782 static int
1783 init_ports(struct ofproto *p)
1784 {
1785     struct odp_port *ports;
1786     size_t n_ports;
1787     size_t i;
1788     int error;
1789
1790     error = dpif_port_list(p->dpif, &ports, &n_ports);
1791     if (error) {
1792         return error;
1793     }
1794
1795     for (i = 0; i < n_ports; i++) {
1796         const struct odp_port *odp_port = &ports[i];
1797         if (!ofport_conflicts(p, odp_port)) {
1798             struct ofport *ofport = make_ofport(odp_port);
1799             if (ofport) {
1800                 ofport_install(p, ofport);
1801             }
1802         }
1803     }
1804     free(ports);
1805     return 0;
1806 }
1807 \f
1808 static struct ofconn *
1809 ofconn_create(struct ofproto *p, struct rconn *rconn, enum ofconn_type type)
1810 {
1811     struct ofconn *ofconn = xzalloc(sizeof *ofconn);
1812     ofconn->ofproto = p;
1813     list_push_back(&p->all_conns, &ofconn->node);
1814     ofconn->rconn = rconn;
1815     ofconn->type = type;
1816     ofconn->flow_format = NXFF_OPENFLOW10;
1817     ofconn->role = NX_ROLE_OTHER;
1818     ofconn->packet_in_counter = rconn_packet_counter_create ();
1819     ofconn->pktbuf = NULL;
1820     ofconn->miss_send_len = 0;
1821     ofconn->reply_counter = rconn_packet_counter_create ();
1822     return ofconn;
1823 }
1824
1825 static void
1826 ofconn_destroy(struct ofconn *ofconn)
1827 {
1828     if (ofconn->type == OFCONN_PRIMARY) {
1829         hmap_remove(&ofconn->ofproto->controllers, &ofconn->hmap_node);
1830     }
1831     discovery_destroy(ofconn->discovery);
1832
1833     list_remove(&ofconn->node);
1834     switch_status_unregister(ofconn->ss);
1835     rconn_destroy(ofconn->rconn);
1836     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1837     rconn_packet_counter_destroy(ofconn->reply_counter);
1838     pktbuf_destroy(ofconn->pktbuf);
1839     free(ofconn);
1840 }
1841
1842 static void
1843 ofconn_run(struct ofconn *ofconn)
1844 {
1845     struct ofproto *p = ofconn->ofproto;
1846     int iteration;
1847     size_t i;
1848
1849     if (ofconn->discovery) {
1850         char *controller_name;
1851         if (rconn_is_connectivity_questionable(ofconn->rconn)) {
1852             discovery_question_connectivity(ofconn->discovery);
1853         }
1854         if (discovery_run(ofconn->discovery, &controller_name)) {
1855             if (controller_name) {
1856                 char *ofconn_name = ofconn_make_name(p, controller_name);
1857                 rconn_connect(ofconn->rconn, controller_name, ofconn_name);
1858                 free(ofconn_name);
1859             } else {
1860                 rconn_disconnect(ofconn->rconn);
1861             }
1862         }
1863     }
1864
1865     for (i = 0; i < N_SCHEDULERS; i++) {
1866         pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1867     }
1868
1869     rconn_run(ofconn->rconn);
1870
1871     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1872         /* Limit the number of iterations to prevent other tasks from
1873          * starving. */
1874         for (iteration = 0; iteration < 50; iteration++) {
1875             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1876             if (!of_msg) {
1877                 break;
1878             }
1879             if (p->fail_open) {
1880                 fail_open_maybe_recover(p->fail_open);
1881             }
1882             handle_openflow(ofconn, of_msg);
1883             ofpbuf_delete(of_msg);
1884         }
1885     }
1886
1887     if (!ofconn->discovery && !rconn_is_alive(ofconn->rconn)) {
1888         ofconn_destroy(ofconn);
1889     }
1890 }
1891
1892 static void
1893 ofconn_wait(struct ofconn *ofconn)
1894 {
1895     int i;
1896
1897     if (ofconn->discovery) {
1898         discovery_wait(ofconn->discovery);
1899     }
1900     for (i = 0; i < N_SCHEDULERS; i++) {
1901         pinsched_wait(ofconn->schedulers[i]);
1902     }
1903     rconn_run_wait(ofconn->rconn);
1904     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1905         rconn_recv_wait(ofconn->rconn);
1906     } else {
1907         COVERAGE_INC(ofproto_ofconn_stuck);
1908     }
1909 }
1910
1911 /* Returns true if 'ofconn' should receive asynchronous messages. */
1912 static bool
1913 ofconn_receives_async_msgs(const struct ofconn *ofconn)
1914 {
1915     if (ofconn->type == OFCONN_PRIMARY) {
1916         /* Primary controllers always get asynchronous messages unless they
1917          * have configured themselves as "slaves".  */
1918         return ofconn->role != NX_ROLE_SLAVE;
1919     } else {
1920         /* Service connections don't get asynchronous messages unless they have
1921          * explicitly asked for them by setting a nonzero miss send length. */
1922         return ofconn->miss_send_len > 0;
1923     }
1924 }
1925
1926 /* Returns a human-readable name for an OpenFlow connection between 'ofproto'
1927  * and 'target', suitable for use in log messages for identifying the
1928  * connection.
1929  *
1930  * The name is dynamically allocated.  The caller should free it (with free())
1931  * when it is no longer needed. */
1932 static char *
1933 ofconn_make_name(const struct ofproto *ofproto, const char *target)
1934 {
1935     return xasprintf("%s<->%s", dpif_base_name(ofproto->dpif), target);
1936 }
1937
1938 static void
1939 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1940 {
1941     int i;
1942
1943     for (i = 0; i < N_SCHEDULERS; i++) {
1944         struct pinsched **s = &ofconn->schedulers[i];
1945
1946         if (rate > 0) {
1947             if (!*s) {
1948                 *s = pinsched_create(rate, burst,
1949                                      ofconn->ofproto->switch_status);
1950             } else {
1951                 pinsched_set_limits(*s, rate, burst);
1952             }
1953         } else {
1954             pinsched_destroy(*s);
1955             *s = NULL;
1956         }
1957     }
1958 }
1959 \f
1960 static void
1961 ofservice_reconfigure(struct ofservice *ofservice,
1962                       const struct ofproto_controller *c)
1963 {
1964     ofservice->probe_interval = c->probe_interval;
1965     ofservice->rate_limit = c->rate_limit;
1966     ofservice->burst_limit = c->burst_limit;
1967 }
1968
1969 /* Creates a new ofservice in 'ofproto'.  Returns 0 if successful, otherwise a
1970  * positive errno value. */
1971 static int
1972 ofservice_create(struct ofproto *ofproto, const struct ofproto_controller *c)
1973 {
1974     struct ofservice *ofservice;
1975     struct pvconn *pvconn;
1976     int error;
1977
1978     error = pvconn_open(c->target, &pvconn);
1979     if (error) {
1980         return error;
1981     }
1982
1983     ofservice = xzalloc(sizeof *ofservice);
1984     hmap_insert(&ofproto->services, &ofservice->node,
1985                 hash_string(c->target, 0));
1986     ofservice->pvconn = pvconn;
1987
1988     ofservice_reconfigure(ofservice, c);
1989
1990     return 0;
1991 }
1992
1993 static void
1994 ofservice_destroy(struct ofproto *ofproto, struct ofservice *ofservice)
1995 {
1996     hmap_remove(&ofproto->services, &ofservice->node);
1997     pvconn_close(ofservice->pvconn);
1998     free(ofservice);
1999 }
2000
2001 /* Finds and returns the ofservice within 'ofproto' that has the given
2002  * 'target', or a null pointer if none exists. */
2003 static struct ofservice *
2004 ofservice_lookup(struct ofproto *ofproto, const char *target)
2005 {
2006     struct ofservice *ofservice;
2007
2008     HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
2009                              &ofproto->services) {
2010         if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
2011             return ofservice;
2012         }
2013     }
2014     return NULL;
2015 }
2016 \f
2017 /* Returns true if 'rule' should be hidden from the controller.
2018  *
2019  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2020  * (e.g. by in-band control) and are intentionally hidden from the
2021  * controller. */
2022 static bool
2023 rule_is_hidden(const struct rule *rule)
2024 {
2025     return rule->cr.priority > UINT16_MAX;
2026 }
2027
2028 /* Creates and returns a new rule initialized as specified.
2029  *
2030  * The caller is responsible for inserting the rule into the classifier (with
2031  * rule_insert()). */
2032 static struct rule *
2033 rule_create(const struct cls_rule *cls_rule,
2034             const union ofp_action *actions, size_t n_actions,
2035             uint16_t idle_timeout, uint16_t hard_timeout,
2036             ovs_be64 flow_cookie, bool send_flow_removed)
2037 {
2038     struct rule *rule = xzalloc(sizeof *rule);
2039     rule->cr = *cls_rule;
2040     rule->idle_timeout = idle_timeout;
2041     rule->hard_timeout = hard_timeout;
2042     rule->flow_cookie = flow_cookie;
2043     rule->used = rule->created = time_msec();
2044     rule->send_flow_removed = send_flow_removed;
2045     list_init(&rule->facets);
2046     if (n_actions > 0) {
2047         rule->n_actions = n_actions;
2048         rule->actions = xmemdup(actions, n_actions * sizeof *actions);
2049     }
2050
2051     return rule;
2052 }
2053
2054 static struct rule *
2055 rule_from_cls_rule(const struct cls_rule *cls_rule)
2056 {
2057     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
2058 }
2059
2060 static void
2061 rule_free(struct rule *rule)
2062 {
2063     free(rule->actions);
2064     free(rule);
2065 }
2066
2067 /* Destroys 'rule' and iterates through all of its facets and revalidates them,
2068  * destroying any that no longer has a rule (which is probably all of them).
2069  *
2070  * The caller must have already removed 'rule' from the classifier. */
2071 static void
2072 rule_destroy(struct ofproto *ofproto, struct rule *rule)
2073 {
2074     struct facet *facet, *next_facet;
2075     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
2076         facet_revalidate(ofproto, facet);
2077     }
2078     rule_free(rule);
2079 }
2080
2081 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2082  * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
2083  * count). */
2084 static bool
2085 rule_has_out_port(const struct rule *rule, ovs_be16 out_port)
2086 {
2087     const union ofp_action *oa;
2088     struct actions_iterator i;
2089
2090     if (out_port == htons(OFPP_NONE)) {
2091         return true;
2092     }
2093     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
2094          oa = actions_next(&i)) {
2095         if (action_outputs_to_port(oa, out_port)) {
2096             return true;
2097         }
2098     }
2099     return false;
2100 }
2101
2102 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
2103  * 'packet', which arrived on 'in_port'.
2104  *
2105  * Takes ownership of 'packet'. */
2106 static bool
2107 execute_odp_actions(struct ofproto *ofproto, uint16_t in_port,
2108                     const struct nlattr *odp_actions, size_t actions_len,
2109                     struct ofpbuf *packet)
2110 {
2111     if (actions_len == NLA_ALIGN(NLA_HDRLEN + sizeof(uint64_t))
2112         && odp_actions->nla_type == ODPAT_CONTROLLER) {
2113         /* As an optimization, avoid a round-trip from userspace to kernel to
2114          * userspace.  This also avoids possibly filling up kernel packet
2115          * buffers along the way. */
2116         struct odp_msg *msg;
2117
2118         msg = ofpbuf_push_uninit(packet, sizeof *msg);
2119         msg->type = _ODPL_ACTION_NR;
2120         msg->length = sizeof(struct odp_msg) + packet->size;
2121         msg->port = in_port;
2122         msg->arg = nl_attr_get_u64(odp_actions);
2123
2124         send_packet_in(ofproto, packet);
2125
2126         return true;
2127     } else {
2128         int error;
2129
2130         error = dpif_execute(ofproto->dpif, odp_actions, actions_len, packet);
2131         ofpbuf_delete(packet);
2132         return !error;
2133     }
2134 }
2135
2136 /* Executes the actions indicated by 'facet' on 'packet' and credits 'facet''s
2137  * statistics appropriately.  'packet' must have at least sizeof(struct
2138  * ofp_packet_in) bytes of headroom.
2139  *
2140  * For correct results, 'packet' must actually be in 'facet''s flow; that is,
2141  * applying flow_extract() to 'packet' would yield the same flow as
2142  * 'facet->flow'.
2143  *
2144  * 'facet' must have accurately composed ODP actions; that is, it must not be
2145  * in need of revalidation.
2146  *
2147  * Takes ownership of 'packet'. */
2148 static void
2149 facet_execute(struct ofproto *ofproto, struct facet *facet,
2150               struct ofpbuf *packet)
2151 {
2152     struct odp_flow_stats stats;
2153
2154     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2155
2156     flow_extract_stats(&facet->flow, packet, &stats);
2157     if (execute_odp_actions(ofproto, facet->flow.in_port,
2158                             facet->actions, facet->actions_len, packet)) {
2159         facet_update_stats(ofproto, facet, &stats);
2160         facet->used = time_msec();
2161         netflow_flow_update_time(ofproto->netflow,
2162                                  &facet->nf_flow, facet->used);
2163     }
2164 }
2165
2166 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2167  * statistics (or the statistics for one of its facets) appropriately.
2168  * 'packet' must have at least sizeof(struct ofp_packet_in) bytes of headroom.
2169  *
2170  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
2171  * with statistics for 'packet' either way.
2172  *
2173  * Takes ownership of 'packet'. */
2174 static void
2175 rule_execute(struct ofproto *ofproto, struct rule *rule, uint16_t in_port,
2176              struct ofpbuf *packet)
2177 {
2178     struct action_xlate_ctx ctx;
2179     struct ofpbuf *odp_actions;
2180     struct facet *facet;
2181     struct flow flow;
2182     size_t size;
2183
2184     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2185
2186     flow_extract(packet, 0, in_port, &flow);
2187
2188     /* First look for a related facet.  If we find one, account it to that. */
2189     facet = facet_lookup_valid(ofproto, &flow);
2190     if (facet && facet->rule == rule) {
2191         facet_execute(ofproto, facet, packet);
2192         return;
2193     }
2194
2195     /* Otherwise, if 'rule' is in fact the correct rule for 'packet', then
2196      * create a new facet for it and use that. */
2197     if (rule_lookup(ofproto, &flow) == rule) {
2198         facet = facet_create(ofproto, rule, &flow, packet);
2199         facet_execute(ofproto, facet, packet);
2200         facet_install(ofproto, facet, true);
2201         return;
2202     }
2203
2204     /* We can't account anything to a facet.  If we were to try, then that
2205      * facet would have a non-matching rule, busting our invariants. */
2206     action_xlate_ctx_init(&ctx, ofproto, &flow, packet);
2207     odp_actions = xlate_actions(&ctx, rule->actions, rule->n_actions);
2208     size = packet->size;
2209     if (execute_odp_actions(ofproto, in_port, odp_actions->data,
2210                             odp_actions->size, packet)) {
2211         rule->used = time_msec();
2212         rule->packet_count++;
2213         rule->byte_count += size;
2214     }
2215     ofpbuf_delete(odp_actions);
2216 }
2217
2218 /* Inserts 'rule' into 'p''s flow table. */
2219 static void
2220 rule_insert(struct ofproto *p, struct rule *rule)
2221 {
2222     struct rule *displaced_rule;
2223
2224     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
2225     if (displaced_rule) {
2226         rule_destroy(p, displaced_rule);
2227     }
2228     p->need_revalidate = true;
2229 }
2230
2231 /* Creates and returns a new facet within 'ofproto' owned by 'rule', given a
2232  * 'flow' and an example 'packet' within that flow.
2233  *
2234  * The caller must already have determined that no facet with an identical
2235  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
2236  * 'ofproto''s classifier table. */
2237 static struct facet *
2238 facet_create(struct ofproto *ofproto, struct rule *rule,
2239              const struct flow *flow, const struct ofpbuf *packet)
2240 {
2241     struct facet *facet;
2242
2243     facet = xzalloc(sizeof *facet);
2244     facet->used = time_msec();
2245     hmap_insert(&ofproto->facets, &facet->hmap_node, flow_hash(flow, 0));
2246     list_push_back(&rule->facets, &facet->list_node);
2247     facet->rule = rule;
2248     facet->flow = *flow;
2249     netflow_flow_init(&facet->nf_flow);
2250     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
2251
2252     facet_make_actions(ofproto, facet, packet);
2253
2254     return facet;
2255 }
2256
2257 static void
2258 facet_free(struct facet *facet)
2259 {
2260     free(facet->actions);
2261     free(facet);
2262 }
2263
2264 /* Remove 'rule' from 'ofproto' and free up the associated memory:
2265  *
2266  *   - Removes 'rule' from the classifier.
2267  *
2268  *   - If 'rule' has facets, revalidates them (and possibly uninstalls and
2269  *     destroys them), via rule_destroy().
2270  */
2271 static void
2272 rule_remove(struct ofproto *ofproto, struct rule *rule)
2273 {
2274     COVERAGE_INC(ofproto_del_rule);
2275     ofproto->need_revalidate = true;
2276     classifier_remove(&ofproto->cls, &rule->cr);
2277     rule_destroy(ofproto, rule);
2278 }
2279
2280 /* Remove 'facet' from 'ofproto' and free up the associated memory:
2281  *
2282  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
2283  *     rule's statistics, via facet_uninstall().
2284  *
2285  *   - Removes 'facet' from its rule and from ofproto->facets.
2286  */
2287 static void
2288 facet_remove(struct ofproto *ofproto, struct facet *facet)
2289 {
2290     facet_uninstall(ofproto, facet);
2291     facet_flush_stats(ofproto, facet);
2292     hmap_remove(&ofproto->facets, &facet->hmap_node);
2293     list_remove(&facet->list_node);
2294     facet_free(facet);
2295 }
2296
2297 /* Composes the ODP actions for 'facet' based on its rule's actions. */
2298 static void
2299 facet_make_actions(struct ofproto *p, struct facet *facet,
2300                    const struct ofpbuf *packet)
2301 {
2302     const struct rule *rule = facet->rule;
2303     struct ofpbuf *odp_actions;
2304     struct action_xlate_ctx ctx;
2305
2306     action_xlate_ctx_init(&ctx, p, &facet->flow, packet);
2307     odp_actions = xlate_actions(&ctx, rule->actions, rule->n_actions);
2308     facet->tags = ctx.tags;
2309     facet->may_install = ctx.may_set_up_flow;
2310     facet->nf_flow.output_iface = ctx.nf_output_iface;
2311
2312     if (facet->actions_len != odp_actions->size
2313         || memcmp(facet->actions, odp_actions->data, odp_actions->size)) {
2314         free(facet->actions);
2315         facet->actions_len = odp_actions->size;
2316         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2317     }
2318
2319     ofpbuf_delete(odp_actions);
2320 }
2321
2322 static int
2323 facet_put__(struct ofproto *ofproto, struct facet *facet, int flags,
2324             struct odp_flow_put *put)
2325 {
2326     memset(&put->flow.stats, 0, sizeof put->flow.stats);
2327     odp_flow_key_from_flow(&put->flow.key, &facet->flow);
2328     put->flow.actions = facet->actions;
2329     put->flow.actions_len = facet->actions_len;
2330     put->flow.flags = 0;
2331     put->flags = flags;
2332     return dpif_flow_put(ofproto->dpif, put);
2333 }
2334
2335 /* If 'facet' is installable, inserts or re-inserts it into 'p''s datapath.  If
2336  * 'zero_stats' is true, clears any existing statistics from the datapath for
2337  * 'facet'. */
2338 static void
2339 facet_install(struct ofproto *p, struct facet *facet, bool zero_stats)
2340 {
2341     if (facet->may_install) {
2342         struct odp_flow_put put;
2343         int flags;
2344
2345         flags = ODPPF_CREATE | ODPPF_MODIFY;
2346         if (zero_stats) {
2347             flags |= ODPPF_ZERO_STATS;
2348         }
2349         if (!facet_put__(p, facet, flags, &put)) {
2350             facet->installed = true;
2351         }
2352     }
2353 }
2354
2355 /* Ensures that the bytes in 'facet', plus 'extra_bytes', have been passed up
2356  * to the accounting hook function in the ofhooks structure. */
2357 static void
2358 facet_account(struct ofproto *ofproto,
2359               struct facet *facet, uint64_t extra_bytes)
2360 {
2361     uint64_t total_bytes = facet->byte_count + extra_bytes;
2362
2363     if (ofproto->ofhooks->account_flow_cb
2364         && total_bytes > facet->accounted_bytes)
2365     {
2366         ofproto->ofhooks->account_flow_cb(
2367             &facet->flow, facet->tags, facet->actions, facet->actions_len,
2368             total_bytes - facet->accounted_bytes, ofproto->aux);
2369         facet->accounted_bytes = total_bytes;
2370     }
2371 }
2372
2373 /* If 'rule' is installed in the datapath, uninstalls it. */
2374 static void
2375 facet_uninstall(struct ofproto *p, struct facet *facet)
2376 {
2377     if (facet->installed) {
2378         struct odp_flow odp_flow;
2379
2380         odp_flow_key_from_flow(&odp_flow.key, &facet->flow);
2381         odp_flow.actions = NULL;
2382         odp_flow.actions_len = 0;
2383         odp_flow.flags = 0;
2384         if (!dpif_flow_del(p->dpif, &odp_flow)) {
2385             facet_update_stats(p, facet, &odp_flow.stats);
2386         }
2387         facet->installed = false;
2388     }
2389 }
2390
2391 /* Returns true if the only action for 'facet' is to send to the controller.
2392  * (We don't report NetFlow expiration messages for such facets because they
2393  * are just part of the control logic for the network, not real traffic). */
2394 static bool
2395 facet_is_controller_flow(struct facet *facet)
2396 {
2397     return (facet
2398             && facet->rule->n_actions == 1
2399             && action_outputs_to_port(&facet->rule->actions[0],
2400                                       htons(OFPP_CONTROLLER)));
2401 }
2402
2403 /* Folds all of 'facet''s statistics into its rule.  Also updates the
2404  * accounting ofhook and emits a NetFlow expiration if appropriate.  */
2405 static void
2406 facet_flush_stats(struct ofproto *ofproto, struct facet *facet)
2407 {
2408     facet_account(ofproto, facet, 0);
2409
2410     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
2411         struct ofexpired expired;
2412         expired.flow = facet->flow;
2413         expired.packet_count = facet->packet_count;
2414         expired.byte_count = facet->byte_count;
2415         expired.used = facet->used;
2416         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
2417     }
2418
2419     facet->rule->packet_count += facet->packet_count;
2420     facet->rule->byte_count += facet->byte_count;
2421
2422     /* Reset counters to prevent double counting if 'facet' ever gets
2423      * reinstalled. */
2424     facet->packet_count = 0;
2425     facet->byte_count = 0;
2426     facet->accounted_bytes = 0;
2427
2428     netflow_flow_clear(&facet->nf_flow);
2429 }
2430
2431 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2432  * Returns it if found, otherwise a null pointer.
2433  *
2434  * The returned facet might need revalidation; use facet_lookup_valid()
2435  * instead if that is important. */
2436 static struct facet *
2437 facet_find(struct ofproto *ofproto, const struct flow *flow)
2438 {
2439     struct facet *facet;
2440
2441     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, flow_hash(flow, 0),
2442                              &ofproto->facets) {
2443         if (flow_equal(flow, &facet->flow)) {
2444             return facet;
2445         }
2446     }
2447
2448     return NULL;
2449 }
2450
2451 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
2452  * Returns it if found, otherwise a null pointer.
2453  *
2454  * The returned facet is guaranteed to be valid. */
2455 static struct facet *
2456 facet_lookup_valid(struct ofproto *ofproto, const struct flow *flow)
2457 {
2458     struct facet *facet = facet_find(ofproto, flow);
2459
2460     /* The facet we found might not be valid, since we could be in need of
2461      * revalidation.  If it is not valid, don't return it. */
2462     if (facet
2463         && ofproto->need_revalidate
2464         && !facet_revalidate(ofproto, facet)) {
2465         COVERAGE_INC(ofproto_invalidated);
2466         return NULL;
2467     }
2468
2469     return facet;
2470 }
2471
2472 /* Re-searches 'ofproto''s classifier for a rule matching 'facet':
2473  *
2474  *   - If the rule found is different from 'facet''s current rule, moves
2475  *     'facet' to the new rule and recompiles its actions.
2476  *
2477  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
2478  *     where it is and recompiles its actions anyway.
2479  *
2480  *   - If there is none, destroys 'facet'.
2481  *
2482  * Returns true if 'facet' still exists, false if it has been destroyed. */
2483 static bool
2484 facet_revalidate(struct ofproto *ofproto, struct facet *facet)
2485 {
2486     struct action_xlate_ctx ctx;
2487     struct ofpbuf *odp_actions;
2488     struct rule *new_rule;
2489     bool actions_changed;
2490
2491     COVERAGE_INC(facet_revalidate);
2492
2493     /* Determine the new rule. */
2494     new_rule = rule_lookup(ofproto, &facet->flow);
2495     if (!new_rule) {
2496         /* No new rule, so delete the facet. */
2497         facet_remove(ofproto, facet);
2498         return false;
2499     }
2500
2501     /* Calculate new ODP actions.
2502      *
2503      * We do not modify any 'facet' state yet, because we might need to, e.g.,
2504      * emit a NetFlow expiration and, if so, we need to have the old state
2505      * around to properly compose it. */
2506     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, NULL);
2507     odp_actions = xlate_actions(&ctx, new_rule->actions, new_rule->n_actions);
2508     actions_changed = (facet->actions_len != odp_actions->size
2509                        || memcmp(facet->actions, odp_actions->data,
2510                                  facet->actions_len));
2511
2512     /* If the ODP actions changed or the installability changed, then we need
2513      * to talk to the datapath. */
2514     if (actions_changed || facet->may_install != facet->installed) {
2515         if (facet->may_install) {
2516             struct odp_flow_put put;
2517
2518             memset(&put.flow.stats, 0, sizeof put.flow.stats);
2519             odp_flow_key_from_flow(&put.flow.key, &facet->flow);
2520             put.flow.actions = odp_actions->data;
2521             put.flow.actions_len = odp_actions->size;
2522             put.flow.flags = 0;
2523             put.flags = ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS;
2524             dpif_flow_put(ofproto->dpif, &put);
2525
2526             facet_update_stats(ofproto, facet, &put.flow.stats);
2527         } else {
2528             facet_uninstall(ofproto, facet);
2529         }
2530
2531         /* The datapath flow is gone or has zeroed stats, so push stats out of
2532          * 'facet' into 'rule'. */
2533         facet_flush_stats(ofproto, facet);
2534     }
2535
2536     /* Update 'facet' now that we've taken care of all the old state. */
2537     facet->tags = ctx.tags;
2538     facet->nf_flow.output_iface = ctx.nf_output_iface;
2539     facet->may_install = ctx.may_set_up_flow;
2540     if (actions_changed) {
2541         free(facet->actions);
2542         facet->actions_len = odp_actions->size;
2543         facet->actions = xmemdup(odp_actions->data, odp_actions->size);
2544     }
2545     if (facet->rule != new_rule) {
2546         COVERAGE_INC(facet_changed_rule);
2547         list_remove(&facet->list_node);
2548         list_push_back(&new_rule->facets, &facet->list_node);
2549         facet->rule = new_rule;
2550         facet->used = new_rule->created;
2551     }
2552
2553     ofpbuf_delete(odp_actions);
2554
2555     return true;
2556 }
2557 \f
2558 static void
2559 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
2560          struct rconn_packet_counter *counter)
2561 {
2562     update_openflow_length(msg);
2563     if (rconn_send(ofconn->rconn, msg, counter)) {
2564         ofpbuf_delete(msg);
2565     }
2566 }
2567
2568 static void
2569 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
2570               int error)
2571 {
2572     struct ofpbuf *buf = ofputil_encode_error_msg(error, oh);
2573     if (buf) {
2574         COVERAGE_INC(ofproto_error);
2575         queue_tx(buf, ofconn, ofconn->reply_counter);
2576     }
2577 }
2578
2579 static void
2580 hton_ofp_phy_port(struct ofp_phy_port *opp)
2581 {
2582     opp->port_no = htons(opp->port_no);
2583     opp->config = htonl(opp->config);
2584     opp->state = htonl(opp->state);
2585     opp->curr = htonl(opp->curr);
2586     opp->advertised = htonl(opp->advertised);
2587     opp->supported = htonl(opp->supported);
2588     opp->peer = htonl(opp->peer);
2589 }
2590
2591 static int
2592 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2593 {
2594     queue_tx(make_echo_reply(oh), ofconn, ofconn->reply_counter);
2595     return 0;
2596 }
2597
2598 static int
2599 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2600 {
2601     struct ofp_switch_features *osf;
2602     struct ofpbuf *buf;
2603     struct ofport *port;
2604
2605     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
2606     osf->datapath_id = htonll(ofconn->ofproto->datapath_id);
2607     osf->n_buffers = htonl(pktbuf_capacity());
2608     osf->n_tables = 2;
2609     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
2610                               OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
2611     osf->actions = htonl((1u << OFPAT_OUTPUT) |
2612                          (1u << OFPAT_SET_VLAN_VID) |
2613                          (1u << OFPAT_SET_VLAN_PCP) |
2614                          (1u << OFPAT_STRIP_VLAN) |
2615                          (1u << OFPAT_SET_DL_SRC) |
2616                          (1u << OFPAT_SET_DL_DST) |
2617                          (1u << OFPAT_SET_NW_SRC) |
2618                          (1u << OFPAT_SET_NW_DST) |
2619                          (1u << OFPAT_SET_NW_TOS) |
2620                          (1u << OFPAT_SET_TP_SRC) |
2621                          (1u << OFPAT_SET_TP_DST) |
2622                          (1u << OFPAT_ENQUEUE));
2623
2624     HMAP_FOR_EACH (port, hmap_node, &ofconn->ofproto->ports) {
2625         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
2626     }
2627
2628     queue_tx(buf, ofconn, ofconn->reply_counter);
2629     return 0;
2630 }
2631
2632 static int
2633 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2634 {
2635     struct ofpbuf *buf;
2636     struct ofp_switch_config *osc;
2637     uint16_t flags;
2638     bool drop_frags;
2639
2640     /* Figure out flags. */
2641     dpif_get_drop_frags(ofconn->ofproto->dpif, &drop_frags);
2642     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
2643
2644     /* Send reply. */
2645     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
2646     osc->flags = htons(flags);
2647     osc->miss_send_len = htons(ofconn->miss_send_len);
2648     queue_tx(buf, ofconn, ofconn->reply_counter);
2649
2650     return 0;
2651 }
2652
2653 static int
2654 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
2655 {
2656     uint16_t flags = ntohs(osc->flags);
2657
2658     if (ofconn->type == OFCONN_PRIMARY && ofconn->role != NX_ROLE_SLAVE) {
2659         switch (flags & OFPC_FRAG_MASK) {
2660         case OFPC_FRAG_NORMAL:
2661             dpif_set_drop_frags(ofconn->ofproto->dpif, false);
2662             break;
2663         case OFPC_FRAG_DROP:
2664             dpif_set_drop_frags(ofconn->ofproto->dpif, true);
2665             break;
2666         default:
2667             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
2668                          osc->flags);
2669             break;
2670         }
2671     }
2672
2673     ofconn->miss_send_len = ntohs(osc->miss_send_len);
2674
2675     return 0;
2676 }
2677
2678 /* Maximum depth of flow table recursion (due to NXAST_RESUBMIT actions) in a
2679  * flow translation. */
2680 #define MAX_RESUBMIT_RECURSION 16
2681
2682 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2683                              struct action_xlate_ctx *ctx);
2684
2685 static void
2686 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
2687 {
2688     const struct ofport *ofport = get_port(ctx->ofproto, port);
2689
2690     if (ofport) {
2691         if (ofport->opp.config & OFPPC_NO_FWD) {
2692             /* Forwarding disabled on port. */
2693             return;
2694         }
2695     } else {
2696         /*
2697          * We don't have an ofport record for this port, but it doesn't hurt to
2698          * allow forwarding to it anyhow.  Maybe such a port will appear later
2699          * and we're pre-populating the flow table.
2700          */
2701     }
2702
2703     nl_msg_put_u32(ctx->odp_actions, ODPAT_OUTPUT, port);
2704     ctx->nf_output_iface = port;
2705 }
2706
2707 static struct rule *
2708 rule_lookup(struct ofproto *ofproto, const struct flow *flow)
2709 {
2710     return rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
2711 }
2712
2713 static void
2714 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2715 {
2716     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
2717         uint16_t old_in_port;
2718         struct rule *rule;
2719
2720         /* Look up a flow with 'in_port' as the input port.  Then restore the
2721          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
2722          * have surprising behavior). */
2723         old_in_port = ctx->flow.in_port;
2724         ctx->flow.in_port = in_port;
2725         rule = rule_lookup(ctx->ofproto, &ctx->flow);
2726         ctx->flow.in_port = old_in_port;
2727
2728         if (ctx->resubmit_hook) {
2729             ctx->resubmit_hook(ctx, rule);
2730         }
2731
2732         if (rule) {
2733             ctx->recurse++;
2734             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2735             ctx->recurse--;
2736         }
2737     } else {
2738         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
2739
2740         VLOG_ERR_RL(&recurse_rl, "NXAST_RESUBMIT recursed over %d times",
2741                     MAX_RESUBMIT_RECURSION);
2742     }
2743 }
2744
2745 static void
2746 flood_packets(struct ofproto *ofproto, uint16_t odp_in_port, uint32_t mask,
2747               uint16_t *nf_output_iface, struct ofpbuf *odp_actions)
2748 {
2749     struct ofport *ofport;
2750
2751     HMAP_FOR_EACH (ofport, hmap_node, &ofproto->ports) {
2752         uint16_t odp_port = ofport->odp_port;
2753         if (odp_port != odp_in_port && !(ofport->opp.config & mask)) {
2754             nl_msg_put_u32(odp_actions, ODPAT_OUTPUT, odp_port);
2755         }
2756     }
2757     *nf_output_iface = NF_OUT_FLOOD;
2758 }
2759
2760 static void
2761 xlate_output_action__(struct action_xlate_ctx *ctx,
2762                       uint16_t port, uint16_t max_len)
2763 {
2764     uint16_t odp_port;
2765     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2766
2767     ctx->nf_output_iface = NF_OUT_DROP;
2768
2769     switch (port) {
2770     case OFPP_IN_PORT:
2771         add_output_action(ctx, ctx->flow.in_port);
2772         break;
2773     case OFPP_TABLE:
2774         xlate_table_action(ctx, ctx->flow.in_port);
2775         break;
2776     case OFPP_NORMAL:
2777         if (!ctx->ofproto->ofhooks->normal_cb(&ctx->flow, ctx->packet,
2778                                               ctx->odp_actions, &ctx->tags,
2779                                               &ctx->nf_output_iface,
2780                                               ctx->ofproto->aux)) {
2781             COVERAGE_INC(ofproto_uninstallable);
2782             ctx->may_set_up_flow = false;
2783         }
2784         break;
2785     case OFPP_FLOOD:
2786         flood_packets(ctx->ofproto, ctx->flow.in_port, OFPPC_NO_FLOOD,
2787                       &ctx->nf_output_iface, ctx->odp_actions);
2788         break;
2789     case OFPP_ALL:
2790         flood_packets(ctx->ofproto, ctx->flow.in_port, 0,
2791                       &ctx->nf_output_iface, ctx->odp_actions);
2792         break;
2793     case OFPP_CONTROLLER:
2794         nl_msg_put_u64(ctx->odp_actions, ODPAT_CONTROLLER, max_len);
2795         break;
2796     case OFPP_LOCAL:
2797         add_output_action(ctx, ODPP_LOCAL);
2798         break;
2799     default:
2800         odp_port = ofp_port_to_odp_port(port);
2801         if (odp_port != ctx->flow.in_port) {
2802             add_output_action(ctx, odp_port);
2803         }
2804         break;
2805     }
2806
2807     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2808         ctx->nf_output_iface = NF_OUT_FLOOD;
2809     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2810         ctx->nf_output_iface = prev_nf_output_iface;
2811     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2812                ctx->nf_output_iface != NF_OUT_FLOOD) {
2813         ctx->nf_output_iface = NF_OUT_MULTI;
2814     }
2815 }
2816
2817 static void
2818 xlate_output_action(struct action_xlate_ctx *ctx,
2819                     const struct ofp_action_output *oao)
2820 {
2821     xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
2822 }
2823
2824 /* If the final ODP action in 'ctx' is "pop priority", drop it, as an
2825  * optimization, because we're going to add another action that sets the
2826  * priority immediately after, or because there are no actions following the
2827  * pop.  */
2828 static void
2829 remove_pop_action(struct action_xlate_ctx *ctx)
2830 {
2831     if (ctx->odp_actions->size == ctx->last_pop_priority) {
2832         ctx->odp_actions->size -= NLA_ALIGN(NLA_HDRLEN);
2833         ctx->last_pop_priority = -1;
2834     }
2835 }
2836
2837 static void
2838 add_pop_action(struct action_xlate_ctx *ctx)
2839 {
2840     if (ctx->odp_actions->size != ctx->last_pop_priority) {
2841         nl_msg_put_flag(ctx->odp_actions, ODPAT_POP_PRIORITY);
2842         ctx->last_pop_priority = ctx->odp_actions->size;
2843     }
2844 }
2845
2846 static void
2847 xlate_enqueue_action(struct action_xlate_ctx *ctx,
2848                      const struct ofp_action_enqueue *oae)
2849 {
2850     uint16_t ofp_port, odp_port;
2851     uint32_t priority;
2852     int error;
2853
2854     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
2855                                    &priority);
2856     if (error) {
2857         /* Fall back to ordinary output action. */
2858         xlate_output_action__(ctx, ntohs(oae->port), 0);
2859         return;
2860     }
2861
2862     /* Figure out ODP output port. */
2863     ofp_port = ntohs(oae->port);
2864     if (ofp_port != OFPP_IN_PORT) {
2865         odp_port = ofp_port_to_odp_port(ofp_port);
2866     } else {
2867         odp_port = ctx->flow.in_port;
2868     }
2869
2870     /* Add ODP actions. */
2871     remove_pop_action(ctx);
2872     nl_msg_put_u32(ctx->odp_actions, ODPAT_SET_PRIORITY, priority);
2873     add_output_action(ctx, odp_port);
2874     add_pop_action(ctx);
2875
2876     /* Update NetFlow output port. */
2877     if (ctx->nf_output_iface == NF_OUT_DROP) {
2878         ctx->nf_output_iface = odp_port;
2879     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
2880         ctx->nf_output_iface = NF_OUT_MULTI;
2881     }
2882 }
2883
2884 static void
2885 xlate_set_queue_action(struct action_xlate_ctx *ctx,
2886                        const struct nx_action_set_queue *nasq)
2887 {
2888     uint32_t priority;
2889     int error;
2890
2891     error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
2892                                    &priority);
2893     if (error) {
2894         /* Couldn't translate queue to a priority, so ignore.  A warning
2895          * has already been logged. */
2896         return;
2897     }
2898
2899     remove_pop_action(ctx);
2900     nl_msg_put_u32(ctx->odp_actions, ODPAT_SET_PRIORITY, priority);
2901 }
2902
2903 static void
2904 xlate_set_dl_tci(struct action_xlate_ctx *ctx)
2905 {
2906     ovs_be16 tci = ctx->flow.vlan_tci;
2907     if (!(tci & htons(VLAN_CFI))) {
2908         nl_msg_put_flag(ctx->odp_actions, ODPAT_STRIP_VLAN);
2909     } else {
2910         nl_msg_put_be16(ctx->odp_actions, ODPAT_SET_DL_TCI,
2911                         tci & ~htons(VLAN_CFI));
2912     }
2913 }
2914
2915 struct xlate_reg_state {
2916     ovs_be16 vlan_tci;
2917     ovs_be64 tun_id;
2918 };
2919
2920 static void
2921 save_reg_state(const struct action_xlate_ctx *ctx,
2922                struct xlate_reg_state *state)
2923 {
2924     state->vlan_tci = ctx->flow.vlan_tci;
2925     state->tun_id = ctx->flow.tun_id;
2926 }
2927
2928 static void
2929 update_reg_state(struct action_xlate_ctx *ctx,
2930                  const struct xlate_reg_state *state)
2931 {
2932     if (ctx->flow.vlan_tci != state->vlan_tci) {
2933         xlate_set_dl_tci(ctx);
2934     }
2935     if (ctx->flow.tun_id != state->tun_id) {
2936         nl_msg_put_be64(ctx->odp_actions, ODPAT_SET_TUNNEL, ctx->flow.tun_id);
2937     }
2938 }
2939
2940 static void
2941 xlate_nicira_action(struct action_xlate_ctx *ctx,
2942                     const struct nx_action_header *nah)
2943 {
2944     const struct nx_action_resubmit *nar;
2945     const struct nx_action_set_tunnel *nast;
2946     const struct nx_action_set_queue *nasq;
2947     const struct nx_action_multipath *nam;
2948     enum nx_action_subtype subtype = ntohs(nah->subtype);
2949     struct xlate_reg_state state;
2950     ovs_be64 tun_id;
2951
2952     assert(nah->vendor == htonl(NX_VENDOR_ID));
2953     switch (subtype) {
2954     case NXAST_RESUBMIT:
2955         nar = (const struct nx_action_resubmit *) nah;
2956         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2957         break;
2958
2959     case NXAST_SET_TUNNEL:
2960         nast = (const struct nx_action_set_tunnel *) nah;
2961         tun_id = htonll(ntohl(nast->tun_id));
2962         nl_msg_put_be64(ctx->odp_actions, ODPAT_SET_TUNNEL, tun_id);
2963         ctx->flow.tun_id = tun_id;
2964         break;
2965
2966     case NXAST_DROP_SPOOFED_ARP:
2967         if (ctx->flow.dl_type == htons(ETH_TYPE_ARP)) {
2968             nl_msg_put_flag(ctx->odp_actions, ODPAT_DROP_SPOOFED_ARP);
2969         }
2970         break;
2971
2972     case NXAST_SET_QUEUE:
2973         nasq = (const struct nx_action_set_queue *) nah;
2974         xlate_set_queue_action(ctx, nasq);
2975         break;
2976
2977     case NXAST_POP_QUEUE:
2978         add_pop_action(ctx);
2979         break;
2980
2981     case NXAST_REG_MOVE:
2982         save_reg_state(ctx, &state);
2983         nxm_execute_reg_move((const struct nx_action_reg_move *) nah,
2984                              &ctx->flow);
2985         update_reg_state(ctx, &state);
2986         break;
2987
2988     case NXAST_REG_LOAD:
2989         save_reg_state(ctx, &state);
2990         nxm_execute_reg_load((const struct nx_action_reg_load *) nah,
2991                              &ctx->flow);
2992         update_reg_state(ctx, &state);
2993         break;
2994
2995     case NXAST_NOTE:
2996         /* Nothing to do. */
2997         break;
2998
2999     case NXAST_SET_TUNNEL64:
3000         tun_id = ((const struct nx_action_set_tunnel64 *) nah)->tun_id;
3001         nl_msg_put_be64(ctx->odp_actions, ODPAT_SET_TUNNEL, tun_id);
3002         ctx->flow.tun_id = tun_id;
3003         break;
3004
3005     case NXAST_MULTIPATH:
3006         nam = (const struct nx_action_multipath *) nah;
3007         multipath_execute(nam, &ctx->flow);
3008         break;
3009
3010     /* If you add a new action here that modifies flow data, don't forget to
3011      * update the flow key in ctx->flow at the same time. */
3012
3013     case NXAST_SNAT__OBSOLETE:
3014     default:
3015         VLOG_DBG_RL(&rl, "unknown Nicira action type %d", (int) subtype);
3016         break;
3017     }
3018 }
3019
3020 static void
3021 do_xlate_actions(const union ofp_action *in, size_t n_in,
3022                  struct action_xlate_ctx *ctx)
3023 {
3024     struct actions_iterator iter;
3025     const union ofp_action *ia;
3026     const struct ofport *port;
3027
3028     port = get_port(ctx->ofproto, ctx->flow.in_port);
3029     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
3030         port->opp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
3031                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
3032         /* Drop this flow. */
3033         return;
3034     }
3035
3036     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
3037         enum ofp_action_type type = ntohs(ia->type);
3038         const struct ofp_action_dl_addr *oada;
3039
3040         switch (type) {
3041         case OFPAT_OUTPUT:
3042             xlate_output_action(ctx, &ia->output);
3043             break;
3044
3045         case OFPAT_SET_VLAN_VID:
3046             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
3047             ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
3048             xlate_set_dl_tci(ctx);
3049             break;
3050
3051         case OFPAT_SET_VLAN_PCP:
3052             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
3053             ctx->flow.vlan_tci |= htons(
3054                 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
3055             xlate_set_dl_tci(ctx);
3056             break;
3057
3058         case OFPAT_STRIP_VLAN:
3059             ctx->flow.vlan_tci = htons(0);
3060             xlate_set_dl_tci(ctx);
3061             break;
3062
3063         case OFPAT_SET_DL_SRC:
3064             oada = ((struct ofp_action_dl_addr *) ia);
3065             nl_msg_put_unspec(ctx->odp_actions, ODPAT_SET_DL_SRC,
3066                               oada->dl_addr, ETH_ADDR_LEN);
3067             memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
3068             break;
3069
3070         case OFPAT_SET_DL_DST:
3071             oada = ((struct ofp_action_dl_addr *) ia);
3072             nl_msg_put_unspec(ctx->odp_actions, ODPAT_SET_DL_DST,
3073                               oada->dl_addr, ETH_ADDR_LEN);
3074             memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
3075             break;
3076
3077         case OFPAT_SET_NW_SRC:
3078             nl_msg_put_be32(ctx->odp_actions, ODPAT_SET_NW_SRC,
3079                             ia->nw_addr.nw_addr);
3080             ctx->flow.nw_src = ia->nw_addr.nw_addr;
3081             break;
3082
3083         case OFPAT_SET_NW_DST:
3084             nl_msg_put_be32(ctx->odp_actions, ODPAT_SET_NW_DST,
3085                             ia->nw_addr.nw_addr);
3086             ctx->flow.nw_dst = ia->nw_addr.nw_addr;
3087             break;
3088
3089         case OFPAT_SET_NW_TOS:
3090             nl_msg_put_u8(ctx->odp_actions, ODPAT_SET_NW_TOS,
3091                           ia->nw_tos.nw_tos);
3092             ctx->flow.nw_tos = ia->nw_tos.nw_tos;
3093             break;
3094
3095         case OFPAT_SET_TP_SRC:
3096             nl_msg_put_be16(ctx->odp_actions, ODPAT_SET_TP_SRC,
3097                             ia->tp_port.tp_port);
3098             ctx->flow.tp_src = ia->tp_port.tp_port;
3099             break;
3100
3101         case OFPAT_SET_TP_DST:
3102             nl_msg_put_be16(ctx->odp_actions, ODPAT_SET_TP_DST,
3103                             ia->tp_port.tp_port);
3104             ctx->flow.tp_dst = ia->tp_port.tp_port;
3105             break;
3106
3107         case OFPAT_VENDOR:
3108             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
3109             break;
3110
3111         case OFPAT_ENQUEUE:
3112             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
3113             break;
3114
3115         default:
3116             VLOG_DBG_RL(&rl, "unknown action type %d", (int) type);
3117             break;
3118         }
3119     }
3120 }
3121
3122 static void
3123 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
3124                       struct ofproto *ofproto, const struct flow *flow,
3125                       const struct ofpbuf *packet)
3126 {
3127     ctx->ofproto = ofproto;
3128     ctx->flow = *flow;
3129     ctx->packet = packet;
3130     ctx->resubmit_hook = NULL;
3131 }
3132
3133 static struct ofpbuf *
3134 xlate_actions(struct action_xlate_ctx *ctx,
3135               const union ofp_action *in, size_t n_in)
3136 {
3137     COVERAGE_INC(ofproto_ofp2odp);
3138
3139     ctx->odp_actions = ofpbuf_new(512);
3140     ctx->tags = 0;
3141     ctx->may_set_up_flow = true;
3142     ctx->nf_output_iface = NF_OUT_DROP;
3143     ctx->recurse = 0;
3144     ctx->last_pop_priority = -1;
3145     do_xlate_actions(in, n_in, ctx);
3146     remove_pop_action(ctx);
3147
3148     /* Check with in-band control to see if we're allowed to set up this
3149      * flow. */
3150     if (!in_band_rule_check(ctx->ofproto->in_band, &ctx->flow,
3151                             ctx->odp_actions->data, ctx->odp_actions->size)) {
3152         ctx->may_set_up_flow = false;
3153     }
3154
3155     return ctx->odp_actions;
3156 }
3157
3158 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
3159  * error message code (composed with ofp_mkerr()) for the caller to propagate
3160  * upward.  Otherwise, returns 0.
3161  *
3162  * The log message mentions 'msg_type'. */
3163 static int
3164 reject_slave_controller(struct ofconn *ofconn, const const char *msg_type)
3165 {
3166     if (ofconn->type == OFCONN_PRIMARY && ofconn->role == NX_ROLE_SLAVE) {
3167         static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
3168         VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
3169                      msg_type);
3170
3171         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
3172     } else {
3173         return 0;
3174     }
3175 }
3176
3177 static int
3178 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
3179 {
3180     struct ofproto *p = ofconn->ofproto;
3181     struct ofp_packet_out *opo;
3182     struct ofpbuf payload, *buffer;
3183     union ofp_action *ofp_actions;
3184     struct action_xlate_ctx ctx;
3185     struct ofpbuf *odp_actions;
3186     struct ofpbuf request;
3187     struct flow flow;
3188     size_t n_ofp_actions;
3189     uint16_t in_port;
3190     int error;
3191
3192     COVERAGE_INC(ofproto_packet_out);
3193
3194     error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
3195     if (error) {
3196         return error;
3197     }
3198
3199     /* Get ofp_packet_out. */
3200     ofpbuf_use_const(&request, oh, ntohs(oh->length));
3201     opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
3202
3203     /* Get actions. */
3204     error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
3205                                  &ofp_actions, &n_ofp_actions);
3206     if (error) {
3207         return error;
3208     }
3209
3210     /* Get payload. */
3211     if (opo->buffer_id != htonl(UINT32_MAX)) {
3212         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
3213                                 &buffer, &in_port);
3214         if (error || !buffer) {
3215             return error;
3216         }
3217         payload = *buffer;
3218     } else {
3219         payload = request;
3220         buffer = NULL;
3221     }
3222
3223     /* Extract flow, check actions. */
3224     flow_extract(&payload, 0, ofp_port_to_odp_port(ntohs(opo->in_port)),
3225                  &flow);
3226     error = validate_actions(ofp_actions, n_ofp_actions, &flow, p->max_ports);
3227     if (error) {
3228         goto exit;
3229     }
3230
3231     /* Send. */
3232     action_xlate_ctx_init(&ctx, p, &flow, &payload);
3233     odp_actions = xlate_actions(&ctx, ofp_actions, n_ofp_actions);
3234     dpif_execute(p->dpif, odp_actions->data, odp_actions->size, &payload);
3235     ofpbuf_delete(odp_actions);
3236
3237 exit:
3238     ofpbuf_delete(buffer);
3239     return 0;
3240 }
3241
3242 static void
3243 update_port_config(struct ofproto *p, struct ofport *port,
3244                    uint32_t config, uint32_t mask)
3245 {
3246     mask &= config ^ port->opp.config;
3247     if (mask & OFPPC_PORT_DOWN) {
3248         if (config & OFPPC_PORT_DOWN) {
3249             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
3250         } else {
3251             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
3252         }
3253     }
3254 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP |    \
3255                          OFPPC_NO_FWD | OFPPC_NO_FLOOD)
3256     if (mask & REVALIDATE_BITS) {
3257         COVERAGE_INC(ofproto_costly_flags);
3258         port->opp.config ^= mask & REVALIDATE_BITS;
3259         p->need_revalidate = true;
3260     }
3261 #undef REVALIDATE_BITS
3262     if (mask & OFPPC_NO_PACKET_IN) {
3263         port->opp.config ^= OFPPC_NO_PACKET_IN;
3264     }
3265 }
3266
3267 static int
3268 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3269 {
3270     struct ofproto *p = ofconn->ofproto;
3271     const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
3272     struct ofport *port;
3273     int error;
3274
3275     error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
3276     if (error) {
3277         return error;
3278     }
3279
3280     port = get_port(p, ofp_port_to_odp_port(ntohs(opm->port_no)));
3281     if (!port) {
3282         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
3283     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
3284         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
3285     } else {
3286         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
3287         if (opm->advertise) {
3288             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
3289         }
3290     }
3291     return 0;
3292 }
3293
3294 static struct ofpbuf *
3295 make_ofp_stats_reply(ovs_be32 xid, ovs_be16 type, size_t body_len)
3296 {
3297     struct ofp_stats_reply *osr;
3298     struct ofpbuf *msg;
3299
3300     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
3301     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
3302     osr->type = type;
3303     osr->flags = htons(0);
3304     return msg;
3305 }
3306
3307 static struct ofpbuf *
3308 start_ofp_stats_reply(const struct ofp_header *request, size_t body_len)
3309 {
3310     const struct ofp_stats_request *osr
3311         = (const struct ofp_stats_request *) request;
3312     return make_ofp_stats_reply(osr->header.xid, osr->type, body_len);
3313 }
3314
3315 static void *
3316 append_ofp_stats_reply(size_t nbytes, struct ofconn *ofconn,
3317                        struct ofpbuf **msgp)
3318 {
3319     struct ofpbuf *msg = *msgp;
3320     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
3321     if (nbytes + msg->size > UINT16_MAX) {
3322         struct ofp_stats_reply *reply = msg->data;
3323         reply->flags = htons(OFPSF_REPLY_MORE);
3324         *msgp = make_ofp_stats_reply(reply->header.xid, reply->type, nbytes);
3325         queue_tx(msg, ofconn, ofconn->reply_counter);
3326     }
3327     return ofpbuf_put_uninit(*msgp, nbytes);
3328 }
3329
3330 static struct ofpbuf *
3331 make_nxstats_reply(ovs_be32 xid, ovs_be32 subtype, size_t body_len)
3332 {
3333     struct nicira_stats_msg *nsm;
3334     struct ofpbuf *msg;
3335
3336     msg = ofpbuf_new(MIN(sizeof *nsm + body_len, UINT16_MAX));
3337     nsm = put_openflow_xid(sizeof *nsm, OFPT_STATS_REPLY, xid, msg);
3338     nsm->type = htons(OFPST_VENDOR);
3339     nsm->flags = htons(0);
3340     nsm->vendor = htonl(NX_VENDOR_ID);
3341     nsm->subtype = subtype;
3342     return msg;
3343 }
3344
3345 static struct ofpbuf *
3346 start_nxstats_reply(const struct nicira_stats_msg *request, size_t body_len)
3347 {
3348     return make_nxstats_reply(request->header.xid, request->subtype, body_len);
3349 }
3350
3351 static void
3352 append_nxstats_reply(size_t nbytes, struct ofconn *ofconn,
3353                      struct ofpbuf **msgp)
3354 {
3355     struct ofpbuf *msg = *msgp;
3356     assert(nbytes <= UINT16_MAX - sizeof(struct nicira_stats_msg));
3357     if (nbytes + msg->size > UINT16_MAX) {
3358         struct nicira_stats_msg *reply = msg->data;
3359         reply->flags = htons(OFPSF_REPLY_MORE);
3360         *msgp = make_nxstats_reply(reply->header.xid, reply->subtype, nbytes);
3361         queue_tx(msg, ofconn, ofconn->reply_counter);
3362     }
3363     ofpbuf_prealloc_tailroom(*msgp, nbytes);
3364 }
3365
3366 static int
3367 handle_desc_stats_request(struct ofconn *ofconn,
3368                           const struct ofp_header *request)
3369 {
3370     struct ofproto *p = ofconn->ofproto;
3371     struct ofp_desc_stats *ods;
3372     struct ofpbuf *msg;
3373
3374     msg = start_ofp_stats_reply(request, sizeof *ods);
3375     ods = append_ofp_stats_reply(sizeof *ods, ofconn, &msg);
3376     memset(ods, 0, sizeof *ods);
3377     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
3378     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
3379     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
3380     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
3381     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
3382     queue_tx(msg, ofconn, ofconn->reply_counter);
3383
3384     return 0;
3385 }
3386
3387 static int
3388 handle_table_stats_request(struct ofconn *ofconn,
3389                            const struct ofp_header *request)
3390 {
3391     struct ofproto *p = ofconn->ofproto;
3392     struct ofp_table_stats *ots;
3393     struct ofpbuf *msg;
3394
3395     msg = start_ofp_stats_reply(request, sizeof *ots * 2);
3396
3397     /* Classifier table. */
3398     ots = append_ofp_stats_reply(sizeof *ots, ofconn, &msg);
3399     memset(ots, 0, sizeof *ots);
3400     strcpy(ots->name, "classifier");
3401     ots->wildcards = (ofconn->flow_format == NXFF_OPENFLOW10
3402                       ? htonl(OFPFW_ALL) : htonl(OVSFW_ALL));
3403     ots->max_entries = htonl(1024 * 1024); /* An arbitrary big number. */
3404     ots->active_count = htonl(classifier_count(&p->cls));
3405     ots->lookup_count = htonll(0);              /* XXX */
3406     ots->matched_count = htonll(0);             /* XXX */
3407
3408     queue_tx(msg, ofconn, ofconn->reply_counter);
3409     return 0;
3410 }
3411
3412 static void
3413 append_port_stat(struct ofport *port, struct ofconn *ofconn,
3414                  struct ofpbuf **msgp)
3415 {
3416     struct netdev_stats stats;
3417     struct ofp_port_stats *ops;
3418
3419     /* Intentionally ignore return value, since errors will set
3420      * 'stats' to all-1s, which is correct for OpenFlow, and
3421      * netdev_get_stats() will log errors. */
3422     netdev_get_stats(port->netdev, &stats);
3423
3424     ops = append_ofp_stats_reply(sizeof *ops, ofconn, msgp);
3425     ops->port_no = htons(port->opp.port_no);
3426     memset(ops->pad, 0, sizeof ops->pad);
3427     ops->rx_packets = htonll(stats.rx_packets);
3428     ops->tx_packets = htonll(stats.tx_packets);
3429     ops->rx_bytes = htonll(stats.rx_bytes);
3430     ops->tx_bytes = htonll(stats.tx_bytes);
3431     ops->rx_dropped = htonll(stats.rx_dropped);
3432     ops->tx_dropped = htonll(stats.tx_dropped);
3433     ops->rx_errors = htonll(stats.rx_errors);
3434     ops->tx_errors = htonll(stats.tx_errors);
3435     ops->rx_frame_err = htonll(stats.rx_frame_errors);
3436     ops->rx_over_err = htonll(stats.rx_over_errors);
3437     ops->rx_crc_err = htonll(stats.rx_crc_errors);
3438     ops->collisions = htonll(stats.collisions);
3439 }
3440
3441 static int
3442 handle_port_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3443 {
3444     struct ofproto *p = ofconn->ofproto;
3445     const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
3446     struct ofp_port_stats *ops;
3447     struct ofpbuf *msg;
3448     struct ofport *port;
3449
3450     msg = start_ofp_stats_reply(oh, sizeof *ops * 16);
3451     if (psr->port_no != htons(OFPP_NONE)) {
3452         port = get_port(p, ofp_port_to_odp_port(ntohs(psr->port_no)));
3453         if (port) {
3454             append_port_stat(port, ofconn, &msg);
3455         }
3456     } else {
3457         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3458             append_port_stat(port, ofconn, &msg);
3459         }
3460     }
3461
3462     queue_tx(msg, ofconn, ofconn->reply_counter);
3463     return 0;
3464 }
3465
3466 /* Obtains statistic counters for 'rule' within 'p' and stores them into
3467  * '*packet_countp' and '*byte_countp'.  The returned statistics include
3468  * statistics for all of 'rule''s facets. */
3469 static void
3470 query_stats(struct ofproto *p, struct rule *rule,
3471             uint64_t *packet_countp, uint64_t *byte_countp)
3472 {
3473     uint64_t packet_count, byte_count;
3474     struct facet *facet;
3475     struct odp_flow *odp_flows;
3476     size_t n_odp_flows;
3477
3478     /* Start from historical data for 'rule' itself that are no longer tracked
3479      * by the datapath.  This counts, for example, facets that have expired. */
3480     packet_count = rule->packet_count;
3481     byte_count = rule->byte_count;
3482
3483     /* Prepare to ask the datapath for statistics on all of the rule's facets.
3484      *
3485      * Also, add any statistics that are not tracked by the datapath for each
3486      * facet.  This includes, for example, statistics for packets that were
3487      * executed "by hand" by ofproto via dpif_execute() but must be accounted
3488      * to a rule. */
3489     odp_flows = xzalloc(list_size(&rule->facets) * sizeof *odp_flows);
3490     n_odp_flows = 0;
3491     LIST_FOR_EACH (facet, list_node, &rule->facets) {
3492         struct odp_flow *odp_flow = &odp_flows[n_odp_flows++];
3493         odp_flow_key_from_flow(&odp_flow->key, &facet->flow);
3494         packet_count += facet->packet_count;
3495         byte_count += facet->byte_count;
3496     }
3497
3498     /* Fetch up-to-date statistics from the datapath and add them in. */
3499     if (!dpif_flow_get_multiple(p->dpif, odp_flows, n_odp_flows)) {
3500         size_t i;
3501
3502         for (i = 0; i < n_odp_flows; i++) {
3503             struct odp_flow *odp_flow = &odp_flows[i];
3504             packet_count += odp_flow->stats.n_packets;
3505             byte_count += odp_flow->stats.n_bytes;
3506         }
3507     }
3508     free(odp_flows);
3509
3510     /* Return the stats to the caller. */
3511     *packet_countp = packet_count;
3512     *byte_countp = byte_count;
3513 }
3514
3515 static void
3516 calc_flow_duration(long long int start, ovs_be32 *sec, ovs_be32 *nsec)
3517 {
3518     long long int msecs = time_msec() - start;
3519     *sec = htonl(msecs / 1000);
3520     *nsec = htonl((msecs % 1000) * (1000 * 1000));
3521 }
3522
3523 static void
3524 put_ofp_flow_stats(struct ofconn *ofconn, struct rule *rule,
3525                    ovs_be16 out_port, struct ofpbuf **replyp)
3526 {
3527     struct ofp_flow_stats *ofs;
3528     uint64_t packet_count, byte_count;
3529     size_t act_len, len;
3530
3531     if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
3532         return;
3533     }
3534
3535     act_len = sizeof *rule->actions * rule->n_actions;
3536     len = offsetof(struct ofp_flow_stats, actions) + act_len;
3537
3538     query_stats(ofconn->ofproto, rule, &packet_count, &byte_count);
3539
3540     ofs = append_ofp_stats_reply(len, ofconn, replyp);
3541     ofs->length = htons(len);
3542     ofs->table_id = 0;
3543     ofs->pad = 0;
3544     ofputil_cls_rule_to_match(&rule->cr, ofconn->flow_format, &ofs->match,
3545                               rule->flow_cookie, &ofs->cookie);
3546     calc_flow_duration(rule->created, &ofs->duration_sec, &ofs->duration_nsec);
3547     ofs->priority = htons(rule->cr.priority);
3548     ofs->idle_timeout = htons(rule->idle_timeout);
3549     ofs->hard_timeout = htons(rule->hard_timeout);
3550     memset(ofs->pad2, 0, sizeof ofs->pad2);
3551     ofs->packet_count = htonll(packet_count);
3552     ofs->byte_count = htonll(byte_count);
3553     if (rule->n_actions > 0) {
3554         memcpy(ofs->actions, rule->actions, act_len);
3555     }
3556 }
3557
3558 static bool
3559 is_valid_table(uint8_t table_id)
3560 {
3561     return table_id == 0 || table_id == 0xff;
3562 }
3563
3564 static int
3565 handle_flow_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3566 {
3567     const struct ofp_flow_stats_request *fsr = ofputil_stats_body(oh);
3568     struct ofpbuf *reply;
3569
3570     COVERAGE_INC(ofproto_flows_req);
3571     reply = start_ofp_stats_reply(oh, 1024);
3572     if (is_valid_table(fsr->table_id)) {
3573         struct cls_cursor cursor;
3574         struct cls_rule target;
3575         struct rule *rule;
3576
3577         ofputil_cls_rule_from_match(&fsr->match, 0, NXFF_OPENFLOW10, 0,
3578                                     &target);
3579         cls_cursor_init(&cursor, &ofconn->ofproto->cls, &target);
3580         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3581             put_ofp_flow_stats(ofconn, rule, fsr->out_port, &reply);
3582         }
3583     }
3584     queue_tx(reply, ofconn, ofconn->reply_counter);
3585
3586     return 0;
3587 }
3588
3589 static void
3590 put_nx_flow_stats(struct ofconn *ofconn, struct rule *rule,
3591                   ovs_be16 out_port, struct ofpbuf **replyp)
3592 {
3593     struct nx_flow_stats *nfs;
3594     uint64_t packet_count, byte_count;
3595     size_t act_len, start_len;
3596     struct ofpbuf *reply;
3597
3598     if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
3599         return;
3600     }
3601
3602     query_stats(ofconn->ofproto, rule, &packet_count, &byte_count);
3603
3604     act_len = sizeof *rule->actions * rule->n_actions;
3605
3606     append_nxstats_reply(sizeof *nfs + NXM_MAX_LEN + act_len, ofconn, replyp);
3607     start_len = (*replyp)->size;
3608     reply = *replyp;
3609
3610     nfs = ofpbuf_put_uninit(reply, sizeof *nfs);
3611     nfs->table_id = 0;
3612     nfs->pad = 0;
3613     calc_flow_duration(rule->created, &nfs->duration_sec, &nfs->duration_nsec);
3614     nfs->cookie = rule->flow_cookie;
3615     nfs->priority = htons(rule->cr.priority);
3616     nfs->idle_timeout = htons(rule->idle_timeout);
3617     nfs->hard_timeout = htons(rule->hard_timeout);
3618     nfs->match_len = htons(nx_put_match(reply, &rule->cr));
3619     memset(nfs->pad2, 0, sizeof nfs->pad2);
3620     nfs->packet_count = htonll(packet_count);
3621     nfs->byte_count = htonll(byte_count);
3622     if (rule->n_actions > 0) {
3623         ofpbuf_put(reply, rule->actions, act_len);
3624     }
3625     nfs->length = htons(reply->size - start_len);
3626 }
3627
3628 static int
3629 handle_nxst_flow(struct ofconn *ofconn, const struct ofp_header *oh)
3630 {
3631     struct nx_flow_stats_request *nfsr;
3632     struct cls_rule target;
3633     struct ofpbuf *reply;
3634     struct ofpbuf b;
3635     int error;
3636
3637     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3638
3639     /* Dissect the message. */
3640     nfsr = ofpbuf_pull(&b, sizeof *nfsr);
3641     error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &target);
3642     if (error) {
3643         return error;
3644     }
3645     if (b.size) {
3646         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3647     }
3648
3649     COVERAGE_INC(ofproto_flows_req);
3650     reply = start_nxstats_reply(&nfsr->nsm, 1024);
3651     if (is_valid_table(nfsr->table_id)) {
3652         struct cls_cursor cursor;
3653         struct rule *rule;
3654
3655         cls_cursor_init(&cursor, &ofconn->ofproto->cls, &target);
3656         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3657             put_nx_flow_stats(ofconn, rule, nfsr->out_port, &reply);
3658         }
3659     }
3660     queue_tx(reply, ofconn, ofconn->reply_counter);
3661
3662     return 0;
3663 }
3664
3665 static void
3666 flow_stats_ds(struct ofproto *ofproto, struct rule *rule, struct ds *results)
3667 {
3668     uint64_t packet_count, byte_count;
3669     size_t act_len = sizeof *rule->actions * rule->n_actions;
3670
3671     query_stats(ofproto, rule, &packet_count, &byte_count);
3672
3673     ds_put_format(results, "duration=%llds, ",
3674                   (time_msec() - rule->created) / 1000);
3675     ds_put_format(results, "priority=%u, ", rule->cr.priority);
3676     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3677     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3678     cls_rule_format(&rule->cr, results);
3679     if (act_len > 0) {
3680         ofp_print_actions(results, &rule->actions->header, act_len);
3681     } else {
3682         ds_put_cstr(results, "drop");
3683     }
3684     ds_put_cstr(results, "\n");
3685 }
3686
3687 /* Adds a pretty-printed description of all flows to 'results', including
3688  * those marked hidden by secchan (e.g., by in-band control). */
3689 void
3690 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3691 {
3692     struct cls_cursor cursor;
3693     struct rule *rule;
3694
3695     cls_cursor_init(&cursor, &p->cls, NULL);
3696     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3697         flow_stats_ds(p, rule, results);
3698     }
3699 }
3700
3701 static void
3702 query_aggregate_stats(struct ofproto *ofproto, struct cls_rule *target,
3703                       ovs_be16 out_port, uint8_t table_id,
3704                       struct ofp_aggregate_stats_reply *oasr)
3705 {
3706     uint64_t total_packets = 0;
3707     uint64_t total_bytes = 0;
3708     int n_flows = 0;
3709
3710     COVERAGE_INC(ofproto_agg_request);
3711
3712     if (is_valid_table(table_id)) {
3713         struct cls_cursor cursor;
3714         struct rule *rule;
3715
3716         cls_cursor_init(&cursor, &ofproto->cls, target);
3717         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3718             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
3719                 uint64_t packet_count;
3720                 uint64_t byte_count;
3721
3722                 query_stats(ofproto, rule, &packet_count, &byte_count);
3723
3724                 total_packets += packet_count;
3725                 total_bytes += byte_count;
3726                 n_flows++;
3727             }
3728         }
3729     }
3730
3731     oasr->flow_count = htonl(n_flows);
3732     oasr->packet_count = htonll(total_packets);
3733     oasr->byte_count = htonll(total_bytes);
3734     memset(oasr->pad, 0, sizeof oasr->pad);
3735 }
3736
3737 static int
3738 handle_aggregate_stats_request(struct ofconn *ofconn,
3739                                const struct ofp_header *oh)
3740 {
3741     const struct ofp_aggregate_stats_request *request = ofputil_stats_body(oh);
3742     struct ofp_aggregate_stats_reply *reply;
3743     struct cls_rule target;
3744     struct ofpbuf *msg;
3745
3746     ofputil_cls_rule_from_match(&request->match, 0, NXFF_OPENFLOW10, 0,
3747                                 &target);
3748
3749     msg = start_ofp_stats_reply(oh, sizeof *reply);
3750     reply = append_ofp_stats_reply(sizeof *reply, ofconn, &msg);
3751     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3752                           request->table_id, reply);
3753     queue_tx(msg, ofconn, ofconn->reply_counter);
3754     return 0;
3755 }
3756
3757 static int
3758 handle_nxst_aggregate(struct ofconn *ofconn, const struct ofp_header *oh)
3759 {
3760     struct nx_aggregate_stats_request *request;
3761     struct ofp_aggregate_stats_reply *reply;
3762     struct cls_rule target;
3763     struct ofpbuf b;
3764     struct ofpbuf *buf;
3765     int error;
3766
3767     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3768
3769     /* Dissect the message. */
3770     request = ofpbuf_pull(&b, sizeof *request);
3771     error = nx_pull_match(&b, ntohs(request->match_len), 0, &target);
3772     if (error) {
3773         return error;
3774     }
3775     if (b.size) {
3776         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3777     }
3778
3779     /* Reply. */
3780     COVERAGE_INC(ofproto_flows_req);
3781     buf = start_nxstats_reply(&request->nsm, sizeof *reply);
3782     reply = ofpbuf_put_uninit(buf, sizeof *reply);
3783     query_aggregate_stats(ofconn->ofproto, &target, request->out_port,
3784                           request->table_id, reply);
3785     queue_tx(buf, ofconn, ofconn->reply_counter);
3786
3787     return 0;
3788 }
3789
3790 struct queue_stats_cbdata {
3791     struct ofconn *ofconn;
3792     struct ofport *ofport;
3793     struct ofpbuf *msg;
3794 };
3795
3796 static void
3797 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3798                 const struct netdev_queue_stats *stats)
3799 {
3800     struct ofp_queue_stats *reply;
3801
3802     reply = append_ofp_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
3803     reply->port_no = htons(cbdata->ofport->opp.port_no);
3804     memset(reply->pad, 0, sizeof reply->pad);
3805     reply->queue_id = htonl(queue_id);
3806     reply->tx_bytes = htonll(stats->tx_bytes);
3807     reply->tx_packets = htonll(stats->tx_packets);
3808     reply->tx_errors = htonll(stats->tx_errors);
3809 }
3810
3811 static void
3812 handle_queue_stats_dump_cb(uint32_t queue_id,
3813                            struct netdev_queue_stats *stats,
3814                            void *cbdata_)
3815 {
3816     struct queue_stats_cbdata *cbdata = cbdata_;
3817
3818     put_queue_stats(cbdata, queue_id, stats);
3819 }
3820
3821 static void
3822 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3823                             struct queue_stats_cbdata *cbdata)
3824 {
3825     cbdata->ofport = port;
3826     if (queue_id == OFPQ_ALL) {
3827         netdev_dump_queue_stats(port->netdev,
3828                                 handle_queue_stats_dump_cb, cbdata);
3829     } else {
3830         struct netdev_queue_stats stats;
3831
3832         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3833             put_queue_stats(cbdata, queue_id, &stats);
3834         }
3835     }
3836 }
3837
3838 static int
3839 handle_queue_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
3840 {
3841     struct ofproto *ofproto = ofconn->ofproto;
3842     const struct ofp_queue_stats_request *qsr;
3843     struct queue_stats_cbdata cbdata;
3844     struct ofport *port;
3845     unsigned int port_no;
3846     uint32_t queue_id;
3847
3848     qsr = ofputil_stats_body(oh);
3849     if (!qsr) {
3850         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3851     }
3852
3853     COVERAGE_INC(ofproto_queue_req);
3854
3855     cbdata.ofconn = ofconn;
3856     cbdata.msg = start_ofp_stats_reply(oh, 128);
3857
3858     port_no = ntohs(qsr->port_no);
3859     queue_id = ntohl(qsr->queue_id);
3860     if (port_no == OFPP_ALL) {
3861         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3862             handle_queue_stats_for_port(port, queue_id, &cbdata);
3863         }
3864     } else if (port_no < ofproto->max_ports) {
3865         port = get_port(ofproto, ofp_port_to_odp_port(port_no));
3866         if (port) {
3867             handle_queue_stats_for_port(port, queue_id, &cbdata);
3868         }
3869     } else {
3870         ofpbuf_delete(cbdata.msg);
3871         return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
3872     }
3873     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
3874
3875     return 0;
3876 }
3877
3878 static long long int
3879 msec_from_nsec(uint64_t sec, uint32_t nsec)
3880 {
3881     return !sec ? 0 : sec * 1000 + nsec / 1000000;
3882 }
3883
3884 static void
3885 facet_update_time(struct ofproto *ofproto, struct facet *facet,
3886                   const struct odp_flow_stats *stats)
3887 {
3888     long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
3889     if (used > facet->used) {
3890         facet->used = used;
3891         if (used > facet->rule->used) {
3892             facet->rule->used = used;
3893         }
3894         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
3895     }
3896 }
3897
3898 /* Folds the statistics from 'stats' into the counters in 'facet'.
3899  *
3900  * Because of the meaning of a facet's counters, it only makes sense to do this
3901  * if 'stats' are not tracked in the datapath, that is, if 'stats' represents a
3902  * packet that was sent by hand or if it represents statistics that have been
3903  * cleared out of the datapath. */
3904 static void
3905 facet_update_stats(struct ofproto *ofproto, struct facet *facet,
3906                    const struct odp_flow_stats *stats)
3907 {
3908     if (stats->n_packets) {
3909         facet_update_time(ofproto, facet, stats);
3910         facet->packet_count += stats->n_packets;
3911         facet->byte_count += stats->n_bytes;
3912         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
3913     }
3914 }
3915
3916 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3917  * in which no matching flow already exists in the flow table.
3918  *
3919  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3920  * ofp_actions, to ofconn->ofproto's flow table.  Returns 0 on success or an
3921  * OpenFlow error code as encoded by ofp_mkerr() on failure.
3922  *
3923  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3924  * if any. */
3925 static int
3926 add_flow(struct ofconn *ofconn, struct flow_mod *fm)
3927 {
3928     struct ofproto *p = ofconn->ofproto;
3929     struct ofpbuf *packet;
3930     struct rule *rule;
3931     uint16_t in_port;
3932     int error;
3933
3934     if (fm->flags & OFPFF_CHECK_OVERLAP
3935         && classifier_rule_overlaps(&p->cls, &fm->cr)) {
3936         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
3937     }
3938
3939     error = 0;
3940     if (fm->buffer_id != UINT32_MAX) {
3941         error = pktbuf_retrieve(ofconn->pktbuf, fm->buffer_id,
3942                                 &packet, &in_port);
3943     } else {
3944         packet = NULL;
3945         in_port = UINT16_MAX;
3946     }
3947
3948     rule = rule_create(&fm->cr, fm->actions, fm->n_actions,
3949                        fm->idle_timeout, fm->hard_timeout, fm->cookie,
3950                        fm->flags & OFPFF_SEND_FLOW_REM);
3951     rule_insert(p, rule);
3952     if (packet) {
3953         rule_execute(p, rule, in_port, packet);
3954     }
3955     return error;
3956 }
3957
3958 static struct rule *
3959 find_flow_strict(struct ofproto *p, const struct flow_mod *fm)
3960 {
3961     return rule_from_cls_rule(classifier_find_rule_exactly(&p->cls, &fm->cr));
3962 }
3963
3964 static int
3965 send_buffered_packet(struct ofconn *ofconn,
3966                      struct rule *rule, uint32_t buffer_id)
3967 {
3968     struct ofpbuf *packet;
3969     uint16_t in_port;
3970     int error;
3971
3972     if (buffer_id == UINT32_MAX) {
3973         return 0;
3974     }
3975
3976     error = pktbuf_retrieve(ofconn->pktbuf, buffer_id, &packet, &in_port);
3977     if (error) {
3978         return error;
3979     }
3980
3981     rule_execute(ofconn->ofproto, rule, in_port, packet);
3982
3983     return 0;
3984 }
3985 \f
3986 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3987
3988 struct modify_flows_cbdata {
3989     struct ofproto *ofproto;
3990     const struct flow_mod *fm;
3991     struct rule *match;
3992 };
3993
3994 static int modify_flow(struct ofproto *, const struct flow_mod *,
3995                        struct rule *);
3996
3997 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code as
3998  * encoded by ofp_mkerr() on failure.
3999  *
4000  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4001  * if any. */
4002 static int
4003 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm)
4004 {
4005     struct ofproto *p = ofconn->ofproto;
4006     struct rule *match = NULL;
4007     struct cls_cursor cursor;
4008     struct rule *rule;
4009
4010     cls_cursor_init(&cursor, &p->cls, &fm->cr);
4011     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4012         if (!rule_is_hidden(rule)) {
4013             match = rule;
4014             modify_flow(p, fm, rule);
4015         }
4016     }
4017
4018     if (match) {
4019         /* This credits the packet to whichever flow happened to match last.
4020          * That's weird.  Maybe we should do a lookup for the flow that
4021          * actually matches the packet?  Who knows. */
4022         send_buffered_packet(ofconn, match, fm->buffer_id);
4023         return 0;
4024     } else {
4025         return add_flow(ofconn, fm);
4026     }
4027 }
4028
4029 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
4030  * code as encoded by ofp_mkerr() on failure.
4031  *
4032  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4033  * if any. */
4034 static int
4035 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm)
4036 {
4037     struct ofproto *p = ofconn->ofproto;
4038     struct rule *rule = find_flow_strict(p, fm);
4039     if (rule && !rule_is_hidden(rule)) {
4040         modify_flow(p, fm, rule);
4041         return send_buffered_packet(ofconn, rule, fm->buffer_id);
4042     } else {
4043         return add_flow(ofconn, fm);
4044     }
4045 }
4046
4047 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
4048  * been identified as a flow in 'p''s flow table to be modified, by changing
4049  * the rule's actions to match those in 'ofm' (which is followed by 'n_actions'
4050  * ofp_action[] structures). */
4051 static int
4052 modify_flow(struct ofproto *p, const struct flow_mod *fm, struct rule *rule)
4053 {
4054     size_t actions_len = fm->n_actions * sizeof *rule->actions;
4055
4056     rule->flow_cookie = fm->cookie;
4057
4058     /* If the actions are the same, do nothing. */
4059     if (fm->n_actions == rule->n_actions
4060         && (!fm->n_actions
4061             || !memcmp(fm->actions, rule->actions, actions_len))) {
4062         return 0;
4063     }
4064
4065     /* Replace actions. */
4066     free(rule->actions);
4067     rule->actions = fm->n_actions ? xmemdup(fm->actions, actions_len) : NULL;
4068     rule->n_actions = fm->n_actions;
4069
4070     p->need_revalidate = true;
4071
4072     return 0;
4073 }
4074 \f
4075 /* OFPFC_DELETE implementation. */
4076
4077 static void delete_flow(struct ofproto *, struct rule *, ovs_be16 out_port);
4078
4079 /* Implements OFPFC_DELETE. */
4080 static void
4081 delete_flows_loose(struct ofproto *p, const struct flow_mod *fm)
4082 {
4083     struct rule *rule, *next_rule;
4084     struct cls_cursor cursor;
4085
4086     cls_cursor_init(&cursor, &p->cls, &fm->cr);
4087     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
4088         delete_flow(p, rule, htons(fm->out_port));
4089     }
4090 }
4091
4092 /* Implements OFPFC_DELETE_STRICT. */
4093 static void
4094 delete_flow_strict(struct ofproto *p, struct flow_mod *fm)
4095 {
4096     struct rule *rule = find_flow_strict(p, fm);
4097     if (rule) {
4098         delete_flow(p, rule, htons(fm->out_port));
4099     }
4100 }
4101
4102 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
4103  * been identified as a flow to delete from 'p''s flow table, by deleting the
4104  * flow and sending out a OFPT_FLOW_REMOVED message to any interested
4105  * controller.
4106  *
4107  * Will not delete 'rule' if it is hidden.  Will delete 'rule' only if
4108  * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
4109  * specified 'out_port'. */
4110 static void
4111 delete_flow(struct ofproto *p, struct rule *rule, ovs_be16 out_port)
4112 {
4113     if (rule_is_hidden(rule)) {
4114         return;
4115     }
4116
4117     if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
4118         return;
4119     }
4120
4121     rule_send_removed(p, rule, OFPRR_DELETE);
4122     rule_remove(p, rule);
4123 }
4124 \f
4125 static int
4126 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4127 {
4128     struct ofproto *p = ofconn->ofproto;
4129     struct flow_mod fm;
4130     int error;
4131
4132     error = reject_slave_controller(ofconn, "flow_mod");
4133     if (error) {
4134         return error;
4135     }
4136
4137     error = ofputil_decode_flow_mod(&fm, oh, ofconn->flow_format);
4138     if (error) {
4139         return error;
4140     }
4141
4142     /* We do not support the emergency flow cache.  It will hopefully get
4143      * dropped from OpenFlow in the near future. */
4144     if (fm.flags & OFPFF_EMERG) {
4145         /* There isn't a good fit for an error code, so just state that the
4146          * flow table is full. */
4147         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
4148     }
4149
4150     error = validate_actions(fm.actions, fm.n_actions,
4151                              &fm.cr.flow, p->max_ports);
4152     if (error) {
4153         return error;
4154     }
4155
4156     switch (fm.command) {
4157     case OFPFC_ADD:
4158         return add_flow(ofconn, &fm);
4159
4160     case OFPFC_MODIFY:
4161         return modify_flows_loose(ofconn, &fm);
4162
4163     case OFPFC_MODIFY_STRICT:
4164         return modify_flow_strict(ofconn, &fm);
4165
4166     case OFPFC_DELETE:
4167         delete_flows_loose(p, &fm);
4168         return 0;
4169
4170     case OFPFC_DELETE_STRICT:
4171         delete_flow_strict(p, &fm);
4172         return 0;
4173
4174     default:
4175         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
4176     }
4177 }
4178
4179 static int
4180 handle_tun_id_from_cookie(struct ofconn *ofconn, const struct ofp_header *oh)
4181 {
4182     const struct nxt_tun_id_cookie *msg
4183         = (const struct nxt_tun_id_cookie *) oh;
4184
4185     ofconn->flow_format = msg->set ? NXFF_TUN_ID_FROM_COOKIE : NXFF_OPENFLOW10;
4186     return 0;
4187 }
4188
4189 static int
4190 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4191 {
4192     struct nx_role_request *nrr = (struct nx_role_request *) oh;
4193     struct nx_role_request *reply;
4194     struct ofpbuf *buf;
4195     uint32_t role;
4196
4197     if (ofconn->type != OFCONN_PRIMARY) {
4198         VLOG_WARN_RL(&rl, "ignoring role request on non-controller "
4199                      "connection");
4200         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4201     }
4202
4203     role = ntohl(nrr->role);
4204     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
4205         && role != NX_ROLE_SLAVE) {
4206         VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
4207
4208         /* There's no good error code for this. */
4209         return ofp_mkerr(OFPET_BAD_REQUEST, -1);
4210     }
4211
4212     if (role == NX_ROLE_MASTER) {
4213         struct ofconn *other;
4214
4215         HMAP_FOR_EACH (other, hmap_node, &ofconn->ofproto->controllers) {
4216             if (other->role == NX_ROLE_MASTER) {
4217                 other->role = NX_ROLE_SLAVE;
4218             }
4219         }
4220     }
4221     ofconn->role = role;
4222
4223     reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
4224     reply->role = htonl(role);
4225     queue_tx(buf, ofconn, ofconn->reply_counter);
4226
4227     return 0;
4228 }
4229
4230 static int
4231 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4232 {
4233     const struct nxt_set_flow_format *msg
4234         = (const struct nxt_set_flow_format *) oh;
4235     uint32_t format;
4236
4237     format = ntohl(msg->format);
4238     if (format == NXFF_OPENFLOW10
4239         || format == NXFF_TUN_ID_FROM_COOKIE
4240         || format == NXFF_NXM) {
4241         ofconn->flow_format = format;
4242         return 0;
4243     } else {
4244         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
4245     }
4246 }
4247
4248 static int
4249 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4250 {
4251     struct ofp_header *ob;
4252     struct ofpbuf *buf;
4253
4254     /* Currently, everything executes synchronously, so we can just
4255      * immediately send the barrier reply. */
4256     ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
4257     queue_tx(buf, ofconn, ofconn->reply_counter);
4258     return 0;
4259 }
4260
4261 static int
4262 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
4263 {
4264     const struct ofp_header *oh = msg->data;
4265     const struct ofputil_msg_type *type;
4266     int error;
4267
4268     error = ofputil_decode_msg_type(oh, &type);
4269     if (error) {
4270         return error;
4271     }
4272
4273     switch (ofputil_msg_type_code(type)) {
4274         /* OpenFlow requests. */
4275     case OFPUTIL_OFPT_ECHO_REQUEST:
4276         return handle_echo_request(ofconn, oh);
4277
4278     case OFPUTIL_OFPT_FEATURES_REQUEST:
4279         return handle_features_request(ofconn, oh);
4280
4281     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
4282         return handle_get_config_request(ofconn, oh);
4283
4284     case OFPUTIL_OFPT_SET_CONFIG:
4285         return handle_set_config(ofconn, msg->data);
4286
4287     case OFPUTIL_OFPT_PACKET_OUT:
4288         return handle_packet_out(ofconn, oh);
4289
4290     case OFPUTIL_OFPT_PORT_MOD:
4291         return handle_port_mod(ofconn, oh);
4292
4293     case OFPUTIL_OFPT_FLOW_MOD:
4294         return handle_flow_mod(ofconn, oh);
4295
4296     case OFPUTIL_OFPT_BARRIER_REQUEST:
4297         return handle_barrier_request(ofconn, oh);
4298
4299         /* OpenFlow replies. */
4300     case OFPUTIL_OFPT_ECHO_REPLY:
4301         return 0;
4302
4303         /* Nicira extension requests. */
4304     case OFPUTIL_NXT_STATUS_REQUEST:
4305         return switch_status_handle_request(
4306             ofconn->ofproto->switch_status, ofconn->rconn, oh);
4307
4308     case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
4309         return handle_tun_id_from_cookie(ofconn, oh);
4310
4311     case OFPUTIL_NXT_ROLE_REQUEST:
4312         return handle_role_request(ofconn, oh);
4313
4314     case OFPUTIL_NXT_SET_FLOW_FORMAT:
4315         return handle_nxt_set_flow_format(ofconn, oh);
4316
4317     case OFPUTIL_NXT_FLOW_MOD:
4318         return handle_flow_mod(ofconn, oh);
4319
4320         /* OpenFlow statistics requests. */
4321     case OFPUTIL_OFPST_DESC_REQUEST:
4322         return handle_desc_stats_request(ofconn, oh);
4323
4324     case OFPUTIL_OFPST_FLOW_REQUEST:
4325         return handle_flow_stats_request(ofconn, oh);
4326
4327     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
4328         return handle_aggregate_stats_request(ofconn, oh);
4329
4330     case OFPUTIL_OFPST_TABLE_REQUEST:
4331         return handle_table_stats_request(ofconn, oh);
4332
4333     case OFPUTIL_OFPST_PORT_REQUEST:
4334         return handle_port_stats_request(ofconn, oh);
4335
4336     case OFPUTIL_OFPST_QUEUE_REQUEST:
4337         return handle_queue_stats_request(ofconn, oh);
4338
4339         /* Nicira extension statistics requests. */
4340     case OFPUTIL_NXST_FLOW_REQUEST:
4341         return handle_nxst_flow(ofconn, oh);
4342
4343     case OFPUTIL_NXST_AGGREGATE_REQUEST:
4344         return handle_nxst_aggregate(ofconn, oh);
4345
4346     case OFPUTIL_INVALID:
4347     case OFPUTIL_OFPT_HELLO:
4348     case OFPUTIL_OFPT_ERROR:
4349     case OFPUTIL_OFPT_FEATURES_REPLY:
4350     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
4351     case OFPUTIL_OFPT_PACKET_IN:
4352     case OFPUTIL_OFPT_FLOW_REMOVED:
4353     case OFPUTIL_OFPT_PORT_STATUS:
4354     case OFPUTIL_OFPT_BARRIER_REPLY:
4355     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
4356     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
4357     case OFPUTIL_OFPST_DESC_REPLY:
4358     case OFPUTIL_OFPST_FLOW_REPLY:
4359     case OFPUTIL_OFPST_QUEUE_REPLY:
4360     case OFPUTIL_OFPST_PORT_REPLY:
4361     case OFPUTIL_OFPST_TABLE_REPLY:
4362     case OFPUTIL_OFPST_AGGREGATE_REPLY:
4363     case OFPUTIL_NXT_STATUS_REPLY:
4364     case OFPUTIL_NXT_ROLE_REPLY:
4365     case OFPUTIL_NXT_FLOW_REMOVED:
4366     case OFPUTIL_NXST_FLOW_REPLY:
4367     case OFPUTIL_NXST_AGGREGATE_REPLY:
4368     default:
4369         if (VLOG_IS_WARN_ENABLED()) {
4370             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
4371             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
4372             free(s);
4373         }
4374         if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
4375             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
4376         } else {
4377             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
4378         }
4379     }
4380 }
4381
4382 static void
4383 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4384 {
4385     int error = handle_openflow__(ofconn, ofp_msg);
4386     if (error) {
4387         send_error_oh(ofconn, ofp_msg->data, error);
4388     }
4389     COVERAGE_INC(ofproto_recv_openflow);
4390 }
4391 \f
4392 static void
4393 handle_odp_miss_msg(struct ofproto *p, struct ofpbuf *packet)
4394 {
4395     struct odp_msg *msg = packet->data;
4396     struct ofpbuf payload;
4397     struct facet *facet;
4398     struct flow flow;
4399
4400     ofpbuf_use_const(&payload, msg + 1, msg->length - sizeof *msg);
4401     flow_extract(&payload, msg->arg, msg->port, &flow);
4402
4403     packet->l2 = payload.l2;
4404     packet->l3 = payload.l3;
4405     packet->l4 = payload.l4;
4406     packet->l7 = payload.l7;
4407
4408     /* Check with in-band control to see if this packet should be sent
4409      * to the local port regardless of the flow table. */
4410     if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
4411         struct ofpbuf odp_actions;
4412
4413         ofpbuf_init(&odp_actions, 32);
4414         nl_msg_put_u32(&odp_actions, ODPAT_OUTPUT, ODPP_LOCAL);
4415         dpif_execute(p->dpif, odp_actions.data, odp_actions.size, &payload);
4416         ofpbuf_uninit(&odp_actions);
4417     }
4418
4419     facet = facet_lookup_valid(p, &flow);
4420     if (!facet) {
4421         struct rule *rule = rule_lookup(p, &flow);
4422         if (!rule) {
4423             /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
4424             struct ofport *port = get_port(p, msg->port);
4425             if (port) {
4426                 if (port->opp.config & OFPPC_NO_PACKET_IN) {
4427                     COVERAGE_INC(ofproto_no_packet_in);
4428                     /* XXX install 'drop' flow entry */
4429                     ofpbuf_delete(packet);
4430                     return;
4431                 }
4432             } else {
4433                 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16,
4434                              msg->port);
4435             }
4436
4437             COVERAGE_INC(ofproto_packet_in);
4438             send_packet_in(p, packet);
4439             return;
4440         }
4441
4442         facet = facet_create(p, rule, &flow, packet);
4443     } else if (!facet->may_install) {
4444         /* The facet is not installable, that is, we need to process every
4445          * packet, so process the current packet's actions into 'facet'. */
4446         facet_make_actions(p, facet, packet);
4447     }
4448
4449     if (facet->rule->cr.priority == FAIL_OPEN_PRIORITY) {
4450         /*
4451          * Extra-special case for fail-open mode.
4452          *
4453          * We are in fail-open mode and the packet matched the fail-open rule,
4454          * but we are connected to a controller too.  We should send the packet
4455          * up to the controller in the hope that it will try to set up a flow
4456          * and thereby allow us to exit fail-open.
4457          *
4458          * See the top-level comment in fail-open.c for more information.
4459          */
4460         send_packet_in(p, ofpbuf_clone_with_headroom(packet,
4461                                                      DPIF_RECV_MSG_PADDING));
4462     }
4463
4464     ofpbuf_pull(packet, sizeof *msg);
4465     facet_execute(p, facet, packet);
4466     facet_install(p, facet, false);
4467 }
4468
4469 static void
4470 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
4471 {
4472     struct odp_msg *msg = packet->data;
4473
4474     switch (msg->type) {
4475     case _ODPL_ACTION_NR:
4476         COVERAGE_INC(ofproto_ctlr_action);
4477         send_packet_in(p, packet);
4478         break;
4479
4480     case _ODPL_SFLOW_NR:
4481         if (p->sflow) {
4482             ofproto_sflow_received(p->sflow, msg);
4483         }
4484         ofpbuf_delete(packet);
4485         break;
4486
4487     case _ODPL_MISS_NR:
4488         handle_odp_miss_msg(p, packet);
4489         break;
4490
4491     default:
4492         VLOG_WARN_RL(&rl, "received ODP message of unexpected type %"PRIu32,
4493                      msg->type);
4494         break;
4495     }
4496 }
4497 \f
4498 /* Flow expiration. */
4499
4500 static int ofproto_dp_max_idle(const struct ofproto *);
4501 static void ofproto_update_used(struct ofproto *);
4502 static void rule_expire(struct ofproto *, struct rule *);
4503 static void ofproto_expire_facets(struct ofproto *, int dp_max_idle);
4504
4505 /* This function is called periodically by ofproto_run().  Its job is to
4506  * collect updates for the flows that have been installed into the datapath,
4507  * most importantly when they last were used, and then use that information to
4508  * expire flows that have not been used recently.
4509  *
4510  * Returns the number of milliseconds after which it should be called again. */
4511 static int
4512 ofproto_expire(struct ofproto *ofproto)
4513 {
4514     struct rule *rule, *next_rule;
4515     struct cls_cursor cursor;
4516     int dp_max_idle;
4517
4518     /* Update 'used' for each flow in the datapath. */
4519     ofproto_update_used(ofproto);
4520
4521     /* Expire facets that have been idle too long. */
4522     dp_max_idle = ofproto_dp_max_idle(ofproto);
4523     ofproto_expire_facets(ofproto, dp_max_idle);
4524
4525     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
4526     cls_cursor_init(&cursor, &ofproto->cls, NULL);
4527     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
4528         rule_expire(ofproto, rule);
4529     }
4530
4531     /* Let the hook know that we're at a stable point: all outstanding data
4532      * in existing flows has been accounted to the account_cb.  Thus, the
4533      * hook can now reasonably do operations that depend on having accurate
4534      * flow volume accounting (currently, that's just bond rebalancing). */
4535     if (ofproto->ofhooks->account_checkpoint_cb) {
4536         ofproto->ofhooks->account_checkpoint_cb(ofproto->aux);
4537     }
4538
4539     return MIN(dp_max_idle, 1000);
4540 }
4541
4542 /* Update 'used' member of installed facets. */
4543 static void
4544 ofproto_update_used(struct ofproto *p)
4545 {
4546     struct odp_flow *flows;
4547     size_t n_flows;
4548     size_t i;
4549     int error;
4550
4551     error = dpif_flow_list_all(p->dpif, &flows, &n_flows);
4552     if (error) {
4553         return;
4554     }
4555
4556     for (i = 0; i < n_flows; i++) {
4557         struct odp_flow *f = &flows[i];
4558         struct facet *facet;
4559         struct flow flow;
4560
4561         odp_flow_key_to_flow(&f->key, &flow);
4562         facet = facet_find(p, &flow);
4563
4564         if (facet && facet->installed) {
4565             facet_update_time(p, facet, &f->stats);
4566             facet_account(p, facet, f->stats.n_bytes);
4567         } else {
4568             /* There's a flow in the datapath that we know nothing about.
4569              * Delete it. */
4570             COVERAGE_INC(ofproto_unexpected_rule);
4571             dpif_flow_del(p->dpif, f);
4572         }
4573
4574     }
4575     free(flows);
4576 }
4577
4578 /* Calculates and returns the number of milliseconds of idle time after which
4579  * facets should expire from the datapath and we should fold their statistics
4580  * into their parent rules in userspace. */
4581 static int
4582 ofproto_dp_max_idle(const struct ofproto *ofproto)
4583 {
4584     /*
4585      * Idle time histogram.
4586      *
4587      * Most of the time a switch has a relatively small number of facets.  When
4588      * this is the case we might as well keep statistics for all of them in
4589      * userspace and to cache them in the kernel datapath for performance as
4590      * well.
4591      *
4592      * As the number of facets increases, the memory required to maintain
4593      * statistics about them in userspace and in the kernel becomes
4594      * significant.  However, with a large number of facets it is likely that
4595      * only a few of them are "heavy hitters" that consume a large amount of
4596      * bandwidth.  At this point, only heavy hitters are worth caching in the
4597      * kernel and maintaining in userspaces; other facets we can discard.
4598      *
4599      * The technique used to compute the idle time is to build a histogram with
4600      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each facet
4601      * that is installed in the kernel gets dropped in the appropriate bucket.
4602      * After the histogram has been built, we compute the cutoff so that only
4603      * the most-recently-used 1% of facets (but at least 1000 flows) are kept
4604      * cached.  At least the most-recently-used bucket of facets is kept, so
4605      * actually an arbitrary number of facets can be kept in any given
4606      * expiration run (though the next run will delete most of those unless
4607      * they receive additional data).
4608      *
4609      * This requires a second pass through the facets, in addition to the pass
4610      * made by ofproto_update_used(), because the former function never looks
4611      * at uninstallable facets.
4612      */
4613     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4614     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4615     int buckets[N_BUCKETS] = { 0 };
4616     struct facet *facet;
4617     int total, bucket;
4618     long long int now;
4619     int i;
4620
4621     total = hmap_count(&ofproto->facets);
4622     if (total <= 1000) {
4623         return N_BUCKETS * BUCKET_WIDTH;
4624     }
4625
4626     /* Build histogram. */
4627     now = time_msec();
4628     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
4629         long long int idle = now - facet->used;
4630         int bucket = (idle <= 0 ? 0
4631                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4632                       : (unsigned int) idle / BUCKET_WIDTH);
4633         buckets[bucket]++;
4634     }
4635
4636     /* Find the first bucket whose flows should be expired. */
4637     for (bucket = 0; bucket < N_BUCKETS; bucket++) {
4638         if (buckets[bucket]) {
4639             int subtotal = 0;
4640             do {
4641                 subtotal += buckets[bucket++];
4642             } while (bucket < N_BUCKETS && subtotal < MAX(1000, total / 100));
4643             break;
4644         }
4645     }
4646
4647     if (VLOG_IS_DBG_ENABLED()) {
4648         struct ds s;
4649
4650         ds_init(&s);
4651         ds_put_cstr(&s, "keep");
4652         for (i = 0; i < N_BUCKETS; i++) {
4653             if (i == bucket) {
4654                 ds_put_cstr(&s, ", drop");
4655             }
4656             if (buckets[i]) {
4657                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4658             }
4659         }
4660         VLOG_INFO("%s: %s (msec:count)",
4661                   dpif_name(ofproto->dpif), ds_cstr(&s));
4662         ds_destroy(&s);
4663     }
4664
4665     return bucket * BUCKET_WIDTH;
4666 }
4667
4668 static void
4669 facet_active_timeout(struct ofproto *ofproto, struct facet *facet)
4670 {
4671     if (ofproto->netflow && !facet_is_controller_flow(facet) &&
4672         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
4673         struct ofexpired expired;
4674         struct odp_flow odp_flow;
4675
4676         /* Get updated flow stats.
4677          *
4678          * XXX We could avoid this call entirely if (1) ofproto_update_used()
4679          * updated TCP flags and (2) the dpif_flow_list_all() in
4680          * ofproto_update_used() zeroed TCP flags. */
4681         memset(&odp_flow, 0, sizeof odp_flow);
4682         if (facet->installed) {
4683             odp_flow_key_from_flow(&odp_flow.key, &facet->flow);
4684             odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
4685             dpif_flow_get(ofproto->dpif, &odp_flow);
4686
4687             if (odp_flow.stats.n_packets) {
4688                 facet_update_time(ofproto, facet, &odp_flow.stats);
4689                 netflow_flow_update_flags(&facet->nf_flow,
4690                                           odp_flow.stats.tcp_flags);
4691             }
4692         }
4693
4694         expired.flow = facet->flow;
4695         expired.packet_count = facet->packet_count +
4696                                odp_flow.stats.n_packets;
4697         expired.byte_count = facet->byte_count + odp_flow.stats.n_bytes;
4698         expired.used = facet->used;
4699
4700         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4701     }
4702 }
4703
4704 static void
4705 ofproto_expire_facets(struct ofproto *ofproto, int dp_max_idle)
4706 {
4707     long long int cutoff = time_msec() - dp_max_idle;
4708     struct facet *facet, *next_facet;
4709
4710     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
4711         facet_active_timeout(ofproto, facet);
4712         if (facet->used < cutoff) {
4713             facet_remove(ofproto, facet);
4714         }
4715     }
4716 }
4717
4718 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4719  * then delete it entirely. */
4720 static void
4721 rule_expire(struct ofproto *ofproto, struct rule *rule)
4722 {
4723     struct facet *facet, *next_facet;
4724     long long int now;
4725     uint8_t reason;
4726
4727     /* Has 'rule' expired? */
4728     now = time_msec();
4729     if (rule->hard_timeout
4730         && now > rule->created + rule->hard_timeout * 1000) {
4731         reason = OFPRR_HARD_TIMEOUT;
4732     } else if (rule->idle_timeout && list_is_empty(&rule->facets)
4733                && now >rule->used + rule->idle_timeout * 1000) {
4734         reason = OFPRR_IDLE_TIMEOUT;
4735     } else {
4736         return;
4737     }
4738
4739     COVERAGE_INC(ofproto_expired);
4740
4741     /* Update stats.  (This is a no-op if the rule expired due to an idle
4742      * timeout, because that only happens when the rule has no facets left.) */
4743     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4744         facet_remove(ofproto, facet);
4745     }
4746
4747     /* Get rid of the rule. */
4748     if (!rule_is_hidden(rule)) {
4749         rule_send_removed(ofproto, rule, reason);
4750     }
4751     rule_remove(ofproto, rule);
4752 }
4753 \f
4754 static struct ofpbuf *
4755 compose_ofp_flow_removed(struct ofconn *ofconn, const struct rule *rule,
4756                          uint8_t reason)
4757 {
4758     struct ofp_flow_removed *ofr;
4759     struct ofpbuf *buf;
4760
4761     ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0), &buf);
4762     ofputil_cls_rule_to_match(&rule->cr, ofconn->flow_format, &ofr->match,
4763                               rule->flow_cookie, &ofr->cookie);
4764     ofr->priority = htons(rule->cr.priority);
4765     ofr->reason = reason;
4766     calc_flow_duration(rule->created, &ofr->duration_sec, &ofr->duration_nsec);
4767     ofr->idle_timeout = htons(rule->idle_timeout);
4768     ofr->packet_count = htonll(rule->packet_count);
4769     ofr->byte_count = htonll(rule->byte_count);
4770
4771     return buf;
4772 }
4773
4774 static struct ofpbuf *
4775 compose_nx_flow_removed(const struct rule *rule, uint8_t reason)
4776 {
4777     struct nx_flow_removed *nfr;
4778     struct ofpbuf *buf;
4779     int match_len;
4780
4781     make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &buf);
4782     match_len = nx_put_match(buf, &rule->cr);
4783
4784     nfr = buf->data;
4785     nfr->cookie = rule->flow_cookie;
4786     nfr->priority = htons(rule->cr.priority);
4787     nfr->reason = reason;
4788     calc_flow_duration(rule->created, &nfr->duration_sec, &nfr->duration_nsec);
4789     nfr->idle_timeout = htons(rule->idle_timeout);
4790     nfr->match_len = htons(match_len);
4791     nfr->packet_count = htonll(rule->packet_count);
4792     nfr->byte_count = htonll(rule->byte_count);
4793
4794     return buf;
4795 }
4796
4797 static void
4798 rule_send_removed(struct ofproto *p, struct rule *rule, uint8_t reason)
4799 {
4800     struct ofconn *ofconn;
4801
4802     if (!rule->send_flow_removed) {
4803         return;
4804     }
4805
4806     LIST_FOR_EACH (ofconn, node, &p->all_conns) {
4807         struct ofpbuf *msg;
4808
4809         if (!rconn_is_connected(ofconn->rconn)
4810             || !ofconn_receives_async_msgs(ofconn)) {
4811             continue;
4812         }
4813
4814         msg = (ofconn->flow_format == NXFF_NXM
4815                ? compose_nx_flow_removed(rule, reason)
4816                : compose_ofp_flow_removed(ofconn, rule, reason));
4817
4818         /* Account flow expirations under ofconn->reply_counter, the counter
4819          * for replies to OpenFlow requests.  That works because preventing
4820          * OpenFlow requests from being processed also prevents new flows from
4821          * being added (and expiring).  (It also prevents processing OpenFlow
4822          * requests that would not add new flows, so it is imperfect.) */
4823         queue_tx(msg, ofconn, ofconn->reply_counter);
4824     }
4825 }
4826
4827 /* pinsched callback for sending 'packet' on 'ofconn'. */
4828 static void
4829 do_send_packet_in(struct ofpbuf *packet, void *ofconn_)
4830 {
4831     struct ofconn *ofconn = ofconn_;
4832
4833     rconn_send_with_limit(ofconn->rconn, packet,
4834                           ofconn->packet_in_counter, 100);
4835 }
4836
4837 /* Takes 'packet', which has been converted with do_convert_to_packet_in(), and
4838  * finalizes its content for sending on 'ofconn', and passes it to 'ofconn''s
4839  * packet scheduler for sending.
4840  *
4841  * 'max_len' specifies the maximum number of bytes of the packet to send on
4842  * 'ofconn' (INT_MAX specifies no limit).
4843  *
4844  * If 'clone' is true, the caller retains ownership of 'packet'.  Otherwise,
4845  * ownership is transferred to this function. */
4846 static void
4847 schedule_packet_in(struct ofconn *ofconn, struct ofpbuf *packet, int max_len,
4848                    bool clone)
4849 {
4850     struct ofproto *ofproto = ofconn->ofproto;
4851     struct ofp_packet_in *opi = packet->data;
4852     uint16_t in_port = ofp_port_to_odp_port(ntohs(opi->in_port));
4853     int send_len, trim_size;
4854     uint32_t buffer_id;
4855
4856     /* Get buffer. */
4857     if (opi->reason == OFPR_ACTION) {
4858         buffer_id = UINT32_MAX;
4859     } else if (ofproto->fail_open && fail_open_is_active(ofproto->fail_open)) {
4860         buffer_id = pktbuf_get_null();
4861     } else if (!ofconn->pktbuf) {
4862         buffer_id = UINT32_MAX;
4863     } else {
4864         struct ofpbuf payload;
4865
4866         ofpbuf_use_const(&payload, opi->data,
4867                          packet->size - offsetof(struct ofp_packet_in, data));
4868         buffer_id = pktbuf_save(ofconn->pktbuf, &payload, in_port);
4869     }
4870
4871     /* Figure out how much of the packet to send. */
4872     send_len = ntohs(opi->total_len);
4873     if (buffer_id != UINT32_MAX) {
4874         send_len = MIN(send_len, ofconn->miss_send_len);
4875     }
4876     send_len = MIN(send_len, max_len);
4877
4878     /* Adjust packet length and clone if necessary. */
4879     trim_size = offsetof(struct ofp_packet_in, data) + send_len;
4880     if (clone) {
4881         packet = ofpbuf_clone_data(packet->data, trim_size);
4882         opi = packet->data;
4883     } else {
4884         packet->size = trim_size;
4885     }
4886
4887     /* Update packet headers. */
4888     opi->buffer_id = htonl(buffer_id);
4889     update_openflow_length(packet);
4890
4891     /* Hand over to packet scheduler.  It might immediately call into
4892      * do_send_packet_in() or it might buffer it for a while (until a later
4893      * call to pinsched_run()). */
4894     pinsched_send(ofconn->schedulers[opi->reason], in_port,
4895                   packet, do_send_packet_in, ofconn);
4896 }
4897
4898 /* Replace struct odp_msg header in 'packet' by equivalent struct
4899  * ofp_packet_in.  The odp_msg must have sufficient headroom to do so (e.g. as
4900  * returned by dpif_recv()).
4901  *
4902  * The conversion is not complete: the caller still needs to trim any unneeded
4903  * payload off the end of the buffer, set the length in the OpenFlow header,
4904  * and set buffer_id.  Those require us to know the controller settings and so
4905  * must be done on a per-controller basis.
4906  *
4907  * Returns the maximum number of bytes of the packet that should be sent to
4908  * the controller (INT_MAX if no limit). */
4909 static int
4910 do_convert_to_packet_in(struct ofpbuf *packet)
4911 {
4912     struct odp_msg *msg = packet->data;
4913     struct ofp_packet_in *opi;
4914     uint8_t reason;
4915     uint16_t total_len;
4916     uint16_t in_port;
4917     int max_len;
4918
4919     /* Extract relevant header fields */
4920     if (msg->type == _ODPL_ACTION_NR) {
4921         reason = OFPR_ACTION;
4922         max_len = msg->arg;
4923     } else {
4924         reason = OFPR_NO_MATCH;
4925         max_len = INT_MAX;
4926     }
4927     total_len = msg->length - sizeof *msg;
4928     in_port = odp_port_to_ofp_port(msg->port);
4929
4930     /* Repurpose packet buffer by overwriting header. */
4931     ofpbuf_pull(packet, sizeof(struct odp_msg));
4932     opi = ofpbuf_push_zeros(packet, offsetof(struct ofp_packet_in, data));
4933     opi->header.version = OFP_VERSION;
4934     opi->header.type = OFPT_PACKET_IN;
4935     opi->total_len = htons(total_len);
4936     opi->in_port = htons(in_port);
4937     opi->reason = reason;
4938
4939     return max_len;
4940 }
4941
4942 /* Given 'packet' containing an odp_msg of type _ODPL_ACTION_NR or
4943  * _ODPL_MISS_NR, sends an OFPT_PACKET_IN message to each OpenFlow controller
4944  * as necessary according to their individual configurations.
4945  *
4946  * 'packet' must have sufficient headroom to convert it into a struct
4947  * ofp_packet_in (e.g. as returned by dpif_recv()).
4948  *
4949  * Takes ownership of 'packet'. */
4950 static void
4951 send_packet_in(struct ofproto *ofproto, struct ofpbuf *packet)
4952 {
4953     struct ofconn *ofconn, *prev;
4954     int max_len;
4955
4956     max_len = do_convert_to_packet_in(packet);
4957
4958     prev = NULL;
4959     LIST_FOR_EACH (ofconn, node, &ofproto->all_conns) {
4960         if (ofconn_receives_async_msgs(ofconn)) {
4961             if (prev) {
4962                 schedule_packet_in(prev, packet, max_len, true);
4963             }
4964             prev = ofconn;
4965         }
4966     }
4967     if (prev) {
4968         schedule_packet_in(prev, packet, max_len, false);
4969     } else {
4970         ofpbuf_delete(packet);
4971     }
4972 }
4973
4974 static uint64_t
4975 pick_datapath_id(const struct ofproto *ofproto)
4976 {
4977     const struct ofport *port;
4978
4979     port = get_port(ofproto, ODPP_LOCAL);
4980     if (port) {
4981         uint8_t ea[ETH_ADDR_LEN];
4982         int error;
4983
4984         error = netdev_get_etheraddr(port->netdev, ea);
4985         if (!error) {
4986             return eth_addr_to_uint64(ea);
4987         }
4988         VLOG_WARN("could not get MAC address for %s (%s)",
4989                   netdev_get_name(port->netdev), strerror(error));
4990     }
4991     return ofproto->fallback_dpid;
4992 }
4993
4994 static uint64_t
4995 pick_fallback_dpid(void)
4996 {
4997     uint8_t ea[ETH_ADDR_LEN];
4998     eth_addr_nicira_random(ea);
4999     return eth_addr_to_uint64(ea);
5000 }
5001 \f
5002 static void
5003 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
5004                      void *aux OVS_UNUSED)
5005 {
5006     const struct shash_node *node;
5007     struct ds results;
5008
5009     ds_init(&results);
5010     SHASH_FOR_EACH (node, &all_ofprotos) {
5011         ds_put_format(&results, "%s\n", node->name);
5012     }
5013     unixctl_command_reply(conn, 200, ds_cstr(&results));
5014     ds_destroy(&results);
5015 }
5016
5017 struct ofproto_trace {
5018     struct action_xlate_ctx ctx;
5019     struct flow flow;
5020     struct ds *result;
5021 };
5022
5023 static void
5024 trace_format_rule(struct ds *result, int level, const struct rule *rule)
5025 {
5026     ds_put_char_multiple(result, '\t', level);
5027     if (!rule) {
5028         ds_put_cstr(result, "No match\n");
5029         return;
5030     }
5031
5032     ds_put_format(result, "Rule: cookie=%#"PRIx64" ",
5033                   ntohll(rule->flow_cookie));
5034     cls_rule_format(&rule->cr, result);
5035     ds_put_char(result, '\n');
5036
5037     ds_put_char_multiple(result, '\t', level);
5038     ds_put_cstr(result, "OpenFlow ");
5039     ofp_print_actions(result, (const struct ofp_action_header *) rule->actions,
5040                       rule->n_actions * sizeof *rule->actions);
5041     ds_put_char(result, '\n');
5042 }
5043
5044 static void
5045 trace_format_flow(struct ds *result, int level, const char *title,
5046                  struct ofproto_trace *trace)
5047 {
5048     ds_put_char_multiple(result, '\t', level);
5049     ds_put_format(result, "%s: ", title);
5050     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
5051         ds_put_cstr(result, "unchanged");
5052     } else {
5053         flow_format(result, &trace->ctx.flow);
5054         trace->flow = trace->ctx.flow;
5055     }
5056     ds_put_char(result, '\n');
5057 }
5058
5059 static void
5060 trace_resubmit(struct action_xlate_ctx *ctx, const struct rule *rule)
5061 {
5062     struct ofproto_trace *trace = CONTAINER_OF(ctx, struct ofproto_trace, ctx);
5063     struct ds *result = trace->result;
5064
5065     ds_put_char(result, '\n');
5066     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
5067     trace_format_rule(result, ctx->recurse + 1, rule);
5068 }
5069
5070 static void
5071 ofproto_unixctl_trace(struct unixctl_conn *conn, const char *args_,
5072                       void *aux OVS_UNUSED)
5073 {
5074     char *dpname, *in_port_s, *tun_id_s, *packet_s;
5075     char *args = xstrdup(args_);
5076     char *save_ptr = NULL;
5077     struct ofproto *ofproto;
5078     struct ofpbuf packet;
5079     struct rule *rule;
5080     struct ds result;
5081     struct flow flow;
5082     uint16_t in_port;
5083     ovs_be64 tun_id;
5084     char *s;
5085
5086     ofpbuf_init(&packet, strlen(args) / 2);
5087     ds_init(&result);
5088
5089     dpname = strtok_r(args, " ", &save_ptr);
5090     tun_id_s = strtok_r(NULL, " ", &save_ptr);
5091     in_port_s = strtok_r(NULL, " ", &save_ptr);
5092     packet_s = strtok_r(NULL, "", &save_ptr); /* Get entire rest of line. */
5093     if (!dpname || !in_port_s || !packet_s) {
5094         unixctl_command_reply(conn, 501, "Bad command syntax");
5095         goto exit;
5096     }
5097
5098     ofproto = shash_find_data(&all_ofprotos, dpname);
5099     if (!ofproto) {
5100         unixctl_command_reply(conn, 501, "Unknown ofproto (use ofproto/list "
5101                               "for help)");
5102         goto exit;
5103     }
5104
5105     tun_id = htonll(strtoull(tun_id_s, NULL, 10));
5106     in_port = ofp_port_to_odp_port(atoi(in_port_s));
5107
5108     packet_s = ofpbuf_put_hex(&packet, packet_s, NULL);
5109     packet_s += strspn(packet_s, " ");
5110     if (*packet_s != '\0') {
5111         unixctl_command_reply(conn, 501, "Trailing garbage in command");
5112         goto exit;
5113     }
5114     if (packet.size < ETH_HEADER_LEN) {
5115         unixctl_command_reply(conn, 501, "Packet data too short for Ethernet");
5116         goto exit;
5117     }
5118
5119     ds_put_cstr(&result, "Packet: ");
5120     s = ofp_packet_to_string(packet.data, packet.size, packet.size);
5121     ds_put_cstr(&result, s);
5122     free(s);
5123
5124     flow_extract(&packet, tun_id, in_port, &flow);
5125     ds_put_cstr(&result, "Flow: ");
5126     flow_format(&result, &flow);
5127     ds_put_char(&result, '\n');
5128
5129     rule = rule_lookup(ofproto, &flow);
5130     trace_format_rule(&result, 0, rule);
5131     if (rule) {
5132         struct ofproto_trace trace;
5133         struct ofpbuf *odp_actions;
5134
5135         trace.result = &result;
5136         trace.flow = flow;
5137         action_xlate_ctx_init(&trace.ctx, ofproto, &flow, &packet);
5138         trace.ctx.resubmit_hook = trace_resubmit;
5139         odp_actions = xlate_actions(&trace.ctx,
5140                                     rule->actions, rule->n_actions);
5141
5142         ds_put_char(&result, '\n');
5143         trace_format_flow(&result, 0, "Final flow", &trace);
5144         ds_put_cstr(&result, "Datapath actions: ");
5145         format_odp_actions(&result, odp_actions->data, odp_actions->size);
5146         ofpbuf_delete(odp_actions);
5147     }
5148
5149     unixctl_command_reply(conn, 200, ds_cstr(&result));
5150
5151 exit:
5152     ds_destroy(&result);
5153     ofpbuf_uninit(&packet);
5154     free(args);
5155 }
5156
5157 static void
5158 ofproto_unixctl_init(void)
5159 {
5160     static bool registered;
5161     if (registered) {
5162         return;
5163     }
5164     registered = true;
5165
5166     unixctl_command_register("ofproto/list", ofproto_unixctl_list, NULL);
5167     unixctl_command_register("ofproto/trace", ofproto_unixctl_trace, NULL);
5168 }
5169 \f
5170 static bool
5171 default_normal_ofhook_cb(const struct flow *flow, const struct ofpbuf *packet,
5172                          struct ofpbuf *odp_actions, tag_type *tags,
5173                          uint16_t *nf_output_iface, void *ofproto_)
5174 {
5175     struct ofproto *ofproto = ofproto_;
5176     int out_port;
5177
5178     /* Drop frames for reserved multicast addresses. */
5179     if (eth_addr_is_reserved(flow->dl_dst)) {
5180         return true;
5181     }
5182
5183     /* Learn source MAC (but don't try to learn from revalidation). */
5184     if (packet != NULL) {
5185         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
5186                                               0, flow->in_port,
5187                                               GRAT_ARP_LOCK_NONE);
5188         if (rev_tag) {
5189             /* The log messages here could actually be useful in debugging,
5190              * so keep the rate limit relatively high. */
5191             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5192             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
5193                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
5194             ofproto_revalidate(ofproto, rev_tag);
5195         }
5196     }
5197
5198     /* Determine output port. */
5199     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags,
5200                                        NULL);
5201     if (out_port < 0) {
5202         flood_packets(ofproto, flow->in_port, OFPPC_NO_FLOOD,
5203                       nf_output_iface, odp_actions);
5204     } else if (out_port != flow->in_port) {
5205         nl_msg_put_u32(odp_actions, ODPAT_OUTPUT, out_port);
5206         *nf_output_iface = out_port;
5207     } else {
5208         /* Drop. */
5209     }
5210
5211     return true;
5212 }
5213
5214 static const struct ofhooks default_ofhooks = {
5215     default_normal_ofhook_cb,
5216     NULL,
5217     NULL
5218 };