man-pages: Add missing entry for matching metadata
[sliver-openvswitch.git] / ofproto / ofproto-dpif.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18
19 #include "ofproto/ofproto-provider.h"
20
21 #include <errno.h>
22
23 #include "autopath.h"
24 #include "bond.h"
25 #include "bundle.h"
26 #include "byte-order.h"
27 #include "connmgr.h"
28 #include "coverage.h"
29 #include "cfm.h"
30 #include "dpif.h"
31 #include "dynamic-string.h"
32 #include "fail-open.h"
33 #include "hmapx.h"
34 #include "lacp.h"
35 #include "learn.h"
36 #include "mac-learning.h"
37 #include "meta-flow.h"
38 #include "multipath.h"
39 #include "netdev.h"
40 #include "netlink.h"
41 #include "nx-match.h"
42 #include "odp-util.h"
43 #include "ofp-util.h"
44 #include "ofpbuf.h"
45 #include "ofp-actions.h"
46 #include "ofp-parse.h"
47 #include "ofp-print.h"
48 #include "ofproto-dpif-governor.h"
49 #include "ofproto-dpif-sflow.h"
50 #include "poll-loop.h"
51 #include "simap.h"
52 #include "timer.h"
53 #include "unaligned.h"
54 #include "unixctl.h"
55 #include "vlan-bitmap.h"
56 #include "vlog.h"
57
58 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
59
60 COVERAGE_DEFINE(ofproto_dpif_expired);
61 COVERAGE_DEFINE(ofproto_dpif_xlate);
62 COVERAGE_DEFINE(facet_changed_rule);
63 COVERAGE_DEFINE(facet_revalidate);
64 COVERAGE_DEFINE(facet_unexpected);
65 COVERAGE_DEFINE(facet_suppress);
66
67 /* Maximum depth of flow table recursion (due to resubmit actions) in a
68  * flow translation. */
69 #define MAX_RESUBMIT_RECURSION 64
70
71 /* Number of implemented OpenFlow tables. */
72 enum { N_TABLES = 255 };
73 enum { TBL_INTERNAL = N_TABLES - 1 };    /* Used for internal hidden rules. */
74 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
75
76 struct ofport_dpif;
77 struct ofproto_dpif;
78
79 struct rule_dpif {
80     struct rule up;
81
82     /* These statistics:
83      *
84      *   - Do include packets and bytes from facets that have been deleted or
85      *     whose own statistics have been folded into the rule.
86      *
87      *   - Do include packets and bytes sent "by hand" that were accounted to
88      *     the rule without any facet being involved (this is a rare corner
89      *     case in rule_execute()).
90      *
91      *   - Do not include packet or bytes that can be obtained from any facet's
92      *     packet_count or byte_count member or that can be obtained from the
93      *     datapath by, e.g., dpif_flow_get() for any subfacet.
94      */
95     uint64_t packet_count;       /* Number of packets received. */
96     uint64_t byte_count;         /* Number of bytes received. */
97
98     tag_type tag;                /* Caches rule_calculate_tag() result. */
99
100     struct list facets;          /* List of "struct facet"s. */
101 };
102
103 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
104 {
105     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
106 }
107
108 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
109                                           const struct flow *);
110 static struct rule_dpif *rule_dpif_lookup__(struct ofproto_dpif *,
111                                             const struct flow *,
112                                             uint8_t table);
113
114 static void rule_credit_stats(struct rule_dpif *,
115                               const struct dpif_flow_stats *);
116 static void flow_push_stats(struct rule_dpif *, const struct flow *,
117                             const struct dpif_flow_stats *);
118 static tag_type rule_calculate_tag(const struct flow *,
119                                    const struct flow_wildcards *,
120                                    uint32_t basis);
121 static void rule_invalidate(const struct rule_dpif *);
122
123 #define MAX_MIRRORS 32
124 typedef uint32_t mirror_mask_t;
125 #define MIRROR_MASK_C(X) UINT32_C(X)
126 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
127 struct ofmirror {
128     struct ofproto_dpif *ofproto; /* Owning ofproto. */
129     size_t idx;                 /* In ofproto's "mirrors" array. */
130     void *aux;                  /* Key supplied by ofproto's client. */
131     char *name;                 /* Identifier for log messages. */
132
133     /* Selection criteria. */
134     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
135     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
136     unsigned long *vlans;       /* Bitmap of chosen VLANs, NULL selects all. */
137
138     /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
139     struct ofbundle *out;       /* Output port or NULL. */
140     int out_vlan;               /* Output VLAN or -1. */
141     mirror_mask_t dup_mirrors;  /* Bitmap of mirrors with the same output. */
142
143     /* Counters. */
144     int64_t packet_count;       /* Number of packets sent. */
145     int64_t byte_count;         /* Number of bytes sent. */
146 };
147
148 static void mirror_destroy(struct ofmirror *);
149 static void update_mirror_stats(struct ofproto_dpif *ofproto,
150                                 mirror_mask_t mirrors,
151                                 uint64_t packets, uint64_t bytes);
152
153 struct ofbundle {
154     struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
155     struct ofproto_dpif *ofproto; /* Owning ofproto. */
156     void *aux;                  /* Key supplied by ofproto's client. */
157     char *name;                 /* Identifier for log messages. */
158
159     /* Configuration. */
160     struct list ports;          /* Contains "struct ofport"s. */
161     enum port_vlan_mode vlan_mode; /* VLAN mode */
162     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
163     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1.
164                                  * NULL if all VLANs are trunked. */
165     struct lacp *lacp;          /* LACP if LACP is enabled, otherwise NULL. */
166     struct bond *bond;          /* Nonnull iff more than one port. */
167     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
168
169     /* Status. */
170     bool floodable;          /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
171
172     /* Port mirroring info. */
173     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
174     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
175     mirror_mask_t mirror_out;   /* Mirrors that output to this bundle. */
176 };
177
178 static void bundle_remove(struct ofport *);
179 static void bundle_update(struct ofbundle *);
180 static void bundle_destroy(struct ofbundle *);
181 static void bundle_del_port(struct ofport_dpif *);
182 static void bundle_run(struct ofbundle *);
183 static void bundle_wait(struct ofbundle *);
184 static struct ofbundle *lookup_input_bundle(const struct ofproto_dpif *,
185                                             uint16_t in_port, bool warn,
186                                             struct ofport_dpif **in_ofportp);
187
188 /* A controller may use OFPP_NONE as the ingress port to indicate that
189  * it did not arrive on a "real" port.  'ofpp_none_bundle' exists for
190  * when an input bundle is needed for validation (e.g., mirroring or
191  * OFPP_NORMAL processing).  It is not connected to an 'ofproto' or have
192  * any 'port' structs, so care must be taken when dealing with it. */
193 static struct ofbundle ofpp_none_bundle = {
194     .name      = "OFPP_NONE",
195     .vlan_mode = PORT_VLAN_TRUNK
196 };
197
198 static void stp_run(struct ofproto_dpif *ofproto);
199 static void stp_wait(struct ofproto_dpif *ofproto);
200 static int set_stp_port(struct ofport *,
201                         const struct ofproto_port_stp_settings *);
202
203 static bool ofbundle_includes_vlan(const struct ofbundle *, uint16_t vlan);
204
205 struct action_xlate_ctx {
206 /* action_xlate_ctx_init() initializes these members. */
207
208     /* The ofproto. */
209     struct ofproto_dpif *ofproto;
210
211     /* Flow to which the OpenFlow actions apply.  xlate_actions() will modify
212      * this flow when actions change header fields. */
213     struct flow flow;
214
215     /* The packet corresponding to 'flow', or a null pointer if we are
216      * revalidating without a packet to refer to. */
217     const struct ofpbuf *packet;
218
219     /* Should OFPP_NORMAL update the MAC learning table?  Should "learn"
220      * actions update the flow table?
221      *
222      * We want to update these tables if we are actually processing a packet,
223      * or if we are accounting for packets that the datapath has processed, but
224      * not if we are just revalidating. */
225     bool may_learn;
226
227     /* The rule that we are currently translating, or NULL. */
228     struct rule_dpif *rule;
229
230     /* Union of the set of TCP flags seen so far in this flow.  (Used only by
231      * NXAST_FIN_TIMEOUT.  Set to zero to avoid updating updating rules'
232      * timeouts.) */
233     uint8_t tcp_flags;
234
235     /* If nonnull, flow translation calls this function just before executing a
236      * resubmit or OFPP_TABLE action.  In addition, disables logging of traces
237      * when the recursion depth is exceeded.
238      *
239      * 'rule' is the rule being submitted into.  It will be null if the
240      * resubmit or OFPP_TABLE action didn't find a matching rule.
241      *
242      * This is normally null so the client has to set it manually after
243      * calling action_xlate_ctx_init(). */
244     void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *rule);
245
246     /* If nonnull, flow translation calls this function to report some
247      * significant decision, e.g. to explain why OFPP_NORMAL translation
248      * dropped a packet. */
249     void (*report_hook)(struct action_xlate_ctx *, const char *s);
250
251     /* If nonnull, flow translation credits the specified statistics to each
252      * rule reached through a resubmit or OFPP_TABLE action.
253      *
254      * This is normally null so the client has to set it manually after
255      * calling action_xlate_ctx_init(). */
256     const struct dpif_flow_stats *resubmit_stats;
257
258 /* xlate_actions() initializes and uses these members.  The client might want
259  * to look at them after it returns. */
260
261     struct ofpbuf *odp_actions; /* Datapath actions. */
262     tag_type tags;              /* Tags associated with actions. */
263     enum slow_path_reason slow; /* 0 if fast path may be used. */
264     bool has_learn;             /* Actions include NXAST_LEARN? */
265     bool has_normal;            /* Actions output to OFPP_NORMAL? */
266     bool has_fin_timeout;       /* Actions include NXAST_FIN_TIMEOUT? */
267     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
268     mirror_mask_t mirrors;      /* Bitmap of associated mirrors. */
269
270 /* xlate_actions() initializes and uses these members, but the client has no
271  * reason to look at them. */
272
273     int recurse;                /* Recursion level, via xlate_table_action. */
274     bool max_resubmit_trigger;  /* Recursed too deeply during translation. */
275     struct flow base_flow;      /* Flow at the last commit. */
276     uint32_t orig_skb_priority; /* Priority when packet arrived. */
277     uint8_t table_id;           /* OpenFlow table ID where flow was found. */
278     uint32_t sflow_n_outputs;   /* Number of output ports. */
279     uint16_t sflow_odp_port;    /* Output port for composing sFlow action. */
280     uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
281     bool exit;                  /* No further actions should be processed. */
282     struct flow orig_flow;      /* Copy of original flow. */
283 };
284
285 static void action_xlate_ctx_init(struct action_xlate_ctx *,
286                                   struct ofproto_dpif *, const struct flow *,
287                                   ovs_be16 initial_tci, struct rule_dpif *,
288                                   uint8_t tcp_flags, const struct ofpbuf *);
289 static void xlate_actions(struct action_xlate_ctx *,
290                           const struct ofpact *ofpacts, size_t ofpacts_len,
291                           struct ofpbuf *odp_actions);
292 static void xlate_actions_for_side_effects(struct action_xlate_ctx *,
293                                            const struct ofpact *ofpacts,
294                                            size_t ofpacts_len);
295
296 static size_t put_userspace_action(const struct ofproto_dpif *,
297                                    struct ofpbuf *odp_actions,
298                                    const struct flow *,
299                                    const union user_action_cookie *);
300
301 static void compose_slow_path(const struct ofproto_dpif *, const struct flow *,
302                               enum slow_path_reason,
303                               uint64_t *stub, size_t stub_size,
304                               const struct nlattr **actionsp,
305                               size_t *actions_lenp);
306
307 static void xlate_report(struct action_xlate_ctx *ctx, const char *s);
308
309 /* A subfacet (see "struct subfacet" below) has three possible installation
310  * states:
311  *
312  *   - SF_NOT_INSTALLED: Not installed in the datapath.  This will only be the
313  *     case just after the subfacet is created, just before the subfacet is
314  *     destroyed, or if the datapath returns an error when we try to install a
315  *     subfacet.
316  *
317  *   - SF_FAST_PATH: The subfacet's actions are installed in the datapath.
318  *
319  *   - SF_SLOW_PATH: An action that sends every packet for the subfacet through
320  *     ofproto_dpif is installed in the datapath.
321  */
322 enum subfacet_path {
323     SF_NOT_INSTALLED,           /* No datapath flow for this subfacet. */
324     SF_FAST_PATH,               /* Full actions are installed. */
325     SF_SLOW_PATH,               /* Send-to-userspace action is installed. */
326 };
327
328 static const char *subfacet_path_to_string(enum subfacet_path);
329
330 /* A dpif flow and actions associated with a facet.
331  *
332  * See also the large comment on struct facet. */
333 struct subfacet {
334     /* Owners. */
335     struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
336     struct list list_node;      /* In struct facet's 'facets' list. */
337     struct facet *facet;        /* Owning facet. */
338
339     /* Key.
340      *
341      * To save memory in the common case, 'key' is NULL if 'key_fitness' is
342      * ODP_FIT_PERFECT, that is, odp_flow_key_from_flow() can accurately
343      * regenerate the ODP flow key from ->facet->flow. */
344     enum odp_key_fitness key_fitness;
345     struct nlattr *key;
346     int key_len;
347
348     long long int used;         /* Time last used; time created if not used. */
349
350     uint64_t dp_packet_count;   /* Last known packet count in the datapath. */
351     uint64_t dp_byte_count;     /* Last known byte count in the datapath. */
352
353     /* Datapath actions.
354      *
355      * These should be essentially identical for every subfacet in a facet, but
356      * may differ in trivial ways due to VLAN splinters. */
357     size_t actions_len;         /* Number of bytes in actions[]. */
358     struct nlattr *actions;     /* Datapath actions. */
359
360     enum slow_path_reason slow; /* 0 if fast path may be used. */
361     enum subfacet_path path;    /* Installed in datapath? */
362
363     /* This value is normally the same as ->facet->flow.vlan_tci.  Only VLAN
364      * splinters can cause it to differ.  This value should be removed when
365      * the VLAN splinters feature is no longer needed.  */
366     ovs_be16 initial_tci;       /* Initial VLAN TCI value. */
367 };
368
369 static struct subfacet *subfacet_create(struct facet *, enum odp_key_fitness,
370                                         const struct nlattr *key,
371                                         size_t key_len, ovs_be16 initial_tci);
372 static struct subfacet *subfacet_find(struct ofproto_dpif *,
373                                       const struct nlattr *key, size_t key_len);
374 static void subfacet_destroy(struct subfacet *);
375 static void subfacet_destroy__(struct subfacet *);
376 static void subfacet_get_key(struct subfacet *, struct odputil_keybuf *,
377                              struct ofpbuf *key);
378 static void subfacet_reset_dp_stats(struct subfacet *,
379                                     struct dpif_flow_stats *);
380 static void subfacet_update_time(struct subfacet *, long long int used);
381 static void subfacet_update_stats(struct subfacet *,
382                                   const struct dpif_flow_stats *);
383 static void subfacet_make_actions(struct subfacet *,
384                                   const struct ofpbuf *packet,
385                                   struct ofpbuf *odp_actions);
386 static int subfacet_install(struct subfacet *,
387                             const struct nlattr *actions, size_t actions_len,
388                             struct dpif_flow_stats *, enum slow_path_reason);
389 static void subfacet_uninstall(struct subfacet *);
390
391 static enum subfacet_path subfacet_want_path(enum slow_path_reason);
392
393 /* An exact-match instantiation of an OpenFlow flow.
394  *
395  * A facet associates a "struct flow", which represents the Open vSwitch
396  * userspace idea of an exact-match flow, with one or more subfacets.  Each
397  * subfacet tracks the datapath's idea of the exact-match flow equivalent to
398  * the facet.  When the kernel module (or other dpif implementation) and Open
399  * vSwitch userspace agree on the definition of a flow key, there is exactly
400  * one subfacet per facet.  If the dpif implementation supports more-specific
401  * flow matching than userspace, however, a facet can have more than one
402  * subfacet, each of which corresponds to some distinction in flow that
403  * userspace simply doesn't understand.
404  *
405  * Flow expiration works in terms of subfacets, so a facet must have at least
406  * one subfacet or it will never expire, leaking memory. */
407 struct facet {
408     /* Owners. */
409     struct hmap_node hmap_node;  /* In owning ofproto's 'facets' hmap. */
410     struct list list_node;       /* In owning rule's 'facets' list. */
411     struct rule_dpif *rule;      /* Owning rule. */
412
413     /* Owned data. */
414     struct list subfacets;
415     long long int used;         /* Time last used; time created if not used. */
416
417     /* Key. */
418     struct flow flow;
419
420     /* These statistics:
421      *
422      *   - Do include packets and bytes sent "by hand", e.g. with
423      *     dpif_execute().
424      *
425      *   - Do include packets and bytes that were obtained from the datapath
426      *     when a subfacet's statistics were reset (e.g. dpif_flow_put() with
427      *     DPIF_FP_ZERO_STATS).
428      *
429      *   - Do not include packets or bytes that can be obtained from the
430      *     datapath for any existing subfacet.
431      */
432     uint64_t packet_count;       /* Number of packets received. */
433     uint64_t byte_count;         /* Number of bytes received. */
434
435     /* Resubmit statistics. */
436     uint64_t prev_packet_count;  /* Number of packets from last stats push. */
437     uint64_t prev_byte_count;    /* Number of bytes from last stats push. */
438     long long int prev_used;     /* Used time from last stats push. */
439
440     /* Accounting. */
441     uint64_t accounted_bytes;    /* Bytes processed by facet_account(). */
442     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
443     uint8_t tcp_flags;           /* TCP flags seen for this 'rule'. */
444
445     /* Properties of datapath actions.
446      *
447      * Every subfacet has its own actions because actions can differ slightly
448      * between splintered and non-splintered subfacets due to the VLAN tag
449      * being initially different (present vs. absent).  All of them have these
450      * properties in common so we just store one copy of them here. */
451     bool has_learn;              /* Actions include NXAST_LEARN? */
452     bool has_normal;             /* Actions output to OFPP_NORMAL? */
453     bool has_fin_timeout;        /* Actions include NXAST_FIN_TIMEOUT? */
454     tag_type tags;               /* Tags that would require revalidation. */
455     mirror_mask_t mirrors;       /* Bitmap of dependent mirrors. */
456
457     /* Storage for a single subfacet, to reduce malloc() time and space
458      * overhead.  (A facet always has at least one subfacet and in the common
459      * case has exactly one subfacet.) */
460     struct subfacet one_subfacet;
461 };
462
463 static struct facet *facet_create(struct rule_dpif *,
464                                   const struct flow *, uint32_t hash);
465 static void facet_remove(struct facet *);
466 static void facet_free(struct facet *);
467
468 static struct facet *facet_find(struct ofproto_dpif *,
469                                 const struct flow *, uint32_t hash);
470 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
471                                         const struct flow *, uint32_t hash);
472 static void facet_revalidate(struct facet *);
473 static bool facet_check_consistency(struct facet *);
474
475 static void facet_flush_stats(struct facet *);
476
477 static void facet_update_time(struct facet *, long long int used);
478 static void facet_reset_counters(struct facet *);
479 static void facet_push_stats(struct facet *);
480 static void facet_learn(struct facet *);
481 static void facet_account(struct facet *);
482
483 static bool facet_is_controller_flow(struct facet *);
484
485 struct ofport_dpif {
486     struct ofport up;
487
488     uint32_t odp_port;
489     struct ofbundle *bundle;    /* Bundle that contains this port, if any. */
490     struct list bundle_node;    /* In struct ofbundle's "ports" list. */
491     struct cfm *cfm;            /* Connectivity Fault Management, if any. */
492     tag_type tag;               /* Tag associated with this port. */
493     uint32_t bond_stable_id;    /* stable_id to use as bond slave, or 0. */
494     bool may_enable;            /* May be enabled in bonds. */
495     long long int carrier_seq;  /* Carrier status changes. */
496
497     /* Spanning tree. */
498     struct stp_port *stp_port;  /* Spanning Tree Protocol, if any. */
499     enum stp_state stp_state;   /* Always STP_DISABLED if STP not in use. */
500     long long int stp_state_entered;
501
502     struct hmap priorities;     /* Map of attached 'priority_to_dscp's. */
503
504     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
505      *
506      * This is deprecated.  It is only for compatibility with broken device
507      * drivers in old versions of Linux that do not properly support VLANs when
508      * VLAN devices are not used.  When broken device drivers are no longer in
509      * widespread use, we will delete these interfaces. */
510     uint16_t realdev_ofp_port;
511     int vlandev_vid;
512 };
513
514 /* Node in 'ofport_dpif''s 'priorities' map.  Used to maintain a map from
515  * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
516  * traffic egressing the 'ofport' with that priority should be marked with. */
517 struct priority_to_dscp {
518     struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
519     uint32_t priority;          /* Priority of this queue (see struct flow). */
520
521     uint8_t dscp;               /* DSCP bits to mark outgoing traffic with. */
522 };
523
524 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
525  *
526  * This is deprecated.  It is only for compatibility with broken device drivers
527  * in old versions of Linux that do not properly support VLANs when VLAN
528  * devices are not used.  When broken device drivers are no longer in
529  * widespread use, we will delete these interfaces. */
530 struct vlan_splinter {
531     struct hmap_node realdev_vid_node;
532     struct hmap_node vlandev_node;
533     uint16_t realdev_ofp_port;
534     uint16_t vlandev_ofp_port;
535     int vid;
536 };
537
538 static uint32_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
539                                        uint32_t realdev, ovs_be16 vlan_tci);
540 static bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
541 static void vsp_remove(struct ofport_dpif *);
542 static void vsp_add(struct ofport_dpif *, uint16_t realdev_ofp_port, int vid);
543
544 static struct ofport_dpif *
545 ofport_dpif_cast(const struct ofport *ofport)
546 {
547     assert(ofport->ofproto->ofproto_class == &ofproto_dpif_class);
548     return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
549 }
550
551 static void port_run(struct ofport_dpif *);
552 static void port_run_fast(struct ofport_dpif *);
553 static void port_wait(struct ofport_dpif *);
554 static int set_cfm(struct ofport *, const struct cfm_settings *);
555 static void ofport_clear_priorities(struct ofport_dpif *);
556
557 struct dpif_completion {
558     struct list list_node;
559     struct ofoperation *op;
560 };
561
562 /* Extra information about a classifier table.
563  * Currently used just for optimized flow revalidation. */
564 struct table_dpif {
565     /* If either of these is nonnull, then this table has a form that allows
566      * flows to be tagged to avoid revalidating most flows for the most common
567      * kinds of flow table changes. */
568     struct cls_table *catchall_table; /* Table that wildcards all fields. */
569     struct cls_table *other_table;    /* Table with any other wildcard set. */
570     uint32_t basis;                   /* Keeps each table's tags separate. */
571 };
572
573 /* Reasons that we might need to revalidate every facet, and corresponding
574  * coverage counters.
575  *
576  * A value of 0 means that there is no need to revalidate.
577  *
578  * It would be nice to have some cleaner way to integrate with coverage
579  * counters, but with only a few reasons I guess this is good enough for
580  * now. */
581 enum revalidate_reason {
582     REV_RECONFIGURE = 1,       /* Switch configuration changed. */
583     REV_STP,                   /* Spanning tree protocol port status change. */
584     REV_PORT_TOGGLED,          /* Port enabled or disabled by CFM, LACP, ...*/
585     REV_FLOW_TABLE,            /* Flow table changed. */
586     REV_INCONSISTENCY          /* Facet self-check failed. */
587 };
588 COVERAGE_DEFINE(rev_reconfigure);
589 COVERAGE_DEFINE(rev_stp);
590 COVERAGE_DEFINE(rev_port_toggled);
591 COVERAGE_DEFINE(rev_flow_table);
592 COVERAGE_DEFINE(rev_inconsistency);
593
594 struct ofproto_dpif {
595     struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
596     struct ofproto up;
597     struct dpif *dpif;
598     int max_ports;
599
600     /* Special OpenFlow rules. */
601     struct rule_dpif *miss_rule; /* Sends flow table misses to controller. */
602     struct rule_dpif *no_packet_in_rule; /* Drops flow table misses. */
603
604     /* Statistics. */
605     uint64_t n_matches;
606
607     /* Bridging. */
608     struct netflow *netflow;
609     struct dpif_sflow *sflow;
610     struct hmap bundles;        /* Contains "struct ofbundle"s. */
611     struct mac_learning *ml;
612     struct ofmirror *mirrors[MAX_MIRRORS];
613     bool has_mirrors;
614     bool has_bonded_bundles;
615
616     /* Expiration. */
617     struct timer next_expiration;
618
619     /* Facets. */
620     struct hmap facets;
621     struct hmap subfacets;
622     struct governor *governor;
623
624     /* Revalidation. */
625     struct table_dpif tables[N_TABLES];
626     enum revalidate_reason need_revalidate;
627     struct tag_set revalidate_set;
628
629     /* Support for debugging async flow mods. */
630     struct list completions;
631
632     bool has_bundle_action; /* True when the first bundle action appears. */
633     struct netdev_stats stats; /* To account packets generated and consumed in
634                                 * userspace. */
635
636     /* Spanning tree. */
637     struct stp *stp;
638     long long int stp_last_tick;
639
640     /* VLAN splinters. */
641     struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
642     struct hmap vlandev_map;     /* vlandev -> (realdev,vid). */
643 };
644
645 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"?  (Useful only
646  * for debugging the asynchronous flow_mod implementation.) */
647 static bool clogged;
648
649 /* All existing ofproto_dpif instances, indexed by ->up.name. */
650 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
651
652 static void ofproto_dpif_unixctl_init(void);
653
654 static struct ofproto_dpif *
655 ofproto_dpif_cast(const struct ofproto *ofproto)
656 {
657     assert(ofproto->ofproto_class == &ofproto_dpif_class);
658     return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
659 }
660
661 static struct ofport_dpif *get_ofp_port(const struct ofproto_dpif *,
662                                         uint16_t ofp_port);
663 static struct ofport_dpif *get_odp_port(const struct ofproto_dpif *,
664                                         uint32_t odp_port);
665 static void ofproto_trace(struct ofproto_dpif *, const struct flow *,
666                           const struct ofpbuf *, ovs_be16 initial_tci,
667                           struct ds *);
668
669 /* Packet processing. */
670 static void update_learning_table(struct ofproto_dpif *,
671                                   const struct flow *, int vlan,
672                                   struct ofbundle *);
673 /* Upcalls. */
674 #define FLOW_MISS_MAX_BATCH 50
675 static int handle_upcalls(struct ofproto_dpif *, unsigned int max_batch);
676
677 /* Flow expiration. */
678 static int expire(struct ofproto_dpif *);
679
680 /* NetFlow. */
681 static void send_netflow_active_timeouts(struct ofproto_dpif *);
682
683 /* Utilities. */
684 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
685 static size_t compose_sflow_action(const struct ofproto_dpif *,
686                                    struct ofpbuf *odp_actions,
687                                    const struct flow *, uint32_t odp_port);
688 static void add_mirror_actions(struct action_xlate_ctx *ctx,
689                                const struct flow *flow);
690 /* Global variables. */
691 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
692 \f
693 /* Factory functions. */
694
695 static void
696 enumerate_types(struct sset *types)
697 {
698     dp_enumerate_types(types);
699 }
700
701 static int
702 enumerate_names(const char *type, struct sset *names)
703 {
704     return dp_enumerate_names(type, names);
705 }
706
707 static int
708 del(const char *type, const char *name)
709 {
710     struct dpif *dpif;
711     int error;
712
713     error = dpif_open(name, type, &dpif);
714     if (!error) {
715         error = dpif_delete(dpif);
716         dpif_close(dpif);
717     }
718     return error;
719 }
720 \f
721 /* Basic life-cycle. */
722
723 static int add_internal_flows(struct ofproto_dpif *);
724
725 static struct ofproto *
726 alloc(void)
727 {
728     struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
729     return &ofproto->up;
730 }
731
732 static void
733 dealloc(struct ofproto *ofproto_)
734 {
735     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
736     free(ofproto);
737 }
738
739 static int
740 construct(struct ofproto *ofproto_)
741 {
742     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
743     const char *name = ofproto->up.name;
744     int error;
745     int i;
746
747     error = dpif_create_and_open(name, ofproto->up.type, &ofproto->dpif);
748     if (error) {
749         VLOG_ERR("failed to open datapath %s: %s", name, strerror(error));
750         return error;
751     }
752
753     ofproto->max_ports = dpif_get_max_ports(ofproto->dpif);
754     ofproto->n_matches = 0;
755
756     dpif_flow_flush(ofproto->dpif);
757     dpif_recv_purge(ofproto->dpif);
758
759     error = dpif_recv_set(ofproto->dpif, true);
760     if (error) {
761         VLOG_ERR("failed to listen on datapath %s: %s", name, strerror(error));
762         dpif_close(ofproto->dpif);
763         return error;
764     }
765
766     ofproto->netflow = NULL;
767     ofproto->sflow = NULL;
768     ofproto->stp = NULL;
769     hmap_init(&ofproto->bundles);
770     ofproto->ml = mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME);
771     for (i = 0; i < MAX_MIRRORS; i++) {
772         ofproto->mirrors[i] = NULL;
773     }
774     ofproto->has_bonded_bundles = false;
775
776     timer_set_duration(&ofproto->next_expiration, 1000);
777
778     hmap_init(&ofproto->facets);
779     hmap_init(&ofproto->subfacets);
780     ofproto->governor = NULL;
781
782     for (i = 0; i < N_TABLES; i++) {
783         struct table_dpif *table = &ofproto->tables[i];
784
785         table->catchall_table = NULL;
786         table->other_table = NULL;
787         table->basis = random_uint32();
788     }
789     ofproto->need_revalidate = 0;
790     tag_set_init(&ofproto->revalidate_set);
791
792     list_init(&ofproto->completions);
793
794     ofproto_dpif_unixctl_init();
795
796     ofproto->has_mirrors = false;
797     ofproto->has_bundle_action = false;
798
799     hmap_init(&ofproto->vlandev_map);
800     hmap_init(&ofproto->realdev_vid_map);
801
802     hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
803                 hash_string(ofproto->up.name, 0));
804     memset(&ofproto->stats, 0, sizeof ofproto->stats);
805
806     ofproto_init_tables(ofproto_, N_TABLES);
807     error = add_internal_flows(ofproto);
808     ofproto->up.tables[TBL_INTERNAL].flags = OFTABLE_HIDDEN | OFTABLE_READONLY;
809
810     return error;
811 }
812
813 static int
814 add_internal_flow(struct ofproto_dpif *ofproto, int id,
815                   const struct ofpbuf *ofpacts, struct rule_dpif **rulep)
816 {
817     struct ofputil_flow_mod fm;
818     int error;
819
820     cls_rule_init_catchall(&fm.cr, 0);
821     cls_rule_set_reg(&fm.cr, 0, id);
822     fm.new_cookie = htonll(0);
823     fm.cookie = htonll(0);
824     fm.cookie_mask = htonll(0);
825     fm.table_id = TBL_INTERNAL;
826     fm.command = OFPFC_ADD;
827     fm.idle_timeout = 0;
828     fm.hard_timeout = 0;
829     fm.buffer_id = 0;
830     fm.out_port = 0;
831     fm.flags = 0;
832     fm.ofpacts = ofpacts->data;
833     fm.ofpacts_len = ofpacts->size;
834
835     error = ofproto_flow_mod(&ofproto->up, &fm);
836     if (error) {
837         VLOG_ERR_RL(&rl, "failed to add internal flow %d (%s)",
838                     id, ofperr_to_string(error));
839         return error;
840     }
841
842     *rulep = rule_dpif_lookup__(ofproto, &fm.cr.flow, TBL_INTERNAL);
843     assert(*rulep != NULL);
844
845     return 0;
846 }
847
848 static int
849 add_internal_flows(struct ofproto_dpif *ofproto)
850 {
851     struct ofpact_controller *controller;
852     uint64_t ofpacts_stub[128 / 8];
853     struct ofpbuf ofpacts;
854     int error;
855     int id;
856
857     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
858     id = 1;
859
860     controller = ofpact_put_CONTROLLER(&ofpacts);
861     controller->max_len = UINT16_MAX;
862     controller->controller_id = 0;
863     controller->reason = OFPR_NO_MATCH;
864     ofpact_pad(&ofpacts);
865
866     error = add_internal_flow(ofproto, id++, &ofpacts, &ofproto->miss_rule);
867     if (error) {
868         return error;
869     }
870
871     ofpbuf_clear(&ofpacts);
872     error = add_internal_flow(ofproto, id++, &ofpacts,
873                               &ofproto->no_packet_in_rule);
874     return error;
875 }
876
877 static void
878 complete_operations(struct ofproto_dpif *ofproto)
879 {
880     struct dpif_completion *c, *next;
881
882     LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
883         ofoperation_complete(c->op, 0);
884         list_remove(&c->list_node);
885         free(c);
886     }
887 }
888
889 static void
890 destruct(struct ofproto *ofproto_)
891 {
892     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
893     struct rule_dpif *rule, *next_rule;
894     struct oftable *table;
895     int i;
896
897     hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
898     complete_operations(ofproto);
899
900     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
901         struct cls_cursor cursor;
902
903         cls_cursor_init(&cursor, &table->cls, NULL);
904         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
905             ofproto_rule_destroy(&rule->up);
906         }
907     }
908
909     for (i = 0; i < MAX_MIRRORS; i++) {
910         mirror_destroy(ofproto->mirrors[i]);
911     }
912
913     netflow_destroy(ofproto->netflow);
914     dpif_sflow_destroy(ofproto->sflow);
915     hmap_destroy(&ofproto->bundles);
916     mac_learning_destroy(ofproto->ml);
917
918     hmap_destroy(&ofproto->facets);
919     hmap_destroy(&ofproto->subfacets);
920     governor_destroy(ofproto->governor);
921
922     hmap_destroy(&ofproto->vlandev_map);
923     hmap_destroy(&ofproto->realdev_vid_map);
924
925     dpif_close(ofproto->dpif);
926 }
927
928 static int
929 run_fast(struct ofproto *ofproto_)
930 {
931     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
932     struct ofport_dpif *ofport;
933     unsigned int work;
934
935     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
936         port_run_fast(ofport);
937     }
938
939     /* Handle one or more batches of upcalls, until there's nothing left to do
940      * or until we do a fixed total amount of work.
941      *
942      * We do work in batches because it can be much cheaper to set up a number
943      * of flows and fire off their patches all at once.  We do multiple batches
944      * because in some cases handling a packet can cause another packet to be
945      * queued almost immediately as part of the return flow.  Both
946      * optimizations can make major improvements on some benchmarks and
947      * presumably for real traffic as well. */
948     work = 0;
949     while (work < FLOW_MISS_MAX_BATCH) {
950         int retval = handle_upcalls(ofproto, FLOW_MISS_MAX_BATCH - work);
951         if (retval <= 0) {
952             return -retval;
953         }
954         work += retval;
955     }
956     return 0;
957 }
958
959 static int
960 run(struct ofproto *ofproto_)
961 {
962     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
963     struct ofport_dpif *ofport;
964     struct ofbundle *bundle;
965     int error;
966
967     if (!clogged) {
968         complete_operations(ofproto);
969     }
970     dpif_run(ofproto->dpif);
971
972     error = run_fast(ofproto_);
973     if (error) {
974         return error;
975     }
976
977     if (timer_expired(&ofproto->next_expiration)) {
978         int delay = expire(ofproto);
979         timer_set_duration(&ofproto->next_expiration, delay);
980     }
981
982     if (ofproto->netflow) {
983         if (netflow_run(ofproto->netflow)) {
984             send_netflow_active_timeouts(ofproto);
985         }
986     }
987     if (ofproto->sflow) {
988         dpif_sflow_run(ofproto->sflow);
989     }
990
991     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
992         port_run(ofport);
993     }
994     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
995         bundle_run(bundle);
996     }
997
998     stp_run(ofproto);
999     mac_learning_run(ofproto->ml, &ofproto->revalidate_set);
1000
1001     /* Now revalidate if there's anything to do. */
1002     if (ofproto->need_revalidate
1003         || !tag_set_is_empty(&ofproto->revalidate_set)) {
1004         struct tag_set revalidate_set = ofproto->revalidate_set;
1005         bool revalidate_all = ofproto->need_revalidate;
1006         struct facet *facet;
1007
1008         switch (ofproto->need_revalidate) {
1009         case REV_RECONFIGURE:   COVERAGE_INC(rev_reconfigure);   break;
1010         case REV_STP:           COVERAGE_INC(rev_stp);           break;
1011         case REV_PORT_TOGGLED:  COVERAGE_INC(rev_port_toggled);  break;
1012         case REV_FLOW_TABLE:    COVERAGE_INC(rev_flow_table);    break;
1013         case REV_INCONSISTENCY: COVERAGE_INC(rev_inconsistency); break;
1014         }
1015
1016         /* Clear the revalidation flags. */
1017         tag_set_init(&ofproto->revalidate_set);
1018         ofproto->need_revalidate = 0;
1019
1020         HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
1021             if (revalidate_all
1022                 || tag_set_intersects(&revalidate_set, facet->tags)) {
1023                 facet_revalidate(facet);
1024             }
1025         }
1026     }
1027
1028     /* Check the consistency of a random facet, to aid debugging. */
1029     if (!hmap_is_empty(&ofproto->facets) && !ofproto->need_revalidate) {
1030         struct facet *facet;
1031
1032         facet = CONTAINER_OF(hmap_random_node(&ofproto->facets),
1033                              struct facet, hmap_node);
1034         if (!tag_set_intersects(&ofproto->revalidate_set, facet->tags)) {
1035             if (!facet_check_consistency(facet)) {
1036                 ofproto->need_revalidate = REV_INCONSISTENCY;
1037             }
1038         }
1039     }
1040
1041     if (ofproto->governor) {
1042         size_t n_subfacets;
1043
1044         governor_run(ofproto->governor);
1045
1046         /* If the governor has shrunk to its minimum size and the number of
1047          * subfacets has dwindled, then drop the governor entirely.
1048          *
1049          * For hysteresis, the number of subfacets to drop the governor is
1050          * smaller than the number needed to trigger its creation. */
1051         n_subfacets = hmap_count(&ofproto->subfacets);
1052         if (n_subfacets * 4 < ofproto->up.flow_eviction_threshold
1053             && governor_is_idle(ofproto->governor)) {
1054             governor_destroy(ofproto->governor);
1055             ofproto->governor = NULL;
1056         }
1057     }
1058
1059     return 0;
1060 }
1061
1062 static void
1063 wait(struct ofproto *ofproto_)
1064 {
1065     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1066     struct ofport_dpif *ofport;
1067     struct ofbundle *bundle;
1068
1069     if (!clogged && !list_is_empty(&ofproto->completions)) {
1070         poll_immediate_wake();
1071     }
1072
1073     dpif_wait(ofproto->dpif);
1074     dpif_recv_wait(ofproto->dpif);
1075     if (ofproto->sflow) {
1076         dpif_sflow_wait(ofproto->sflow);
1077     }
1078     if (!tag_set_is_empty(&ofproto->revalidate_set)) {
1079         poll_immediate_wake();
1080     }
1081     HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1082         port_wait(ofport);
1083     }
1084     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1085         bundle_wait(bundle);
1086     }
1087     if (ofproto->netflow) {
1088         netflow_wait(ofproto->netflow);
1089     }
1090     mac_learning_wait(ofproto->ml);
1091     stp_wait(ofproto);
1092     if (ofproto->need_revalidate) {
1093         /* Shouldn't happen, but if it does just go around again. */
1094         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1095         poll_immediate_wake();
1096     } else {
1097         timer_wait(&ofproto->next_expiration);
1098     }
1099     if (ofproto->governor) {
1100         governor_wait(ofproto->governor);
1101     }
1102 }
1103
1104 static void
1105 get_memory_usage(const struct ofproto *ofproto_, struct simap *usage)
1106 {
1107     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1108
1109     simap_increase(usage, "facets", hmap_count(&ofproto->facets));
1110     simap_increase(usage, "subfacets", hmap_count(&ofproto->subfacets));
1111 }
1112
1113 static void
1114 flush(struct ofproto *ofproto_)
1115 {
1116     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1117     struct facet *facet, *next_facet;
1118
1119     HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
1120         /* Mark the facet as not installed so that facet_remove() doesn't
1121          * bother trying to uninstall it.  There is no point in uninstalling it
1122          * individually since we are about to blow away all the facets with
1123          * dpif_flow_flush(). */
1124         struct subfacet *subfacet;
1125
1126         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
1127             subfacet->path = SF_NOT_INSTALLED;
1128             subfacet->dp_packet_count = 0;
1129             subfacet->dp_byte_count = 0;
1130         }
1131         facet_remove(facet);
1132     }
1133     dpif_flow_flush(ofproto->dpif);
1134 }
1135
1136 static void
1137 get_features(struct ofproto *ofproto_ OVS_UNUSED,
1138              bool *arp_match_ip, enum ofputil_action_bitmap *actions)
1139 {
1140     *arp_match_ip = true;
1141     *actions = (OFPUTIL_A_OUTPUT |
1142                 OFPUTIL_A_SET_VLAN_VID |
1143                 OFPUTIL_A_SET_VLAN_PCP |
1144                 OFPUTIL_A_STRIP_VLAN |
1145                 OFPUTIL_A_SET_DL_SRC |
1146                 OFPUTIL_A_SET_DL_DST |
1147                 OFPUTIL_A_SET_NW_SRC |
1148                 OFPUTIL_A_SET_NW_DST |
1149                 OFPUTIL_A_SET_NW_TOS |
1150                 OFPUTIL_A_SET_TP_SRC |
1151                 OFPUTIL_A_SET_TP_DST |
1152                 OFPUTIL_A_ENQUEUE);
1153 }
1154
1155 static void
1156 get_tables(struct ofproto *ofproto_, struct ofp10_table_stats *ots)
1157 {
1158     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1159     struct dpif_dp_stats s;
1160
1161     strcpy(ots->name, "classifier");
1162
1163     dpif_get_dp_stats(ofproto->dpif, &s);
1164     put_32aligned_be64(&ots->lookup_count, htonll(s.n_hit + s.n_missed));
1165     put_32aligned_be64(&ots->matched_count,
1166                        htonll(s.n_hit + ofproto->n_matches));
1167 }
1168
1169 static struct ofport *
1170 port_alloc(void)
1171 {
1172     struct ofport_dpif *port = xmalloc(sizeof *port);
1173     return &port->up;
1174 }
1175
1176 static void
1177 port_dealloc(struct ofport *port_)
1178 {
1179     struct ofport_dpif *port = ofport_dpif_cast(port_);
1180     free(port);
1181 }
1182
1183 static int
1184 port_construct(struct ofport *port_)
1185 {
1186     struct ofport_dpif *port = ofport_dpif_cast(port_);
1187     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1188
1189     ofproto->need_revalidate = REV_RECONFIGURE;
1190     port->odp_port = ofp_port_to_odp_port(port->up.ofp_port);
1191     port->bundle = NULL;
1192     port->cfm = NULL;
1193     port->tag = tag_create_random();
1194     port->may_enable = true;
1195     port->stp_port = NULL;
1196     port->stp_state = STP_DISABLED;
1197     hmap_init(&port->priorities);
1198     port->realdev_ofp_port = 0;
1199     port->vlandev_vid = 0;
1200     port->carrier_seq = netdev_get_carrier_resets(port->up.netdev);
1201
1202     if (ofproto->sflow) {
1203         dpif_sflow_add_port(ofproto->sflow, port_);
1204     }
1205
1206     return 0;
1207 }
1208
1209 static void
1210 port_destruct(struct ofport *port_)
1211 {
1212     struct ofport_dpif *port = ofport_dpif_cast(port_);
1213     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1214
1215     ofproto->need_revalidate = REV_RECONFIGURE;
1216     bundle_remove(port_);
1217     set_cfm(port_, NULL);
1218     if (ofproto->sflow) {
1219         dpif_sflow_del_port(ofproto->sflow, port->odp_port);
1220     }
1221
1222     ofport_clear_priorities(port);
1223     hmap_destroy(&port->priorities);
1224 }
1225
1226 static void
1227 port_modified(struct ofport *port_)
1228 {
1229     struct ofport_dpif *port = ofport_dpif_cast(port_);
1230
1231     if (port->bundle && port->bundle->bond) {
1232         bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
1233     }
1234 }
1235
1236 static void
1237 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1238 {
1239     struct ofport_dpif *port = ofport_dpif_cast(port_);
1240     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1241     enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1242
1243     if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1244                    OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD |
1245                    OFPUTIL_PC_NO_PACKET_IN)) {
1246         ofproto->need_revalidate = REV_RECONFIGURE;
1247
1248         if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1249             bundle_update(port->bundle);
1250         }
1251     }
1252 }
1253
1254 static int
1255 set_sflow(struct ofproto *ofproto_,
1256           const struct ofproto_sflow_options *sflow_options)
1257 {
1258     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1259     struct dpif_sflow *ds = ofproto->sflow;
1260
1261     if (sflow_options) {
1262         if (!ds) {
1263             struct ofport_dpif *ofport;
1264
1265             ds = ofproto->sflow = dpif_sflow_create(ofproto->dpif);
1266             HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1267                 dpif_sflow_add_port(ds, &ofport->up);
1268             }
1269             ofproto->need_revalidate = REV_RECONFIGURE;
1270         }
1271         dpif_sflow_set_options(ds, sflow_options);
1272     } else {
1273         if (ds) {
1274             dpif_sflow_destroy(ds);
1275             ofproto->need_revalidate = REV_RECONFIGURE;
1276             ofproto->sflow = NULL;
1277         }
1278     }
1279     return 0;
1280 }
1281
1282 static int
1283 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1284 {
1285     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1286     int error;
1287
1288     if (!s) {
1289         error = 0;
1290     } else {
1291         if (!ofport->cfm) {
1292             struct ofproto_dpif *ofproto;
1293
1294             ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1295             ofproto->need_revalidate = REV_RECONFIGURE;
1296             ofport->cfm = cfm_create(netdev_get_name(ofport->up.netdev));
1297         }
1298
1299         if (cfm_configure(ofport->cfm, s)) {
1300             return 0;
1301         }
1302
1303         error = EINVAL;
1304     }
1305     cfm_destroy(ofport->cfm);
1306     ofport->cfm = NULL;
1307     return error;
1308 }
1309
1310 static int
1311 get_cfm_fault(const struct ofport *ofport_)
1312 {
1313     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1314
1315     return ofport->cfm ? cfm_get_fault(ofport->cfm) : -1;
1316 }
1317
1318 static int
1319 get_cfm_opup(const struct ofport *ofport_)
1320 {
1321     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1322
1323     return ofport->cfm ? cfm_get_opup(ofport->cfm) : -1;
1324 }
1325
1326 static int
1327 get_cfm_remote_mpids(const struct ofport *ofport_, const uint64_t **rmps,
1328                      size_t *n_rmps)
1329 {
1330     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1331
1332     if (ofport->cfm) {
1333         cfm_get_remote_mpids(ofport->cfm, rmps, n_rmps);
1334         return 0;
1335     } else {
1336         return -1;
1337     }
1338 }
1339
1340 static int
1341 get_cfm_health(const struct ofport *ofport_)
1342 {
1343     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1344
1345     return ofport->cfm ? cfm_get_health(ofport->cfm) : -1;
1346 }
1347 \f
1348 /* Spanning Tree. */
1349
1350 static void
1351 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
1352 {
1353     struct ofproto_dpif *ofproto = ofproto_;
1354     struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
1355     struct ofport_dpif *ofport;
1356
1357     ofport = stp_port_get_aux(sp);
1358     if (!ofport) {
1359         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
1360                      ofproto->up.name, port_num);
1361     } else {
1362         struct eth_header *eth = pkt->l2;
1363
1364         netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
1365         if (eth_addr_is_zero(eth->eth_src)) {
1366             VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
1367                          "with unknown MAC", ofproto->up.name, port_num);
1368         } else {
1369             send_packet(ofport, pkt);
1370         }
1371     }
1372     ofpbuf_delete(pkt);
1373 }
1374
1375 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
1376 static int
1377 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
1378 {
1379     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1380
1381     /* Only revalidate flows if the configuration changed. */
1382     if (!s != !ofproto->stp) {
1383         ofproto->need_revalidate = REV_RECONFIGURE;
1384     }
1385
1386     if (s) {
1387         if (!ofproto->stp) {
1388             ofproto->stp = stp_create(ofproto_->name, s->system_id,
1389                                       send_bpdu_cb, ofproto);
1390             ofproto->stp_last_tick = time_msec();
1391         }
1392
1393         stp_set_bridge_id(ofproto->stp, s->system_id);
1394         stp_set_bridge_priority(ofproto->stp, s->priority);
1395         stp_set_hello_time(ofproto->stp, s->hello_time);
1396         stp_set_max_age(ofproto->stp, s->max_age);
1397         stp_set_forward_delay(ofproto->stp, s->fwd_delay);
1398     }  else {
1399         struct ofport *ofport;
1400
1401         HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
1402             set_stp_port(ofport, NULL);
1403         }
1404
1405         stp_destroy(ofproto->stp);
1406         ofproto->stp = NULL;
1407     }
1408
1409     return 0;
1410 }
1411
1412 static int
1413 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
1414 {
1415     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1416
1417     if (ofproto->stp) {
1418         s->enabled = true;
1419         s->bridge_id = stp_get_bridge_id(ofproto->stp);
1420         s->designated_root = stp_get_designated_root(ofproto->stp);
1421         s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
1422     } else {
1423         s->enabled = false;
1424     }
1425
1426     return 0;
1427 }
1428
1429 static void
1430 update_stp_port_state(struct ofport_dpif *ofport)
1431 {
1432     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1433     enum stp_state state;
1434
1435     /* Figure out new state. */
1436     state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
1437                              : STP_DISABLED;
1438
1439     /* Update state. */
1440     if (ofport->stp_state != state) {
1441         enum ofputil_port_state of_state;
1442         bool fwd_change;
1443
1444         VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
1445                     netdev_get_name(ofport->up.netdev),
1446                     stp_state_name(ofport->stp_state),
1447                     stp_state_name(state));
1448         if (stp_learn_in_state(ofport->stp_state)
1449                 != stp_learn_in_state(state)) {
1450             /* xxx Learning action flows should also be flushed. */
1451             mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
1452         }
1453         fwd_change = stp_forward_in_state(ofport->stp_state)
1454                         != stp_forward_in_state(state);
1455
1456         ofproto->need_revalidate = REV_STP;
1457         ofport->stp_state = state;
1458         ofport->stp_state_entered = time_msec();
1459
1460         if (fwd_change && ofport->bundle) {
1461             bundle_update(ofport->bundle);
1462         }
1463
1464         /* Update the STP state bits in the OpenFlow port description. */
1465         of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
1466         of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
1467                      : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
1468                      : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
1469                      : state == STP_BLOCKING ?  OFPUTIL_PS_STP_BLOCK
1470                      : 0);
1471         ofproto_port_set_state(&ofport->up, of_state);
1472     }
1473 }
1474
1475 /* Configures STP on 'ofport_' using the settings defined in 's'.  The
1476  * caller is responsible for assigning STP port numbers and ensuring
1477  * there are no duplicates. */
1478 static int
1479 set_stp_port(struct ofport *ofport_,
1480              const struct ofproto_port_stp_settings *s)
1481 {
1482     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1483     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1484     struct stp_port *sp = ofport->stp_port;
1485
1486     if (!s || !s->enable) {
1487         if (sp) {
1488             ofport->stp_port = NULL;
1489             stp_port_disable(sp);
1490             update_stp_port_state(ofport);
1491         }
1492         return 0;
1493     } else if (sp && stp_port_no(sp) != s->port_num
1494             && ofport == stp_port_get_aux(sp)) {
1495         /* The port-id changed, so disable the old one if it's not
1496          * already in use by another port. */
1497         stp_port_disable(sp);
1498     }
1499
1500     sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
1501     stp_port_enable(sp);
1502
1503     stp_port_set_aux(sp, ofport);
1504     stp_port_set_priority(sp, s->priority);
1505     stp_port_set_path_cost(sp, s->path_cost);
1506
1507     update_stp_port_state(ofport);
1508
1509     return 0;
1510 }
1511
1512 static int
1513 get_stp_port_status(struct ofport *ofport_,
1514                     struct ofproto_port_stp_status *s)
1515 {
1516     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1517     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1518     struct stp_port *sp = ofport->stp_port;
1519
1520     if (!ofproto->stp || !sp) {
1521         s->enabled = false;
1522         return 0;
1523     }
1524
1525     s->enabled = true;
1526     s->port_id = stp_port_get_id(sp);
1527     s->state = stp_port_get_state(sp);
1528     s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
1529     s->role = stp_port_get_role(sp);
1530     stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
1531
1532     return 0;
1533 }
1534
1535 static void
1536 stp_run(struct ofproto_dpif *ofproto)
1537 {
1538     if (ofproto->stp) {
1539         long long int now = time_msec();
1540         long long int elapsed = now - ofproto->stp_last_tick;
1541         struct stp_port *sp;
1542
1543         if (elapsed > 0) {
1544             stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
1545             ofproto->stp_last_tick = now;
1546         }
1547         while (stp_get_changed_port(ofproto->stp, &sp)) {
1548             struct ofport_dpif *ofport = stp_port_get_aux(sp);
1549
1550             if (ofport) {
1551                 update_stp_port_state(ofport);
1552             }
1553         }
1554
1555         if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
1556             mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
1557         }
1558     }
1559 }
1560
1561 static void
1562 stp_wait(struct ofproto_dpif *ofproto)
1563 {
1564     if (ofproto->stp) {
1565         poll_timer_wait(1000);
1566     }
1567 }
1568
1569 /* Returns true if STP should process 'flow'. */
1570 static bool
1571 stp_should_process_flow(const struct flow *flow)
1572 {
1573     return eth_addr_equals(flow->dl_dst, eth_addr_stp);
1574 }
1575
1576 static void
1577 stp_process_packet(const struct ofport_dpif *ofport,
1578                    const struct ofpbuf *packet)
1579 {
1580     struct ofpbuf payload = *packet;
1581     struct eth_header *eth = payload.data;
1582     struct stp_port *sp = ofport->stp_port;
1583
1584     /* Sink packets on ports that have STP disabled when the bridge has
1585      * STP enabled. */
1586     if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
1587         return;
1588     }
1589
1590     /* Trim off padding on payload. */
1591     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1592         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
1593     }
1594
1595     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1596         stp_received_bpdu(sp, payload.data, payload.size);
1597     }
1598 }
1599 \f
1600 static struct priority_to_dscp *
1601 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
1602 {
1603     struct priority_to_dscp *pdscp;
1604     uint32_t hash;
1605
1606     hash = hash_int(priority, 0);
1607     HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
1608         if (pdscp->priority == priority) {
1609             return pdscp;
1610         }
1611     }
1612     return NULL;
1613 }
1614
1615 static void
1616 ofport_clear_priorities(struct ofport_dpif *ofport)
1617 {
1618     struct priority_to_dscp *pdscp, *next;
1619
1620     HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
1621         hmap_remove(&ofport->priorities, &pdscp->hmap_node);
1622         free(pdscp);
1623     }
1624 }
1625
1626 static int
1627 set_queues(struct ofport *ofport_,
1628            const struct ofproto_port_queue *qdscp_list,
1629            size_t n_qdscp)
1630 {
1631     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1632     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1633     struct hmap new = HMAP_INITIALIZER(&new);
1634     size_t i;
1635
1636     for (i = 0; i < n_qdscp; i++) {
1637         struct priority_to_dscp *pdscp;
1638         uint32_t priority;
1639         uint8_t dscp;
1640
1641         dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
1642         if (dpif_queue_to_priority(ofproto->dpif, qdscp_list[i].queue,
1643                                    &priority)) {
1644             continue;
1645         }
1646
1647         pdscp = get_priority(ofport, priority);
1648         if (pdscp) {
1649             hmap_remove(&ofport->priorities, &pdscp->hmap_node);
1650         } else {
1651             pdscp = xmalloc(sizeof *pdscp);
1652             pdscp->priority = priority;
1653             pdscp->dscp = dscp;
1654             ofproto->need_revalidate = REV_RECONFIGURE;
1655         }
1656
1657         if (pdscp->dscp != dscp) {
1658             pdscp->dscp = dscp;
1659             ofproto->need_revalidate = REV_RECONFIGURE;
1660         }
1661
1662         hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
1663     }
1664
1665     if (!hmap_is_empty(&ofport->priorities)) {
1666         ofport_clear_priorities(ofport);
1667         ofproto->need_revalidate = REV_RECONFIGURE;
1668     }
1669
1670     hmap_swap(&new, &ofport->priorities);
1671     hmap_destroy(&new);
1672
1673     return 0;
1674 }
1675 \f
1676 /* Bundles. */
1677
1678 /* Expires all MAC learning entries associated with 'bundle' and forces its
1679  * ofproto to revalidate every flow.
1680  *
1681  * Normally MAC learning entries are removed only from the ofproto associated
1682  * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
1683  * are removed from every ofproto.  When patch ports and SLB bonds are in use
1684  * and a VM migration happens and the gratuitous ARPs are somehow lost, this
1685  * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
1686  * with the host from which it migrated. */
1687 static void
1688 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
1689 {
1690     struct ofproto_dpif *ofproto = bundle->ofproto;
1691     struct mac_learning *ml = ofproto->ml;
1692     struct mac_entry *mac, *next_mac;
1693
1694     ofproto->need_revalidate = REV_RECONFIGURE;
1695     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
1696         if (mac->port.p == bundle) {
1697             if (all_ofprotos) {
1698                 struct ofproto_dpif *o;
1699
1700                 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1701                     if (o != ofproto) {
1702                         struct mac_entry *e;
1703
1704                         e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
1705                                                 NULL);
1706                         if (e) {
1707                             tag_set_add(&o->revalidate_set, e->tag);
1708                             mac_learning_expire(o->ml, e);
1709                         }
1710                     }
1711                 }
1712             }
1713
1714             mac_learning_expire(ml, mac);
1715         }
1716     }
1717 }
1718
1719 static struct ofbundle *
1720 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
1721 {
1722     struct ofbundle *bundle;
1723
1724     HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
1725                              &ofproto->bundles) {
1726         if (bundle->aux == aux) {
1727             return bundle;
1728         }
1729     }
1730     return NULL;
1731 }
1732
1733 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
1734  * ones that are found to 'bundles'. */
1735 static void
1736 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
1737                        void **auxes, size_t n_auxes,
1738                        struct hmapx *bundles)
1739 {
1740     size_t i;
1741
1742     hmapx_init(bundles);
1743     for (i = 0; i < n_auxes; i++) {
1744         struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
1745         if (bundle) {
1746             hmapx_add(bundles, bundle);
1747         }
1748     }
1749 }
1750
1751 static void
1752 bundle_update(struct ofbundle *bundle)
1753 {
1754     struct ofport_dpif *port;
1755
1756     bundle->floodable = true;
1757     LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1758         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
1759             || !stp_forward_in_state(port->stp_state)) {
1760             bundle->floodable = false;
1761             break;
1762         }
1763     }
1764 }
1765
1766 static void
1767 bundle_del_port(struct ofport_dpif *port)
1768 {
1769     struct ofbundle *bundle = port->bundle;
1770
1771     bundle->ofproto->need_revalidate = REV_RECONFIGURE;
1772
1773     list_remove(&port->bundle_node);
1774     port->bundle = NULL;
1775
1776     if (bundle->lacp) {
1777         lacp_slave_unregister(bundle->lacp, port);
1778     }
1779     if (bundle->bond) {
1780         bond_slave_unregister(bundle->bond, port);
1781     }
1782
1783     bundle_update(bundle);
1784 }
1785
1786 static bool
1787 bundle_add_port(struct ofbundle *bundle, uint32_t ofp_port,
1788                 struct lacp_slave_settings *lacp,
1789                 uint32_t bond_stable_id)
1790 {
1791     struct ofport_dpif *port;
1792
1793     port = get_ofp_port(bundle->ofproto, ofp_port);
1794     if (!port) {
1795         return false;
1796     }
1797
1798     if (port->bundle != bundle) {
1799         bundle->ofproto->need_revalidate = REV_RECONFIGURE;
1800         if (port->bundle) {
1801             bundle_del_port(port);
1802         }
1803
1804         port->bundle = bundle;
1805         list_push_back(&bundle->ports, &port->bundle_node);
1806         if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
1807             || !stp_forward_in_state(port->stp_state)) {
1808             bundle->floodable = false;
1809         }
1810     }
1811     if (lacp) {
1812         port->bundle->ofproto->need_revalidate = REV_RECONFIGURE;
1813         lacp_slave_register(bundle->lacp, port, lacp);
1814     }
1815
1816     port->bond_stable_id = bond_stable_id;
1817
1818     return true;
1819 }
1820
1821 static void
1822 bundle_destroy(struct ofbundle *bundle)
1823 {
1824     struct ofproto_dpif *ofproto;
1825     struct ofport_dpif *port, *next_port;
1826     int i;
1827
1828     if (!bundle) {
1829         return;
1830     }
1831
1832     ofproto = bundle->ofproto;
1833     for (i = 0; i < MAX_MIRRORS; i++) {
1834         struct ofmirror *m = ofproto->mirrors[i];
1835         if (m) {
1836             if (m->out == bundle) {
1837                 mirror_destroy(m);
1838             } else if (hmapx_find_and_delete(&m->srcs, bundle)
1839                        || hmapx_find_and_delete(&m->dsts, bundle)) {
1840                 ofproto->need_revalidate = REV_RECONFIGURE;
1841             }
1842         }
1843     }
1844
1845     LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1846         bundle_del_port(port);
1847     }
1848
1849     bundle_flush_macs(bundle, true);
1850     hmap_remove(&ofproto->bundles, &bundle->hmap_node);
1851     free(bundle->name);
1852     free(bundle->trunks);
1853     lacp_destroy(bundle->lacp);
1854     bond_destroy(bundle->bond);
1855     free(bundle);
1856 }
1857
1858 static int
1859 bundle_set(struct ofproto *ofproto_, void *aux,
1860            const struct ofproto_bundle_settings *s)
1861 {
1862     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1863     bool need_flush = false;
1864     struct ofport_dpif *port;
1865     struct ofbundle *bundle;
1866     unsigned long *trunks;
1867     int vlan;
1868     size_t i;
1869     bool ok;
1870
1871     if (!s) {
1872         bundle_destroy(bundle_lookup(ofproto, aux));
1873         return 0;
1874     }
1875
1876     assert(s->n_slaves == 1 || s->bond != NULL);
1877     assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
1878
1879     bundle = bundle_lookup(ofproto, aux);
1880     if (!bundle) {
1881         bundle = xmalloc(sizeof *bundle);
1882
1883         bundle->ofproto = ofproto;
1884         hmap_insert(&ofproto->bundles, &bundle->hmap_node,
1885                     hash_pointer(aux, 0));
1886         bundle->aux = aux;
1887         bundle->name = NULL;
1888
1889         list_init(&bundle->ports);
1890         bundle->vlan_mode = PORT_VLAN_TRUNK;
1891         bundle->vlan = -1;
1892         bundle->trunks = NULL;
1893         bundle->use_priority_tags = s->use_priority_tags;
1894         bundle->lacp = NULL;
1895         bundle->bond = NULL;
1896
1897         bundle->floodable = true;
1898
1899         bundle->src_mirrors = 0;
1900         bundle->dst_mirrors = 0;
1901         bundle->mirror_out = 0;
1902     }
1903
1904     if (!bundle->name || strcmp(s->name, bundle->name)) {
1905         free(bundle->name);
1906         bundle->name = xstrdup(s->name);
1907     }
1908
1909     /* LACP. */
1910     if (s->lacp) {
1911         if (!bundle->lacp) {
1912             ofproto->need_revalidate = REV_RECONFIGURE;
1913             bundle->lacp = lacp_create();
1914         }
1915         lacp_configure(bundle->lacp, s->lacp);
1916     } else {
1917         lacp_destroy(bundle->lacp);
1918         bundle->lacp = NULL;
1919     }
1920
1921     /* Update set of ports. */
1922     ok = true;
1923     for (i = 0; i < s->n_slaves; i++) {
1924         if (!bundle_add_port(bundle, s->slaves[i],
1925                              s->lacp ? &s->lacp_slaves[i] : NULL,
1926                              s->bond_stable_ids ? s->bond_stable_ids[i] : 0)) {
1927             ok = false;
1928         }
1929     }
1930     if (!ok || list_size(&bundle->ports) != s->n_slaves) {
1931         struct ofport_dpif *next_port;
1932
1933         LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1934             for (i = 0; i < s->n_slaves; i++) {
1935                 if (s->slaves[i] == port->up.ofp_port) {
1936                     goto found;
1937                 }
1938             }
1939
1940             bundle_del_port(port);
1941         found: ;
1942         }
1943     }
1944     assert(list_size(&bundle->ports) <= s->n_slaves);
1945
1946     if (list_is_empty(&bundle->ports)) {
1947         bundle_destroy(bundle);
1948         return EINVAL;
1949     }
1950
1951     /* Set VLAN tagging mode */
1952     if (s->vlan_mode != bundle->vlan_mode
1953         || s->use_priority_tags != bundle->use_priority_tags) {
1954         bundle->vlan_mode = s->vlan_mode;
1955         bundle->use_priority_tags = s->use_priority_tags;
1956         need_flush = true;
1957     }
1958
1959     /* Set VLAN tag. */
1960     vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
1961             : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
1962             : 0);
1963     if (vlan != bundle->vlan) {
1964         bundle->vlan = vlan;
1965         need_flush = true;
1966     }
1967
1968     /* Get trunked VLANs. */
1969     switch (s->vlan_mode) {
1970     case PORT_VLAN_ACCESS:
1971         trunks = NULL;
1972         break;
1973
1974     case PORT_VLAN_TRUNK:
1975         trunks = CONST_CAST(unsigned long *, s->trunks);
1976         break;
1977
1978     case PORT_VLAN_NATIVE_UNTAGGED:
1979     case PORT_VLAN_NATIVE_TAGGED:
1980         if (vlan != 0 && (!s->trunks
1981                           || !bitmap_is_set(s->trunks, vlan)
1982                           || bitmap_is_set(s->trunks, 0))) {
1983             /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
1984             if (s->trunks) {
1985                 trunks = bitmap_clone(s->trunks, 4096);
1986             } else {
1987                 trunks = bitmap_allocate1(4096);
1988             }
1989             bitmap_set1(trunks, vlan);
1990             bitmap_set0(trunks, 0);
1991         } else {
1992             trunks = CONST_CAST(unsigned long *, s->trunks);
1993         }
1994         break;
1995
1996     default:
1997         NOT_REACHED();
1998     }
1999     if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
2000         free(bundle->trunks);
2001         if (trunks == s->trunks) {
2002             bundle->trunks = vlan_bitmap_clone(trunks);
2003         } else {
2004             bundle->trunks = trunks;
2005             trunks = NULL;
2006         }
2007         need_flush = true;
2008     }
2009     if (trunks != s->trunks) {
2010         free(trunks);
2011     }
2012
2013     /* Bonding. */
2014     if (!list_is_short(&bundle->ports)) {
2015         bundle->ofproto->has_bonded_bundles = true;
2016         if (bundle->bond) {
2017             if (bond_reconfigure(bundle->bond, s->bond)) {
2018                 ofproto->need_revalidate = REV_RECONFIGURE;
2019             }
2020         } else {
2021             bundle->bond = bond_create(s->bond);
2022             ofproto->need_revalidate = REV_RECONFIGURE;
2023         }
2024
2025         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2026             bond_slave_register(bundle->bond, port, port->bond_stable_id,
2027                                 port->up.netdev);
2028         }
2029     } else {
2030         bond_destroy(bundle->bond);
2031         bundle->bond = NULL;
2032     }
2033
2034     /* If we changed something that would affect MAC learning, un-learn
2035      * everything on this port and force flow revalidation. */
2036     if (need_flush) {
2037         bundle_flush_macs(bundle, false);
2038     }
2039
2040     return 0;
2041 }
2042
2043 static void
2044 bundle_remove(struct ofport *port_)
2045 {
2046     struct ofport_dpif *port = ofport_dpif_cast(port_);
2047     struct ofbundle *bundle = port->bundle;
2048
2049     if (bundle) {
2050         bundle_del_port(port);
2051         if (list_is_empty(&bundle->ports)) {
2052             bundle_destroy(bundle);
2053         } else if (list_is_short(&bundle->ports)) {
2054             bond_destroy(bundle->bond);
2055             bundle->bond = NULL;
2056         }
2057     }
2058 }
2059
2060 static void
2061 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
2062 {
2063     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
2064     struct ofport_dpif *port = port_;
2065     uint8_t ea[ETH_ADDR_LEN];
2066     int error;
2067
2068     error = netdev_get_etheraddr(port->up.netdev, ea);
2069     if (!error) {
2070         struct ofpbuf packet;
2071         void *packet_pdu;
2072
2073         ofpbuf_init(&packet, 0);
2074         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
2075                                  pdu_size);
2076         memcpy(packet_pdu, pdu, pdu_size);
2077
2078         send_packet(port, &packet);
2079         ofpbuf_uninit(&packet);
2080     } else {
2081         VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
2082                     "%s (%s)", port->bundle->name,
2083                     netdev_get_name(port->up.netdev), strerror(error));
2084     }
2085 }
2086
2087 static void
2088 bundle_send_learning_packets(struct ofbundle *bundle)
2089 {
2090     struct ofproto_dpif *ofproto = bundle->ofproto;
2091     int error, n_packets, n_errors;
2092     struct mac_entry *e;
2093
2094     error = n_packets = n_errors = 0;
2095     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
2096         if (e->port.p != bundle) {
2097             struct ofpbuf *learning_packet;
2098             struct ofport_dpif *port;
2099             void *port_void;
2100             int ret;
2101
2102             /* The assignment to "port" is unnecessary but makes "grep"ing for
2103              * struct ofport_dpif more effective. */
2104             learning_packet = bond_compose_learning_packet(bundle->bond,
2105                                                            e->mac, e->vlan,
2106                                                            &port_void);
2107             port = port_void;
2108             ret = send_packet(port, learning_packet);
2109             ofpbuf_delete(learning_packet);
2110             if (ret) {
2111                 error = ret;
2112                 n_errors++;
2113             }
2114             n_packets++;
2115         }
2116     }
2117
2118     if (n_errors) {
2119         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2120         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2121                      "packets, last error was: %s",
2122                      bundle->name, n_errors, n_packets, strerror(error));
2123     } else {
2124         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2125                  bundle->name, n_packets);
2126     }
2127 }
2128
2129 static void
2130 bundle_run(struct ofbundle *bundle)
2131 {
2132     if (bundle->lacp) {
2133         lacp_run(bundle->lacp, send_pdu_cb);
2134     }
2135     if (bundle->bond) {
2136         struct ofport_dpif *port;
2137
2138         LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2139             bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
2140         }
2141
2142         bond_run(bundle->bond, &bundle->ofproto->revalidate_set,
2143                  lacp_status(bundle->lacp));
2144         if (bond_should_send_learning_packets(bundle->bond)) {
2145             bundle_send_learning_packets(bundle);
2146         }
2147     }
2148 }
2149
2150 static void
2151 bundle_wait(struct ofbundle *bundle)
2152 {
2153     if (bundle->lacp) {
2154         lacp_wait(bundle->lacp);
2155     }
2156     if (bundle->bond) {
2157         bond_wait(bundle->bond);
2158     }
2159 }
2160 \f
2161 /* Mirrors. */
2162
2163 static int
2164 mirror_scan(struct ofproto_dpif *ofproto)
2165 {
2166     int idx;
2167
2168     for (idx = 0; idx < MAX_MIRRORS; idx++) {
2169         if (!ofproto->mirrors[idx]) {
2170             return idx;
2171         }
2172     }
2173     return -1;
2174 }
2175
2176 static struct ofmirror *
2177 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2178 {
2179     int i;
2180
2181     for (i = 0; i < MAX_MIRRORS; i++) {
2182         struct ofmirror *mirror = ofproto->mirrors[i];
2183         if (mirror && mirror->aux == aux) {
2184             return mirror;
2185         }
2186     }
2187
2188     return NULL;
2189 }
2190
2191 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2192 static void
2193 mirror_update_dups(struct ofproto_dpif *ofproto)
2194 {
2195     int i;
2196
2197     for (i = 0; i < MAX_MIRRORS; i++) {
2198         struct ofmirror *m = ofproto->mirrors[i];
2199
2200         if (m) {
2201             m->dup_mirrors = MIRROR_MASK_C(1) << i;
2202         }
2203     }
2204
2205     for (i = 0; i < MAX_MIRRORS; i++) {
2206         struct ofmirror *m1 = ofproto->mirrors[i];
2207         int j;
2208
2209         if (!m1) {
2210             continue;
2211         }
2212
2213         for (j = i + 1; j < MAX_MIRRORS; j++) {
2214             struct ofmirror *m2 = ofproto->mirrors[j];
2215
2216             if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2217                 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2218                 m2->dup_mirrors |= m1->dup_mirrors;
2219             }
2220         }
2221     }
2222 }
2223
2224 static int
2225 mirror_set(struct ofproto *ofproto_, void *aux,
2226            const struct ofproto_mirror_settings *s)
2227 {
2228     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2229     mirror_mask_t mirror_bit;
2230     struct ofbundle *bundle;
2231     struct ofmirror *mirror;
2232     struct ofbundle *out;
2233     struct hmapx srcs;          /* Contains "struct ofbundle *"s. */
2234     struct hmapx dsts;          /* Contains "struct ofbundle *"s. */
2235     int out_vlan;
2236
2237     mirror = mirror_lookup(ofproto, aux);
2238     if (!s) {
2239         mirror_destroy(mirror);
2240         return 0;
2241     }
2242     if (!mirror) {
2243         int idx;
2244
2245         idx = mirror_scan(ofproto);
2246         if (idx < 0) {
2247             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2248                       "cannot create %s",
2249                       ofproto->up.name, MAX_MIRRORS, s->name);
2250             return EFBIG;
2251         }
2252
2253         mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2254         mirror->ofproto = ofproto;
2255         mirror->idx = idx;
2256         mirror->aux = aux;
2257         mirror->out_vlan = -1;
2258         mirror->name = NULL;
2259     }
2260
2261     if (!mirror->name || strcmp(s->name, mirror->name)) {
2262         free(mirror->name);
2263         mirror->name = xstrdup(s->name);
2264     }
2265
2266     /* Get the new configuration. */
2267     if (s->out_bundle) {
2268         out = bundle_lookup(ofproto, s->out_bundle);
2269         if (!out) {
2270             mirror_destroy(mirror);
2271             return EINVAL;
2272         }
2273         out_vlan = -1;
2274     } else {
2275         out = NULL;
2276         out_vlan = s->out_vlan;
2277     }
2278     bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2279     bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2280
2281     /* If the configuration has not changed, do nothing. */
2282     if (hmapx_equals(&srcs, &mirror->srcs)
2283         && hmapx_equals(&dsts, &mirror->dsts)
2284         && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2285         && mirror->out == out
2286         && mirror->out_vlan == out_vlan)
2287     {
2288         hmapx_destroy(&srcs);
2289         hmapx_destroy(&dsts);
2290         return 0;
2291     }
2292
2293     hmapx_swap(&srcs, &mirror->srcs);
2294     hmapx_destroy(&srcs);
2295
2296     hmapx_swap(&dsts, &mirror->dsts);
2297     hmapx_destroy(&dsts);
2298
2299     free(mirror->vlans);
2300     mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2301
2302     mirror->out = out;
2303     mirror->out_vlan = out_vlan;
2304
2305     /* Update bundles. */
2306     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2307     HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2308         if (hmapx_contains(&mirror->srcs, bundle)) {
2309             bundle->src_mirrors |= mirror_bit;
2310         } else {
2311             bundle->src_mirrors &= ~mirror_bit;
2312         }
2313
2314         if (hmapx_contains(&mirror->dsts, bundle)) {
2315             bundle->dst_mirrors |= mirror_bit;
2316         } else {
2317             bundle->dst_mirrors &= ~mirror_bit;
2318         }
2319
2320         if (mirror->out == bundle) {
2321             bundle->mirror_out |= mirror_bit;
2322         } else {
2323             bundle->mirror_out &= ~mirror_bit;
2324         }
2325     }
2326
2327     ofproto->need_revalidate = REV_RECONFIGURE;
2328     ofproto->has_mirrors = true;
2329     mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
2330     mirror_update_dups(ofproto);
2331
2332     return 0;
2333 }
2334
2335 static void
2336 mirror_destroy(struct ofmirror *mirror)
2337 {
2338     struct ofproto_dpif *ofproto;
2339     mirror_mask_t mirror_bit;
2340     struct ofbundle *bundle;
2341     int i;
2342
2343     if (!mirror) {
2344         return;
2345     }
2346
2347     ofproto = mirror->ofproto;
2348     ofproto->need_revalidate = REV_RECONFIGURE;
2349     mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
2350
2351     mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2352     HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2353         bundle->src_mirrors &= ~mirror_bit;
2354         bundle->dst_mirrors &= ~mirror_bit;
2355         bundle->mirror_out &= ~mirror_bit;
2356     }
2357
2358     hmapx_destroy(&mirror->srcs);
2359     hmapx_destroy(&mirror->dsts);
2360     free(mirror->vlans);
2361
2362     ofproto->mirrors[mirror->idx] = NULL;
2363     free(mirror->name);
2364     free(mirror);
2365
2366     mirror_update_dups(ofproto);
2367
2368     ofproto->has_mirrors = false;
2369     for (i = 0; i < MAX_MIRRORS; i++) {
2370         if (ofproto->mirrors[i]) {
2371             ofproto->has_mirrors = true;
2372             break;
2373         }
2374     }
2375 }
2376
2377 static int
2378 mirror_get_stats(struct ofproto *ofproto_, void *aux,
2379                  uint64_t *packets, uint64_t *bytes)
2380 {
2381     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2382     struct ofmirror *mirror = mirror_lookup(ofproto, aux);
2383
2384     if (!mirror) {
2385         *packets = *bytes = UINT64_MAX;
2386         return 0;
2387     }
2388
2389     *packets = mirror->packet_count;
2390     *bytes = mirror->byte_count;
2391
2392     return 0;
2393 }
2394
2395 static int
2396 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
2397 {
2398     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2399     if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
2400         mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
2401     }
2402     return 0;
2403 }
2404
2405 static bool
2406 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
2407 {
2408     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2409     struct ofbundle *bundle = bundle_lookup(ofproto, aux);
2410     return bundle && bundle->mirror_out != 0;
2411 }
2412
2413 static void
2414 forward_bpdu_changed(struct ofproto *ofproto_)
2415 {
2416     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2417     ofproto->need_revalidate = REV_RECONFIGURE;
2418 }
2419
2420 static void
2421 set_mac_idle_time(struct ofproto *ofproto_, unsigned int idle_time)
2422 {
2423     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2424     mac_learning_set_idle_time(ofproto->ml, idle_time);
2425 }
2426 \f
2427 /* Ports. */
2428
2429 static struct ofport_dpif *
2430 get_ofp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
2431 {
2432     struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
2433     return ofport ? ofport_dpif_cast(ofport) : NULL;
2434 }
2435
2436 static struct ofport_dpif *
2437 get_odp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
2438 {
2439     return get_ofp_port(ofproto, odp_port_to_ofp_port(odp_port));
2440 }
2441
2442 static void
2443 ofproto_port_from_dpif_port(struct ofproto_port *ofproto_port,
2444                             struct dpif_port *dpif_port)
2445 {
2446     ofproto_port->name = dpif_port->name;
2447     ofproto_port->type = dpif_port->type;
2448     ofproto_port->ofp_port = odp_port_to_ofp_port(dpif_port->port_no);
2449 }
2450
2451 static void
2452 port_run_fast(struct ofport_dpif *ofport)
2453 {
2454     if (ofport->cfm && cfm_should_send_ccm(ofport->cfm)) {
2455         struct ofpbuf packet;
2456
2457         ofpbuf_init(&packet, 0);
2458         cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
2459         send_packet(ofport, &packet);
2460         ofpbuf_uninit(&packet);
2461     }
2462 }
2463
2464 static void
2465 port_run(struct ofport_dpif *ofport)
2466 {
2467     long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
2468     bool carrier_changed = carrier_seq != ofport->carrier_seq;
2469     bool enable = netdev_get_carrier(ofport->up.netdev);
2470
2471     ofport->carrier_seq = carrier_seq;
2472
2473     port_run_fast(ofport);
2474     if (ofport->cfm) {
2475         int cfm_opup = cfm_get_opup(ofport->cfm);
2476
2477         cfm_run(ofport->cfm);
2478         enable = enable && !cfm_get_fault(ofport->cfm);
2479
2480         if (cfm_opup >= 0) {
2481             enable = enable && cfm_opup;
2482         }
2483     }
2484
2485     if (ofport->bundle) {
2486         enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
2487         if (carrier_changed) {
2488             lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
2489         }
2490     }
2491
2492     if (ofport->may_enable != enable) {
2493         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2494
2495         if (ofproto->has_bundle_action) {
2496             ofproto->need_revalidate = REV_PORT_TOGGLED;
2497         }
2498     }
2499
2500     ofport->may_enable = enable;
2501 }
2502
2503 static void
2504 port_wait(struct ofport_dpif *ofport)
2505 {
2506     if (ofport->cfm) {
2507         cfm_wait(ofport->cfm);
2508     }
2509 }
2510
2511 static int
2512 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
2513                    struct ofproto_port *ofproto_port)
2514 {
2515     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2516     struct dpif_port dpif_port;
2517     int error;
2518
2519     error = dpif_port_query_by_name(ofproto->dpif, devname, &dpif_port);
2520     if (!error) {
2521         ofproto_port_from_dpif_port(ofproto_port, &dpif_port);
2522     }
2523     return error;
2524 }
2525
2526 static int
2527 port_add(struct ofproto *ofproto_, struct netdev *netdev, uint16_t *ofp_portp)
2528 {
2529     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2530     uint16_t odp_port = UINT16_MAX;
2531     int error;
2532
2533     error = dpif_port_add(ofproto->dpif, netdev, &odp_port);
2534     if (!error) {
2535         *ofp_portp = odp_port_to_ofp_port(odp_port);
2536     }
2537     return error;
2538 }
2539
2540 static int
2541 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
2542 {
2543     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2544     int error;
2545
2546     error = dpif_port_del(ofproto->dpif, ofp_port_to_odp_port(ofp_port));
2547     if (!error) {
2548         struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
2549         if (ofport) {
2550             /* The caller is going to close ofport->up.netdev.  If this is a
2551              * bonded port, then the bond is using that netdev, so remove it
2552              * from the bond.  The client will need to reconfigure everything
2553              * after deleting ports, so then the slave will get re-added. */
2554             bundle_remove(&ofport->up);
2555         }
2556     }
2557     return error;
2558 }
2559
2560 static int
2561 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
2562 {
2563     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2564     int error;
2565
2566     error = netdev_get_stats(ofport->up.netdev, stats);
2567
2568     if (!error && ofport->odp_port == OVSP_LOCAL) {
2569         struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2570
2571         /* ofproto->stats.tx_packets represents packets that we created
2572          * internally and sent to some port (e.g. packets sent with
2573          * send_packet()).  Account for them as if they had come from
2574          * OFPP_LOCAL and got forwarded. */
2575
2576         if (stats->rx_packets != UINT64_MAX) {
2577             stats->rx_packets += ofproto->stats.tx_packets;
2578         }
2579
2580         if (stats->rx_bytes != UINT64_MAX) {
2581             stats->rx_bytes += ofproto->stats.tx_bytes;
2582         }
2583
2584         /* ofproto->stats.rx_packets represents packets that were received on
2585          * some port and we processed internally and dropped (e.g. STP).
2586          * Account for them as if they had been forwarded to OFPP_LOCAL. */
2587
2588         if (stats->tx_packets != UINT64_MAX) {
2589             stats->tx_packets += ofproto->stats.rx_packets;
2590         }
2591
2592         if (stats->tx_bytes != UINT64_MAX) {
2593             stats->tx_bytes += ofproto->stats.rx_bytes;
2594         }
2595     }
2596
2597     return error;
2598 }
2599
2600 /* Account packets for LOCAL port. */
2601 static void
2602 ofproto_update_local_port_stats(const struct ofproto *ofproto_,
2603                                 size_t tx_size, size_t rx_size)
2604 {
2605     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2606
2607     if (rx_size) {
2608         ofproto->stats.rx_packets++;
2609         ofproto->stats.rx_bytes += rx_size;
2610     }
2611     if (tx_size) {
2612         ofproto->stats.tx_packets++;
2613         ofproto->stats.tx_bytes += tx_size;
2614     }
2615 }
2616
2617 struct port_dump_state {
2618     struct dpif_port_dump dump;
2619     bool done;
2620 };
2621
2622 static int
2623 port_dump_start(const struct ofproto *ofproto_, void **statep)
2624 {
2625     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2626     struct port_dump_state *state;
2627
2628     *statep = state = xmalloc(sizeof *state);
2629     dpif_port_dump_start(&state->dump, ofproto->dpif);
2630     state->done = false;
2631     return 0;
2632 }
2633
2634 static int
2635 port_dump_next(const struct ofproto *ofproto_ OVS_UNUSED, void *state_,
2636                struct ofproto_port *port)
2637 {
2638     struct port_dump_state *state = state_;
2639     struct dpif_port dpif_port;
2640
2641     if (dpif_port_dump_next(&state->dump, &dpif_port)) {
2642         ofproto_port_from_dpif_port(port, &dpif_port);
2643         return 0;
2644     } else {
2645         int error = dpif_port_dump_done(&state->dump);
2646         state->done = true;
2647         return error ? error : EOF;
2648     }
2649 }
2650
2651 static int
2652 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
2653 {
2654     struct port_dump_state *state = state_;
2655
2656     if (!state->done) {
2657         dpif_port_dump_done(&state->dump);
2658     }
2659     free(state);
2660     return 0;
2661 }
2662
2663 static int
2664 port_poll(const struct ofproto *ofproto_, char **devnamep)
2665 {
2666     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2667     return dpif_port_poll(ofproto->dpif, devnamep);
2668 }
2669
2670 static void
2671 port_poll_wait(const struct ofproto *ofproto_)
2672 {
2673     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2674     dpif_port_poll_wait(ofproto->dpif);
2675 }
2676
2677 static int
2678 port_is_lacp_current(const struct ofport *ofport_)
2679 {
2680     const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2681     return (ofport->bundle && ofport->bundle->lacp
2682             ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
2683             : -1);
2684 }
2685 \f
2686 /* Upcall handling. */
2687
2688 /* Flow miss batching.
2689  *
2690  * Some dpifs implement operations faster when you hand them off in a batch.
2691  * To allow batching, "struct flow_miss" queues the dpif-related work needed
2692  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
2693  * more packets, plus possibly installing the flow in the dpif.
2694  *
2695  * So far we only batch the operations that affect flow setup time the most.
2696  * It's possible to batch more than that, but the benefit might be minimal. */
2697 struct flow_miss {
2698     struct hmap_node hmap_node;
2699     struct flow flow;
2700     enum odp_key_fitness key_fitness;
2701     const struct nlattr *key;
2702     size_t key_len;
2703     ovs_be16 initial_tci;
2704     struct list packets;
2705     enum dpif_upcall_type upcall_type;
2706 };
2707
2708 struct flow_miss_op {
2709     struct dpif_op dpif_op;
2710     struct subfacet *subfacet;  /* Subfacet  */
2711     void *garbage;              /* Pointer to pass to free(), NULL if none. */
2712     uint64_t stub[1024 / 8];    /* Temporary buffer. */
2713 };
2714
2715 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
2716  * OpenFlow controller as necessary according to their individual
2717  * configurations. */
2718 static void
2719 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
2720                     const struct flow *flow)
2721 {
2722     struct ofputil_packet_in pin;
2723
2724     pin.packet = packet->data;
2725     pin.packet_len = packet->size;
2726     pin.reason = OFPR_NO_MATCH;
2727     pin.controller_id = 0;
2728
2729     pin.table_id = 0;
2730     pin.cookie = 0;
2731
2732     pin.send_len = 0;           /* not used for flow table misses */
2733
2734     flow_get_metadata(flow, &pin.fmd);
2735
2736     /* Registers aren't meaningful on a miss. */
2737     memset(pin.fmd.reg_masks, 0, sizeof pin.fmd.reg_masks);
2738
2739     connmgr_send_packet_in(ofproto->up.connmgr, &pin);
2740 }
2741
2742 static enum slow_path_reason
2743 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
2744                 const struct ofpbuf *packet)
2745 {
2746     struct ofport_dpif *ofport = get_ofp_port(ofproto, flow->in_port);
2747
2748     if (!ofport) {
2749         return 0;
2750     }
2751
2752     if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
2753         if (packet) {
2754             cfm_process_heartbeat(ofport->cfm, packet);
2755         }
2756         return SLOW_CFM;
2757     } else if (ofport->bundle && ofport->bundle->lacp
2758                && flow->dl_type == htons(ETH_TYPE_LACP)) {
2759         if (packet) {
2760             lacp_process_packet(ofport->bundle->lacp, ofport, packet);
2761         }
2762         return SLOW_LACP;
2763     } else if (ofproto->stp && stp_should_process_flow(flow)) {
2764         if (packet) {
2765             stp_process_packet(ofport, packet);
2766         }
2767         return SLOW_STP;
2768     }
2769     return 0;
2770 }
2771
2772 static struct flow_miss *
2773 flow_miss_find(struct hmap *todo, const struct flow *flow, uint32_t hash)
2774 {
2775     struct flow_miss *miss;
2776
2777     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
2778         if (flow_equal(&miss->flow, flow)) {
2779             return miss;
2780         }
2781     }
2782
2783     return NULL;
2784 }
2785
2786 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
2787  * 'packet'.  The caller must initialize op->actions and op->actions_len.  If
2788  * 'miss' is associated with a subfacet the caller must also initialize the
2789  * returned op->subfacet, and if anything needs to be freed after processing
2790  * the op, the caller must initialize op->garbage also. */
2791 static void
2792 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
2793                           struct flow_miss_op *op)
2794 {
2795     if (miss->flow.vlan_tci != miss->initial_tci) {
2796         /* This packet was received on a VLAN splinter port.  We
2797          * added a VLAN to the packet to make the packet resemble
2798          * the flow, but the actions were composed assuming that
2799          * the packet contained no VLAN.  So, we must remove the
2800          * VLAN header from the packet before trying to execute the
2801          * actions. */
2802         eth_pop_vlan(packet);
2803     }
2804
2805     op->subfacet = NULL;
2806     op->garbage = NULL;
2807     op->dpif_op.type = DPIF_OP_EXECUTE;
2808     op->dpif_op.u.execute.key = miss->key;
2809     op->dpif_op.u.execute.key_len = miss->key_len;
2810     op->dpif_op.u.execute.packet = packet;
2811 }
2812
2813 /* Helper for handle_flow_miss_without_facet() and
2814  * handle_flow_miss_with_facet(). */
2815 static void
2816 handle_flow_miss_common(struct rule_dpif *rule,
2817                         struct ofpbuf *packet, const struct flow *flow)
2818 {
2819     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2820
2821     ofproto->n_matches++;
2822
2823     if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
2824         /*
2825          * Extra-special case for fail-open mode.
2826          *
2827          * We are in fail-open mode and the packet matched the fail-open
2828          * rule, but we are connected to a controller too.  We should send
2829          * the packet up to the controller in the hope that it will try to
2830          * set up a flow and thereby allow us to exit fail-open.
2831          *
2832          * See the top-level comment in fail-open.c for more information.
2833          */
2834         send_packet_in_miss(ofproto, packet, flow);
2835     }
2836 }
2837
2838 /* Figures out whether a flow that missed in 'ofproto', whose details are in
2839  * 'miss', is likely to be worth tracking in detail in userspace and (usually)
2840  * installing a datapath flow.  The answer is usually "yes" (a return value of
2841  * true).  However, for short flows the cost of bookkeeping is much higher than
2842  * the benefits, so when the datapath holds a large number of flows we impose
2843  * some heuristics to decide which flows are likely to be worth tracking. */
2844 static bool
2845 flow_miss_should_make_facet(struct ofproto_dpif *ofproto,
2846                             struct flow_miss *miss, uint32_t hash)
2847 {
2848     if (!ofproto->governor) {
2849         size_t n_subfacets;
2850
2851         n_subfacets = hmap_count(&ofproto->subfacets);
2852         if (n_subfacets * 2 <= ofproto->up.flow_eviction_threshold) {
2853             return true;
2854         }
2855
2856         ofproto->governor = governor_create(ofproto->up.name);
2857     }
2858
2859     return governor_should_install_flow(ofproto->governor, hash,
2860                                         list_size(&miss->packets));
2861 }
2862
2863 /* Handles 'miss', which matches 'rule', without creating a facet or subfacet
2864  * or creating any datapath flow.  May add an "execute" operation to 'ops' and
2865  * increment '*n_ops'. */
2866 static void
2867 handle_flow_miss_without_facet(struct flow_miss *miss,
2868                                struct rule_dpif *rule,
2869                                struct flow_miss_op *ops, size_t *n_ops)
2870 {
2871     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2872     struct action_xlate_ctx ctx;
2873     struct ofpbuf *packet;
2874
2875     LIST_FOR_EACH (packet, list_node, &miss->packets) {
2876         struct flow_miss_op *op = &ops[*n_ops];
2877         struct dpif_flow_stats stats;
2878         struct ofpbuf odp_actions;
2879
2880         COVERAGE_INC(facet_suppress);
2881
2882         ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
2883
2884         dpif_flow_stats_extract(&miss->flow, packet, &stats);
2885         rule_credit_stats(rule, &stats);
2886
2887         action_xlate_ctx_init(&ctx, ofproto, &miss->flow, miss->initial_tci,
2888                               rule, 0, packet);
2889         ctx.resubmit_stats = &stats;
2890         xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
2891                       &odp_actions);
2892
2893         if (odp_actions.size) {
2894             struct dpif_execute *execute = &op->dpif_op.u.execute;
2895
2896             init_flow_miss_execute_op(miss, packet, op);
2897             execute->actions = odp_actions.data;
2898             execute->actions_len = odp_actions.size;
2899             op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
2900
2901             (*n_ops)++;
2902         } else {
2903             ofpbuf_uninit(&odp_actions);
2904         }
2905     }
2906 }
2907
2908 /* Handles 'miss', which matches 'facet'.  May add any required datapath
2909  * operations to 'ops', incrementing '*n_ops' for each new op. */
2910 static void
2911 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
2912                             struct flow_miss_op *ops, size_t *n_ops)
2913 {
2914     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
2915     enum subfacet_path want_path;
2916     struct subfacet *subfacet;
2917     struct ofpbuf *packet;
2918
2919     subfacet = subfacet_create(facet,
2920                                miss->key_fitness, miss->key, miss->key_len,
2921                                miss->initial_tci);
2922
2923     LIST_FOR_EACH (packet, list_node, &miss->packets) {
2924         struct flow_miss_op *op = &ops[*n_ops];
2925         struct dpif_flow_stats stats;
2926         struct ofpbuf odp_actions;
2927
2928         handle_flow_miss_common(facet->rule, packet, &miss->flow);
2929
2930         ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
2931         if (!subfacet->actions || subfacet->slow) {
2932             subfacet_make_actions(subfacet, packet, &odp_actions);
2933         }
2934
2935         dpif_flow_stats_extract(&facet->flow, packet, &stats);
2936         subfacet_update_stats(subfacet, &stats);
2937
2938         if (subfacet->actions_len) {
2939             struct dpif_execute *execute = &op->dpif_op.u.execute;
2940
2941             init_flow_miss_execute_op(miss, packet, op);
2942             op->subfacet = subfacet;
2943             if (!subfacet->slow) {
2944                 execute->actions = subfacet->actions;
2945                 execute->actions_len = subfacet->actions_len;
2946                 ofpbuf_uninit(&odp_actions);
2947             } else {
2948                 execute->actions = odp_actions.data;
2949                 execute->actions_len = odp_actions.size;
2950                 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
2951             }
2952
2953             (*n_ops)++;
2954         } else {
2955             ofpbuf_uninit(&odp_actions);
2956         }
2957     }
2958
2959     want_path = subfacet_want_path(subfacet->slow);
2960     if (miss->upcall_type == DPIF_UC_MISS || subfacet->path != want_path) {
2961         struct flow_miss_op *op = &ops[(*n_ops)++];
2962         struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
2963
2964         op->subfacet = subfacet;
2965         op->garbage = NULL;
2966         op->dpif_op.type = DPIF_OP_FLOW_PUT;
2967         put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2968         put->key = miss->key;
2969         put->key_len = miss->key_len;
2970         if (want_path == SF_FAST_PATH) {
2971             put->actions = subfacet->actions;
2972             put->actions_len = subfacet->actions_len;
2973         } else {
2974             compose_slow_path(ofproto, &facet->flow, subfacet->slow,
2975                               op->stub, sizeof op->stub,
2976                               &put->actions, &put->actions_len);
2977         }
2978         put->stats = NULL;
2979     }
2980 }
2981
2982 /* Handles flow miss 'miss' on 'ofproto'.  May add any required datapath
2983  * operations to 'ops', incrementing '*n_ops' for each new op. */
2984 static void
2985 handle_flow_miss(struct ofproto_dpif *ofproto, struct flow_miss *miss,
2986                  struct flow_miss_op *ops, size_t *n_ops)
2987 {
2988     struct facet *facet;
2989     uint32_t hash;
2990
2991     /* The caller must ensure that miss->hmap_node.hash contains
2992      * flow_hash(miss->flow, 0). */
2993     hash = miss->hmap_node.hash;
2994
2995     facet = facet_lookup_valid(ofproto, &miss->flow, hash);
2996     if (!facet) {
2997         struct rule_dpif *rule = rule_dpif_lookup(ofproto, &miss->flow);
2998
2999         if (!flow_miss_should_make_facet(ofproto, miss, hash)) {
3000             handle_flow_miss_without_facet(miss, rule, ops, n_ops);
3001             return;
3002         }
3003
3004         facet = facet_create(rule, &miss->flow, hash);
3005     }
3006     handle_flow_miss_with_facet(miss, facet, ops, n_ops);
3007 }
3008
3009 /* Like odp_flow_key_to_flow(), this function converts the 'key_len' bytes of
3010  * OVS_KEY_ATTR_* attributes in 'key' to a flow structure in 'flow' and returns
3011  * an ODP_FIT_* value that indicates how well 'key' fits our expectations for
3012  * what a flow key should contain.
3013  *
3014  * This function also includes some logic to help make VLAN splinters
3015  * transparent to the rest of the upcall processing logic.  In particular, if
3016  * the extracted in_port is a VLAN splinter port, it replaces flow->in_port by
3017  * the "real" port, sets flow->vlan_tci correctly for the VLAN of the VLAN
3018  * splinter port, and pushes a VLAN header onto 'packet' (if it is nonnull).
3019  *
3020  * Sets '*initial_tci' to the VLAN TCI with which the packet was really
3021  * received, that is, the actual VLAN TCI extracted by odp_flow_key_to_flow().
3022  * (This differs from the value returned in flow->vlan_tci only for packets
3023  * received on VLAN splinters.)
3024  */
3025 static enum odp_key_fitness
3026 ofproto_dpif_extract_flow_key(const struct ofproto_dpif *ofproto,
3027                               const struct nlattr *key, size_t key_len,
3028                               struct flow *flow, ovs_be16 *initial_tci,
3029                               struct ofpbuf *packet)
3030 {
3031     enum odp_key_fitness fitness;
3032
3033     fitness = odp_flow_key_to_flow(key, key_len, flow);
3034     if (fitness == ODP_FIT_ERROR) {
3035         return fitness;
3036     }
3037     *initial_tci = flow->vlan_tci;
3038
3039     if (vsp_adjust_flow(ofproto, flow)) {
3040         if (packet) {
3041             /* Make the packet resemble the flow, so that it gets sent to an
3042              * OpenFlow controller properly, so that it looks correct for
3043              * sFlow, and so that flow_extract() will get the correct vlan_tci
3044              * if it is called on 'packet'.
3045              *
3046              * The allocated space inside 'packet' probably also contains
3047              * 'key', that is, both 'packet' and 'key' are probably part of a
3048              * struct dpif_upcall (see the large comment on that structure
3049              * definition), so pushing data on 'packet' is in general not a
3050              * good idea since it could overwrite 'key' or free it as a side
3051              * effect.  However, it's OK in this special case because we know
3052              * that 'packet' is inside a Netlink attribute: pushing 4 bytes
3053              * will just overwrite the 4-byte "struct nlattr", which is fine
3054              * since we don't need that header anymore. */
3055             eth_push_vlan(packet, flow->vlan_tci);
3056         }
3057
3058         /* Let the caller know that we can't reproduce 'key' from 'flow'. */
3059         if (fitness == ODP_FIT_PERFECT) {
3060             fitness = ODP_FIT_TOO_MUCH;
3061         }
3062     }
3063
3064     return fitness;
3065 }
3066
3067 static void
3068 handle_miss_upcalls(struct ofproto_dpif *ofproto, struct dpif_upcall *upcalls,
3069                     size_t n_upcalls)
3070 {
3071     struct dpif_upcall *upcall;
3072     struct flow_miss *miss;
3073     struct flow_miss misses[FLOW_MISS_MAX_BATCH];
3074     struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
3075     struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
3076     struct hmap todo;
3077     int n_misses;
3078     size_t n_ops;
3079     size_t i;
3080
3081     if (!n_upcalls) {
3082         return;
3083     }
3084
3085     /* Construct the to-do list.
3086      *
3087      * This just amounts to extracting the flow from each packet and sticking
3088      * the packets that have the same flow in the same "flow_miss" structure so
3089      * that we can process them together. */
3090     hmap_init(&todo);
3091     n_misses = 0;
3092     for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
3093         struct flow_miss *miss = &misses[n_misses];
3094         struct flow_miss *existing_miss;
3095         uint32_t hash;
3096
3097         /* Obtain metadata and check userspace/kernel agreement on flow match,
3098          * then set 'flow''s header pointers. */
3099         miss->key_fitness = ofproto_dpif_extract_flow_key(
3100             ofproto, upcall->key, upcall->key_len,
3101             &miss->flow, &miss->initial_tci, upcall->packet);
3102         if (miss->key_fitness == ODP_FIT_ERROR) {
3103             continue;
3104         }
3105         flow_extract(upcall->packet, miss->flow.skb_priority,
3106                      miss->flow.tun_id, miss->flow.in_port, &miss->flow);
3107
3108         /* Add other packets to a to-do list. */
3109         hash = flow_hash(&miss->flow, 0);
3110         existing_miss = flow_miss_find(&todo, &miss->flow, hash);
3111         if (!existing_miss) {
3112             hmap_insert(&todo, &miss->hmap_node, hash);
3113             miss->key = upcall->key;
3114             miss->key_len = upcall->key_len;
3115             miss->upcall_type = upcall->type;
3116             list_init(&miss->packets);
3117
3118             n_misses++;
3119         } else {
3120             miss = existing_miss;
3121         }
3122         list_push_back(&miss->packets, &upcall->packet->list_node);
3123     }
3124
3125     /* Process each element in the to-do list, constructing the set of
3126      * operations to batch. */
3127     n_ops = 0;
3128     HMAP_FOR_EACH (miss, hmap_node, &todo) {
3129         handle_flow_miss(ofproto, miss, flow_miss_ops, &n_ops);
3130     }
3131     assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
3132
3133     /* Execute batch. */
3134     for (i = 0; i < n_ops; i++) {
3135         dpif_ops[i] = &flow_miss_ops[i].dpif_op;
3136     }
3137     dpif_operate(ofproto->dpif, dpif_ops, n_ops);
3138
3139     /* Free memory and update facets. */
3140     for (i = 0; i < n_ops; i++) {
3141         struct flow_miss_op *op = &flow_miss_ops[i];
3142
3143         switch (op->dpif_op.type) {
3144         case DPIF_OP_EXECUTE:
3145             break;
3146
3147         case DPIF_OP_FLOW_PUT:
3148             if (!op->dpif_op.error) {
3149                 op->subfacet->path = subfacet_want_path(op->subfacet->slow);
3150             }
3151             break;
3152
3153         case DPIF_OP_FLOW_DEL:
3154             NOT_REACHED();
3155         }
3156
3157         free(op->garbage);
3158     }
3159     hmap_destroy(&todo);
3160 }
3161
3162 static enum { SFLOW_UPCALL, MISS_UPCALL, BAD_UPCALL }
3163 classify_upcall(const struct dpif_upcall *upcall)
3164 {
3165     union user_action_cookie cookie;
3166
3167     /* First look at the upcall type. */
3168     switch (upcall->type) {
3169     case DPIF_UC_ACTION:
3170         break;
3171
3172     case DPIF_UC_MISS:
3173         return MISS_UPCALL;
3174
3175     case DPIF_N_UC_TYPES:
3176     default:
3177         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
3178         return BAD_UPCALL;
3179     }
3180
3181     /* "action" upcalls need a closer look. */
3182     memcpy(&cookie, &upcall->userdata, sizeof(cookie));
3183     switch (cookie.type) {
3184     case USER_ACTION_COOKIE_SFLOW:
3185         return SFLOW_UPCALL;
3186
3187     case USER_ACTION_COOKIE_SLOW_PATH:
3188         return MISS_UPCALL;
3189
3190     case USER_ACTION_COOKIE_UNSPEC:
3191     default:
3192         VLOG_WARN_RL(&rl, "invalid user cookie : 0x%"PRIx64, upcall->userdata);
3193         return BAD_UPCALL;
3194     }
3195 }
3196
3197 static void
3198 handle_sflow_upcall(struct ofproto_dpif *ofproto,
3199                     const struct dpif_upcall *upcall)
3200 {
3201     union user_action_cookie cookie;
3202     enum odp_key_fitness fitness;
3203     ovs_be16 initial_tci;
3204     struct flow flow;
3205
3206     fitness = ofproto_dpif_extract_flow_key(ofproto, upcall->key,
3207                                             upcall->key_len, &flow,
3208                                             &initial_tci, upcall->packet);
3209     if (fitness == ODP_FIT_ERROR) {
3210         return;
3211     }
3212
3213     memcpy(&cookie, &upcall->userdata, sizeof(cookie));
3214     dpif_sflow_received(ofproto->sflow, upcall->packet, &flow, &cookie);
3215 }
3216
3217 static int
3218 handle_upcalls(struct ofproto_dpif *ofproto, unsigned int max_batch)
3219 {
3220     struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
3221     struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
3222     uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
3223     int n_processed;
3224     int n_misses;
3225     int i;
3226
3227     assert(max_batch <= FLOW_MISS_MAX_BATCH);
3228
3229     n_misses = 0;
3230     for (n_processed = 0; n_processed < max_batch; n_processed++) {
3231         struct dpif_upcall *upcall = &misses[n_misses];
3232         struct ofpbuf *buf = &miss_bufs[n_misses];
3233         int error;
3234
3235         ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
3236                         sizeof miss_buf_stubs[n_misses]);
3237         error = dpif_recv(ofproto->dpif, upcall, buf);
3238         if (error) {
3239             ofpbuf_uninit(buf);
3240             break;
3241         }
3242
3243         switch (classify_upcall(upcall)) {
3244         case MISS_UPCALL:
3245             /* Handle it later. */
3246             n_misses++;
3247             break;
3248
3249         case SFLOW_UPCALL:
3250             if (ofproto->sflow) {
3251                 handle_sflow_upcall(ofproto, upcall);
3252             }
3253             ofpbuf_uninit(buf);
3254             break;
3255
3256         case BAD_UPCALL:
3257             ofpbuf_uninit(buf);
3258             break;
3259         }
3260     }
3261
3262     /* Handle deferred MISS_UPCALL processing. */
3263     handle_miss_upcalls(ofproto, misses, n_misses);
3264     for (i = 0; i < n_misses; i++) {
3265         ofpbuf_uninit(&miss_bufs[i]);
3266     }
3267
3268     return n_processed;
3269 }
3270 \f
3271 /* Flow expiration. */
3272
3273 static int subfacet_max_idle(const struct ofproto_dpif *);
3274 static void update_stats(struct ofproto_dpif *);
3275 static void rule_expire(struct rule_dpif *);
3276 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
3277
3278 /* This function is called periodically by run().  Its job is to collect
3279  * updates for the flows that have been installed into the datapath, most
3280  * importantly when they last were used, and then use that information to
3281  * expire flows that have not been used recently.
3282  *
3283  * Returns the number of milliseconds after which it should be called again. */
3284 static int
3285 expire(struct ofproto_dpif *ofproto)
3286 {
3287     struct rule_dpif *rule, *next_rule;
3288     struct oftable *table;
3289     int dp_max_idle;
3290
3291     /* Update stats for each flow in the datapath. */
3292     update_stats(ofproto);
3293
3294     /* Expire subfacets that have been idle too long. */
3295     dp_max_idle = subfacet_max_idle(ofproto);
3296     expire_subfacets(ofproto, dp_max_idle);
3297
3298     /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
3299     OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
3300         struct cls_cursor cursor;
3301
3302         cls_cursor_init(&cursor, &table->cls, NULL);
3303         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
3304             rule_expire(rule);
3305         }
3306     }
3307
3308     /* All outstanding data in existing flows has been accounted, so it's a
3309      * good time to do bond rebalancing. */
3310     if (ofproto->has_bonded_bundles) {
3311         struct ofbundle *bundle;
3312
3313         HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3314             if (bundle->bond) {
3315                 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
3316             }
3317         }
3318     }
3319
3320     return MIN(dp_max_idle, 1000);
3321 }
3322
3323 /* Updates flow table statistics given that the datapath just reported 'stats'
3324  * as 'subfacet''s statistics. */
3325 static void
3326 update_subfacet_stats(struct subfacet *subfacet,
3327                       const struct dpif_flow_stats *stats)
3328 {
3329     struct facet *facet = subfacet->facet;
3330
3331     if (stats->n_packets >= subfacet->dp_packet_count) {
3332         uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
3333         facet->packet_count += extra;
3334     } else {
3335         VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
3336     }
3337
3338     if (stats->n_bytes >= subfacet->dp_byte_count) {
3339         facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
3340     } else {
3341         VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
3342     }
3343
3344     subfacet->dp_packet_count = stats->n_packets;
3345     subfacet->dp_byte_count = stats->n_bytes;
3346
3347     facet->tcp_flags |= stats->tcp_flags;
3348
3349     subfacet_update_time(subfacet, stats->used);
3350     if (facet->accounted_bytes < facet->byte_count) {
3351         facet_learn(facet);
3352         facet_account(facet);
3353         facet->accounted_bytes = facet->byte_count;
3354     }
3355     facet_push_stats(facet);
3356 }
3357
3358 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
3359  * about, or a flow that shouldn't be installed but was anyway.  Delete it. */
3360 static void
3361 delete_unexpected_flow(struct dpif *dpif,
3362                        const struct nlattr *key, size_t key_len)
3363 {
3364     if (!VLOG_DROP_WARN(&rl)) {
3365         struct ds s;
3366
3367         ds_init(&s);
3368         odp_flow_key_format(key, key_len, &s);
3369         VLOG_WARN("unexpected flow from datapath %s", ds_cstr(&s));
3370         ds_destroy(&s);
3371     }
3372
3373     COVERAGE_INC(facet_unexpected);
3374     dpif_flow_del(dpif, key, key_len, NULL);
3375 }
3376
3377 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
3378  *
3379  * This function also pushes statistics updates to rules which each facet
3380  * resubmits into.  Generally these statistics will be accurate.  However, if a
3381  * facet changes the rule it resubmits into at some time in between
3382  * update_stats() runs, it is possible that statistics accrued to the
3383  * old rule will be incorrectly attributed to the new rule.  This could be
3384  * avoided by calling update_stats() whenever rules are created or
3385  * deleted.  However, the performance impact of making so many calls to the
3386  * datapath do not justify the benefit of having perfectly accurate statistics.
3387  */
3388 static void
3389 update_stats(struct ofproto_dpif *p)
3390 {
3391     const struct dpif_flow_stats *stats;
3392     struct dpif_flow_dump dump;
3393     const struct nlattr *key;
3394     size_t key_len;
3395
3396     dpif_flow_dump_start(&dump, p->dpif);
3397     while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
3398         struct subfacet *subfacet;
3399
3400         subfacet = subfacet_find(p, key, key_len);
3401         switch (subfacet ? subfacet->path : SF_NOT_INSTALLED) {
3402         case SF_FAST_PATH:
3403             update_subfacet_stats(subfacet, stats);
3404             break;
3405
3406         case SF_SLOW_PATH:
3407             /* Stats are updated per-packet. */
3408             break;
3409
3410         case SF_NOT_INSTALLED:
3411         default:
3412             delete_unexpected_flow(p->dpif, key, key_len);
3413             break;
3414         }
3415     }
3416     dpif_flow_dump_done(&dump);
3417 }
3418
3419 /* Calculates and returns the number of milliseconds of idle time after which
3420  * subfacets should expire from the datapath.  When a subfacet expires, we fold
3421  * its statistics into its facet, and when a facet's last subfacet expires, we
3422  * fold its statistic into its rule. */
3423 static int
3424 subfacet_max_idle(const struct ofproto_dpif *ofproto)
3425 {
3426     /*
3427      * Idle time histogram.
3428      *
3429      * Most of the time a switch has a relatively small number of subfacets.
3430      * When this is the case we might as well keep statistics for all of them
3431      * in userspace and to cache them in the kernel datapath for performance as
3432      * well.
3433      *
3434      * As the number of subfacets increases, the memory required to maintain
3435      * statistics about them in userspace and in the kernel becomes
3436      * significant.  However, with a large number of subfacets it is likely
3437      * that only a few of them are "heavy hitters" that consume a large amount
3438      * of bandwidth.  At this point, only heavy hitters are worth caching in
3439      * the kernel and maintaining in userspaces; other subfacets we can
3440      * discard.
3441      *
3442      * The technique used to compute the idle time is to build a histogram with
3443      * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each.  Each subfacet
3444      * that is installed in the kernel gets dropped in the appropriate bucket.
3445      * After the histogram has been built, we compute the cutoff so that only
3446      * the most-recently-used 1% of subfacets (but at least
3447      * ofproto->up.flow_eviction_threshold flows) are kept cached.  At least
3448      * the most-recently-used bucket of subfacets is kept, so actually an
3449      * arbitrary number of subfacets can be kept in any given expiration run
3450      * (though the next run will delete most of those unless they receive
3451      * additional data).
3452      *
3453      * This requires a second pass through the subfacets, in addition to the
3454      * pass made by update_stats(), because the former function never looks at
3455      * uninstallable subfacets.
3456      */
3457     enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
3458     enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
3459     int buckets[N_BUCKETS] = { 0 };
3460     int total, subtotal, bucket;
3461     struct subfacet *subfacet;
3462     long long int now;
3463     int i;
3464
3465     total = hmap_count(&ofproto->subfacets);
3466     if (total <= ofproto->up.flow_eviction_threshold) {
3467         return N_BUCKETS * BUCKET_WIDTH;
3468     }
3469
3470     /* Build histogram. */
3471     now = time_msec();
3472     HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
3473         long long int idle = now - subfacet->used;
3474         int bucket = (idle <= 0 ? 0
3475                       : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
3476                       : (unsigned int) idle / BUCKET_WIDTH);
3477         buckets[bucket]++;
3478     }
3479
3480     /* Find the first bucket whose flows should be expired. */
3481     subtotal = bucket = 0;
3482     do {
3483         subtotal += buckets[bucket++];
3484     } while (bucket < N_BUCKETS &&
3485              subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
3486
3487     if (VLOG_IS_DBG_ENABLED()) {
3488         struct ds s;
3489
3490         ds_init(&s);
3491         ds_put_cstr(&s, "keep");
3492         for (i = 0; i < N_BUCKETS; i++) {
3493             if (i == bucket) {
3494                 ds_put_cstr(&s, ", drop");
3495             }
3496             if (buckets[i]) {
3497                 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
3498             }
3499         }
3500         VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
3501         ds_destroy(&s);
3502     }
3503
3504     return bucket * BUCKET_WIDTH;
3505 }
3506
3507 enum { EXPIRE_MAX_BATCH = 50 };
3508
3509 static void
3510 expire_batch(struct ofproto_dpif *ofproto, struct subfacet **subfacets, int n)
3511 {
3512     struct odputil_keybuf keybufs[EXPIRE_MAX_BATCH];
3513     struct dpif_op ops[EXPIRE_MAX_BATCH];
3514     struct dpif_op *opsp[EXPIRE_MAX_BATCH];
3515     struct ofpbuf keys[EXPIRE_MAX_BATCH];
3516     struct dpif_flow_stats stats[EXPIRE_MAX_BATCH];
3517     int i;
3518
3519     for (i = 0; i < n; i++) {
3520         ops[i].type = DPIF_OP_FLOW_DEL;
3521         subfacet_get_key(subfacets[i], &keybufs[i], &keys[i]);
3522         ops[i].u.flow_del.key = keys[i].data;
3523         ops[i].u.flow_del.key_len = keys[i].size;
3524         ops[i].u.flow_del.stats = &stats[i];
3525         opsp[i] = &ops[i];
3526     }
3527
3528     dpif_operate(ofproto->dpif, opsp, n);
3529     for (i = 0; i < n; i++) {
3530         subfacet_reset_dp_stats(subfacets[i], &stats[i]);
3531         subfacets[i]->path = SF_NOT_INSTALLED;
3532         subfacet_destroy(subfacets[i]);
3533     }
3534 }
3535
3536 static void
3537 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
3538 {
3539     /* Cutoff time for most flows. */
3540     long long int normal_cutoff = time_msec() - dp_max_idle;
3541
3542     /* We really want to keep flows for special protocols around, so use a more
3543      * conservative cutoff. */
3544     long long int special_cutoff = time_msec() - 10000;
3545
3546     struct subfacet *subfacet, *next_subfacet;
3547     struct subfacet *batch[EXPIRE_MAX_BATCH];
3548     int n_batch;
3549
3550     n_batch = 0;
3551     HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
3552                         &ofproto->subfacets) {
3553         long long int cutoff;
3554
3555         cutoff = (subfacet->slow & (SLOW_CFM | SLOW_LACP | SLOW_STP)
3556                   ? special_cutoff
3557                   : normal_cutoff);
3558         if (subfacet->used < cutoff) {
3559             if (subfacet->path != SF_NOT_INSTALLED) {
3560                 batch[n_batch++] = subfacet;
3561                 if (n_batch >= EXPIRE_MAX_BATCH) {
3562                     expire_batch(ofproto, batch, n_batch);
3563                     n_batch = 0;
3564                 }
3565             } else {
3566                 subfacet_destroy(subfacet);
3567             }
3568         }
3569     }
3570
3571     if (n_batch > 0) {
3572         expire_batch(ofproto, batch, n_batch);
3573     }
3574 }
3575
3576 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
3577  * then delete it entirely. */
3578 static void
3579 rule_expire(struct rule_dpif *rule)
3580 {
3581     struct facet *facet, *next_facet;
3582     long long int now;
3583     uint8_t reason;
3584
3585     if (rule->up.pending) {
3586         /* We'll have to expire it later. */
3587         return;
3588     }
3589
3590     /* Has 'rule' expired? */
3591     now = time_msec();
3592     if (rule->up.hard_timeout
3593         && now > rule->up.modified + rule->up.hard_timeout * 1000) {
3594         reason = OFPRR_HARD_TIMEOUT;
3595     } else if (rule->up.idle_timeout
3596                && now > rule->up.used + rule->up.idle_timeout * 1000) {
3597         reason = OFPRR_IDLE_TIMEOUT;
3598     } else {
3599         return;
3600     }
3601
3602     COVERAGE_INC(ofproto_dpif_expired);
3603
3604     /* Update stats.  (This is a no-op if the rule expired due to an idle
3605      * timeout, because that only happens when the rule has no facets left.) */
3606     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
3607         facet_remove(facet);
3608     }
3609
3610     /* Get rid of the rule. */
3611     ofproto_rule_expire(&rule->up, reason);
3612 }
3613 \f
3614 /* Facets. */
3615
3616 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
3617  *
3618  * The caller must already have determined that no facet with an identical
3619  * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
3620  * the ofproto's classifier table.
3621  *
3622  * 'hash' must be the return value of flow_hash(flow, 0).
3623  *
3624  * The facet will initially have no subfacets.  The caller should create (at
3625  * least) one subfacet with subfacet_create(). */
3626 static struct facet *
3627 facet_create(struct rule_dpif *rule, const struct flow *flow, uint32_t hash)
3628 {
3629     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3630     struct facet *facet;
3631
3632     facet = xzalloc(sizeof *facet);
3633     facet->used = time_msec();
3634     hmap_insert(&ofproto->facets, &facet->hmap_node, hash);
3635     list_push_back(&rule->facets, &facet->list_node);
3636     facet->rule = rule;
3637     facet->flow = *flow;
3638     list_init(&facet->subfacets);
3639     netflow_flow_init(&facet->nf_flow);
3640     netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
3641
3642     return facet;
3643 }
3644
3645 static void
3646 facet_free(struct facet *facet)
3647 {
3648     free(facet);
3649 }
3650
3651 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
3652  * 'packet', which arrived on 'in_port'.
3653  *
3654  * Takes ownership of 'packet'. */
3655 static bool
3656 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
3657                     const struct nlattr *odp_actions, size_t actions_len,
3658                     struct ofpbuf *packet)
3659 {
3660     struct odputil_keybuf keybuf;
3661     struct ofpbuf key;
3662     int error;
3663
3664     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
3665     odp_flow_key_from_flow(&key, flow);
3666
3667     error = dpif_execute(ofproto->dpif, key.data, key.size,
3668                          odp_actions, actions_len, packet);
3669
3670     ofpbuf_delete(packet);
3671     return !error;
3672 }
3673
3674 /* Remove 'facet' from 'ofproto' and free up the associated memory:
3675  *
3676  *   - If 'facet' was installed in the datapath, uninstalls it and updates its
3677  *     rule's statistics, via subfacet_uninstall().
3678  *
3679  *   - Removes 'facet' from its rule and from ofproto->facets.
3680  */
3681 static void
3682 facet_remove(struct facet *facet)
3683 {
3684     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3685     struct subfacet *subfacet, *next_subfacet;
3686
3687     assert(!list_is_empty(&facet->subfacets));
3688
3689     /* First uninstall all of the subfacets to get final statistics. */
3690     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3691         subfacet_uninstall(subfacet);
3692     }
3693
3694     /* Flush the final stats to the rule.
3695      *
3696      * This might require us to have at least one subfacet around so that we
3697      * can use its actions for accounting in facet_account(), which is why we
3698      * have uninstalled but not yet destroyed the subfacets. */
3699     facet_flush_stats(facet);
3700
3701     /* Now we're really all done so destroy everything. */
3702     LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
3703                         &facet->subfacets) {
3704         subfacet_destroy__(subfacet);
3705     }
3706     hmap_remove(&ofproto->facets, &facet->hmap_node);
3707     list_remove(&facet->list_node);
3708     facet_free(facet);
3709 }
3710
3711 /* Feed information from 'facet' back into the learning table to keep it in
3712  * sync with what is actually flowing through the datapath. */
3713 static void
3714 facet_learn(struct facet *facet)
3715 {
3716     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3717     struct action_xlate_ctx ctx;
3718
3719     if (!facet->has_learn
3720         && !facet->has_normal
3721         && (!facet->has_fin_timeout
3722             || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
3723         return;
3724     }
3725
3726     action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3727                           facet->flow.vlan_tci,
3728                           facet->rule, facet->tcp_flags, NULL);
3729     ctx.may_learn = true;
3730     xlate_actions_for_side_effects(&ctx, facet->rule->up.ofpacts,
3731                                    facet->rule->up.ofpacts_len);
3732 }
3733
3734 static void
3735 facet_account(struct facet *facet)
3736 {
3737     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3738     struct subfacet *subfacet;
3739     const struct nlattr *a;
3740     unsigned int left;
3741     ovs_be16 vlan_tci;
3742     uint64_t n_bytes;
3743
3744     if (!facet->has_normal || !ofproto->has_bonded_bundles) {
3745         return;
3746     }
3747     n_bytes = facet->byte_count - facet->accounted_bytes;
3748
3749     /* This loop feeds byte counters to bond_account() for rebalancing to use
3750      * as a basis.  We also need to track the actual VLAN on which the packet
3751      * is going to be sent to ensure that it matches the one passed to
3752      * bond_choose_output_slave().  (Otherwise, we will account to the wrong
3753      * hash bucket.)
3754      *
3755      * We use the actions from an arbitrary subfacet because they should all
3756      * be equally valid for our purpose. */
3757     subfacet = CONTAINER_OF(list_front(&facet->subfacets),
3758                             struct subfacet, list_node);
3759     vlan_tci = facet->flow.vlan_tci;
3760     NL_ATTR_FOR_EACH_UNSAFE (a, left,
3761                              subfacet->actions, subfacet->actions_len) {
3762         const struct ovs_action_push_vlan *vlan;
3763         struct ofport_dpif *port;
3764
3765         switch (nl_attr_type(a)) {
3766         case OVS_ACTION_ATTR_OUTPUT:
3767             port = get_odp_port(ofproto, nl_attr_get_u32(a));
3768             if (port && port->bundle && port->bundle->bond) {
3769                 bond_account(port->bundle->bond, &facet->flow,
3770                              vlan_tci_to_vid(vlan_tci), n_bytes);
3771             }
3772             break;
3773
3774         case OVS_ACTION_ATTR_POP_VLAN:
3775             vlan_tci = htons(0);
3776             break;
3777
3778         case OVS_ACTION_ATTR_PUSH_VLAN:
3779             vlan = nl_attr_get(a);
3780             vlan_tci = vlan->vlan_tci;
3781             break;
3782         }
3783     }
3784 }
3785
3786 /* Returns true if the only action for 'facet' is to send to the controller.
3787  * (We don't report NetFlow expiration messages for such facets because they
3788  * are just part of the control logic for the network, not real traffic). */
3789 static bool
3790 facet_is_controller_flow(struct facet *facet)
3791 {
3792     if (facet) {
3793         const struct rule *rule = &facet->rule->up;
3794         const struct ofpact *ofpacts = rule->ofpacts;
3795         size_t ofpacts_len = rule->ofpacts_len;
3796
3797         if (ofpacts_len > 0 &&
3798             ofpacts->type == OFPACT_CONTROLLER &&
3799             ofpact_next(ofpacts) >= ofpact_end(ofpacts, ofpacts_len)) {
3800             return true;
3801         }
3802     }
3803     return false;
3804 }
3805
3806 /* Folds all of 'facet''s statistics into its rule.  Also updates the
3807  * accounting ofhook and emits a NetFlow expiration if appropriate.  All of
3808  * 'facet''s statistics in the datapath should have been zeroed and folded into
3809  * its packet and byte counts before this function is called. */
3810 static void
3811 facet_flush_stats(struct facet *facet)
3812 {
3813     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3814     struct subfacet *subfacet;
3815
3816     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3817         assert(!subfacet->dp_byte_count);
3818         assert(!subfacet->dp_packet_count);
3819     }
3820
3821     facet_push_stats(facet);
3822     if (facet->accounted_bytes < facet->byte_count) {
3823         facet_account(facet);
3824         facet->accounted_bytes = facet->byte_count;
3825     }
3826
3827     if (ofproto->netflow && !facet_is_controller_flow(facet)) {
3828         struct ofexpired expired;
3829         expired.flow = facet->flow;
3830         expired.packet_count = facet->packet_count;
3831         expired.byte_count = facet->byte_count;
3832         expired.used = facet->used;
3833         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
3834     }
3835
3836     facet->rule->packet_count += facet->packet_count;
3837     facet->rule->byte_count += facet->byte_count;
3838
3839     /* Reset counters to prevent double counting if 'facet' ever gets
3840      * reinstalled. */
3841     facet_reset_counters(facet);
3842
3843     netflow_flow_clear(&facet->nf_flow);
3844     facet->tcp_flags = 0;
3845 }
3846
3847 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3848  * Returns it if found, otherwise a null pointer.
3849  *
3850  * 'hash' must be the return value of flow_hash(flow, 0).
3851  *
3852  * The returned facet might need revalidation; use facet_lookup_valid()
3853  * instead if that is important. */
3854 static struct facet *
3855 facet_find(struct ofproto_dpif *ofproto,
3856            const struct flow *flow, uint32_t hash)
3857 {
3858     struct facet *facet;
3859
3860     HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, hash, &ofproto->facets) {
3861         if (flow_equal(flow, &facet->flow)) {
3862             return facet;
3863         }
3864     }
3865
3866     return NULL;
3867 }
3868
3869 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3870  * Returns it if found, otherwise a null pointer.
3871  *
3872  * 'hash' must be the return value of flow_hash(flow, 0).
3873  *
3874  * The returned facet is guaranteed to be valid. */
3875 static struct facet *
3876 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow,
3877                    uint32_t hash)
3878 {
3879     struct facet *facet;
3880
3881     facet = facet_find(ofproto, flow, hash);
3882     if (facet
3883         && (ofproto->need_revalidate
3884             || tag_set_intersects(&ofproto->revalidate_set, facet->tags))) {
3885         facet_revalidate(facet);
3886     }
3887
3888     return facet;
3889 }
3890
3891 static const char *
3892 subfacet_path_to_string(enum subfacet_path path)
3893 {
3894     switch (path) {
3895     case SF_NOT_INSTALLED:
3896         return "not installed";
3897     case SF_FAST_PATH:
3898         return "in fast path";
3899     case SF_SLOW_PATH:
3900         return "in slow path";
3901     default:
3902         return "<error>";
3903     }
3904 }
3905
3906 /* Returns the path in which a subfacet should be installed if its 'slow'
3907  * member has the specified value. */
3908 static enum subfacet_path
3909 subfacet_want_path(enum slow_path_reason slow)
3910 {
3911     return slow ? SF_SLOW_PATH : SF_FAST_PATH;
3912 }
3913
3914 /* Returns true if 'subfacet' needs to have its datapath flow updated,
3915  * supposing that its actions have been recalculated as 'want_actions' and that
3916  * 'slow' is nonzero iff 'subfacet' should be in the slow path. */
3917 static bool
3918 subfacet_should_install(struct subfacet *subfacet, enum slow_path_reason slow,
3919                         const struct ofpbuf *want_actions)
3920 {
3921     enum subfacet_path want_path = subfacet_want_path(slow);
3922     return (want_path != subfacet->path
3923             || (want_path == SF_FAST_PATH
3924                 && (subfacet->actions_len != want_actions->size
3925                     || memcmp(subfacet->actions, want_actions->data,
3926                               subfacet->actions_len))));
3927 }
3928
3929 static bool
3930 facet_check_consistency(struct facet *facet)
3931 {
3932     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3933
3934     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3935
3936     uint64_t odp_actions_stub[1024 / 8];
3937     struct ofpbuf odp_actions;
3938
3939     struct rule_dpif *rule;
3940     struct subfacet *subfacet;
3941     bool may_log = false;
3942     bool ok;
3943
3944     /* Check the rule for consistency. */
3945     rule = rule_dpif_lookup(ofproto, &facet->flow);
3946     ok = rule == facet->rule;
3947     if (!ok) {
3948         may_log = !VLOG_DROP_WARN(&rl);
3949         if (may_log) {
3950             struct ds s;
3951
3952             ds_init(&s);
3953             flow_format(&s, &facet->flow);
3954             ds_put_format(&s, ": facet associated with wrong rule (was "
3955                           "table=%"PRIu8",", facet->rule->up.table_id);
3956             cls_rule_format(&facet->rule->up.cr, &s);
3957             ds_put_format(&s, ") (should have been table=%"PRIu8",",
3958                           rule->up.table_id);
3959             cls_rule_format(&rule->up.cr, &s);
3960             ds_put_char(&s, ')');
3961
3962             VLOG_WARN("%s", ds_cstr(&s));
3963             ds_destroy(&s);
3964         }
3965     }
3966
3967     /* Check the datapath actions for consistency. */
3968     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
3969     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3970         enum subfacet_path want_path;
3971         struct odputil_keybuf keybuf;
3972         struct action_xlate_ctx ctx;
3973         struct ofpbuf key;
3974         struct ds s;
3975
3976         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3977                               subfacet->initial_tci, rule, 0, NULL);
3978         xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
3979                       &odp_actions);
3980
3981         if (subfacet->path == SF_NOT_INSTALLED) {
3982             /* This only happens if the datapath reported an error when we
3983              * tried to install the flow.  Don't flag another error here. */
3984             continue;
3985         }
3986
3987         want_path = subfacet_want_path(subfacet->slow);
3988         if (want_path == SF_SLOW_PATH && subfacet->path == SF_SLOW_PATH) {
3989             /* The actions for slow-path flows may legitimately vary from one
3990              * packet to the next.  We're done. */
3991             continue;
3992         }
3993
3994         if (!subfacet_should_install(subfacet, subfacet->slow, &odp_actions)) {
3995             continue;
3996         }
3997
3998         /* Inconsistency! */
3999         if (ok) {
4000             may_log = !VLOG_DROP_WARN(&rl);
4001             ok = false;
4002         }
4003         if (!may_log) {
4004             /* Rate-limited, skip reporting. */
4005             continue;
4006         }
4007
4008         ds_init(&s);
4009         subfacet_get_key(subfacet, &keybuf, &key);
4010         odp_flow_key_format(key.data, key.size, &s);
4011
4012         ds_put_cstr(&s, ": inconsistency in subfacet");
4013         if (want_path != subfacet->path) {
4014             enum odp_key_fitness fitness = subfacet->key_fitness;
4015
4016             ds_put_format(&s, " (%s, fitness=%s)",
4017                           subfacet_path_to_string(subfacet->path),
4018                           odp_key_fitness_to_string(fitness));
4019             ds_put_format(&s, " (should have been %s)",
4020                           subfacet_path_to_string(want_path));
4021         } else if (want_path == SF_FAST_PATH) {
4022             ds_put_cstr(&s, " (actions were: ");
4023             format_odp_actions(&s, subfacet->actions,
4024                                subfacet->actions_len);
4025             ds_put_cstr(&s, ") (correct actions: ");
4026             format_odp_actions(&s, odp_actions.data, odp_actions.size);
4027             ds_put_char(&s, ')');
4028         } else {
4029             ds_put_cstr(&s, " (actions: ");
4030             format_odp_actions(&s, subfacet->actions,
4031                                subfacet->actions_len);
4032             ds_put_char(&s, ')');
4033         }
4034         VLOG_WARN("%s", ds_cstr(&s));
4035         ds_destroy(&s);
4036     }
4037     ofpbuf_uninit(&odp_actions);
4038
4039     return ok;
4040 }
4041
4042 /* Re-searches the classifier for 'facet':
4043  *
4044  *   - If the rule found is different from 'facet''s current rule, moves
4045  *     'facet' to the new rule and recompiles its actions.
4046  *
4047  *   - If the rule found is the same as 'facet''s current rule, leaves 'facet'
4048  *     where it is and recompiles its actions anyway. */
4049 static void
4050 facet_revalidate(struct facet *facet)
4051 {
4052     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4053     struct actions {
4054         struct nlattr *odp_actions;
4055         size_t actions_len;
4056     };
4057     struct actions *new_actions;
4058
4059     struct action_xlate_ctx ctx;
4060     uint64_t odp_actions_stub[1024 / 8];
4061     struct ofpbuf odp_actions;
4062
4063     struct rule_dpif *new_rule;
4064     struct subfacet *subfacet;
4065     int i;
4066
4067     COVERAGE_INC(facet_revalidate);
4068
4069     new_rule = rule_dpif_lookup(ofproto, &facet->flow);
4070
4071     /* Calculate new datapath actions.
4072      *
4073      * We do not modify any 'facet' state yet, because we might need to, e.g.,
4074      * emit a NetFlow expiration and, if so, we need to have the old state
4075      * around to properly compose it. */
4076
4077     /* If the datapath actions changed or the installability changed,
4078      * then we need to talk to the datapath. */
4079     i = 0;
4080     new_actions = NULL;
4081     memset(&ctx, 0, sizeof ctx);
4082     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
4083     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4084         enum slow_path_reason slow;
4085
4086         action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
4087                               subfacet->initial_tci, new_rule, 0, NULL);
4088         xlate_actions(&ctx, new_rule->up.ofpacts, new_rule->up.ofpacts_len,
4089                       &odp_actions);
4090
4091         slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
4092         if (subfacet_should_install(subfacet, slow, &odp_actions)) {
4093             struct dpif_flow_stats stats;
4094
4095             subfacet_install(subfacet,
4096                              odp_actions.data, odp_actions.size, &stats, slow);
4097             subfacet_update_stats(subfacet, &stats);
4098
4099             if (!new_actions) {
4100                 new_actions = xcalloc(list_size(&facet->subfacets),
4101                                       sizeof *new_actions);
4102             }
4103             new_actions[i].odp_actions = xmemdup(odp_actions.data,
4104                                                  odp_actions.size);
4105             new_actions[i].actions_len = odp_actions.size;
4106         }
4107
4108         i++;
4109     }
4110     ofpbuf_uninit(&odp_actions);
4111
4112     if (new_actions) {
4113         facet_flush_stats(facet);
4114     }
4115
4116     /* Update 'facet' now that we've taken care of all the old state. */
4117     facet->tags = ctx.tags;
4118     facet->nf_flow.output_iface = ctx.nf_output_iface;
4119     facet->has_learn = ctx.has_learn;
4120     facet->has_normal = ctx.has_normal;
4121     facet->has_fin_timeout = ctx.has_fin_timeout;
4122     facet->mirrors = ctx.mirrors;
4123
4124     i = 0;
4125     LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4126         subfacet->slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
4127
4128         if (new_actions && new_actions[i].odp_actions) {
4129             free(subfacet->actions);
4130             subfacet->actions = new_actions[i].odp_actions;
4131             subfacet->actions_len = new_actions[i].actions_len;
4132         }
4133         i++;
4134     }
4135     free(new_actions);
4136
4137     if (facet->rule != new_rule) {
4138         COVERAGE_INC(facet_changed_rule);
4139         list_remove(&facet->list_node);
4140         list_push_back(&new_rule->facets, &facet->list_node);
4141         facet->rule = new_rule;
4142         facet->used = new_rule->up.created;
4143         facet->prev_used = facet->used;
4144     }
4145 }
4146
4147 /* Updates 'facet''s used time.  Caller is responsible for calling
4148  * facet_push_stats() to update the flows which 'facet' resubmits into. */
4149 static void
4150 facet_update_time(struct facet *facet, long long int used)
4151 {
4152     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4153     if (used > facet->used) {
4154         facet->used = used;
4155         ofproto_rule_update_used(&facet->rule->up, used);
4156         netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
4157     }
4158 }
4159
4160 static void
4161 facet_reset_counters(struct facet *facet)
4162 {
4163     facet->packet_count = 0;
4164     facet->byte_count = 0;
4165     facet->prev_packet_count = 0;
4166     facet->prev_byte_count = 0;
4167     facet->accounted_bytes = 0;
4168 }
4169
4170 static void
4171 facet_push_stats(struct facet *facet)
4172 {
4173     struct dpif_flow_stats stats;
4174
4175     assert(facet->packet_count >= facet->prev_packet_count);
4176     assert(facet->byte_count >= facet->prev_byte_count);
4177     assert(facet->used >= facet->prev_used);
4178
4179     stats.n_packets = facet->packet_count - facet->prev_packet_count;
4180     stats.n_bytes = facet->byte_count - facet->prev_byte_count;
4181     stats.used = facet->used;
4182     stats.tcp_flags = 0;
4183
4184     if (stats.n_packets || stats.n_bytes || facet->used > facet->prev_used) {
4185         facet->prev_packet_count = facet->packet_count;
4186         facet->prev_byte_count = facet->byte_count;
4187         facet->prev_used = facet->used;
4188
4189         flow_push_stats(facet->rule, &facet->flow, &stats);
4190
4191         update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
4192                             facet->mirrors, stats.n_packets, stats.n_bytes);
4193     }
4194 }
4195
4196 static void
4197 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
4198 {
4199     rule->packet_count += stats->n_packets;
4200     rule->byte_count += stats->n_bytes;
4201     ofproto_rule_update_used(&rule->up, stats->used);
4202 }
4203
4204 /* Pushes flow statistics to the rules which 'flow' resubmits into given
4205  * 'rule''s actions and mirrors. */
4206 static void
4207 flow_push_stats(struct rule_dpif *rule,
4208                 const struct flow *flow, const struct dpif_flow_stats *stats)
4209 {
4210     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4211     struct action_xlate_ctx ctx;
4212
4213     ofproto_rule_update_used(&rule->up, stats->used);
4214
4215     action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci, rule,
4216                           0, NULL);
4217     ctx.resubmit_stats = stats;
4218     xlate_actions_for_side_effects(&ctx, rule->up.ofpacts,
4219                                    rule->up.ofpacts_len);
4220 }
4221 \f
4222 /* Subfacets. */
4223
4224 static struct subfacet *
4225 subfacet_find__(struct ofproto_dpif *ofproto,
4226                 const struct nlattr *key, size_t key_len, uint32_t key_hash,
4227                 const struct flow *flow)
4228 {
4229     struct subfacet *subfacet;
4230
4231     HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
4232                              &ofproto->subfacets) {
4233         if (subfacet->key
4234             ? (subfacet->key_len == key_len
4235                && !memcmp(key, subfacet->key, key_len))
4236             : flow_equal(flow, &subfacet->facet->flow)) {
4237             return subfacet;
4238         }
4239     }
4240
4241     return NULL;
4242 }
4243
4244 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
4245  * 'key_fitness', 'key', and 'key_len'.  Returns the existing subfacet if
4246  * there is one, otherwise creates and returns a new subfacet.
4247  *
4248  * If the returned subfacet is new, then subfacet->actions will be NULL, in
4249  * which case the caller must populate the actions with
4250  * subfacet_make_actions(). */
4251 static struct subfacet *
4252 subfacet_create(struct facet *facet, enum odp_key_fitness key_fitness,
4253                 const struct nlattr *key, size_t key_len, ovs_be16 initial_tci)
4254 {
4255     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4256     uint32_t key_hash = odp_flow_key_hash(key, key_len);
4257     struct subfacet *subfacet;
4258
4259     if (list_is_empty(&facet->subfacets)) {
4260         subfacet = &facet->one_subfacet;
4261
4262         /* This subfacet should conceptually be created, and have its first
4263          * packet pass through, at the same time that its facet was created.
4264          * If we called time_msec() here, then the subfacet could look
4265          * (occasionally) as though it was used some time after the facet was
4266          * used.  That can make a one-packet flow look like it has a nonzero
4267          * duration, which looks odd in e.g. NetFlow statistics. */
4268         subfacet->used = facet->used;
4269     } else {
4270         subfacet = subfacet_find__(ofproto, key, key_len, key_hash,
4271                                    &facet->flow);
4272         if (subfacet) {
4273             if (subfacet->facet == facet) {
4274                 return subfacet;
4275             }
4276
4277             /* This shouldn't happen. */
4278             VLOG_ERR_RL(&rl, "subfacet with wrong facet");
4279             subfacet_destroy(subfacet);
4280         }
4281
4282         subfacet = xmalloc(sizeof *subfacet);
4283         subfacet->used = time_msec();
4284     }
4285
4286     hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
4287     list_push_back(&facet->subfacets, &subfacet->list_node);
4288     subfacet->facet = facet;
4289     subfacet->key_fitness = key_fitness;
4290     if (key_fitness != ODP_FIT_PERFECT) {
4291         subfacet->key = xmemdup(key, key_len);
4292         subfacet->key_len = key_len;
4293     } else {
4294         subfacet->key = NULL;
4295         subfacet->key_len = 0;
4296     }
4297     subfacet->dp_packet_count = 0;
4298     subfacet->dp_byte_count = 0;
4299     subfacet->actions_len = 0;
4300     subfacet->actions = NULL;
4301     subfacet->slow = (subfacet->key_fitness == ODP_FIT_TOO_LITTLE
4302                       ? SLOW_MATCH
4303                       : 0);
4304     subfacet->path = SF_NOT_INSTALLED;
4305     subfacet->initial_tci = initial_tci;
4306
4307     return subfacet;
4308 }
4309
4310 /* Searches 'ofproto' for a subfacet with the given 'key', 'key_len', and
4311  * 'flow'.  Returns the subfacet if one exists, otherwise NULL. */
4312 static struct subfacet *
4313 subfacet_find(struct ofproto_dpif *ofproto,
4314               const struct nlattr *key, size_t key_len)
4315 {
4316     uint32_t key_hash = odp_flow_key_hash(key, key_len);
4317     enum odp_key_fitness fitness;
4318     struct flow flow;
4319
4320     fitness = odp_flow_key_to_flow(key, key_len, &flow);
4321     if (fitness == ODP_FIT_ERROR) {
4322         return NULL;
4323     }
4324
4325     return subfacet_find__(ofproto, key, key_len, key_hash, &flow);
4326 }
4327
4328 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
4329  * its facet within 'ofproto', and frees it. */
4330 static void
4331 subfacet_destroy__(struct subfacet *subfacet)
4332 {
4333     struct facet *facet = subfacet->facet;
4334     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4335
4336     subfacet_uninstall(subfacet);
4337     hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
4338     list_remove(&subfacet->list_node);
4339     free(subfacet->key);
4340     free(subfacet->actions);
4341     if (subfacet != &facet->one_subfacet) {
4342         free(subfacet);
4343     }
4344 }
4345
4346 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
4347  * last remaining subfacet in its facet destroys the facet too. */
4348 static void
4349 subfacet_destroy(struct subfacet *subfacet)
4350 {
4351     struct facet *facet = subfacet->facet;
4352
4353     if (list_is_singleton(&facet->subfacets)) {
4354         /* facet_remove() needs at least one subfacet (it will remove it). */
4355         facet_remove(facet);
4356     } else {
4357         subfacet_destroy__(subfacet);
4358     }
4359 }
4360
4361 /* Initializes 'key' with the sequence of OVS_KEY_ATTR_* Netlink attributes
4362  * that can be used to refer to 'subfacet'.  The caller must provide 'keybuf'
4363  * for use as temporary storage. */
4364 static void
4365 subfacet_get_key(struct subfacet *subfacet, struct odputil_keybuf *keybuf,
4366                  struct ofpbuf *key)
4367 {
4368     if (!subfacet->key) {
4369         ofpbuf_use_stack(key, keybuf, sizeof *keybuf);
4370         odp_flow_key_from_flow(key, &subfacet->facet->flow);
4371     } else {
4372         ofpbuf_use_const(key, subfacet->key, subfacet->key_len);
4373     }
4374 }
4375
4376 /* Composes the datapath actions for 'subfacet' based on its rule's actions.
4377  * Translates the actions into 'odp_actions', which the caller must have
4378  * initialized and is responsible for uninitializing. */
4379 static void
4380 subfacet_make_actions(struct subfacet *subfacet, const struct ofpbuf *packet,
4381                       struct ofpbuf *odp_actions)
4382 {
4383     struct facet *facet = subfacet->facet;
4384     struct rule_dpif *rule = facet->rule;
4385     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4386
4387     struct action_xlate_ctx ctx;
4388
4389     action_xlate_ctx_init(&ctx, ofproto, &facet->flow, subfacet->initial_tci,
4390                           rule, 0, packet);
4391     xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, odp_actions);
4392     facet->tags = ctx.tags;
4393     facet->has_learn = ctx.has_learn;
4394     facet->has_normal = ctx.has_normal;
4395     facet->has_fin_timeout = ctx.has_fin_timeout;
4396     facet->nf_flow.output_iface = ctx.nf_output_iface;
4397     facet->mirrors = ctx.mirrors;
4398
4399     subfacet->slow = (subfacet->slow & SLOW_MATCH) | ctx.slow;
4400     if (subfacet->actions_len != odp_actions->size
4401         || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
4402         free(subfacet->actions);
4403         subfacet->actions_len = odp_actions->size;
4404         subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
4405     }
4406 }
4407
4408 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
4409  * bytes of actions in 'actions'.  If 'stats' is non-null, statistics counters
4410  * in the datapath will be zeroed and 'stats' will be updated with traffic new
4411  * since 'subfacet' was last updated.
4412  *
4413  * Returns 0 if successful, otherwise a positive errno value. */
4414 static int
4415 subfacet_install(struct subfacet *subfacet,
4416                  const struct nlattr *actions, size_t actions_len,
4417                  struct dpif_flow_stats *stats,
4418                  enum slow_path_reason slow)
4419 {
4420     struct facet *facet = subfacet->facet;
4421     struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4422     enum subfacet_path path = subfacet_want_path(slow);
4423     uint64_t slow_path_stub[128 / 8];
4424     struct odputil_keybuf keybuf;
4425     enum dpif_flow_put_flags flags;
4426     struct ofpbuf key;
4427     int ret;
4428
4429     flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
4430     if (stats) {
4431         flags |= DPIF_FP_ZERO_STATS;
4432     }
4433
4434     if (path == SF_SLOW_PATH) {
4435         compose_slow_path(ofproto, &facet->flow, slow,
4436                           slow_path_stub, sizeof slow_path_stub,
4437                           &actions, &actions_len);
4438     }
4439
4440     subfacet_get_key(subfacet, &keybuf, &key);
4441     ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
4442                         actions, actions_len, stats);
4443
4444     if (stats) {
4445         subfacet_reset_dp_stats(subfacet, stats);
4446     }
4447
4448     if (!ret) {
4449         subfacet->path = path;
4450     }
4451     return ret;
4452 }
4453
4454 static int
4455 subfacet_reinstall(struct subfacet *subfacet, struct dpif_flow_stats *stats)
4456 {
4457     return subfacet_install(subfacet, subfacet->actions, subfacet->actions_len,
4458                             stats, subfacet->slow);
4459 }
4460
4461 /* If 'subfacet' is installed in the datapath, uninstalls it. */
4462 static void
4463 subfacet_uninstall(struct subfacet *subfacet)
4464 {
4465     if (subfacet->path != SF_NOT_INSTALLED) {
4466         struct rule_dpif *rule = subfacet->facet->rule;
4467         struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4468         struct odputil_keybuf keybuf;
4469         struct dpif_flow_stats stats;
4470         struct ofpbuf key;
4471         int error;
4472
4473         subfacet_get_key(subfacet, &keybuf, &key);
4474         error = dpif_flow_del(ofproto->dpif, key.data, key.size, &stats);
4475         subfacet_reset_dp_stats(subfacet, &stats);
4476         if (!error) {
4477             subfacet_update_stats(subfacet, &stats);
4478         }
4479         subfacet->path = SF_NOT_INSTALLED;
4480     } else {
4481         assert(subfacet->dp_packet_count == 0);
4482         assert(subfacet->dp_byte_count == 0);
4483     }
4484 }
4485
4486 /* Resets 'subfacet''s datapath statistics counters.  This should be called
4487  * when 'subfacet''s statistics are cleared in the datapath.  If 'stats' is
4488  * non-null, it should contain the statistics returned by dpif when 'subfacet'
4489  * was reset in the datapath.  'stats' will be modified to include only
4490  * statistics new since 'subfacet' was last updated. */
4491 static void
4492 subfacet_reset_dp_stats(struct subfacet *subfacet,
4493                         struct dpif_flow_stats *stats)
4494 {
4495     if (stats
4496         && subfacet->dp_packet_count <= stats->n_packets
4497         && subfacet->dp_byte_count <= stats->n_bytes) {
4498         stats->n_packets -= subfacet->dp_packet_count;
4499         stats->n_bytes -= subfacet->dp_byte_count;
4500     }
4501
4502     subfacet->dp_packet_count = 0;
4503     subfacet->dp_byte_count = 0;
4504 }
4505
4506 /* Updates 'subfacet''s used time.  The caller is responsible for calling
4507  * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
4508 static void
4509 subfacet_update_time(struct subfacet *subfacet, long long int used)
4510 {
4511     if (used > subfacet->used) {
4512         subfacet->used = used;
4513         facet_update_time(subfacet->facet, used);
4514     }
4515 }
4516
4517 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
4518  *
4519  * Because of the meaning of a subfacet's counters, it only makes sense to do
4520  * this if 'stats' are not tracked in the datapath, that is, if 'stats'
4521  * represents a packet that was sent by hand or if it represents statistics
4522  * that have been cleared out of the datapath. */
4523 static void
4524 subfacet_update_stats(struct subfacet *subfacet,
4525                       const struct dpif_flow_stats *stats)
4526 {
4527     if (stats->n_packets || stats->used > subfacet->used) {
4528         struct facet *facet = subfacet->facet;
4529
4530         subfacet_update_time(subfacet, stats->used);
4531         facet->packet_count += stats->n_packets;
4532         facet->byte_count += stats->n_bytes;
4533         facet->tcp_flags |= stats->tcp_flags;
4534         facet_push_stats(facet);
4535         netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
4536     }
4537 }
4538 \f
4539 /* Rules. */
4540
4541 static struct rule_dpif *
4542 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow)
4543 {
4544     struct ofport_dpif *port;
4545     struct rule_dpif *rule;
4546
4547     rule = rule_dpif_lookup__(ofproto, flow, 0);
4548     if (rule) {
4549         return rule;
4550     }
4551
4552     port = get_ofp_port(ofproto, flow->in_port);
4553     if (!port) {
4554         VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, flow->in_port);
4555         return ofproto->miss_rule;
4556     }
4557
4558     if (port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
4559         return ofproto->no_packet_in_rule;
4560     }
4561     return ofproto->miss_rule;
4562 }
4563
4564 static struct rule_dpif *
4565 rule_dpif_lookup__(struct ofproto_dpif *ofproto, const struct flow *flow,
4566                    uint8_t table_id)
4567 {
4568     struct cls_rule *cls_rule;
4569     struct classifier *cls;
4570
4571     if (table_id >= N_TABLES) {
4572         return NULL;
4573     }
4574
4575     cls = &ofproto->up.tables[table_id].cls;
4576     if (flow->nw_frag & FLOW_NW_FRAG_ANY
4577         && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
4578         /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
4579          * are unavailable. */
4580         struct flow ofpc_normal_flow = *flow;
4581         ofpc_normal_flow.tp_src = htons(0);
4582         ofpc_normal_flow.tp_dst = htons(0);
4583         cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
4584     } else {
4585         cls_rule = classifier_lookup(cls, flow);
4586     }
4587     return rule_dpif_cast(rule_from_cls_rule(cls_rule));
4588 }
4589
4590 static void
4591 complete_operation(struct rule_dpif *rule)
4592 {
4593     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4594
4595     rule_invalidate(rule);
4596     if (clogged) {
4597         struct dpif_completion *c = xmalloc(sizeof *c);
4598         c->op = rule->up.pending;
4599         list_push_back(&ofproto->completions, &c->list_node);
4600     } else {
4601         ofoperation_complete(rule->up.pending, 0);
4602     }
4603 }
4604
4605 static struct rule *
4606 rule_alloc(void)
4607 {
4608     struct rule_dpif *rule = xmalloc(sizeof *rule);
4609     return &rule->up;
4610 }
4611
4612 static void
4613 rule_dealloc(struct rule *rule_)
4614 {
4615     struct rule_dpif *rule = rule_dpif_cast(rule_);
4616     free(rule);
4617 }
4618
4619 static enum ofperr
4620 rule_construct(struct rule *rule_)
4621 {
4622     struct rule_dpif *rule = rule_dpif_cast(rule_);
4623     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4624     struct rule_dpif *victim;
4625     uint8_t table_id;
4626     enum ofperr error;
4627
4628     error = ofpacts_check(rule->up.ofpacts, rule->up.ofpacts_len,
4629                           &rule->up.cr.flow, ofproto->max_ports);
4630     if (error) {
4631         return error;
4632     }
4633
4634     rule->packet_count = 0;
4635     rule->byte_count = 0;
4636
4637     victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
4638     if (victim && !list_is_empty(&victim->facets)) {
4639         struct facet *facet;
4640
4641         rule->facets = victim->facets;
4642         list_moved(&rule->facets);
4643         LIST_FOR_EACH (facet, list_node, &rule->facets) {
4644             /* XXX: We're only clearing our local counters here.  It's possible
4645              * that quite a few packets are unaccounted for in the datapath
4646              * statistics.  These will be accounted to the new rule instead of
4647              * cleared as required.  This could be fixed by clearing out the
4648              * datapath statistics for this facet, but currently it doesn't
4649              * seem worth it. */
4650             facet_reset_counters(facet);
4651             facet->rule = rule;
4652         }
4653     } else {
4654         /* Must avoid list_moved() in this case. */
4655         list_init(&rule->facets);
4656     }
4657
4658     table_id = rule->up.table_id;
4659     rule->tag = (victim ? victim->tag
4660                  : table_id == 0 ? 0
4661                  : rule_calculate_tag(&rule->up.cr.flow, &rule->up.cr.wc,
4662                                       ofproto->tables[table_id].basis));
4663
4664     complete_operation(rule);
4665     return 0;
4666 }
4667
4668 static void
4669 rule_destruct(struct rule *rule_)
4670 {
4671     struct rule_dpif *rule = rule_dpif_cast(rule_);
4672     struct facet *facet, *next_facet;
4673
4674     LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4675         facet_revalidate(facet);
4676     }
4677
4678     complete_operation(rule);
4679 }
4680
4681 static void
4682 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
4683 {
4684     struct rule_dpif *rule = rule_dpif_cast(rule_);
4685     struct facet *facet;
4686
4687     /* Start from historical data for 'rule' itself that are no longer tracked
4688      * in facets.  This counts, for example, facets that have expired. */
4689     *packets = rule->packet_count;
4690     *bytes = rule->byte_count;
4691
4692     /* Add any statistics that are tracked by facets.  This includes
4693      * statistical data recently updated by ofproto_update_stats() as well as
4694      * stats for packets that were executed "by hand" via dpif_execute(). */
4695     LIST_FOR_EACH (facet, list_node, &rule->facets) {
4696         *packets += facet->packet_count;
4697         *bytes += facet->byte_count;
4698     }
4699 }
4700
4701 static enum ofperr
4702 rule_execute(struct rule *rule_, const struct flow *flow,
4703              struct ofpbuf *packet)
4704 {
4705     struct rule_dpif *rule = rule_dpif_cast(rule_);
4706     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4707
4708     struct dpif_flow_stats stats;
4709
4710     struct action_xlate_ctx ctx;
4711     uint64_t odp_actions_stub[1024 / 8];
4712     struct ofpbuf odp_actions;
4713
4714     dpif_flow_stats_extract(flow, packet, &stats);
4715     rule_credit_stats(rule, &stats);
4716
4717     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
4718     action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci,
4719                           rule, stats.tcp_flags, packet);
4720     ctx.resubmit_stats = &stats;
4721     xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, &odp_actions);
4722
4723     execute_odp_actions(ofproto, flow, odp_actions.data,
4724                         odp_actions.size, packet);
4725
4726     ofpbuf_uninit(&odp_actions);
4727
4728     return 0;
4729 }
4730
4731 static void
4732 rule_modify_actions(struct rule *rule_)
4733 {
4734     struct rule_dpif *rule = rule_dpif_cast(rule_);
4735     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4736     enum ofperr error;
4737
4738     error = ofpacts_check(rule->up.ofpacts, rule->up.ofpacts_len,
4739                           &rule->up.cr.flow, ofproto->max_ports);
4740     if (error) {
4741         ofoperation_complete(rule->up.pending, error);
4742         return;
4743     }
4744
4745     complete_operation(rule);
4746 }
4747 \f
4748 /* Sends 'packet' out 'ofport'.
4749  * May modify 'packet'.
4750  * Returns 0 if successful, otherwise a positive errno value. */
4751 static int
4752 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
4753 {
4754     const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
4755     struct ofpbuf key, odp_actions;
4756     struct odputil_keybuf keybuf;
4757     uint16_t odp_port;
4758     struct flow flow;
4759     int error;
4760
4761     flow_extract(packet, 0, 0, 0, &flow);
4762     odp_port = vsp_realdev_to_vlandev(ofproto, ofport->odp_port,
4763                                       flow.vlan_tci);
4764     if (odp_port != ofport->odp_port) {
4765         eth_pop_vlan(packet);
4766         flow.vlan_tci = htons(0);
4767     }
4768
4769     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4770     odp_flow_key_from_flow(&key, &flow);
4771
4772     ofpbuf_init(&odp_actions, 32);
4773     compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
4774
4775     nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
4776     error = dpif_execute(ofproto->dpif,
4777                          key.data, key.size,
4778                          odp_actions.data, odp_actions.size,
4779                          packet);
4780     ofpbuf_uninit(&odp_actions);
4781
4782     if (error) {
4783         VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
4784                      ofproto->up.name, odp_port, strerror(error));
4785     }
4786     ofproto_update_local_port_stats(ofport->up.ofproto, packet->size, 0);
4787     return error;
4788 }
4789 \f
4790 /* OpenFlow to datapath action translation. */
4791
4792 static void do_xlate_actions(const struct ofpact *, size_t ofpacts_len,
4793                              struct action_xlate_ctx *);
4794 static void xlate_normal(struct action_xlate_ctx *);
4795
4796 /* Composes an ODP action for a "slow path" action for 'flow' within 'ofproto'.
4797  * The action will state 'slow' as the reason that the action is in the slow
4798  * path.  (This is purely informational: it allows a human viewing "ovs-dpctl
4799  * dump-flows" output to see why a flow is in the slow path.)
4800  *
4801  * The 'stub_size' bytes in 'stub' will be used to store the action.
4802  * 'stub_size' must be large enough for the action.
4803  *
4804  * The action and its size will be stored in '*actionsp' and '*actions_lenp',
4805  * respectively. */
4806 static void
4807 compose_slow_path(const struct ofproto_dpif *ofproto, const struct flow *flow,
4808                   enum slow_path_reason slow,
4809                   uint64_t *stub, size_t stub_size,
4810                   const struct nlattr **actionsp, size_t *actions_lenp)
4811 {
4812     union user_action_cookie cookie;
4813     struct ofpbuf buf;
4814
4815     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
4816     cookie.slow_path.unused = 0;
4817     cookie.slow_path.reason = slow;
4818
4819     ofpbuf_use_stack(&buf, stub, stub_size);
4820     if (slow & (SLOW_CFM | SLOW_LACP | SLOW_STP)) {
4821         uint32_t pid = dpif_port_get_pid(ofproto->dpif, UINT16_MAX);
4822         odp_put_userspace_action(pid, &cookie, &buf);
4823     } else {
4824         put_userspace_action(ofproto, &buf, flow, &cookie);
4825     }
4826     *actionsp = buf.data;
4827     *actions_lenp = buf.size;
4828 }
4829
4830 static size_t
4831 put_userspace_action(const struct ofproto_dpif *ofproto,
4832                      struct ofpbuf *odp_actions,
4833                      const struct flow *flow,
4834                      const union user_action_cookie *cookie)
4835 {
4836     uint32_t pid;
4837
4838     pid = dpif_port_get_pid(ofproto->dpif,
4839                             ofp_port_to_odp_port(flow->in_port));
4840
4841     return odp_put_userspace_action(pid, cookie, odp_actions);
4842 }
4843
4844 static void
4845 compose_sflow_cookie(const struct ofproto_dpif *ofproto,
4846                      ovs_be16 vlan_tci, uint32_t odp_port,
4847                      unsigned int n_outputs, union user_action_cookie *cookie)
4848 {
4849     int ifindex;
4850
4851     cookie->type = USER_ACTION_COOKIE_SFLOW;
4852     cookie->sflow.vlan_tci = vlan_tci;
4853
4854     /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
4855      * port information") for the interpretation of cookie->output. */
4856     switch (n_outputs) {
4857     case 0:
4858         /* 0x40000000 | 256 means "packet dropped for unknown reason". */
4859         cookie->sflow.output = 0x40000000 | 256;
4860         break;
4861
4862     case 1:
4863         ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
4864         if (ifindex) {
4865             cookie->sflow.output = ifindex;
4866             break;
4867         }
4868         /* Fall through. */
4869     default:
4870         /* 0x80000000 means "multiple output ports. */
4871         cookie->sflow.output = 0x80000000 | n_outputs;
4872         break;
4873     }
4874 }
4875
4876 /* Compose SAMPLE action for sFlow. */
4877 static size_t
4878 compose_sflow_action(const struct ofproto_dpif *ofproto,
4879                      struct ofpbuf *odp_actions,
4880                      const struct flow *flow,
4881                      uint32_t odp_port)
4882 {
4883     uint32_t probability;
4884     union user_action_cookie cookie;
4885     size_t sample_offset, actions_offset;
4886     int cookie_offset;
4887
4888     if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
4889         return 0;
4890     }
4891
4892     sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
4893
4894     /* Number of packets out of UINT_MAX to sample. */
4895     probability = dpif_sflow_get_probability(ofproto->sflow);
4896     nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
4897
4898     actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
4899     compose_sflow_cookie(ofproto, htons(0), odp_port,
4900                          odp_port == OVSP_NONE ? 0 : 1, &cookie);
4901     cookie_offset = put_userspace_action(ofproto, odp_actions, flow, &cookie);
4902
4903     nl_msg_end_nested(odp_actions, actions_offset);
4904     nl_msg_end_nested(odp_actions, sample_offset);
4905     return cookie_offset;
4906 }
4907
4908 /* SAMPLE action must be first action in any given list of actions.
4909  * At this point we do not have all information required to build it. So try to
4910  * build sample action as complete as possible. */
4911 static void
4912 add_sflow_action(struct action_xlate_ctx *ctx)
4913 {
4914     ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
4915                                                    ctx->odp_actions,
4916                                                    &ctx->flow, OVSP_NONE);
4917     ctx->sflow_odp_port = 0;
4918     ctx->sflow_n_outputs = 0;
4919 }
4920
4921 /* Fix SAMPLE action according to data collected while composing ODP actions.
4922  * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
4923  * USERSPACE action's user-cookie which is required for sflow. */
4924 static void
4925 fix_sflow_action(struct action_xlate_ctx *ctx)
4926 {
4927     const struct flow *base = &ctx->base_flow;
4928     union user_action_cookie *cookie;
4929
4930     if (!ctx->user_cookie_offset) {
4931         return;
4932     }
4933
4934     cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
4935                        sizeof(*cookie));
4936     assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
4937
4938     compose_sflow_cookie(ctx->ofproto, base->vlan_tci,
4939                          ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
4940 }
4941
4942 static void
4943 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
4944                         bool check_stp)
4945 {
4946     const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
4947     uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
4948     ovs_be16 flow_vlan_tci = ctx->flow.vlan_tci;
4949     uint8_t flow_nw_tos = ctx->flow.nw_tos;
4950     uint16_t out_port;
4951
4952     if (ofport) {
4953         struct priority_to_dscp *pdscp;
4954
4955         if (ofport->up.pp.config & OFPUTIL_PC_NO_FWD
4956             || (check_stp && !stp_forward_in_state(ofport->stp_state))) {
4957             return;
4958         }
4959
4960         pdscp = get_priority(ofport, ctx->flow.skb_priority);
4961         if (pdscp) {
4962             ctx->flow.nw_tos &= ~IP_DSCP_MASK;
4963             ctx->flow.nw_tos |= pdscp->dscp;
4964         }
4965     } else {
4966         /* We may not have an ofport record for this port, but it doesn't hurt
4967          * to allow forwarding to it anyhow.  Maybe such a port will appear
4968          * later and we're pre-populating the flow table.  */
4969     }
4970
4971     out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
4972                                       ctx->flow.vlan_tci);
4973     if (out_port != odp_port) {
4974         ctx->flow.vlan_tci = htons(0);
4975     }
4976     commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
4977     nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
4978
4979     ctx->sflow_odp_port = odp_port;
4980     ctx->sflow_n_outputs++;
4981     ctx->nf_output_iface = ofp_port;
4982     ctx->flow.vlan_tci = flow_vlan_tci;
4983     ctx->flow.nw_tos = flow_nw_tos;
4984 }
4985
4986 static void
4987 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
4988 {
4989     compose_output_action__(ctx, ofp_port, true);
4990 }
4991
4992 static void
4993 xlate_table_action(struct action_xlate_ctx *ctx,
4994                    uint16_t in_port, uint8_t table_id)
4995 {
4996     if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
4997         struct ofproto_dpif *ofproto = ctx->ofproto;
4998         struct rule_dpif *rule;
4999         uint16_t old_in_port;
5000         uint8_t old_table_id;
5001
5002         old_table_id = ctx->table_id;
5003         ctx->table_id = table_id;
5004
5005         /* Look up a flow with 'in_port' as the input port. */
5006         old_in_port = ctx->flow.in_port;
5007         ctx->flow.in_port = in_port;
5008         rule = rule_dpif_lookup__(ofproto, &ctx->flow, table_id);
5009
5010         /* Tag the flow. */
5011         if (table_id > 0 && table_id < N_TABLES) {
5012             struct table_dpif *table = &ofproto->tables[table_id];
5013             if (table->other_table) {
5014                 ctx->tags |= (rule && rule->tag
5015                               ? rule->tag
5016                               : rule_calculate_tag(&ctx->flow,
5017                                                    &table->other_table->wc,
5018                                                    table->basis));
5019             }
5020         }
5021
5022         /* Restore the original input port.  Otherwise OFPP_NORMAL and
5023          * OFPP_IN_PORT will have surprising behavior. */
5024         ctx->flow.in_port = old_in_port;
5025
5026         if (ctx->resubmit_hook) {
5027             ctx->resubmit_hook(ctx, rule);
5028         }
5029
5030         if (rule) {
5031             struct rule_dpif *old_rule = ctx->rule;
5032
5033             if (ctx->resubmit_stats) {
5034                 rule_credit_stats(rule, ctx->resubmit_stats);
5035             }
5036
5037             ctx->recurse++;
5038             ctx->rule = rule;
5039             do_xlate_actions(rule->up.ofpacts, rule->up.ofpacts_len, ctx);
5040             ctx->rule = old_rule;
5041             ctx->recurse--;
5042         }
5043
5044         ctx->table_id = old_table_id;
5045     } else {
5046         static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
5047
5048         VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
5049                     MAX_RESUBMIT_RECURSION);
5050         ctx->max_resubmit_trigger = true;
5051     }
5052 }
5053
5054 static void
5055 xlate_ofpact_resubmit(struct action_xlate_ctx *ctx,
5056                       const struct ofpact_resubmit *resubmit)
5057 {
5058     uint16_t in_port;
5059     uint8_t table_id;
5060
5061     in_port = resubmit->in_port;
5062     if (in_port == OFPP_IN_PORT) {
5063         in_port = ctx->flow.in_port;
5064     }
5065
5066     table_id = resubmit->table_id;
5067     if (table_id == 255) {
5068         table_id = ctx->table_id;
5069     }
5070
5071     xlate_table_action(ctx, in_port, table_id);
5072 }
5073
5074 static void
5075 flood_packets(struct action_xlate_ctx *ctx, bool all)
5076 {
5077     struct ofport_dpif *ofport;
5078
5079     HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
5080         uint16_t ofp_port = ofport->up.ofp_port;
5081
5082         if (ofp_port == ctx->flow.in_port) {
5083             continue;
5084         }
5085
5086         if (all) {
5087             compose_output_action__(ctx, ofp_port, false);
5088         } else if (!(ofport->up.pp.config & OFPUTIL_PC_NO_FLOOD)) {
5089             compose_output_action(ctx, ofp_port);
5090         }
5091     }
5092
5093     ctx->nf_output_iface = NF_OUT_FLOOD;
5094 }
5095
5096 static void
5097 execute_controller_action(struct action_xlate_ctx *ctx, int len,
5098                           enum ofp_packet_in_reason reason,
5099                           uint16_t controller_id)
5100 {
5101     struct ofputil_packet_in pin;
5102     struct ofpbuf *packet;
5103
5104     ctx->slow |= SLOW_CONTROLLER;
5105     if (!ctx->packet) {
5106         return;
5107     }
5108
5109     packet = ofpbuf_clone(ctx->packet);
5110
5111     if (packet->l2 && packet->l3) {
5112         struct eth_header *eh;
5113
5114         eth_pop_vlan(packet);
5115         eh = packet->l2;
5116
5117         /* If the Ethernet type is less than ETH_TYPE_MIN, it's likely an 802.2
5118          * LLC frame.  Calculating the Ethernet type of these frames is more
5119          * trouble than seems appropriate for a simple assertion. */
5120         assert(ntohs(eh->eth_type) < ETH_TYPE_MIN
5121                || eh->eth_type == ctx->flow.dl_type);
5122
5123         memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
5124         memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
5125
5126         if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
5127             eth_push_vlan(packet, ctx->flow.vlan_tci);
5128         }
5129
5130         if (packet->l4) {
5131             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
5132                 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
5133                                 ctx->flow.nw_tos, ctx->flow.nw_ttl);
5134             }
5135
5136             if (packet->l7) {
5137                 if (ctx->flow.nw_proto == IPPROTO_TCP) {
5138                     packet_set_tcp_port(packet, ctx->flow.tp_src,
5139                                         ctx->flow.tp_dst);
5140                 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
5141                     packet_set_udp_port(packet, ctx->flow.tp_src,
5142                                         ctx->flow.tp_dst);
5143                 }
5144             }
5145         }
5146     }
5147
5148     pin.packet = packet->data;
5149     pin.packet_len = packet->size;
5150     pin.reason = reason;
5151     pin.controller_id = controller_id;
5152     pin.table_id = ctx->table_id;
5153     pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
5154
5155     pin.send_len = len;
5156     flow_get_metadata(&ctx->flow, &pin.fmd);
5157
5158     connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin);
5159     ofpbuf_delete(packet);
5160 }
5161
5162 static bool
5163 compose_dec_ttl(struct action_xlate_ctx *ctx, struct ofpact_cnt_ids *ids)
5164 {
5165     if (ctx->flow.dl_type != htons(ETH_TYPE_IP) &&
5166         ctx->flow.dl_type != htons(ETH_TYPE_IPV6)) {
5167         return false;
5168     }
5169
5170     if (ctx->flow.nw_ttl > 1) {
5171         ctx->flow.nw_ttl--;
5172         return false;
5173     } else {
5174         size_t i;
5175
5176         for (i = 0; i < ids->n_controllers; i++) {
5177             execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL,
5178                                       ids->cnt_ids[i]);
5179         }
5180
5181         /* Stop processing for current table. */
5182         return true;
5183     }
5184 }
5185
5186 static void
5187 xlate_output_action(struct action_xlate_ctx *ctx,
5188                     uint16_t port, uint16_t max_len)
5189 {
5190     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
5191
5192     ctx->nf_output_iface = NF_OUT_DROP;
5193
5194     switch (port) {
5195     case OFPP_IN_PORT:
5196         compose_output_action(ctx, ctx->flow.in_port);
5197         break;
5198     case OFPP_TABLE:
5199         xlate_table_action(ctx, ctx->flow.in_port, 0);
5200         break;
5201     case OFPP_NORMAL:
5202         xlate_normal(ctx);
5203         break;
5204     case OFPP_FLOOD:
5205         flood_packets(ctx,  false);
5206         break;
5207     case OFPP_ALL:
5208         flood_packets(ctx, true);
5209         break;
5210     case OFPP_CONTROLLER:
5211         execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
5212         break;
5213     case OFPP_NONE:
5214         break;
5215     case OFPP_LOCAL:
5216     default:
5217         if (port != ctx->flow.in_port) {
5218             compose_output_action(ctx, port);
5219         }
5220         break;
5221     }
5222
5223     if (prev_nf_output_iface == NF_OUT_FLOOD) {
5224         ctx->nf_output_iface = NF_OUT_FLOOD;
5225     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
5226         ctx->nf_output_iface = prev_nf_output_iface;
5227     } else if (prev_nf_output_iface != NF_OUT_DROP &&
5228                ctx->nf_output_iface != NF_OUT_FLOOD) {
5229         ctx->nf_output_iface = NF_OUT_MULTI;
5230     }
5231 }
5232
5233 static void
5234 xlate_output_reg_action(struct action_xlate_ctx *ctx,
5235                         const struct ofpact_output_reg *or)
5236 {
5237     uint64_t port = mf_get_subfield(&or->src, &ctx->flow);
5238     if (port <= UINT16_MAX) {
5239         xlate_output_action(ctx, port, or->max_len);
5240     }
5241 }
5242
5243 static void
5244 xlate_enqueue_action(struct action_xlate_ctx *ctx,
5245                      const struct ofpact_enqueue *enqueue)
5246 {
5247     uint16_t ofp_port = enqueue->port;
5248     uint32_t queue_id = enqueue->queue;
5249     uint32_t flow_priority, priority;
5250     int error;
5251
5252     /* Translate queue to priority. */
5253     error = dpif_queue_to_priority(ctx->ofproto->dpif, queue_id, &priority);
5254     if (error) {
5255         /* Fall back to ordinary output action. */
5256         xlate_output_action(ctx, enqueue->port, 0);
5257         return;
5258     }
5259
5260     /* Check output port. */
5261     if (ofp_port == OFPP_IN_PORT) {
5262         ofp_port = ctx->flow.in_port;
5263     } else if (ofp_port == ctx->flow.in_port) {
5264         return;
5265     }
5266
5267     /* Add datapath actions. */
5268     flow_priority = ctx->flow.skb_priority;
5269     ctx->flow.skb_priority = priority;
5270     compose_output_action(ctx, ofp_port);
5271     ctx->flow.skb_priority = flow_priority;
5272
5273     /* Update NetFlow output port. */
5274     if (ctx->nf_output_iface == NF_OUT_DROP) {
5275         ctx->nf_output_iface = ofp_port;
5276     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
5277         ctx->nf_output_iface = NF_OUT_MULTI;
5278     }
5279 }
5280
5281 static void
5282 xlate_set_queue_action(struct action_xlate_ctx *ctx, uint32_t queue_id)
5283 {
5284     uint32_t skb_priority;
5285
5286     if (!dpif_queue_to_priority(ctx->ofproto->dpif, queue_id, &skb_priority)) {
5287         ctx->flow.skb_priority = skb_priority;
5288     } else {
5289         /* Couldn't translate queue to a priority.  Nothing to do.  A warning
5290          * has already been logged. */
5291     }
5292 }
5293
5294 struct xlate_reg_state {
5295     ovs_be16 vlan_tci;
5296     ovs_be64 tun_id;
5297 };
5298
5299 static void
5300 xlate_autopath(struct action_xlate_ctx *ctx,
5301                const struct ofpact_autopath *ap)
5302 {
5303     uint16_t ofp_port = ap->port;
5304     struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
5305
5306     if (!port || !port->bundle) {
5307         ofp_port = OFPP_NONE;
5308     } else if (port->bundle->bond) {
5309         /* Autopath does not support VLAN hashing. */
5310         struct ofport_dpif *slave = bond_choose_output_slave(
5311             port->bundle->bond, &ctx->flow, 0, &ctx->tags);
5312         if (slave) {
5313             ofp_port = slave->up.ofp_port;
5314         }
5315     }
5316     nxm_reg_load(&ap->dst, ofp_port, &ctx->flow);
5317 }
5318
5319 static bool
5320 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
5321 {
5322     struct ofproto_dpif *ofproto = ofproto_;
5323     struct ofport_dpif *port;
5324
5325     switch (ofp_port) {
5326     case OFPP_IN_PORT:
5327     case OFPP_TABLE:
5328     case OFPP_NORMAL:
5329     case OFPP_FLOOD:
5330     case OFPP_ALL:
5331     case OFPP_NONE:
5332         return true;
5333     case OFPP_CONTROLLER: /* Not supported by the bundle action. */
5334         return false;
5335     default:
5336         port = get_ofp_port(ofproto, ofp_port);
5337         return port ? port->may_enable : false;
5338     }
5339 }
5340
5341 static void
5342 xlate_bundle_action(struct action_xlate_ctx *ctx,
5343                     const struct ofpact_bundle *bundle)
5344 {
5345     uint16_t port;
5346
5347     port = bundle_execute(bundle, &ctx->flow, slave_enabled_cb, ctx->ofproto);
5348     if (bundle->dst.field) {
5349         nxm_reg_load(&bundle->dst, port, &ctx->flow);
5350     } else {
5351         xlate_output_action(ctx, port, 0);
5352     }
5353 }
5354
5355 static void
5356 xlate_learn_action(struct action_xlate_ctx *ctx,
5357                    const struct ofpact_learn *learn)
5358 {
5359     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
5360     struct ofputil_flow_mod fm;
5361     uint64_t ofpacts_stub[1024 / 8];
5362     struct ofpbuf ofpacts;
5363     int error;
5364
5365     ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
5366     learn_execute(learn, &ctx->flow, &fm, &ofpacts);
5367
5368     error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
5369     if (error && !VLOG_DROP_WARN(&rl)) {
5370         VLOG_WARN("learning action failed to modify flow table (%s)",
5371                   ofperr_get_name(error));
5372     }
5373
5374     ofpbuf_uninit(&ofpacts);
5375 }
5376
5377 /* Reduces '*timeout' to no more than 'max'.  A value of zero in either case
5378  * means "infinite". */
5379 static void
5380 reduce_timeout(uint16_t max, uint16_t *timeout)
5381 {
5382     if (max && (!*timeout || *timeout > max)) {
5383         *timeout = max;
5384     }
5385 }
5386
5387 static void
5388 xlate_fin_timeout(struct action_xlate_ctx *ctx,
5389                   const struct ofpact_fin_timeout *oft)
5390 {
5391     if (ctx->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
5392         struct rule_dpif *rule = ctx->rule;
5393
5394         reduce_timeout(oft->fin_idle_timeout, &rule->up.idle_timeout);
5395         reduce_timeout(oft->fin_hard_timeout, &rule->up.hard_timeout);
5396     }
5397 }
5398
5399 static bool
5400 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
5401 {
5402     if (port->up.pp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
5403                               ? OFPUTIL_PC_NO_RECV_STP
5404                               : OFPUTIL_PC_NO_RECV)) {
5405         return false;
5406     }
5407
5408     /* Only drop packets here if both forwarding and learning are
5409      * disabled.  If just learning is enabled, we need to have
5410      * OFPP_NORMAL and the learning action have a look at the packet
5411      * before we can drop it. */
5412     if (!stp_forward_in_state(port->stp_state)
5413             && !stp_learn_in_state(port->stp_state)) {
5414         return false;
5415     }
5416
5417     return true;
5418 }
5419
5420 static void
5421 do_xlate_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
5422                  struct action_xlate_ctx *ctx)
5423 {
5424     const struct ofport_dpif *port;
5425     bool was_evictable = true;
5426     const struct ofpact *a;
5427
5428     port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
5429     if (port && !may_receive(port, ctx)) {
5430         /* Drop this flow. */
5431         return;
5432     }
5433
5434     if (ctx->rule) {
5435         /* Don't let the rule we're working on get evicted underneath us. */
5436         was_evictable = ctx->rule->up.evictable;
5437         ctx->rule->up.evictable = false;
5438     }
5439     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
5440         struct ofpact_controller *controller;
5441
5442         if (ctx->exit) {
5443             break;
5444         }
5445
5446         switch (a->type) {
5447         case OFPACT_OUTPUT:
5448             xlate_output_action(ctx, ofpact_get_OUTPUT(a)->port,
5449                                 ofpact_get_OUTPUT(a)->max_len);
5450             break;
5451
5452         case OFPACT_CONTROLLER:
5453             controller = ofpact_get_CONTROLLER(a);
5454             execute_controller_action(ctx, controller->max_len,
5455                                       controller->reason,
5456                                       controller->controller_id);
5457             break;
5458
5459         case OFPACT_ENQUEUE:
5460             xlate_enqueue_action(ctx, ofpact_get_ENQUEUE(a));
5461             break;
5462
5463         case OFPACT_SET_VLAN_VID:
5464             ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
5465             ctx->flow.vlan_tci |= (htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid)
5466                                    | htons(VLAN_CFI));
5467             break;
5468
5469         case OFPACT_SET_VLAN_PCP:
5470             ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
5471             ctx->flow.vlan_tci |= htons((ofpact_get_SET_VLAN_PCP(a)->vlan_pcp
5472                                          << VLAN_PCP_SHIFT)
5473                                         | VLAN_CFI);
5474             break;
5475
5476         case OFPACT_STRIP_VLAN:
5477             ctx->flow.vlan_tci = htons(0);
5478             break;
5479
5480         case OFPACT_SET_ETH_SRC:
5481             memcpy(ctx->flow.dl_src, ofpact_get_SET_ETH_SRC(a)->mac,
5482                    ETH_ADDR_LEN);
5483             break;
5484
5485         case OFPACT_SET_ETH_DST:
5486             memcpy(ctx->flow.dl_dst, ofpact_get_SET_ETH_DST(a)->mac,
5487                    ETH_ADDR_LEN);
5488             break;
5489
5490         case OFPACT_SET_IPV4_SRC:
5491             ctx->flow.nw_src = ofpact_get_SET_IPV4_SRC(a)->ipv4;
5492             break;
5493
5494         case OFPACT_SET_IPV4_DST:
5495             ctx->flow.nw_dst = ofpact_get_SET_IPV4_DST(a)->ipv4;
5496             break;
5497
5498         case OFPACT_SET_IPV4_DSCP:
5499             /* OpenFlow 1.0 only supports IPv4. */
5500             if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
5501                 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
5502                 ctx->flow.nw_tos |= ofpact_get_SET_IPV4_DSCP(a)->dscp;
5503             }
5504             break;
5505
5506         case OFPACT_SET_L4_SRC_PORT:
5507             ctx->flow.tp_src = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
5508             break;
5509
5510         case OFPACT_SET_L4_DST_PORT:
5511             ctx->flow.tp_dst = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
5512             break;
5513
5514         case OFPACT_RESUBMIT:
5515             xlate_ofpact_resubmit(ctx, ofpact_get_RESUBMIT(a));
5516             break;
5517
5518         case OFPACT_SET_TUNNEL:
5519             ctx->flow.tun_id = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
5520             break;
5521
5522         case OFPACT_SET_QUEUE:
5523             xlate_set_queue_action(ctx, ofpact_get_SET_QUEUE(a)->queue_id);
5524             break;
5525
5526         case OFPACT_POP_QUEUE:
5527             ctx->flow.skb_priority = ctx->orig_skb_priority;
5528             break;
5529
5530         case OFPACT_REG_MOVE:
5531             nxm_execute_reg_move(ofpact_get_REG_MOVE(a), &ctx->flow);
5532             break;
5533
5534         case OFPACT_REG_LOAD:
5535             nxm_execute_reg_load(ofpact_get_REG_LOAD(a), &ctx->flow);
5536             break;
5537
5538         case OFPACT_DEC_TTL:
5539             if (compose_dec_ttl(ctx, ofpact_get_DEC_TTL(a))) {
5540                 goto out;
5541             }
5542             break;
5543
5544         case OFPACT_NOTE:
5545             /* Nothing to do. */
5546             break;
5547
5548         case OFPACT_MULTIPATH:
5549             multipath_execute(ofpact_get_MULTIPATH(a), &ctx->flow);
5550             break;
5551
5552         case OFPACT_AUTOPATH:
5553             xlate_autopath(ctx, ofpact_get_AUTOPATH(a));
5554             break;
5555
5556         case OFPACT_BUNDLE:
5557             ctx->ofproto->has_bundle_action = true;
5558             xlate_bundle_action(ctx, ofpact_get_BUNDLE(a));
5559             break;
5560
5561         case OFPACT_OUTPUT_REG:
5562             xlate_output_reg_action(ctx, ofpact_get_OUTPUT_REG(a));
5563             break;
5564
5565         case OFPACT_LEARN:
5566             ctx->has_learn = true;
5567             if (ctx->may_learn) {
5568                 xlate_learn_action(ctx, ofpact_get_LEARN(a));
5569             }
5570             break;
5571
5572         case OFPACT_EXIT:
5573             ctx->exit = true;
5574             break;
5575
5576         case OFPACT_FIN_TIMEOUT:
5577             ctx->has_fin_timeout = true;
5578             xlate_fin_timeout(ctx, ofpact_get_FIN_TIMEOUT(a));
5579             break;
5580         }
5581     }
5582
5583 out:
5584     /* We've let OFPP_NORMAL and the learning action look at the packet,
5585      * so drop it now if forwarding is disabled. */
5586     if (port && !stp_forward_in_state(port->stp_state)) {
5587         ofpbuf_clear(ctx->odp_actions);
5588         add_sflow_action(ctx);
5589     }
5590     if (ctx->rule) {
5591         ctx->rule->up.evictable = was_evictable;
5592     }
5593 }
5594
5595 static void
5596 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
5597                       struct ofproto_dpif *ofproto, const struct flow *flow,
5598                       ovs_be16 initial_tci, struct rule_dpif *rule,
5599                       uint8_t tcp_flags, const struct ofpbuf *packet)
5600 {
5601     ctx->ofproto = ofproto;
5602     ctx->flow = *flow;
5603     ctx->base_flow = ctx->flow;
5604     ctx->base_flow.tun_id = 0;
5605     ctx->base_flow.vlan_tci = initial_tci;
5606     ctx->rule = rule;
5607     ctx->packet = packet;
5608     ctx->may_learn = packet != NULL;
5609     ctx->tcp_flags = tcp_flags;
5610     ctx->resubmit_hook = NULL;
5611     ctx->report_hook = NULL;
5612     ctx->resubmit_stats = NULL;
5613 }
5614
5615 /* Translates the 'ofpacts_len' bytes of "struct ofpacts" starting at 'ofpacts'
5616  * into datapath actions in 'odp_actions', using 'ctx'. */
5617 static void
5618 xlate_actions(struct action_xlate_ctx *ctx,
5619               const struct ofpact *ofpacts, size_t ofpacts_len,
5620               struct ofpbuf *odp_actions)
5621 {
5622     /* Normally false.  Set to true if we ever hit MAX_RESUBMIT_RECURSION, so
5623      * that in the future we always keep a copy of the original flow for
5624      * tracing purposes. */
5625     static bool hit_resubmit_limit;
5626
5627     enum slow_path_reason special;
5628
5629     COVERAGE_INC(ofproto_dpif_xlate);
5630
5631     ofpbuf_clear(odp_actions);
5632     ofpbuf_reserve(odp_actions, NL_A_U32_SIZE);
5633
5634     ctx->odp_actions = odp_actions;
5635     ctx->tags = 0;
5636     ctx->slow = 0;
5637     ctx->has_learn = false;
5638     ctx->has_normal = false;
5639     ctx->has_fin_timeout = false;
5640     ctx->nf_output_iface = NF_OUT_DROP;
5641     ctx->mirrors = 0;
5642     ctx->recurse = 0;
5643     ctx->max_resubmit_trigger = false;
5644     ctx->orig_skb_priority = ctx->flow.skb_priority;
5645     ctx->table_id = 0;
5646     ctx->exit = false;
5647
5648     if (ctx->ofproto->has_mirrors || hit_resubmit_limit) {
5649         /* Do this conditionally because the copy is expensive enough that it
5650          * shows up in profiles.
5651          *
5652          * We keep orig_flow in 'ctx' only because I couldn't make GCC 4.4
5653          * believe that I wasn't using it without initializing it if I kept it
5654          * in a local variable. */
5655         ctx->orig_flow = ctx->flow;
5656     }
5657
5658     if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
5659         switch (ctx->ofproto->up.frag_handling) {
5660         case OFPC_FRAG_NORMAL:
5661             /* We must pretend that transport ports are unavailable. */
5662             ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
5663             ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
5664             break;
5665
5666         case OFPC_FRAG_DROP:
5667             return;
5668
5669         case OFPC_FRAG_REASM:
5670             NOT_REACHED();
5671
5672         case OFPC_FRAG_NX_MATCH:
5673             /* Nothing to do. */
5674             break;
5675
5676         case OFPC_INVALID_TTL_TO_CONTROLLER:
5677             NOT_REACHED();
5678         }
5679     }
5680
5681     special = process_special(ctx->ofproto, &ctx->flow, ctx->packet);
5682     if (special) {
5683         ctx->slow |= special;
5684     } else {
5685         static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
5686         ovs_be16 initial_tci = ctx->base_flow.vlan_tci;
5687
5688         add_sflow_action(ctx);
5689         do_xlate_actions(ofpacts, ofpacts_len, ctx);
5690
5691         if (ctx->max_resubmit_trigger && !ctx->resubmit_hook) {
5692             if (!hit_resubmit_limit) {
5693                 /* We didn't record the original flow.  Make sure we do from
5694                  * now on. */
5695                 hit_resubmit_limit = true;
5696             } else if (!VLOG_DROP_ERR(&trace_rl)) {
5697                 struct ds ds = DS_EMPTY_INITIALIZER;
5698
5699                 ofproto_trace(ctx->ofproto, &ctx->orig_flow, ctx->packet,
5700                               initial_tci, &ds);
5701                 VLOG_ERR("Trace triggered by excessive resubmit "
5702                          "recursion:\n%s", ds_cstr(&ds));
5703                 ds_destroy(&ds);
5704             }
5705         }
5706
5707         if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
5708                                      ctx->odp_actions->data,
5709                                      ctx->odp_actions->size)) {
5710             ctx->slow |= SLOW_IN_BAND;
5711             if (ctx->packet
5712                 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
5713                                        ctx->packet)) {
5714                 compose_output_action(ctx, OFPP_LOCAL);
5715             }
5716         }
5717         if (ctx->ofproto->has_mirrors) {
5718             add_mirror_actions(ctx, &ctx->orig_flow);
5719         }
5720         fix_sflow_action(ctx);
5721     }
5722 }
5723
5724 /* Translates the 'ofpacts_len' bytes of "struct ofpact"s starting at 'ofpacts'
5725  * into datapath actions, using 'ctx', and discards the datapath actions. */
5726 static void
5727 xlate_actions_for_side_effects(struct action_xlate_ctx *ctx,
5728                                const struct ofpact *ofpacts,
5729                                size_t ofpacts_len)
5730 {
5731     uint64_t odp_actions_stub[1024 / 8];
5732     struct ofpbuf odp_actions;
5733
5734     ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5735     xlate_actions(ctx, ofpacts, ofpacts_len, &odp_actions);
5736     ofpbuf_uninit(&odp_actions);
5737 }
5738
5739 static void
5740 xlate_report(struct action_xlate_ctx *ctx, const char *s)
5741 {
5742     if (ctx->report_hook) {
5743         ctx->report_hook(ctx, s);
5744     }
5745 }
5746 \f
5747 /* OFPP_NORMAL implementation. */
5748
5749 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
5750
5751 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
5752  * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
5753  * the bundle on which the packet was received, returns the VLAN to which the
5754  * packet belongs.
5755  *
5756  * Both 'vid' and the return value are in the range 0...4095. */
5757 static uint16_t
5758 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
5759 {
5760     switch (in_bundle->vlan_mode) {
5761     case PORT_VLAN_ACCESS:
5762         return in_bundle->vlan;
5763         break;
5764
5765     case PORT_VLAN_TRUNK:
5766         return vid;
5767
5768     case PORT_VLAN_NATIVE_UNTAGGED:
5769     case PORT_VLAN_NATIVE_TAGGED:
5770         return vid ? vid : in_bundle->vlan;
5771
5772     default:
5773         NOT_REACHED();
5774     }
5775 }
5776
5777 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
5778  * If so, returns true.  Otherwise, returns false and, if 'warn' is true, logs
5779  * a warning.
5780  *
5781  * 'vid' should be the VID obtained from the 802.1Q header that was received as
5782  * part of a packet (specify 0 if there was no 802.1Q header), in the range
5783  * 0...4095. */
5784 static bool
5785 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
5786 {
5787     /* Allow any VID on the OFPP_NONE port. */
5788     if (in_bundle == &ofpp_none_bundle) {
5789         return true;
5790     }
5791
5792     switch (in_bundle->vlan_mode) {
5793     case PORT_VLAN_ACCESS:
5794         if (vid) {
5795             if (warn) {
5796                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5797                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
5798                              "packet received on port %s configured as VLAN "
5799                              "%"PRIu16" access port",
5800                              in_bundle->ofproto->up.name, vid,
5801                              in_bundle->name, in_bundle->vlan);
5802             }
5803             return false;
5804         }
5805         return true;
5806
5807     case PORT_VLAN_NATIVE_UNTAGGED:
5808     case PORT_VLAN_NATIVE_TAGGED:
5809         if (!vid) {
5810             /* Port must always carry its native VLAN. */
5811             return true;
5812         }
5813         /* Fall through. */
5814     case PORT_VLAN_TRUNK:
5815         if (!ofbundle_includes_vlan(in_bundle, vid)) {
5816             if (warn) {
5817                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5818                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
5819                              "received on port %s not configured for trunking "
5820                              "VLAN %"PRIu16,
5821                              in_bundle->ofproto->up.name, vid,
5822                              in_bundle->name, vid);
5823             }
5824             return false;
5825         }
5826         return true;
5827
5828     default:
5829         NOT_REACHED();
5830     }
5831
5832 }
5833
5834 /* Given 'vlan', the VLAN that a packet belongs to, and
5835  * 'out_bundle', a bundle on which the packet is to be output, returns the VID
5836  * that should be included in the 802.1Q header.  (If the return value is 0,
5837  * then the 802.1Q header should only be included in the packet if there is a
5838  * nonzero PCP.)
5839  *
5840  * Both 'vlan' and the return value are in the range 0...4095. */
5841 static uint16_t
5842 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
5843 {
5844     switch (out_bundle->vlan_mode) {
5845     case PORT_VLAN_ACCESS:
5846         return 0;
5847
5848     case PORT_VLAN_TRUNK:
5849     case PORT_VLAN_NATIVE_TAGGED:
5850         return vlan;
5851
5852     case PORT_VLAN_NATIVE_UNTAGGED:
5853         return vlan == out_bundle->vlan ? 0 : vlan;
5854
5855     default:
5856         NOT_REACHED();
5857     }
5858 }
5859
5860 static void
5861 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
5862               uint16_t vlan)
5863 {
5864     struct ofport_dpif *port;
5865     uint16_t vid;
5866     ovs_be16 tci, old_tci;
5867
5868     vid = output_vlan_to_vid(out_bundle, vlan);
5869     if (!out_bundle->bond) {
5870         port = ofbundle_get_a_port(out_bundle);
5871     } else {
5872         port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
5873                                         vid, &ctx->tags);
5874         if (!port) {
5875             /* No slaves enabled, so drop packet. */
5876             return;
5877         }
5878     }
5879
5880     old_tci = ctx->flow.vlan_tci;
5881     tci = htons(vid);
5882     if (tci || out_bundle->use_priority_tags) {
5883         tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
5884         if (tci) {
5885             tci |= htons(VLAN_CFI);
5886         }
5887     }
5888     ctx->flow.vlan_tci = tci;
5889
5890     compose_output_action(ctx, port->up.ofp_port);
5891     ctx->flow.vlan_tci = old_tci;
5892 }
5893
5894 static int
5895 mirror_mask_ffs(mirror_mask_t mask)
5896 {
5897     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
5898     return ffs(mask);
5899 }
5900
5901 static bool
5902 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
5903 {
5904     return (bundle->vlan_mode != PORT_VLAN_ACCESS
5905             && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
5906 }
5907
5908 static bool
5909 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
5910 {
5911     return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
5912 }
5913
5914 /* Returns an arbitrary interface within 'bundle'. */
5915 static struct ofport_dpif *
5916 ofbundle_get_a_port(const struct ofbundle *bundle)
5917 {
5918     return CONTAINER_OF(list_front(&bundle->ports),
5919                         struct ofport_dpif, bundle_node);
5920 }
5921
5922 static bool
5923 vlan_is_mirrored(const struct ofmirror *m, int vlan)
5924 {
5925     return !m->vlans || bitmap_is_set(m->vlans, vlan);
5926 }
5927
5928 static void
5929 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
5930 {
5931     struct ofproto_dpif *ofproto = ctx->ofproto;
5932     mirror_mask_t mirrors;
5933     struct ofbundle *in_bundle;
5934     uint16_t vlan;
5935     uint16_t vid;
5936     const struct nlattr *a;
5937     size_t left;
5938
5939     in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
5940                                     ctx->packet != NULL, NULL);
5941     if (!in_bundle) {
5942         return;
5943     }
5944     mirrors = in_bundle->src_mirrors;
5945
5946     /* Drop frames on bundles reserved for mirroring. */
5947     if (in_bundle->mirror_out) {
5948         if (ctx->packet != NULL) {
5949             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5950             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5951                          "%s, which is reserved exclusively for mirroring",
5952                          ctx->ofproto->up.name, in_bundle->name);
5953         }
5954         return;
5955     }
5956
5957     /* Check VLAN. */
5958     vid = vlan_tci_to_vid(orig_flow->vlan_tci);
5959     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5960         return;
5961     }
5962     vlan = input_vid_to_vlan(in_bundle, vid);
5963
5964     /* Look at the output ports to check for destination selections. */
5965
5966     NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
5967                       ctx->odp_actions->size) {
5968         enum ovs_action_attr type = nl_attr_type(a);
5969         struct ofport_dpif *ofport;
5970
5971         if (type != OVS_ACTION_ATTR_OUTPUT) {
5972             continue;
5973         }
5974
5975         ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
5976         if (ofport && ofport->bundle) {
5977             mirrors |= ofport->bundle->dst_mirrors;
5978         }
5979     }
5980
5981     if (!mirrors) {
5982         return;
5983     }
5984
5985     /* Restore the original packet before adding the mirror actions. */
5986     ctx->flow = *orig_flow;
5987
5988     while (mirrors) {
5989         struct ofmirror *m;
5990
5991         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5992
5993         if (!vlan_is_mirrored(m, vlan)) {
5994             mirrors &= mirrors - 1;
5995             continue;
5996         }
5997
5998         mirrors &= ~m->dup_mirrors;
5999         ctx->mirrors |= m->dup_mirrors;
6000         if (m->out) {
6001             output_normal(ctx, m->out, vlan);
6002         } else if (vlan != m->out_vlan
6003                    && !eth_addr_is_reserved(orig_flow->dl_dst)) {
6004             struct ofbundle *bundle;
6005
6006             HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
6007                 if (ofbundle_includes_vlan(bundle, m->out_vlan)
6008                     && !bundle->mirror_out) {
6009                     output_normal(ctx, bundle, m->out_vlan);
6010                 }
6011             }
6012         }
6013     }
6014 }
6015
6016 static void
6017 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
6018                     uint64_t packets, uint64_t bytes)
6019 {
6020     if (!mirrors) {
6021         return;
6022     }
6023
6024     for (; mirrors; mirrors &= mirrors - 1) {
6025         struct ofmirror *m;
6026
6027         m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
6028
6029         if (!m) {
6030             /* In normal circumstances 'm' will not be NULL.  However,
6031              * if mirrors are reconfigured, we can temporarily get out
6032              * of sync in facet_revalidate().  We could "correct" the
6033              * mirror list before reaching here, but doing that would
6034              * not properly account the traffic stats we've currently
6035              * accumulated for previous mirror configuration. */
6036             continue;
6037         }
6038
6039         m->packet_count += packets;
6040         m->byte_count += bytes;
6041     }
6042 }
6043
6044 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
6045  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
6046  * indicate this; newer upstream kernels use gratuitous ARP requests. */
6047 static bool
6048 is_gratuitous_arp(const struct flow *flow)
6049 {
6050     return (flow->dl_type == htons(ETH_TYPE_ARP)
6051             && eth_addr_is_broadcast(flow->dl_dst)
6052             && (flow->nw_proto == ARP_OP_REPLY
6053                 || (flow->nw_proto == ARP_OP_REQUEST
6054                     && flow->nw_src == flow->nw_dst)));
6055 }
6056
6057 static void
6058 update_learning_table(struct ofproto_dpif *ofproto,
6059                       const struct flow *flow, int vlan,
6060                       struct ofbundle *in_bundle)
6061 {
6062     struct mac_entry *mac;
6063
6064     /* Don't learn the OFPP_NONE port. */
6065     if (in_bundle == &ofpp_none_bundle) {
6066         return;
6067     }
6068
6069     if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
6070         return;
6071     }
6072
6073     mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
6074     if (is_gratuitous_arp(flow)) {
6075         /* We don't want to learn from gratuitous ARP packets that are
6076          * reflected back over bond slaves so we lock the learning table. */
6077         if (!in_bundle->bond) {
6078             mac_entry_set_grat_arp_lock(mac);
6079         } else if (mac_entry_is_grat_arp_locked(mac)) {
6080             return;
6081         }
6082     }
6083
6084     if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
6085         /* The log messages here could actually be useful in debugging,
6086          * so keep the rate limit relatively high. */
6087         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
6088         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
6089                     "on port %s in VLAN %d",
6090                     ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
6091                     in_bundle->name, vlan);
6092
6093         mac->port.p = in_bundle;
6094         tag_set_add(&ofproto->revalidate_set,
6095                     mac_learning_changed(ofproto->ml, mac));
6096     }
6097 }
6098
6099 static struct ofbundle *
6100 lookup_input_bundle(const struct ofproto_dpif *ofproto, uint16_t in_port,
6101                     bool warn, struct ofport_dpif **in_ofportp)
6102 {
6103     struct ofport_dpif *ofport;
6104
6105     /* Find the port and bundle for the received packet. */
6106     ofport = get_ofp_port(ofproto, in_port);
6107     if (in_ofportp) {
6108         *in_ofportp = ofport;
6109     }
6110     if (ofport && ofport->bundle) {
6111         return ofport->bundle;
6112     }
6113
6114     /* Special-case OFPP_NONE, which a controller may use as the ingress
6115      * port for traffic that it is sourcing. */
6116     if (in_port == OFPP_NONE) {
6117         return &ofpp_none_bundle;
6118     }
6119
6120     /* Odd.  A few possible reasons here:
6121      *
6122      * - We deleted a port but there are still a few packets queued up
6123      *   from it.
6124      *
6125      * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
6126      *   we don't know about.
6127      *
6128      * - The ofproto client didn't configure the port as part of a bundle.
6129      *   This is particularly likely to happen if a packet was received on the
6130      *   port after it was created, but before the client had a chance to
6131      *   configure its bundle.
6132      */
6133     if (warn) {
6134         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
6135
6136         VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
6137                      "port %"PRIu16, ofproto->up.name, in_port);
6138     }
6139     return NULL;
6140 }
6141
6142 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
6143  * dropped.  Returns true if they may be forwarded, false if they should be
6144  * dropped.
6145  *
6146  * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
6147  * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
6148  *
6149  * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
6150  * returned by input_vid_to_vlan().  It must be a valid VLAN for 'in_port', as
6151  * checked by input_vid_is_valid().
6152  *
6153  * May also add tags to '*tags', although the current implementation only does
6154  * so in one special case.
6155  */
6156 static bool
6157 is_admissible(struct action_xlate_ctx *ctx, struct ofport_dpif *in_port,
6158               uint16_t vlan)
6159 {
6160     struct ofproto_dpif *ofproto = ctx->ofproto;
6161     struct flow *flow = &ctx->flow;
6162     struct ofbundle *in_bundle = in_port->bundle;
6163
6164     /* Drop frames for reserved multicast addresses
6165      * only if forward_bpdu option is absent. */
6166     if (!ofproto->up.forward_bpdu && eth_addr_is_reserved(flow->dl_dst)) {
6167         xlate_report(ctx, "packet has reserved destination MAC, dropping");
6168         return false;
6169     }
6170
6171     if (in_bundle->bond) {
6172         struct mac_entry *mac;
6173
6174         switch (bond_check_admissibility(in_bundle->bond, in_port,
6175                                          flow->dl_dst, &ctx->tags)) {
6176         case BV_ACCEPT:
6177             break;
6178
6179         case BV_DROP:
6180             xlate_report(ctx, "bonding refused admissibility, dropping");
6181             return false;
6182
6183         case BV_DROP_IF_MOVED:
6184             mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
6185             if (mac && mac->port.p != in_bundle &&
6186                 (!is_gratuitous_arp(flow)
6187                  || mac_entry_is_grat_arp_locked(mac))) {
6188                 xlate_report(ctx, "SLB bond thinks this packet looped back, "
6189                             "dropping");
6190                 return false;
6191             }
6192             break;
6193         }
6194     }
6195
6196     return true;
6197 }
6198
6199 static void
6200 xlate_normal(struct action_xlate_ctx *ctx)
6201 {
6202     struct ofport_dpif *in_port;
6203     struct ofbundle *in_bundle;
6204     struct mac_entry *mac;
6205     uint16_t vlan;
6206     uint16_t vid;
6207
6208     ctx->has_normal = true;
6209
6210     in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
6211                                     ctx->packet != NULL, &in_port);
6212     if (!in_bundle) {
6213         xlate_report(ctx, "no input bundle, dropping");
6214         return;
6215     }
6216
6217     /* Drop malformed frames. */
6218     if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
6219         !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
6220         if (ctx->packet != NULL) {
6221             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
6222             VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
6223                          "VLAN tag received on port %s",
6224                          ctx->ofproto->up.name, in_bundle->name);
6225         }
6226         xlate_report(ctx, "partial VLAN tag, dropping");
6227         return;
6228     }
6229
6230     /* Drop frames on bundles reserved for mirroring. */
6231     if (in_bundle->mirror_out) {
6232         if (ctx->packet != NULL) {
6233             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
6234             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
6235                          "%s, which is reserved exclusively for mirroring",
6236                          ctx->ofproto->up.name, in_bundle->name);
6237         }
6238         xlate_report(ctx, "input port is mirror output port, dropping");
6239         return;
6240     }
6241
6242     /* Check VLAN. */
6243     vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
6244     if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
6245         xlate_report(ctx, "disallowed VLAN VID for this input port, dropping");
6246         return;
6247     }
6248     vlan = input_vid_to_vlan(in_bundle, vid);
6249
6250     /* Check other admissibility requirements. */
6251     if (in_port && !is_admissible(ctx, in_port, vlan)) {
6252         return;
6253     }
6254
6255     /* Learn source MAC. */
6256     if (ctx->may_learn) {
6257         update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
6258     }
6259
6260     /* Determine output bundle. */
6261     mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
6262                               &ctx->tags);
6263     if (mac) {
6264         if (mac->port.p != in_bundle) {
6265             xlate_report(ctx, "forwarding to learned port");
6266             output_normal(ctx, mac->port.p, vlan);
6267         } else {
6268             xlate_report(ctx, "learned port is input port, dropping");
6269         }
6270     } else {
6271         struct ofbundle *bundle;
6272
6273         xlate_report(ctx, "no learned MAC for destination, flooding");
6274         HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
6275             if (bundle != in_bundle
6276                 && ofbundle_includes_vlan(bundle, vlan)
6277                 && bundle->floodable
6278                 && !bundle->mirror_out) {
6279                 output_normal(ctx, bundle, vlan);
6280             }
6281         }
6282         ctx->nf_output_iface = NF_OUT_FLOOD;
6283     }
6284 }
6285 \f
6286 /* Optimized flow revalidation.
6287  *
6288  * It's a difficult problem, in general, to tell which facets need to have
6289  * their actions recalculated whenever the OpenFlow flow table changes.  We
6290  * don't try to solve that general problem: for most kinds of OpenFlow flow
6291  * table changes, we recalculate the actions for every facet.  This is
6292  * relatively expensive, but it's good enough if the OpenFlow flow table
6293  * doesn't change very often.
6294  *
6295  * However, we can expect one particular kind of OpenFlow flow table change to
6296  * happen frequently: changes caused by MAC learning.  To avoid wasting a lot
6297  * of CPU on revalidating every facet whenever MAC learning modifies the flow
6298  * table, we add a special case that applies to flow tables in which every rule
6299  * has the same form (that is, the same wildcards), except that the table is
6300  * also allowed to have a single "catch-all" flow that matches all packets.  We
6301  * optimize this case by tagging all of the facets that resubmit into the table
6302  * and invalidating the same tag whenever a flow changes in that table.  The
6303  * end result is that we revalidate just the facets that need it (and sometimes
6304  * a few more, but not all of the facets or even all of the facets that
6305  * resubmit to the table modified by MAC learning). */
6306
6307 /* Calculates the tag to use for 'flow' and wildcards 'wc' when it is inserted
6308  * into an OpenFlow table with the given 'basis'. */
6309 static tag_type
6310 rule_calculate_tag(const struct flow *flow, const struct flow_wildcards *wc,
6311                    uint32_t secret)
6312 {
6313     if (flow_wildcards_is_catchall(wc)) {
6314         return 0;
6315     } else {
6316         struct flow tag_flow = *flow;
6317         flow_zero_wildcards(&tag_flow, wc);
6318         return tag_create_deterministic(flow_hash(&tag_flow, secret));
6319     }
6320 }
6321
6322 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
6323  * taggability of that table.
6324  *
6325  * This function must be called after *each* change to a flow table.  If you
6326  * skip calling it on some changes then the pointer comparisons at the end can
6327  * be invalid if you get unlucky.  For example, if a flow removal causes a
6328  * cls_table to be destroyed and then a flow insertion causes a cls_table with
6329  * different wildcards to be created with the same address, then this function
6330  * will incorrectly skip revalidation. */
6331 static void
6332 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
6333 {
6334     struct table_dpif *table = &ofproto->tables[table_id];
6335     const struct oftable *oftable = &ofproto->up.tables[table_id];
6336     struct cls_table *catchall, *other;
6337     struct cls_table *t;
6338
6339     catchall = other = NULL;
6340
6341     switch (hmap_count(&oftable->cls.tables)) {
6342     case 0:
6343         /* We could tag this OpenFlow table but it would make the logic a
6344          * little harder and it's a corner case that doesn't seem worth it
6345          * yet. */
6346         break;
6347
6348     case 1:
6349     case 2:
6350         HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
6351             if (cls_table_is_catchall(t)) {
6352                 catchall = t;
6353             } else if (!other) {
6354                 other = t;
6355             } else {
6356                 /* Indicate that we can't tag this by setting both tables to
6357                  * NULL.  (We know that 'catchall' is already NULL.) */
6358                 other = NULL;
6359             }
6360         }
6361         break;
6362
6363     default:
6364         /* Can't tag this table. */
6365         break;
6366     }
6367
6368     if (table->catchall_table != catchall || table->other_table != other) {
6369         table->catchall_table = catchall;
6370         table->other_table = other;
6371         ofproto->need_revalidate = REV_FLOW_TABLE;
6372     }
6373 }
6374
6375 /* Given 'rule' that has changed in some way (either it is a rule being
6376  * inserted, a rule being deleted, or a rule whose actions are being
6377  * modified), marks facets for revalidation to ensure that packets will be
6378  * forwarded correctly according to the new state of the flow table.
6379  *
6380  * This function must be called after *each* change to a flow table.  See
6381  * the comment on table_update_taggable() for more information. */
6382 static void
6383 rule_invalidate(const struct rule_dpif *rule)
6384 {
6385     struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
6386
6387     table_update_taggable(ofproto, rule->up.table_id);
6388
6389     if (!ofproto->need_revalidate) {
6390         struct table_dpif *table = &ofproto->tables[rule->up.table_id];
6391
6392         if (table->other_table && rule->tag) {
6393             tag_set_add(&ofproto->revalidate_set, rule->tag);
6394         } else {
6395             ofproto->need_revalidate = REV_FLOW_TABLE;
6396         }
6397     }
6398 }
6399 \f
6400 static bool
6401 set_frag_handling(struct ofproto *ofproto_,
6402                   enum ofp_config_flags frag_handling)
6403 {
6404     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6405
6406     if (frag_handling != OFPC_FRAG_REASM) {
6407         ofproto->need_revalidate = REV_RECONFIGURE;
6408         return true;
6409     } else {
6410         return false;
6411     }
6412 }
6413
6414 static enum ofperr
6415 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
6416            const struct flow *flow,
6417            const struct ofpact *ofpacts, size_t ofpacts_len)
6418 {
6419     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6420     enum ofperr error;
6421
6422     if (flow->in_port >= ofproto->max_ports && flow->in_port < OFPP_MAX) {
6423         return OFPERR_NXBRC_BAD_IN_PORT;
6424     }
6425
6426     error = ofpacts_check(ofpacts, ofpacts_len, flow, ofproto->max_ports);
6427     if (!error) {
6428         struct odputil_keybuf keybuf;
6429         struct dpif_flow_stats stats;
6430
6431         struct ofpbuf key;
6432
6433         struct action_xlate_ctx ctx;
6434         uint64_t odp_actions_stub[1024 / 8];
6435         struct ofpbuf odp_actions;
6436
6437         ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
6438         odp_flow_key_from_flow(&key, flow);
6439
6440         dpif_flow_stats_extract(flow, packet, &stats);
6441
6442         action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci, NULL,
6443                               packet_get_tcp_flags(packet, flow), packet);
6444         ctx.resubmit_stats = &stats;
6445
6446         ofpbuf_use_stub(&odp_actions,
6447                         odp_actions_stub, sizeof odp_actions_stub);
6448         xlate_actions(&ctx, ofpacts, ofpacts_len, &odp_actions);
6449         dpif_execute(ofproto->dpif, key.data, key.size,
6450                      odp_actions.data, odp_actions.size, packet);
6451         ofpbuf_uninit(&odp_actions);
6452     }
6453     return error;
6454 }
6455 \f
6456 /* NetFlow. */
6457
6458 static int
6459 set_netflow(struct ofproto *ofproto_,
6460             const struct netflow_options *netflow_options)
6461 {
6462     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6463
6464     if (netflow_options) {
6465         if (!ofproto->netflow) {
6466             ofproto->netflow = netflow_create();
6467         }
6468         return netflow_set_options(ofproto->netflow, netflow_options);
6469     } else {
6470         netflow_destroy(ofproto->netflow);
6471         ofproto->netflow = NULL;
6472         return 0;
6473     }
6474 }
6475
6476 static void
6477 get_netflow_ids(const struct ofproto *ofproto_,
6478                 uint8_t *engine_type, uint8_t *engine_id)
6479 {
6480     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6481
6482     dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
6483 }
6484
6485 static void
6486 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
6487 {
6488     if (!facet_is_controller_flow(facet) &&
6489         netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
6490         struct subfacet *subfacet;
6491         struct ofexpired expired;
6492
6493         LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
6494             if (subfacet->path == SF_FAST_PATH) {
6495                 struct dpif_flow_stats stats;
6496
6497                 subfacet_reinstall(subfacet, &stats);
6498                 subfacet_update_stats(subfacet, &stats);
6499             }
6500         }
6501
6502         expired.flow = facet->flow;
6503         expired.packet_count = facet->packet_count;
6504         expired.byte_count = facet->byte_count;
6505         expired.used = facet->used;
6506         netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
6507     }
6508 }
6509
6510 static void
6511 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
6512 {
6513     struct facet *facet;
6514
6515     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
6516         send_active_timeout(ofproto, facet);
6517     }
6518 }
6519 \f
6520 static struct ofproto_dpif *
6521 ofproto_dpif_lookup(const char *name)
6522 {
6523     struct ofproto_dpif *ofproto;
6524
6525     HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
6526                              hash_string(name, 0), &all_ofproto_dpifs) {
6527         if (!strcmp(ofproto->up.name, name)) {
6528             return ofproto;
6529         }
6530     }
6531     return NULL;
6532 }
6533
6534 static void
6535 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
6536                           const char *argv[], void *aux OVS_UNUSED)
6537 {
6538     struct ofproto_dpif *ofproto;
6539
6540     if (argc > 1) {
6541         ofproto = ofproto_dpif_lookup(argv[1]);
6542         if (!ofproto) {
6543             unixctl_command_reply_error(conn, "no such bridge");
6544             return;
6545         }
6546         mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
6547     } else {
6548         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6549             mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
6550         }
6551     }
6552
6553     unixctl_command_reply(conn, "table successfully flushed");
6554 }
6555
6556 static void
6557 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
6558                          const char *argv[], void *aux OVS_UNUSED)
6559 {
6560     struct ds ds = DS_EMPTY_INITIALIZER;
6561     const struct ofproto_dpif *ofproto;
6562     const struct mac_entry *e;
6563
6564     ofproto = ofproto_dpif_lookup(argv[1]);
6565     if (!ofproto) {
6566         unixctl_command_reply_error(conn, "no such bridge");
6567         return;
6568     }
6569
6570     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
6571     LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
6572         struct ofbundle *bundle = e->port.p;
6573         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
6574                       ofbundle_get_a_port(bundle)->odp_port,
6575                       e->vlan, ETH_ADDR_ARGS(e->mac),
6576                       mac_entry_age(ofproto->ml, e));
6577     }
6578     unixctl_command_reply(conn, ds_cstr(&ds));
6579     ds_destroy(&ds);
6580 }
6581
6582 struct trace_ctx {
6583     struct action_xlate_ctx ctx;
6584     struct flow flow;
6585     struct ds *result;
6586 };
6587
6588 static void
6589 trace_format_rule(struct ds *result, uint8_t table_id, int level,
6590                   const struct rule_dpif *rule)
6591 {
6592     ds_put_char_multiple(result, '\t', level);
6593     if (!rule) {
6594         ds_put_cstr(result, "No match\n");
6595         return;
6596     }
6597
6598     ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
6599                   table_id, ntohll(rule->up.flow_cookie));
6600     cls_rule_format(&rule->up.cr, result);
6601     ds_put_char(result, '\n');
6602
6603     ds_put_char_multiple(result, '\t', level);
6604     ds_put_cstr(result, "OpenFlow ");
6605     ofpacts_format(rule->up.ofpacts, rule->up.ofpacts_len, result);
6606     ds_put_char(result, '\n');
6607 }
6608
6609 static void
6610 trace_format_flow(struct ds *result, int level, const char *title,
6611                  struct trace_ctx *trace)
6612 {
6613     ds_put_char_multiple(result, '\t', level);
6614     ds_put_format(result, "%s: ", title);
6615     if (flow_equal(&trace->ctx.flow, &trace->flow)) {
6616         ds_put_cstr(result, "unchanged");
6617     } else {
6618         flow_format(result, &trace->ctx.flow);
6619         trace->flow = trace->ctx.flow;
6620     }
6621     ds_put_char(result, '\n');
6622 }
6623
6624 static void
6625 trace_format_regs(struct ds *result, int level, const char *title,
6626                   struct trace_ctx *trace)
6627 {
6628     size_t i;
6629
6630     ds_put_char_multiple(result, '\t', level);
6631     ds_put_format(result, "%s:", title);
6632     for (i = 0; i < FLOW_N_REGS; i++) {
6633         ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
6634     }
6635     ds_put_char(result, '\n');
6636 }
6637
6638 static void
6639 trace_format_odp(struct ds *result, int level, const char *title,
6640                  struct trace_ctx *trace)
6641 {
6642     struct ofpbuf *odp_actions = trace->ctx.odp_actions;
6643
6644     ds_put_char_multiple(result, '\t', level);
6645     ds_put_format(result, "%s: ", title);
6646     format_odp_actions(result, odp_actions->data, odp_actions->size);
6647     ds_put_char(result, '\n');
6648 }
6649
6650 static void
6651 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
6652 {
6653     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
6654     struct ds *result = trace->result;
6655
6656     ds_put_char(result, '\n');
6657     trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
6658     trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
6659     trace_format_odp(result,  ctx->recurse + 1, "Resubmitted  odp", trace);
6660     trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
6661 }
6662
6663 static void
6664 trace_report(struct action_xlate_ctx *ctx, const char *s)
6665 {
6666     struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
6667     struct ds *result = trace->result;
6668
6669     ds_put_char_multiple(result, '\t', ctx->recurse);
6670     ds_put_cstr(result, s);
6671     ds_put_char(result, '\n');
6672 }
6673
6674 static void
6675 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
6676                       void *aux OVS_UNUSED)
6677 {
6678     const char *dpname = argv[1];
6679     struct ofproto_dpif *ofproto;
6680     struct ofpbuf odp_key;
6681     struct ofpbuf *packet;
6682     ovs_be16 initial_tci;
6683     struct ds result;
6684     struct flow flow;
6685     char *s;
6686
6687     packet = NULL;
6688     ofpbuf_init(&odp_key, 0);
6689     ds_init(&result);
6690
6691     ofproto = ofproto_dpif_lookup(dpname);
6692     if (!ofproto) {
6693         unixctl_command_reply_error(conn, "Unknown ofproto (use ofproto/list "
6694                                     "for help)");
6695         goto exit;
6696     }
6697     if (argc == 3 || (argc == 4 && !strcmp(argv[3], "-generate"))) {
6698         /* ofproto/trace dpname flow [-generate] */
6699         const char *flow_s = argv[2];
6700         const char *generate_s = argv[3];
6701
6702         /* Allow 'flow_s' to be either a datapath flow or an OpenFlow-like
6703          * flow.  We guess which type it is based on whether 'flow_s' contains
6704          * an '(', since a datapath flow always contains '(') but an
6705          * OpenFlow-like flow should not (in fact it's allowed but I believe
6706          * that's not documented anywhere).
6707          *
6708          * An alternative would be to try to parse 'flow_s' both ways, but then
6709          * it would be tricky giving a sensible error message.  After all, do
6710          * you just say "syntax error" or do you present both error messages?
6711          * Both choices seem lousy. */
6712         if (strchr(flow_s, '(')) {
6713             int error;
6714
6715             /* Convert string to datapath key. */
6716             ofpbuf_init(&odp_key, 0);
6717             error = odp_flow_key_from_string(flow_s, NULL, &odp_key);
6718             if (error) {
6719                 unixctl_command_reply_error(conn, "Bad flow syntax");
6720                 goto exit;
6721             }
6722
6723             /* Convert odp_key to flow. */
6724             error = ofproto_dpif_extract_flow_key(ofproto, odp_key.data,
6725                                                   odp_key.size, &flow,
6726                                                   &initial_tci, NULL);
6727             if (error == ODP_FIT_ERROR) {
6728                 unixctl_command_reply_error(conn, "Invalid flow");
6729                 goto exit;
6730             }
6731         } else {
6732             char *error_s;
6733
6734             error_s = parse_ofp_exact_flow(&flow, argv[2]);
6735             if (error_s) {
6736                 unixctl_command_reply_error(conn, error_s);
6737                 free(error_s);
6738                 goto exit;
6739             }
6740
6741             initial_tci = flow.vlan_tci;
6742             vsp_adjust_flow(ofproto, &flow);
6743         }
6744
6745         /* Generate a packet, if requested. */
6746         if (generate_s) {
6747             packet = ofpbuf_new(0);
6748             flow_compose(packet, &flow);
6749         }
6750     } else if (argc == 6) {
6751         /* ofproto/trace dpname priority tun_id in_port packet */
6752         const char *priority_s = argv[2];
6753         const char *tun_id_s = argv[3];
6754         const char *in_port_s = argv[4];
6755         const char *packet_s = argv[5];
6756         uint16_t in_port = ofp_port_to_odp_port(atoi(in_port_s));
6757         ovs_be64 tun_id = htonll(strtoull(tun_id_s, NULL, 0));
6758         uint32_t priority = atoi(priority_s);
6759         const char *msg;
6760
6761         msg = eth_from_hex(packet_s, &packet);
6762         if (msg) {
6763             unixctl_command_reply_error(conn, msg);
6764             goto exit;
6765         }
6766
6767         ds_put_cstr(&result, "Packet: ");
6768         s = ofp_packet_to_string(packet->data, packet->size);
6769         ds_put_cstr(&result, s);
6770         free(s);
6771
6772         flow_extract(packet, priority, tun_id, in_port, &flow);
6773         initial_tci = flow.vlan_tci;
6774     } else {
6775         unixctl_command_reply_error(conn, "Bad command syntax");
6776         goto exit;
6777     }
6778
6779     ofproto_trace(ofproto, &flow, packet, initial_tci, &result);
6780     unixctl_command_reply(conn, ds_cstr(&result));
6781
6782 exit:
6783     ds_destroy(&result);
6784     ofpbuf_delete(packet);
6785     ofpbuf_uninit(&odp_key);
6786 }
6787
6788 static void
6789 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
6790               const struct ofpbuf *packet, ovs_be16 initial_tci,
6791               struct ds *ds)
6792 {
6793     struct rule_dpif *rule;
6794
6795     ds_put_cstr(ds, "Flow: ");
6796     flow_format(ds, flow);
6797     ds_put_char(ds, '\n');
6798
6799     rule = rule_dpif_lookup(ofproto, flow);
6800
6801     trace_format_rule(ds, 0, 0, rule);
6802     if (rule == ofproto->miss_rule) {
6803         ds_put_cstr(ds, "\nNo match, flow generates \"packet in\"s.\n");
6804     } else if (rule == ofproto->no_packet_in_rule) {
6805         ds_put_cstr(ds, "\nNo match, packets dropped because "
6806                     "OFPPC_NO_PACKET_IN is set on in_port.\n");
6807     }
6808
6809     if (rule) {
6810         uint64_t odp_actions_stub[1024 / 8];
6811         struct ofpbuf odp_actions;
6812
6813         struct trace_ctx trace;
6814         uint8_t tcp_flags;
6815
6816         tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
6817         trace.result = ds;
6818         trace.flow = *flow;
6819         ofpbuf_use_stub(&odp_actions,
6820                         odp_actions_stub, sizeof odp_actions_stub);
6821         action_xlate_ctx_init(&trace.ctx, ofproto, flow, initial_tci,
6822                               rule, tcp_flags, packet);
6823         trace.ctx.resubmit_hook = trace_resubmit;
6824         trace.ctx.report_hook = trace_report;
6825         xlate_actions(&trace.ctx, rule->up.ofpacts, rule->up.ofpacts_len,
6826                       &odp_actions);
6827
6828         ds_put_char(ds, '\n');
6829         trace_format_flow(ds, 0, "Final flow", &trace);
6830         ds_put_cstr(ds, "Datapath actions: ");
6831         format_odp_actions(ds, odp_actions.data, odp_actions.size);
6832         ofpbuf_uninit(&odp_actions);
6833
6834         if (trace.ctx.slow) {
6835             enum slow_path_reason slow;
6836
6837             ds_put_cstr(ds, "\nThis flow is handled by the userspace "
6838                         "slow path because it:");
6839             for (slow = trace.ctx.slow; slow; ) {
6840                 enum slow_path_reason bit = rightmost_1bit(slow);
6841
6842                 switch (bit) {
6843                 case SLOW_CFM:
6844                     ds_put_cstr(ds, "\n\t- Consists of CFM packets.");
6845                     break;
6846                 case SLOW_LACP:
6847                     ds_put_cstr(ds, "\n\t- Consists of LACP packets.");
6848                     break;
6849                 case SLOW_STP:
6850                     ds_put_cstr(ds, "\n\t- Consists of STP packets.");
6851                     break;
6852                 case SLOW_IN_BAND:
6853                     ds_put_cstr(ds, "\n\t- Needs in-band special case "
6854                                 "processing.");
6855                     if (!packet) {
6856                         ds_put_cstr(ds, "\n\t  (The datapath actions are "
6857                                     "incomplete--for complete actions, "
6858                                     "please supply a packet.)");
6859                     }
6860                     break;
6861                 case SLOW_CONTROLLER:
6862                     ds_put_cstr(ds, "\n\t- Sends \"packet-in\" messages "
6863                                 "to the OpenFlow controller.");
6864                     break;
6865                 case SLOW_MATCH:
6866                     ds_put_cstr(ds, "\n\t- Needs more specific matching "
6867                                 "than the datapath supports.");
6868                     break;
6869                 }
6870
6871                 slow &= ~bit;
6872             }
6873
6874             if (slow & ~SLOW_MATCH) {
6875                 ds_put_cstr(ds, "\nThe datapath actions above do not reflect "
6876                             "the special slow-path processing.");
6877             }
6878         }
6879     }
6880 }
6881
6882 static void
6883 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6884                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6885 {
6886     clogged = true;
6887     unixctl_command_reply(conn, NULL);
6888 }
6889
6890 static void
6891 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6892                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6893 {
6894     clogged = false;
6895     unixctl_command_reply(conn, NULL);
6896 }
6897
6898 /* Runs a self-check of flow translations in 'ofproto'.  Appends a message to
6899  * 'reply' describing the results. */
6900 static void
6901 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
6902 {
6903     struct facet *facet;
6904     int errors;
6905
6906     errors = 0;
6907     HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
6908         if (!facet_check_consistency(facet)) {
6909             errors++;
6910         }
6911     }
6912     if (errors) {
6913         ofproto->need_revalidate = REV_INCONSISTENCY;
6914     }
6915
6916     if (errors) {
6917         ds_put_format(reply, "%s: self-check failed (%d errors)\n",
6918                       ofproto->up.name, errors);
6919     } else {
6920         ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
6921     }
6922 }
6923
6924 static void
6925 ofproto_dpif_self_check(struct unixctl_conn *conn,
6926                         int argc, const char *argv[], void *aux OVS_UNUSED)
6927 {
6928     struct ds reply = DS_EMPTY_INITIALIZER;
6929     struct ofproto_dpif *ofproto;
6930
6931     if (argc > 1) {
6932         ofproto = ofproto_dpif_lookup(argv[1]);
6933         if (!ofproto) {
6934             unixctl_command_reply_error(conn, "Unknown ofproto (use "
6935                                         "ofproto/list for help)");
6936             return;
6937         }
6938         ofproto_dpif_self_check__(ofproto, &reply);
6939     } else {
6940         HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6941             ofproto_dpif_self_check__(ofproto, &reply);
6942         }
6943     }
6944
6945     unixctl_command_reply(conn, ds_cstr(&reply));
6946     ds_destroy(&reply);
6947 }
6948
6949 static void
6950 ofproto_dpif_unixctl_init(void)
6951 {
6952     static bool registered;
6953     if (registered) {
6954         return;
6955     }
6956     registered = true;
6957
6958     unixctl_command_register(
6959         "ofproto/trace",
6960         "bridge {tun_id in_port packet | odp_flow [-generate]}",
6961         2, 5, ofproto_unixctl_trace, NULL);
6962     unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
6963                              ofproto_unixctl_fdb_flush, NULL);
6964     unixctl_command_register("fdb/show", "bridge", 1, 1,
6965                              ofproto_unixctl_fdb_show, NULL);
6966     unixctl_command_register("ofproto/clog", "", 0, 0,
6967                              ofproto_dpif_clog, NULL);
6968     unixctl_command_register("ofproto/unclog", "", 0, 0,
6969                              ofproto_dpif_unclog, NULL);
6970     unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
6971                              ofproto_dpif_self_check, NULL);
6972 }
6973 \f
6974 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6975  *
6976  * This is deprecated.  It is only for compatibility with broken device drivers
6977  * in old versions of Linux that do not properly support VLANs when VLAN
6978  * devices are not used.  When broken device drivers are no longer in
6979  * widespread use, we will delete these interfaces. */
6980
6981 static int
6982 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
6983 {
6984     struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
6985     struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
6986
6987     if (realdev_ofp_port == ofport->realdev_ofp_port
6988         && vid == ofport->vlandev_vid) {
6989         return 0;
6990     }
6991
6992     ofproto->need_revalidate = REV_RECONFIGURE;
6993
6994     if (ofport->realdev_ofp_port) {
6995         vsp_remove(ofport);
6996     }
6997     if (realdev_ofp_port && ofport->bundle) {
6998         /* vlandevs are enslaved to their realdevs, so they are not allowed to
6999          * themselves be part of a bundle. */
7000         bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
7001     }
7002
7003     ofport->realdev_ofp_port = realdev_ofp_port;
7004     ofport->vlandev_vid = vid;
7005
7006     if (realdev_ofp_port) {
7007         vsp_add(ofport, realdev_ofp_port, vid);
7008     }
7009
7010     return 0;
7011 }
7012
7013 static uint32_t
7014 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
7015 {
7016     return hash_2words(realdev_ofp_port, vid);
7017 }
7018
7019 /* Returns the ODP port number of the Linux VLAN device that corresponds to
7020  * 'vlan_tci' on the network device with port number 'realdev_odp_port' in
7021  * 'ofproto'.  For example, given 'realdev_odp_port' of eth0 and 'vlan_tci' 9,
7022  * it would return the port number of eth0.9.
7023  *
7024  * Unless VLAN splinters are enabled for port 'realdev_odp_port', this
7025  * function just returns its 'realdev_odp_port' argument. */
7026 static uint32_t
7027 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
7028                        uint32_t realdev_odp_port, ovs_be16 vlan_tci)
7029 {
7030     if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
7031         uint16_t realdev_ofp_port = odp_port_to_ofp_port(realdev_odp_port);
7032         int vid = vlan_tci_to_vid(vlan_tci);
7033         const struct vlan_splinter *vsp;
7034
7035         HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
7036                                  hash_realdev_vid(realdev_ofp_port, vid),
7037                                  &ofproto->realdev_vid_map) {
7038             if (vsp->realdev_ofp_port == realdev_ofp_port
7039                 && vsp->vid == vid) {
7040                 return ofp_port_to_odp_port(vsp->vlandev_ofp_port);
7041             }
7042         }
7043     }
7044     return realdev_odp_port;
7045 }
7046
7047 static struct vlan_splinter *
7048 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
7049 {
7050     struct vlan_splinter *vsp;
7051
7052     HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
7053                              &ofproto->vlandev_map) {
7054         if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
7055             return vsp;
7056         }
7057     }
7058
7059     return NULL;
7060 }
7061
7062 /* Returns the OpenFlow port number of the "real" device underlying the Linux
7063  * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
7064  * VLAN VID of the Linux VLAN device in '*vid'.  For example, given
7065  * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
7066  * eth0 and store 9 in '*vid'.
7067  *
7068  * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
7069  * VLAN device.  Unless VLAN splinters are enabled, this is what this function
7070  * always does.*/
7071 static uint16_t
7072 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
7073                        uint16_t vlandev_ofp_port, int *vid)
7074 {
7075     if (!hmap_is_empty(&ofproto->vlandev_map)) {
7076         const struct vlan_splinter *vsp;
7077
7078         vsp = vlandev_find(ofproto, vlandev_ofp_port);
7079         if (vsp) {
7080             if (vid) {
7081                 *vid = vsp->vid;
7082             }
7083             return vsp->realdev_ofp_port;
7084         }
7085     }
7086     return 0;
7087 }
7088
7089 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
7090  * whether 'flow->in_port' represents a Linux VLAN device.  If so, changes
7091  * 'flow->in_port' to the "real" device backing the VLAN device, sets
7092  * 'flow->vlan_tci' to the VLAN VID, and returns true.  Otherwise (which is
7093  * always the case unless VLAN splinters are enabled), returns false without
7094  * making any changes. */
7095 static bool
7096 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
7097 {
7098     uint16_t realdev;
7099     int vid;
7100
7101     realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port, &vid);
7102     if (!realdev) {
7103         return false;
7104     }
7105
7106     /* Cause the flow to be processed as if it came in on the real device with
7107      * the VLAN device's VLAN ID. */
7108     flow->in_port = realdev;
7109     flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
7110     return true;
7111 }
7112
7113 static void
7114 vsp_remove(struct ofport_dpif *port)
7115 {
7116     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
7117     struct vlan_splinter *vsp;
7118
7119     vsp = vlandev_find(ofproto, port->up.ofp_port);
7120     if (vsp) {
7121         hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
7122         hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
7123         free(vsp);
7124
7125         port->realdev_ofp_port = 0;
7126     } else {
7127         VLOG_ERR("missing vlan device record");
7128     }
7129 }
7130
7131 static void
7132 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
7133 {
7134     struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
7135
7136     if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
7137         && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
7138             == realdev_ofp_port)) {
7139         struct vlan_splinter *vsp;
7140
7141         vsp = xmalloc(sizeof *vsp);
7142         hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
7143                     hash_int(port->up.ofp_port, 0));
7144         hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
7145                     hash_realdev_vid(realdev_ofp_port, vid));
7146         vsp->realdev_ofp_port = realdev_ofp_port;
7147         vsp->vlandev_ofp_port = port->up.ofp_port;
7148         vsp->vid = vid;
7149
7150         port->realdev_ofp_port = realdev_ofp_port;
7151     } else {
7152         VLOG_ERR("duplicate vlan device record");
7153     }
7154 }
7155 \f
7156 const struct ofproto_class ofproto_dpif_class = {
7157     enumerate_types,
7158     enumerate_names,
7159     del,
7160     alloc,
7161     construct,
7162     destruct,
7163     dealloc,
7164     run,
7165     run_fast,
7166     wait,
7167     get_memory_usage,
7168     flush,
7169     get_features,
7170     get_tables,
7171     port_alloc,
7172     port_construct,
7173     port_destruct,
7174     port_dealloc,
7175     port_modified,
7176     port_reconfigured,
7177     port_query_by_name,
7178     port_add,
7179     port_del,
7180     port_get_stats,
7181     port_dump_start,
7182     port_dump_next,
7183     port_dump_done,
7184     port_poll,
7185     port_poll_wait,
7186     port_is_lacp_current,
7187     NULL,                       /* rule_choose_table */
7188     rule_alloc,
7189     rule_construct,
7190     rule_destruct,
7191     rule_dealloc,
7192     rule_get_stats,
7193     rule_execute,
7194     rule_modify_actions,
7195     set_frag_handling,
7196     packet_out,
7197     set_netflow,
7198     get_netflow_ids,
7199     set_sflow,
7200     set_cfm,
7201     get_cfm_fault,
7202     get_cfm_opup,
7203     get_cfm_remote_mpids,
7204     get_cfm_health,
7205     set_stp,
7206     get_stp_status,
7207     set_stp_port,
7208     get_stp_port_status,
7209     set_queues,
7210     bundle_set,
7211     bundle_remove,
7212     mirror_set,
7213     mirror_get_stats,
7214     set_flood_vlans,
7215     is_mirror_output_bundle,
7216     forward_bpdu_changed,
7217     set_mac_idle_time,
7218     set_realdev,
7219 };