2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "ofproto/ofproto-provider.h"
26 #include "byte-order.h"
31 #include "dynamic-string.h"
32 #include "fail-open.h"
36 #include "mac-learning.h"
37 #include "meta-flow.h"
38 #include "multipath.h"
45 #include "ofp-parse.h"
46 #include "ofp-print.h"
47 #include "ofproto-dpif-governor.h"
48 #include "ofproto-dpif-sflow.h"
49 #include "poll-loop.h"
51 #include "unaligned.h"
53 #include "vlan-bitmap.h"
56 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
58 COVERAGE_DEFINE(ofproto_dpif_ctlr_action);
59 COVERAGE_DEFINE(ofproto_dpif_expired);
60 COVERAGE_DEFINE(ofproto_dpif_no_packet_in);
61 COVERAGE_DEFINE(ofproto_dpif_xlate);
62 COVERAGE_DEFINE(facet_changed_rule);
63 COVERAGE_DEFINE(facet_invalidated);
64 COVERAGE_DEFINE(facet_revalidate);
65 COVERAGE_DEFINE(facet_unexpected);
66 COVERAGE_DEFINE(facet_suppress);
68 /* Maximum depth of flow table recursion (due to resubmit actions) in a
69 * flow translation. */
70 #define MAX_RESUBMIT_RECURSION 32
72 /* Number of implemented OpenFlow tables. */
73 enum { N_TABLES = 255 };
74 BUILD_ASSERT_DECL(N_TABLES >= 1 && N_TABLES <= 255);
84 * - Do include packets and bytes from facets that have been deleted or
85 * whose own statistics have been folded into the rule.
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()).
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.
95 uint64_t packet_count; /* Number of packets received. */
96 uint64_t byte_count; /* Number of bytes received. */
98 tag_type tag; /* Caches rule_calculate_tag() result. */
100 struct list facets; /* List of "struct facet"s. */
103 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
105 return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
108 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
109 const struct flow *, uint8_t table);
111 static void rule_credit_stats(struct rule_dpif *,
112 const struct dpif_flow_stats *);
113 static void flow_push_stats(struct rule_dpif *, const struct flow *,
114 const struct dpif_flow_stats *);
115 static tag_type rule_calculate_tag(const struct flow *,
116 const struct flow_wildcards *,
118 static void rule_invalidate(const struct rule_dpif *);
120 #define MAX_MIRRORS 32
121 typedef uint32_t mirror_mask_t;
122 #define MIRROR_MASK_C(X) UINT32_C(X)
123 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
125 struct ofproto_dpif *ofproto; /* Owning ofproto. */
126 size_t idx; /* In ofproto's "mirrors" array. */
127 void *aux; /* Key supplied by ofproto's client. */
128 char *name; /* Identifier for log messages. */
130 /* Selection criteria. */
131 struct hmapx srcs; /* Contains "struct ofbundle *"s. */
132 struct hmapx dsts; /* Contains "struct ofbundle *"s. */
133 unsigned long *vlans; /* Bitmap of chosen VLANs, NULL selects all. */
135 /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
136 struct ofbundle *out; /* Output port or NULL. */
137 int out_vlan; /* Output VLAN or -1. */
138 mirror_mask_t dup_mirrors; /* Bitmap of mirrors with the same output. */
141 int64_t packet_count; /* Number of packets sent. */
142 int64_t byte_count; /* Number of bytes sent. */
145 static void mirror_destroy(struct ofmirror *);
146 static void update_mirror_stats(struct ofproto_dpif *ofproto,
147 mirror_mask_t mirrors,
148 uint64_t packets, uint64_t bytes);
151 struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
152 struct ofproto_dpif *ofproto; /* Owning ofproto. */
153 void *aux; /* Key supplied by ofproto's client. */
154 char *name; /* Identifier for log messages. */
157 struct list ports; /* Contains "struct ofport"s. */
158 enum port_vlan_mode vlan_mode; /* VLAN mode */
159 int vlan; /* -1=trunk port, else a 12-bit VLAN ID. */
160 unsigned long *trunks; /* Bitmap of trunked VLANs, if 'vlan' == -1.
161 * NULL if all VLANs are trunked. */
162 struct lacp *lacp; /* LACP if LACP is enabled, otherwise NULL. */
163 struct bond *bond; /* Nonnull iff more than one port. */
164 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
167 bool floodable; /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
169 /* Port mirroring info. */
170 mirror_mask_t src_mirrors; /* Mirrors triggered when packet received. */
171 mirror_mask_t dst_mirrors; /* Mirrors triggered when packet sent. */
172 mirror_mask_t mirror_out; /* Mirrors that output to this bundle. */
175 static void bundle_remove(struct ofport *);
176 static void bundle_update(struct ofbundle *);
177 static void bundle_destroy(struct ofbundle *);
178 static void bundle_del_port(struct ofport_dpif *);
179 static void bundle_run(struct ofbundle *);
180 static void bundle_wait(struct ofbundle *);
181 static struct ofbundle *lookup_input_bundle(struct ofproto_dpif *,
182 uint16_t in_port, bool warn,
183 struct ofport_dpif **in_ofportp);
185 /* A controller may use OFPP_NONE as the ingress port to indicate that
186 * it did not arrive on a "real" port. 'ofpp_none_bundle' exists for
187 * when an input bundle is needed for validation (e.g., mirroring or
188 * OFPP_NORMAL processing). It is not connected to an 'ofproto' or have
189 * any 'port' structs, so care must be taken when dealing with it. */
190 static struct ofbundle ofpp_none_bundle = {
192 .vlan_mode = PORT_VLAN_TRUNK
195 static void stp_run(struct ofproto_dpif *ofproto);
196 static void stp_wait(struct ofproto_dpif *ofproto);
197 static int set_stp_port(struct ofport *,
198 const struct ofproto_port_stp_settings *);
200 static bool ofbundle_includes_vlan(const struct ofbundle *, uint16_t vlan);
202 struct action_xlate_ctx {
203 /* action_xlate_ctx_init() initializes these members. */
206 struct ofproto_dpif *ofproto;
208 /* Flow to which the OpenFlow actions apply. xlate_actions() will modify
209 * this flow when actions change header fields. */
212 /* The packet corresponding to 'flow', or a null pointer if we are
213 * revalidating without a packet to refer to. */
214 const struct ofpbuf *packet;
216 /* Should OFPP_NORMAL update the MAC learning table? Should "learn"
217 * actions update the flow table?
219 * We want to update these tables if we are actually processing a packet,
220 * or if we are accounting for packets that the datapath has processed, but
221 * not if we are just revalidating. */
224 /* The rule that we are currently translating, or NULL. */
225 struct rule_dpif *rule;
227 /* Union of the set of TCP flags seen so far in this flow. (Used only by
228 * NXAST_FIN_TIMEOUT. Set to zero to avoid updating updating rules'
232 /* If nonnull, flow translation calls this function just before executing a
233 * resubmit or OFPP_TABLE action. In addition, disables logging of traces
234 * when the recursion depth is exceeded.
236 * 'rule' is the rule being submitted into. It will be null if the
237 * resubmit or OFPP_TABLE action didn't find a matching rule.
239 * This is normally null so the client has to set it manually after
240 * calling action_xlate_ctx_init(). */
241 void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *rule);
243 /* If nonnull, flow translation credits the specified statistics to each
244 * rule reached through a resubmit or OFPP_TABLE action.
246 * This is normally null so the client has to set it manually after
247 * calling action_xlate_ctx_init(). */
248 const struct dpif_flow_stats *resubmit_stats;
250 /* xlate_actions() initializes and uses these members. The client might want
251 * to look at them after it returns. */
253 struct ofpbuf *odp_actions; /* Datapath actions. */
254 tag_type tags; /* Tags associated with actions. */
255 bool may_set_up_flow; /* True ordinarily; false if the actions must
256 * be reassessed for every packet. */
257 bool has_learn; /* Actions include NXAST_LEARN? */
258 bool has_normal; /* Actions output to OFPP_NORMAL? */
259 bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
260 uint16_t nf_output_iface; /* Output interface index for NetFlow. */
261 mirror_mask_t mirrors; /* Bitmap of associated mirrors. */
263 /* xlate_actions() initializes and uses these members, but the client has no
264 * reason to look at them. */
266 int recurse; /* Recursion level, via xlate_table_action. */
267 bool max_resubmit_trigger; /* Recursed too deeply during translation. */
268 struct flow base_flow; /* Flow at the last commit. */
269 uint32_t orig_skb_priority; /* Priority when packet arrived. */
270 uint8_t table_id; /* OpenFlow table ID where flow was found. */
271 uint32_t sflow_n_outputs; /* Number of output ports. */
272 uint16_t sflow_odp_port; /* Output port for composing sFlow action. */
273 uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
274 bool exit; /* No further actions should be processed. */
275 struct flow orig_flow; /* Copy of original flow. */
278 static void action_xlate_ctx_init(struct action_xlate_ctx *,
279 struct ofproto_dpif *, const struct flow *,
280 ovs_be16 initial_tci, struct rule_dpif *,
281 uint8_t tcp_flags, const struct ofpbuf *);
282 static void xlate_actions(struct action_xlate_ctx *,
283 const union ofp_action *in, size_t n_in,
284 struct ofpbuf *odp_actions);
285 static void xlate_actions_for_side_effects(struct action_xlate_ctx *,
286 const union ofp_action *in,
289 /* A dpif flow and actions associated with a facet.
291 * See also the large comment on struct facet. */
294 struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
295 struct list list_node; /* In struct facet's 'facets' list. */
296 struct facet *facet; /* Owning facet. */
300 * To save memory in the common case, 'key' is NULL if 'key_fitness' is
301 * ODP_FIT_PERFECT, that is, odp_flow_key_from_flow() can accurately
302 * regenerate the ODP flow key from ->facet->flow. */
303 enum odp_key_fitness key_fitness;
307 long long int used; /* Time last used; time created if not used. */
309 uint64_t dp_packet_count; /* Last known packet count in the datapath. */
310 uint64_t dp_byte_count; /* Last known byte count in the datapath. */
314 * These should be essentially identical for every subfacet in a facet, but
315 * may differ in trivial ways due to VLAN splinters. */
316 size_t actions_len; /* Number of bytes in actions[]. */
317 struct nlattr *actions; /* Datapath actions. */
319 bool installed; /* Installed in datapath? */
321 /* This value is normally the same as ->facet->flow.vlan_tci. Only VLAN
322 * splinters can cause it to differ. This value should be removed when
323 * the VLAN splinters feature is no longer needed. */
324 ovs_be16 initial_tci; /* Initial VLAN TCI value. */
327 static struct subfacet *subfacet_create(struct facet *, enum odp_key_fitness,
328 const struct nlattr *key,
329 size_t key_len, ovs_be16 initial_tci);
330 static struct subfacet *subfacet_find(struct ofproto_dpif *,
331 const struct nlattr *key, size_t key_len);
332 static void subfacet_destroy(struct subfacet *);
333 static void subfacet_destroy__(struct subfacet *);
334 static void subfacet_get_key(struct subfacet *, struct odputil_keybuf *,
336 static void subfacet_reset_dp_stats(struct subfacet *,
337 struct dpif_flow_stats *);
338 static void subfacet_update_time(struct subfacet *, long long int used);
339 static void subfacet_update_stats(struct subfacet *,
340 const struct dpif_flow_stats *);
341 static void subfacet_make_actions(struct subfacet *,
342 const struct ofpbuf *packet,
343 struct ofpbuf *odp_actions);
344 static int subfacet_install(struct subfacet *,
345 const struct nlattr *actions, size_t actions_len,
346 struct dpif_flow_stats *);
347 static void subfacet_uninstall(struct subfacet *);
349 /* An exact-match instantiation of an OpenFlow flow.
351 * A facet associates a "struct flow", which represents the Open vSwitch
352 * userspace idea of an exact-match flow, with one or more subfacets. Each
353 * subfacet tracks the datapath's idea of the exact-match flow equivalent to
354 * the facet. When the kernel module (or other dpif implementation) and Open
355 * vSwitch userspace agree on the definition of a flow key, there is exactly
356 * one subfacet per facet. If the dpif implementation supports more-specific
357 * flow matching than userspace, however, a facet can have more than one
358 * subfacet, each of which corresponds to some distinction in flow that
359 * userspace simply doesn't understand.
361 * Flow expiration works in terms of subfacets, so a facet must have at least
362 * one subfacet or it will never expire, leaking memory. */
365 struct hmap_node hmap_node; /* In owning ofproto's 'facets' hmap. */
366 struct list list_node; /* In owning rule's 'facets' list. */
367 struct rule_dpif *rule; /* Owning rule. */
370 struct list subfacets;
371 long long int used; /* Time last used; time created if not used. */
378 * - Do include packets and bytes sent "by hand", e.g. with
381 * - Do include packets and bytes that were obtained from the datapath
382 * when a subfacet's statistics were reset (e.g. dpif_flow_put() with
383 * DPIF_FP_ZERO_STATS).
385 * - Do not include packets or bytes that can be obtained from the
386 * datapath for any existing subfacet.
388 uint64_t packet_count; /* Number of packets received. */
389 uint64_t byte_count; /* Number of bytes received. */
391 /* Resubmit statistics. */
392 uint64_t prev_packet_count; /* Number of packets from last stats push. */
393 uint64_t prev_byte_count; /* Number of bytes from last stats push. */
394 long long int prev_used; /* Used time from last stats push. */
397 uint64_t accounted_bytes; /* Bytes processed by facet_account(). */
398 struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
399 uint8_t tcp_flags; /* TCP flags seen for this 'rule'. */
401 /* Properties of datapath actions.
403 * Every subfacet has its own actions because actions can differ slightly
404 * between splintered and non-splintered subfacets due to the VLAN tag
405 * being initially different (present vs. absent). All of them have these
406 * properties in common so we just store one copy of them here. */
407 bool may_install; /* Reassess actions for every packet? */
408 bool has_learn; /* Actions include NXAST_LEARN? */
409 bool has_normal; /* Actions output to OFPP_NORMAL? */
410 bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
411 tag_type tags; /* Tags that would require revalidation. */
412 mirror_mask_t mirrors; /* Bitmap of dependent mirrors. */
414 /* Storage for a single subfacet, to reduce malloc() time and space
415 * overhead. (A facet always has at least one subfacet and in the common
416 * case has exactly one subfacet.) */
417 struct subfacet one_subfacet;
420 static struct facet *facet_create(struct rule_dpif *,
421 const struct flow *, uint32_t hash);
422 static void facet_remove(struct facet *);
423 static void facet_free(struct facet *);
425 static struct facet *facet_find(struct ofproto_dpif *,
426 const struct flow *, uint32_t hash);
427 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
428 const struct flow *, uint32_t hash);
429 static bool facet_revalidate(struct facet *);
430 static bool facet_check_consistency(struct facet *);
432 static void facet_flush_stats(struct facet *);
434 static void facet_update_time(struct facet *, long long int used);
435 static void facet_reset_counters(struct facet *);
436 static void facet_push_stats(struct facet *);
437 static void facet_learn(struct facet *);
438 static void facet_account(struct facet *);
440 static bool facet_is_controller_flow(struct facet *);
446 struct ofbundle *bundle; /* Bundle that contains this port, if any. */
447 struct list bundle_node; /* In struct ofbundle's "ports" list. */
448 struct cfm *cfm; /* Connectivity Fault Management, if any. */
449 tag_type tag; /* Tag associated with this port. */
450 uint32_t bond_stable_id; /* stable_id to use as bond slave, or 0. */
451 bool may_enable; /* May be enabled in bonds. */
452 long long int carrier_seq; /* Carrier status changes. */
455 struct stp_port *stp_port; /* Spanning Tree Protocol, if any. */
456 enum stp_state stp_state; /* Always STP_DISABLED if STP not in use. */
457 long long int stp_state_entered;
459 struct hmap priorities; /* Map of attached 'priority_to_dscp's. */
461 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
463 * This is deprecated. It is only for compatibility with broken device
464 * drivers in old versions of Linux that do not properly support VLANs when
465 * VLAN devices are not used. When broken device drivers are no longer in
466 * widespread use, we will delete these interfaces. */
467 uint16_t realdev_ofp_port;
471 /* Node in 'ofport_dpif''s 'priorities' map. Used to maintain a map from
472 * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
473 * traffic egressing the 'ofport' with that priority should be marked with. */
474 struct priority_to_dscp {
475 struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
476 uint32_t priority; /* Priority of this queue (see struct flow). */
478 uint8_t dscp; /* DSCP bits to mark outgoing traffic with. */
481 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
483 * This is deprecated. It is only for compatibility with broken device drivers
484 * in old versions of Linux that do not properly support VLANs when VLAN
485 * devices are not used. When broken device drivers are no longer in
486 * widespread use, we will delete these interfaces. */
487 struct vlan_splinter {
488 struct hmap_node realdev_vid_node;
489 struct hmap_node vlandev_node;
490 uint16_t realdev_ofp_port;
491 uint16_t vlandev_ofp_port;
495 static uint32_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
496 uint32_t realdev, ovs_be16 vlan_tci);
497 static uint16_t vsp_vlandev_to_realdev(const struct ofproto_dpif *,
498 uint16_t vlandev, int *vid);
499 static bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
500 static void vsp_remove(struct ofport_dpif *);
501 static void vsp_add(struct ofport_dpif *, uint16_t realdev_ofp_port, int vid);
503 static struct ofport_dpif *
504 ofport_dpif_cast(const struct ofport *ofport)
506 assert(ofport->ofproto->ofproto_class == &ofproto_dpif_class);
507 return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
510 static void port_run(struct ofport_dpif *);
511 static void port_wait(struct ofport_dpif *);
512 static int set_cfm(struct ofport *, const struct cfm_settings *);
513 static void ofport_clear_priorities(struct ofport_dpif *);
515 struct dpif_completion {
516 struct list list_node;
517 struct ofoperation *op;
520 /* Extra information about a classifier table.
521 * Currently used just for optimized flow revalidation. */
523 /* If either of these is nonnull, then this table has a form that allows
524 * flows to be tagged to avoid revalidating most flows for the most common
525 * kinds of flow table changes. */
526 struct cls_table *catchall_table; /* Table that wildcards all fields. */
527 struct cls_table *other_table; /* Table with any other wildcard set. */
528 uint32_t basis; /* Keeps each table's tags separate. */
531 struct ofproto_dpif {
532 struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
541 struct netflow *netflow;
542 struct dpif_sflow *sflow;
543 struct hmap bundles; /* Contains "struct ofbundle"s. */
544 struct mac_learning *ml;
545 struct ofmirror *mirrors[MAX_MIRRORS];
547 bool has_bonded_bundles;
550 struct timer next_expiration;
554 struct hmap subfacets;
555 struct governor *governor;
558 struct table_dpif tables[N_TABLES];
559 bool need_revalidate;
560 struct tag_set revalidate_set;
562 /* Support for debugging async flow mods. */
563 struct list completions;
565 bool has_bundle_action; /* True when the first bundle action appears. */
566 struct netdev_stats stats; /* To account packets generated and consumed in
571 long long int stp_last_tick;
573 /* VLAN splinters. */
574 struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
575 struct hmap vlandev_map; /* vlandev -> (realdev,vid). */
578 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"? (Useful only
579 * for debugging the asynchronous flow_mod implementation.) */
582 /* All existing ofproto_dpif instances, indexed by ->up.name. */
583 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
585 static void ofproto_dpif_unixctl_init(void);
587 static struct ofproto_dpif *
588 ofproto_dpif_cast(const struct ofproto *ofproto)
590 assert(ofproto->ofproto_class == &ofproto_dpif_class);
591 return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
594 static struct ofport_dpif *get_ofp_port(struct ofproto_dpif *,
596 static struct ofport_dpif *get_odp_port(struct ofproto_dpif *,
598 static void ofproto_trace(struct ofproto_dpif *, const struct flow *,
599 const struct ofpbuf *, ovs_be16 initial_tci,
602 /* Packet processing. */
603 static void update_learning_table(struct ofproto_dpif *,
604 const struct flow *, int vlan,
607 #define FLOW_MISS_MAX_BATCH 50
608 static int handle_upcalls(struct ofproto_dpif *, unsigned int max_batch);
610 /* Flow expiration. */
611 static int expire(struct ofproto_dpif *);
614 static void send_netflow_active_timeouts(struct ofproto_dpif *);
617 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
618 static size_t compose_sflow_action(const struct ofproto_dpif *,
619 struct ofpbuf *odp_actions,
620 const struct flow *, uint32_t odp_port);
621 static void add_mirror_actions(struct action_xlate_ctx *ctx,
622 const struct flow *flow);
623 /* Global variables. */
624 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
626 /* Factory functions. */
629 enumerate_types(struct sset *types)
631 dp_enumerate_types(types);
635 enumerate_names(const char *type, struct sset *names)
637 return dp_enumerate_names(type, names);
641 del(const char *type, const char *name)
646 error = dpif_open(name, type, &dpif);
648 error = dpif_delete(dpif);
654 /* Basic life-cycle. */
656 static struct ofproto *
659 struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
664 dealloc(struct ofproto *ofproto_)
666 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
671 construct(struct ofproto *ofproto_)
673 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
674 const char *name = ofproto->up.name;
678 error = dpif_create_and_open(name, ofproto->up.type, &ofproto->dpif);
680 VLOG_ERR("failed to open datapath %s: %s", name, strerror(error));
684 ofproto->max_ports = dpif_get_max_ports(ofproto->dpif);
685 ofproto->n_matches = 0;
687 dpif_flow_flush(ofproto->dpif);
688 dpif_recv_purge(ofproto->dpif);
690 error = dpif_recv_set(ofproto->dpif, true);
692 VLOG_ERR("failed to listen on datapath %s: %s", name, strerror(error));
693 dpif_close(ofproto->dpif);
697 ofproto->netflow = NULL;
698 ofproto->sflow = NULL;
700 hmap_init(&ofproto->bundles);
701 ofproto->ml = mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME);
702 for (i = 0; i < MAX_MIRRORS; i++) {
703 ofproto->mirrors[i] = NULL;
705 ofproto->has_bonded_bundles = false;
707 timer_set_duration(&ofproto->next_expiration, 1000);
709 hmap_init(&ofproto->facets);
710 hmap_init(&ofproto->subfacets);
711 ofproto->governor = NULL;
713 for (i = 0; i < N_TABLES; i++) {
714 struct table_dpif *table = &ofproto->tables[i];
716 table->catchall_table = NULL;
717 table->other_table = NULL;
718 table->basis = random_uint32();
720 ofproto->need_revalidate = false;
721 tag_set_init(&ofproto->revalidate_set);
723 list_init(&ofproto->completions);
725 ofproto_dpif_unixctl_init();
727 ofproto->has_mirrors = false;
728 ofproto->has_bundle_action = false;
730 hmap_init(&ofproto->vlandev_map);
731 hmap_init(&ofproto->realdev_vid_map);
733 hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
734 hash_string(ofproto->up.name, 0));
735 memset(&ofproto->stats, 0, sizeof ofproto->stats);
737 ofproto_init_tables(ofproto_, N_TABLES);
743 complete_operations(struct ofproto_dpif *ofproto)
745 struct dpif_completion *c, *next;
747 LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
748 ofoperation_complete(c->op, 0);
749 list_remove(&c->list_node);
755 destruct(struct ofproto *ofproto_)
757 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
758 struct rule_dpif *rule, *next_rule;
759 struct oftable *table;
762 hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
763 complete_operations(ofproto);
765 OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
766 struct cls_cursor cursor;
768 cls_cursor_init(&cursor, &table->cls, NULL);
769 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
770 ofproto_rule_destroy(&rule->up);
774 for (i = 0; i < MAX_MIRRORS; i++) {
775 mirror_destroy(ofproto->mirrors[i]);
778 netflow_destroy(ofproto->netflow);
779 dpif_sflow_destroy(ofproto->sflow);
780 hmap_destroy(&ofproto->bundles);
781 mac_learning_destroy(ofproto->ml);
783 hmap_destroy(&ofproto->facets);
784 hmap_destroy(&ofproto->subfacets);
785 governor_destroy(ofproto->governor);
787 hmap_destroy(&ofproto->vlandev_map);
788 hmap_destroy(&ofproto->realdev_vid_map);
790 dpif_close(ofproto->dpif);
794 run_fast(struct ofproto *ofproto_)
796 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
799 /* Handle one or more batches of upcalls, until there's nothing left to do
800 * or until we do a fixed total amount of work.
802 * We do work in batches because it can be much cheaper to set up a number
803 * of flows and fire off their patches all at once. We do multiple batches
804 * because in some cases handling a packet can cause another packet to be
805 * queued almost immediately as part of the return flow. Both
806 * optimizations can make major improvements on some benchmarks and
807 * presumably for real traffic as well. */
809 while (work < FLOW_MISS_MAX_BATCH) {
810 int retval = handle_upcalls(ofproto, FLOW_MISS_MAX_BATCH - work);
820 run(struct ofproto *ofproto_)
822 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
823 struct ofport_dpif *ofport;
824 struct ofbundle *bundle;
828 complete_operations(ofproto);
830 dpif_run(ofproto->dpif);
832 error = run_fast(ofproto_);
837 if (timer_expired(&ofproto->next_expiration)) {
838 int delay = expire(ofproto);
839 timer_set_duration(&ofproto->next_expiration, delay);
842 if (ofproto->netflow) {
843 if (netflow_run(ofproto->netflow)) {
844 send_netflow_active_timeouts(ofproto);
847 if (ofproto->sflow) {
848 dpif_sflow_run(ofproto->sflow);
851 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
854 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
859 mac_learning_run(ofproto->ml, &ofproto->revalidate_set);
861 /* Now revalidate if there's anything to do. */
862 if (ofproto->need_revalidate
863 || !tag_set_is_empty(&ofproto->revalidate_set)) {
864 struct tag_set revalidate_set = ofproto->revalidate_set;
865 bool revalidate_all = ofproto->need_revalidate;
866 struct facet *facet, *next;
868 /* Clear the revalidation flags. */
869 tag_set_init(&ofproto->revalidate_set);
870 ofproto->need_revalidate = false;
872 HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &ofproto->facets) {
874 || tag_set_intersects(&revalidate_set, facet->tags)) {
875 facet_revalidate(facet);
880 /* Check the consistency of a random facet, to aid debugging. */
881 if (!hmap_is_empty(&ofproto->facets) && !ofproto->need_revalidate) {
884 facet = CONTAINER_OF(hmap_random_node(&ofproto->facets),
885 struct facet, hmap_node);
886 if (!tag_set_intersects(&ofproto->revalidate_set, facet->tags)) {
887 if (!facet_check_consistency(facet)) {
888 ofproto->need_revalidate = true;
893 if (ofproto->governor) {
896 governor_run(ofproto->governor);
898 /* If the governor has shrunk to its minimum size and the number of
899 * subfacets has dwindled, then drop the governor entirely.
901 * For hysteresis, the number of subfacets to drop the governor is
902 * smaller than the number needed to trigger its creation. */
903 n_subfacets = hmap_count(&ofproto->subfacets);
904 if (n_subfacets * 4 < ofproto->up.flow_eviction_threshold
905 && governor_is_idle(ofproto->governor)) {
906 governor_destroy(ofproto->governor);
907 ofproto->governor = NULL;
915 wait(struct ofproto *ofproto_)
917 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
918 struct ofport_dpif *ofport;
919 struct ofbundle *bundle;
921 if (!clogged && !list_is_empty(&ofproto->completions)) {
922 poll_immediate_wake();
925 dpif_wait(ofproto->dpif);
926 dpif_recv_wait(ofproto->dpif);
927 if (ofproto->sflow) {
928 dpif_sflow_wait(ofproto->sflow);
930 if (!tag_set_is_empty(&ofproto->revalidate_set)) {
931 poll_immediate_wake();
933 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
936 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
939 if (ofproto->netflow) {
940 netflow_wait(ofproto->netflow);
942 mac_learning_wait(ofproto->ml);
944 if (ofproto->need_revalidate) {
945 /* Shouldn't happen, but if it does just go around again. */
946 VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
947 poll_immediate_wake();
949 timer_wait(&ofproto->next_expiration);
951 if (ofproto->governor) {
952 governor_wait(ofproto->governor);
957 flush(struct ofproto *ofproto_)
959 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
960 struct facet *facet, *next_facet;
962 HMAP_FOR_EACH_SAFE (facet, next_facet, hmap_node, &ofproto->facets) {
963 /* Mark the facet as not installed so that facet_remove() doesn't
964 * bother trying to uninstall it. There is no point in uninstalling it
965 * individually since we are about to blow away all the facets with
966 * dpif_flow_flush(). */
967 struct subfacet *subfacet;
969 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
970 subfacet->installed = false;
971 subfacet->dp_packet_count = 0;
972 subfacet->dp_byte_count = 0;
976 dpif_flow_flush(ofproto->dpif);
980 get_features(struct ofproto *ofproto_ OVS_UNUSED,
981 bool *arp_match_ip, enum ofputil_action_bitmap *actions)
983 *arp_match_ip = true;
984 *actions = (OFPUTIL_A_OUTPUT |
985 OFPUTIL_A_SET_VLAN_VID |
986 OFPUTIL_A_SET_VLAN_PCP |
987 OFPUTIL_A_STRIP_VLAN |
988 OFPUTIL_A_SET_DL_SRC |
989 OFPUTIL_A_SET_DL_DST |
990 OFPUTIL_A_SET_NW_SRC |
991 OFPUTIL_A_SET_NW_DST |
992 OFPUTIL_A_SET_NW_TOS |
993 OFPUTIL_A_SET_TP_SRC |
994 OFPUTIL_A_SET_TP_DST |
999 get_tables(struct ofproto *ofproto_, struct ofp_table_stats *ots)
1001 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1002 struct dpif_dp_stats s;
1004 strcpy(ots->name, "classifier");
1006 dpif_get_dp_stats(ofproto->dpif, &s);
1007 put_32aligned_be64(&ots->lookup_count, htonll(s.n_hit + s.n_missed));
1008 put_32aligned_be64(&ots->matched_count,
1009 htonll(s.n_hit + ofproto->n_matches));
1012 static struct ofport *
1015 struct ofport_dpif *port = xmalloc(sizeof *port);
1020 port_dealloc(struct ofport *port_)
1022 struct ofport_dpif *port = ofport_dpif_cast(port_);
1027 port_construct(struct ofport *port_)
1029 struct ofport_dpif *port = ofport_dpif_cast(port_);
1030 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1032 ofproto->need_revalidate = true;
1033 port->odp_port = ofp_port_to_odp_port(port->up.ofp_port);
1034 port->bundle = NULL;
1036 port->tag = tag_create_random();
1037 port->may_enable = true;
1038 port->stp_port = NULL;
1039 port->stp_state = STP_DISABLED;
1040 hmap_init(&port->priorities);
1041 port->realdev_ofp_port = 0;
1042 port->vlandev_vid = 0;
1043 port->carrier_seq = netdev_get_carrier_resets(port->up.netdev);
1045 if (ofproto->sflow) {
1046 dpif_sflow_add_port(ofproto->sflow, port_);
1053 port_destruct(struct ofport *port_)
1055 struct ofport_dpif *port = ofport_dpif_cast(port_);
1056 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1058 ofproto->need_revalidate = true;
1059 bundle_remove(port_);
1060 set_cfm(port_, NULL);
1061 if (ofproto->sflow) {
1062 dpif_sflow_del_port(ofproto->sflow, port->odp_port);
1065 ofport_clear_priorities(port);
1066 hmap_destroy(&port->priorities);
1070 port_modified(struct ofport *port_)
1072 struct ofport_dpif *port = ofport_dpif_cast(port_);
1074 if (port->bundle && port->bundle->bond) {
1075 bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
1080 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1082 struct ofport_dpif *port = ofport_dpif_cast(port_);
1083 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1084 enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1086 if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1087 OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD)) {
1088 ofproto->need_revalidate = true;
1090 if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1091 bundle_update(port->bundle);
1097 set_sflow(struct ofproto *ofproto_,
1098 const struct ofproto_sflow_options *sflow_options)
1100 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1101 struct dpif_sflow *ds = ofproto->sflow;
1103 if (sflow_options) {
1105 struct ofport_dpif *ofport;
1107 ds = ofproto->sflow = dpif_sflow_create(ofproto->dpif);
1108 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1109 dpif_sflow_add_port(ds, &ofport->up);
1111 ofproto->need_revalidate = true;
1113 dpif_sflow_set_options(ds, sflow_options);
1116 dpif_sflow_destroy(ds);
1117 ofproto->need_revalidate = true;
1118 ofproto->sflow = NULL;
1125 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1127 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1134 struct ofproto_dpif *ofproto;
1136 ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1137 ofproto->need_revalidate = true;
1138 ofport->cfm = cfm_create(netdev_get_name(ofport->up.netdev));
1141 if (cfm_configure(ofport->cfm, s)) {
1147 cfm_destroy(ofport->cfm);
1153 get_cfm_fault(const struct ofport *ofport_)
1155 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1157 return ofport->cfm ? cfm_get_fault(ofport->cfm) : -1;
1161 get_cfm_remote_mpids(const struct ofport *ofport_, const uint64_t **rmps,
1164 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1167 cfm_get_remote_mpids(ofport->cfm, rmps, n_rmps);
1175 get_cfm_health(const struct ofport *ofport_)
1177 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1179 return ofport->cfm ? cfm_get_health(ofport->cfm) : -1;
1182 /* Spanning Tree. */
1185 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
1187 struct ofproto_dpif *ofproto = ofproto_;
1188 struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
1189 struct ofport_dpif *ofport;
1191 ofport = stp_port_get_aux(sp);
1193 VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
1194 ofproto->up.name, port_num);
1196 struct eth_header *eth = pkt->l2;
1198 netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
1199 if (eth_addr_is_zero(eth->eth_src)) {
1200 VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
1201 "with unknown MAC", ofproto->up.name, port_num);
1203 send_packet(ofport, pkt);
1209 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
1211 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
1213 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1215 /* Only revalidate flows if the configuration changed. */
1216 if (!s != !ofproto->stp) {
1217 ofproto->need_revalidate = true;
1221 if (!ofproto->stp) {
1222 ofproto->stp = stp_create(ofproto_->name, s->system_id,
1223 send_bpdu_cb, ofproto);
1224 ofproto->stp_last_tick = time_msec();
1227 stp_set_bridge_id(ofproto->stp, s->system_id);
1228 stp_set_bridge_priority(ofproto->stp, s->priority);
1229 stp_set_hello_time(ofproto->stp, s->hello_time);
1230 stp_set_max_age(ofproto->stp, s->max_age);
1231 stp_set_forward_delay(ofproto->stp, s->fwd_delay);
1233 struct ofport *ofport;
1235 HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
1236 set_stp_port(ofport, NULL);
1239 stp_destroy(ofproto->stp);
1240 ofproto->stp = NULL;
1247 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
1249 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1253 s->bridge_id = stp_get_bridge_id(ofproto->stp);
1254 s->designated_root = stp_get_designated_root(ofproto->stp);
1255 s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
1264 update_stp_port_state(struct ofport_dpif *ofport)
1266 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1267 enum stp_state state;
1269 /* Figure out new state. */
1270 state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
1274 if (ofport->stp_state != state) {
1275 enum ofputil_port_state of_state;
1278 VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
1279 netdev_get_name(ofport->up.netdev),
1280 stp_state_name(ofport->stp_state),
1281 stp_state_name(state));
1282 if (stp_learn_in_state(ofport->stp_state)
1283 != stp_learn_in_state(state)) {
1284 /* xxx Learning action flows should also be flushed. */
1285 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
1287 fwd_change = stp_forward_in_state(ofport->stp_state)
1288 != stp_forward_in_state(state);
1290 ofproto->need_revalidate = true;
1291 ofport->stp_state = state;
1292 ofport->stp_state_entered = time_msec();
1294 if (fwd_change && ofport->bundle) {
1295 bundle_update(ofport->bundle);
1298 /* Update the STP state bits in the OpenFlow port description. */
1299 of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
1300 of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
1301 : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
1302 : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
1303 : state == STP_BLOCKING ? OFPUTIL_PS_STP_BLOCK
1305 ofproto_port_set_state(&ofport->up, of_state);
1309 /* Configures STP on 'ofport_' using the settings defined in 's'. The
1310 * caller is responsible for assigning STP port numbers and ensuring
1311 * there are no duplicates. */
1313 set_stp_port(struct ofport *ofport_,
1314 const struct ofproto_port_stp_settings *s)
1316 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1317 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1318 struct stp_port *sp = ofport->stp_port;
1320 if (!s || !s->enable) {
1322 ofport->stp_port = NULL;
1323 stp_port_disable(sp);
1324 update_stp_port_state(ofport);
1327 } else if (sp && stp_port_no(sp) != s->port_num
1328 && ofport == stp_port_get_aux(sp)) {
1329 /* The port-id changed, so disable the old one if it's not
1330 * already in use by another port. */
1331 stp_port_disable(sp);
1334 sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
1335 stp_port_enable(sp);
1337 stp_port_set_aux(sp, ofport);
1338 stp_port_set_priority(sp, s->priority);
1339 stp_port_set_path_cost(sp, s->path_cost);
1341 update_stp_port_state(ofport);
1347 get_stp_port_status(struct ofport *ofport_,
1348 struct ofproto_port_stp_status *s)
1350 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1351 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1352 struct stp_port *sp = ofport->stp_port;
1354 if (!ofproto->stp || !sp) {
1360 s->port_id = stp_port_get_id(sp);
1361 s->state = stp_port_get_state(sp);
1362 s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
1363 s->role = stp_port_get_role(sp);
1364 stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
1370 stp_run(struct ofproto_dpif *ofproto)
1373 long long int now = time_msec();
1374 long long int elapsed = now - ofproto->stp_last_tick;
1375 struct stp_port *sp;
1378 stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
1379 ofproto->stp_last_tick = now;
1381 while (stp_get_changed_port(ofproto->stp, &sp)) {
1382 struct ofport_dpif *ofport = stp_port_get_aux(sp);
1385 update_stp_port_state(ofport);
1389 if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
1390 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
1396 stp_wait(struct ofproto_dpif *ofproto)
1399 poll_timer_wait(1000);
1403 /* Returns true if STP should process 'flow'. */
1405 stp_should_process_flow(const struct flow *flow)
1407 return eth_addr_equals(flow->dl_dst, eth_addr_stp);
1411 stp_process_packet(const struct ofport_dpif *ofport,
1412 const struct ofpbuf *packet)
1414 struct ofpbuf payload = *packet;
1415 struct eth_header *eth = payload.data;
1416 struct stp_port *sp = ofport->stp_port;
1418 /* Sink packets on ports that have STP disabled when the bridge has
1420 if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
1424 /* Trim off padding on payload. */
1425 if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1426 payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
1429 if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1430 stp_received_bpdu(sp, payload.data, payload.size);
1434 static struct priority_to_dscp *
1435 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
1437 struct priority_to_dscp *pdscp;
1440 hash = hash_int(priority, 0);
1441 HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
1442 if (pdscp->priority == priority) {
1450 ofport_clear_priorities(struct ofport_dpif *ofport)
1452 struct priority_to_dscp *pdscp, *next;
1454 HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
1455 hmap_remove(&ofport->priorities, &pdscp->hmap_node);
1461 set_queues(struct ofport *ofport_,
1462 const struct ofproto_port_queue *qdscp_list,
1465 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1466 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1467 struct hmap new = HMAP_INITIALIZER(&new);
1470 for (i = 0; i < n_qdscp; i++) {
1471 struct priority_to_dscp *pdscp;
1475 dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
1476 if (dpif_queue_to_priority(ofproto->dpif, qdscp_list[i].queue,
1481 pdscp = get_priority(ofport, priority);
1483 hmap_remove(&ofport->priorities, &pdscp->hmap_node);
1485 pdscp = xmalloc(sizeof *pdscp);
1486 pdscp->priority = priority;
1488 ofproto->need_revalidate = true;
1491 if (pdscp->dscp != dscp) {
1493 ofproto->need_revalidate = true;
1496 hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
1499 if (!hmap_is_empty(&ofport->priorities)) {
1500 ofport_clear_priorities(ofport);
1501 ofproto->need_revalidate = true;
1504 hmap_swap(&new, &ofport->priorities);
1512 /* Expires all MAC learning entries associated with 'bundle' and forces its
1513 * ofproto to revalidate every flow.
1515 * Normally MAC learning entries are removed only from the ofproto associated
1516 * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
1517 * are removed from every ofproto. When patch ports and SLB bonds are in use
1518 * and a VM migration happens and the gratuitous ARPs are somehow lost, this
1519 * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
1520 * with the host from which it migrated. */
1522 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
1524 struct ofproto_dpif *ofproto = bundle->ofproto;
1525 struct mac_learning *ml = ofproto->ml;
1526 struct mac_entry *mac, *next_mac;
1528 ofproto->need_revalidate = true;
1529 LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
1530 if (mac->port.p == bundle) {
1532 struct ofproto_dpif *o;
1534 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1536 struct mac_entry *e;
1538 e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
1541 tag_set_add(&o->revalidate_set, e->tag);
1542 mac_learning_expire(o->ml, e);
1548 mac_learning_expire(ml, mac);
1553 static struct ofbundle *
1554 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
1556 struct ofbundle *bundle;
1558 HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
1559 &ofproto->bundles) {
1560 if (bundle->aux == aux) {
1567 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
1568 * ones that are found to 'bundles'. */
1570 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
1571 void **auxes, size_t n_auxes,
1572 struct hmapx *bundles)
1576 hmapx_init(bundles);
1577 for (i = 0; i < n_auxes; i++) {
1578 struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
1580 hmapx_add(bundles, bundle);
1586 bundle_update(struct ofbundle *bundle)
1588 struct ofport_dpif *port;
1590 bundle->floodable = true;
1591 LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1592 if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
1593 || !stp_forward_in_state(port->stp_state)) {
1594 bundle->floodable = false;
1601 bundle_del_port(struct ofport_dpif *port)
1603 struct ofbundle *bundle = port->bundle;
1605 bundle->ofproto->need_revalidate = true;
1607 list_remove(&port->bundle_node);
1608 port->bundle = NULL;
1611 lacp_slave_unregister(bundle->lacp, port);
1614 bond_slave_unregister(bundle->bond, port);
1617 bundle_update(bundle);
1621 bundle_add_port(struct ofbundle *bundle, uint32_t ofp_port,
1622 struct lacp_slave_settings *lacp,
1623 uint32_t bond_stable_id)
1625 struct ofport_dpif *port;
1627 port = get_ofp_port(bundle->ofproto, ofp_port);
1632 if (port->bundle != bundle) {
1633 bundle->ofproto->need_revalidate = true;
1635 bundle_del_port(port);
1638 port->bundle = bundle;
1639 list_push_back(&bundle->ports, &port->bundle_node);
1640 if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
1641 || !stp_forward_in_state(port->stp_state)) {
1642 bundle->floodable = false;
1646 port->bundle->ofproto->need_revalidate = true;
1647 lacp_slave_register(bundle->lacp, port, lacp);
1650 port->bond_stable_id = bond_stable_id;
1656 bundle_destroy(struct ofbundle *bundle)
1658 struct ofproto_dpif *ofproto;
1659 struct ofport_dpif *port, *next_port;
1666 ofproto = bundle->ofproto;
1667 for (i = 0; i < MAX_MIRRORS; i++) {
1668 struct ofmirror *m = ofproto->mirrors[i];
1670 if (m->out == bundle) {
1672 } else if (hmapx_find_and_delete(&m->srcs, bundle)
1673 || hmapx_find_and_delete(&m->dsts, bundle)) {
1674 ofproto->need_revalidate = true;
1679 LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1680 bundle_del_port(port);
1683 bundle_flush_macs(bundle, true);
1684 hmap_remove(&ofproto->bundles, &bundle->hmap_node);
1686 free(bundle->trunks);
1687 lacp_destroy(bundle->lacp);
1688 bond_destroy(bundle->bond);
1693 bundle_set(struct ofproto *ofproto_, void *aux,
1694 const struct ofproto_bundle_settings *s)
1696 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1697 bool need_flush = false;
1698 struct ofport_dpif *port;
1699 struct ofbundle *bundle;
1700 unsigned long *trunks;
1706 bundle_destroy(bundle_lookup(ofproto, aux));
1710 assert(s->n_slaves == 1 || s->bond != NULL);
1711 assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
1713 bundle = bundle_lookup(ofproto, aux);
1715 bundle = xmalloc(sizeof *bundle);
1717 bundle->ofproto = ofproto;
1718 hmap_insert(&ofproto->bundles, &bundle->hmap_node,
1719 hash_pointer(aux, 0));
1721 bundle->name = NULL;
1723 list_init(&bundle->ports);
1724 bundle->vlan_mode = PORT_VLAN_TRUNK;
1726 bundle->trunks = NULL;
1727 bundle->use_priority_tags = s->use_priority_tags;
1728 bundle->lacp = NULL;
1729 bundle->bond = NULL;
1731 bundle->floodable = true;
1733 bundle->src_mirrors = 0;
1734 bundle->dst_mirrors = 0;
1735 bundle->mirror_out = 0;
1738 if (!bundle->name || strcmp(s->name, bundle->name)) {
1740 bundle->name = xstrdup(s->name);
1745 if (!bundle->lacp) {
1746 ofproto->need_revalidate = true;
1747 bundle->lacp = lacp_create();
1749 lacp_configure(bundle->lacp, s->lacp);
1751 lacp_destroy(bundle->lacp);
1752 bundle->lacp = NULL;
1755 /* Update set of ports. */
1757 for (i = 0; i < s->n_slaves; i++) {
1758 if (!bundle_add_port(bundle, s->slaves[i],
1759 s->lacp ? &s->lacp_slaves[i] : NULL,
1760 s->bond_stable_ids ? s->bond_stable_ids[i] : 0)) {
1764 if (!ok || list_size(&bundle->ports) != s->n_slaves) {
1765 struct ofport_dpif *next_port;
1767 LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
1768 for (i = 0; i < s->n_slaves; i++) {
1769 if (s->slaves[i] == port->up.ofp_port) {
1774 bundle_del_port(port);
1778 assert(list_size(&bundle->ports) <= s->n_slaves);
1780 if (list_is_empty(&bundle->ports)) {
1781 bundle_destroy(bundle);
1785 /* Set VLAN tagging mode */
1786 if (s->vlan_mode != bundle->vlan_mode
1787 || s->use_priority_tags != bundle->use_priority_tags) {
1788 bundle->vlan_mode = s->vlan_mode;
1789 bundle->use_priority_tags = s->use_priority_tags;
1794 vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
1795 : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
1797 if (vlan != bundle->vlan) {
1798 bundle->vlan = vlan;
1802 /* Get trunked VLANs. */
1803 switch (s->vlan_mode) {
1804 case PORT_VLAN_ACCESS:
1808 case PORT_VLAN_TRUNK:
1809 trunks = (unsigned long *) s->trunks;
1812 case PORT_VLAN_NATIVE_UNTAGGED:
1813 case PORT_VLAN_NATIVE_TAGGED:
1814 if (vlan != 0 && (!s->trunks
1815 || !bitmap_is_set(s->trunks, vlan)
1816 || bitmap_is_set(s->trunks, 0))) {
1817 /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
1819 trunks = bitmap_clone(s->trunks, 4096);
1821 trunks = bitmap_allocate1(4096);
1823 bitmap_set1(trunks, vlan);
1824 bitmap_set0(trunks, 0);
1826 trunks = (unsigned long *) s->trunks;
1833 if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
1834 free(bundle->trunks);
1835 if (trunks == s->trunks) {
1836 bundle->trunks = vlan_bitmap_clone(trunks);
1838 bundle->trunks = trunks;
1843 if (trunks != s->trunks) {
1848 if (!list_is_short(&bundle->ports)) {
1849 bundle->ofproto->has_bonded_bundles = true;
1851 if (bond_reconfigure(bundle->bond, s->bond)) {
1852 ofproto->need_revalidate = true;
1855 bundle->bond = bond_create(s->bond);
1856 ofproto->need_revalidate = true;
1859 LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1860 bond_slave_register(bundle->bond, port, port->bond_stable_id,
1864 bond_destroy(bundle->bond);
1865 bundle->bond = NULL;
1868 /* If we changed something that would affect MAC learning, un-learn
1869 * everything on this port and force flow revalidation. */
1871 bundle_flush_macs(bundle, false);
1878 bundle_remove(struct ofport *port_)
1880 struct ofport_dpif *port = ofport_dpif_cast(port_);
1881 struct ofbundle *bundle = port->bundle;
1884 bundle_del_port(port);
1885 if (list_is_empty(&bundle->ports)) {
1886 bundle_destroy(bundle);
1887 } else if (list_is_short(&bundle->ports)) {
1888 bond_destroy(bundle->bond);
1889 bundle->bond = NULL;
1895 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
1897 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
1898 struct ofport_dpif *port = port_;
1899 uint8_t ea[ETH_ADDR_LEN];
1902 error = netdev_get_etheraddr(port->up.netdev, ea);
1904 struct ofpbuf packet;
1907 ofpbuf_init(&packet, 0);
1908 packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
1910 memcpy(packet_pdu, pdu, pdu_size);
1912 send_packet(port, &packet);
1913 ofpbuf_uninit(&packet);
1915 VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
1916 "%s (%s)", port->bundle->name,
1917 netdev_get_name(port->up.netdev), strerror(error));
1922 bundle_send_learning_packets(struct ofbundle *bundle)
1924 struct ofproto_dpif *ofproto = bundle->ofproto;
1925 int error, n_packets, n_errors;
1926 struct mac_entry *e;
1928 error = n_packets = n_errors = 0;
1929 LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
1930 if (e->port.p != bundle) {
1931 struct ofpbuf *learning_packet;
1932 struct ofport_dpif *port;
1936 /* The assignment to "port" is unnecessary but makes "grep"ing for
1937 * struct ofport_dpif more effective. */
1938 learning_packet = bond_compose_learning_packet(bundle->bond,
1942 ret = send_packet(port, learning_packet);
1943 ofpbuf_delete(learning_packet);
1953 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1954 VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
1955 "packets, last error was: %s",
1956 bundle->name, n_errors, n_packets, strerror(error));
1958 VLOG_DBG("bond %s: sent %d gratuitous learning packets",
1959 bundle->name, n_packets);
1964 bundle_run(struct ofbundle *bundle)
1967 lacp_run(bundle->lacp, send_pdu_cb);
1970 struct ofport_dpif *port;
1972 LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
1973 bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
1976 bond_run(bundle->bond, &bundle->ofproto->revalidate_set,
1977 lacp_status(bundle->lacp));
1978 if (bond_should_send_learning_packets(bundle->bond)) {
1979 bundle_send_learning_packets(bundle);
1985 bundle_wait(struct ofbundle *bundle)
1988 lacp_wait(bundle->lacp);
1991 bond_wait(bundle->bond);
1998 mirror_scan(struct ofproto_dpif *ofproto)
2002 for (idx = 0; idx < MAX_MIRRORS; idx++) {
2003 if (!ofproto->mirrors[idx]) {
2010 static struct ofmirror *
2011 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2015 for (i = 0; i < MAX_MIRRORS; i++) {
2016 struct ofmirror *mirror = ofproto->mirrors[i];
2017 if (mirror && mirror->aux == aux) {
2025 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2027 mirror_update_dups(struct ofproto_dpif *ofproto)
2031 for (i = 0; i < MAX_MIRRORS; i++) {
2032 struct ofmirror *m = ofproto->mirrors[i];
2035 m->dup_mirrors = MIRROR_MASK_C(1) << i;
2039 for (i = 0; i < MAX_MIRRORS; i++) {
2040 struct ofmirror *m1 = ofproto->mirrors[i];
2047 for (j = i + 1; j < MAX_MIRRORS; j++) {
2048 struct ofmirror *m2 = ofproto->mirrors[j];
2050 if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2051 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2052 m2->dup_mirrors |= m1->dup_mirrors;
2059 mirror_set(struct ofproto *ofproto_, void *aux,
2060 const struct ofproto_mirror_settings *s)
2062 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2063 mirror_mask_t mirror_bit;
2064 struct ofbundle *bundle;
2065 struct ofmirror *mirror;
2066 struct ofbundle *out;
2067 struct hmapx srcs; /* Contains "struct ofbundle *"s. */
2068 struct hmapx dsts; /* Contains "struct ofbundle *"s. */
2071 mirror = mirror_lookup(ofproto, aux);
2073 mirror_destroy(mirror);
2079 idx = mirror_scan(ofproto);
2081 VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2083 ofproto->up.name, MAX_MIRRORS, s->name);
2087 mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2088 mirror->ofproto = ofproto;
2091 mirror->out_vlan = -1;
2092 mirror->name = NULL;
2095 if (!mirror->name || strcmp(s->name, mirror->name)) {
2097 mirror->name = xstrdup(s->name);
2100 /* Get the new configuration. */
2101 if (s->out_bundle) {
2102 out = bundle_lookup(ofproto, s->out_bundle);
2104 mirror_destroy(mirror);
2110 out_vlan = s->out_vlan;
2112 bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2113 bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2115 /* If the configuration has not changed, do nothing. */
2116 if (hmapx_equals(&srcs, &mirror->srcs)
2117 && hmapx_equals(&dsts, &mirror->dsts)
2118 && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2119 && mirror->out == out
2120 && mirror->out_vlan == out_vlan)
2122 hmapx_destroy(&srcs);
2123 hmapx_destroy(&dsts);
2127 hmapx_swap(&srcs, &mirror->srcs);
2128 hmapx_destroy(&srcs);
2130 hmapx_swap(&dsts, &mirror->dsts);
2131 hmapx_destroy(&dsts);
2133 free(mirror->vlans);
2134 mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2137 mirror->out_vlan = out_vlan;
2139 /* Update bundles. */
2140 mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2141 HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2142 if (hmapx_contains(&mirror->srcs, bundle)) {
2143 bundle->src_mirrors |= mirror_bit;
2145 bundle->src_mirrors &= ~mirror_bit;
2148 if (hmapx_contains(&mirror->dsts, bundle)) {
2149 bundle->dst_mirrors |= mirror_bit;
2151 bundle->dst_mirrors &= ~mirror_bit;
2154 if (mirror->out == bundle) {
2155 bundle->mirror_out |= mirror_bit;
2157 bundle->mirror_out &= ~mirror_bit;
2161 ofproto->need_revalidate = true;
2162 ofproto->has_mirrors = true;
2163 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
2164 mirror_update_dups(ofproto);
2170 mirror_destroy(struct ofmirror *mirror)
2172 struct ofproto_dpif *ofproto;
2173 mirror_mask_t mirror_bit;
2174 struct ofbundle *bundle;
2181 ofproto = mirror->ofproto;
2182 ofproto->need_revalidate = true;
2183 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
2185 mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2186 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
2187 bundle->src_mirrors &= ~mirror_bit;
2188 bundle->dst_mirrors &= ~mirror_bit;
2189 bundle->mirror_out &= ~mirror_bit;
2192 hmapx_destroy(&mirror->srcs);
2193 hmapx_destroy(&mirror->dsts);
2194 free(mirror->vlans);
2196 ofproto->mirrors[mirror->idx] = NULL;
2200 mirror_update_dups(ofproto);
2202 ofproto->has_mirrors = false;
2203 for (i = 0; i < MAX_MIRRORS; i++) {
2204 if (ofproto->mirrors[i]) {
2205 ofproto->has_mirrors = true;
2212 mirror_get_stats(struct ofproto *ofproto_, void *aux,
2213 uint64_t *packets, uint64_t *bytes)
2215 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2216 struct ofmirror *mirror = mirror_lookup(ofproto, aux);
2219 *packets = *bytes = UINT64_MAX;
2223 *packets = mirror->packet_count;
2224 *bytes = mirror->byte_count;
2230 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
2232 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2233 if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
2234 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
2240 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
2242 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2243 struct ofbundle *bundle = bundle_lookup(ofproto, aux);
2244 return bundle && bundle->mirror_out != 0;
2248 forward_bpdu_changed(struct ofproto *ofproto_)
2250 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2251 /* Revalidate cached flows whenever forward_bpdu option changes. */
2252 ofproto->need_revalidate = true;
2256 set_mac_idle_time(struct ofproto *ofproto_, unsigned int idle_time)
2258 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2259 mac_learning_set_idle_time(ofproto->ml, idle_time);
2264 static struct ofport_dpif *
2265 get_ofp_port(struct ofproto_dpif *ofproto, uint16_t ofp_port)
2267 struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
2268 return ofport ? ofport_dpif_cast(ofport) : NULL;
2271 static struct ofport_dpif *
2272 get_odp_port(struct ofproto_dpif *ofproto, uint32_t odp_port)
2274 return get_ofp_port(ofproto, odp_port_to_ofp_port(odp_port));
2278 ofproto_port_from_dpif_port(struct ofproto_port *ofproto_port,
2279 struct dpif_port *dpif_port)
2281 ofproto_port->name = dpif_port->name;
2282 ofproto_port->type = dpif_port->type;
2283 ofproto_port->ofp_port = odp_port_to_ofp_port(dpif_port->port_no);
2287 port_run(struct ofport_dpif *ofport)
2289 long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
2290 bool carrier_changed = carrier_seq != ofport->carrier_seq;
2291 bool enable = netdev_get_carrier(ofport->up.netdev);
2293 ofport->carrier_seq = carrier_seq;
2296 cfm_run(ofport->cfm);
2298 if (cfm_should_send_ccm(ofport->cfm)) {
2299 struct ofpbuf packet;
2301 ofpbuf_init(&packet, 0);
2302 cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
2303 send_packet(ofport, &packet);
2304 ofpbuf_uninit(&packet);
2307 enable = enable && !cfm_get_fault(ofport->cfm)
2308 && cfm_get_opup(ofport->cfm);
2311 if (ofport->bundle) {
2312 enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
2313 if (carrier_changed) {
2314 lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
2318 if (ofport->may_enable != enable) {
2319 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2321 if (ofproto->has_bundle_action) {
2322 ofproto->need_revalidate = true;
2326 ofport->may_enable = enable;
2330 port_wait(struct ofport_dpif *ofport)
2333 cfm_wait(ofport->cfm);
2338 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
2339 struct ofproto_port *ofproto_port)
2341 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2342 struct dpif_port dpif_port;
2345 error = dpif_port_query_by_name(ofproto->dpif, devname, &dpif_port);
2347 ofproto_port_from_dpif_port(ofproto_port, &dpif_port);
2353 port_add(struct ofproto *ofproto_, struct netdev *netdev, uint16_t *ofp_portp)
2355 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2359 error = dpif_port_add(ofproto->dpif, netdev, &odp_port);
2361 *ofp_portp = odp_port_to_ofp_port(odp_port);
2367 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
2369 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2372 error = dpif_port_del(ofproto->dpif, ofp_port_to_odp_port(ofp_port));
2374 struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
2376 /* The caller is going to close ofport->up.netdev. If this is a
2377 * bonded port, then the bond is using that netdev, so remove it
2378 * from the bond. The client will need to reconfigure everything
2379 * after deleting ports, so then the slave will get re-added. */
2380 bundle_remove(&ofport->up);
2387 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
2389 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2392 error = netdev_get_stats(ofport->up.netdev, stats);
2394 if (!error && ofport->odp_port == OVSP_LOCAL) {
2395 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2397 /* ofproto->stats.tx_packets represents packets that we created
2398 * internally and sent to some port (e.g. packets sent with
2399 * send_packet()). Account for them as if they had come from
2400 * OFPP_LOCAL and got forwarded. */
2402 if (stats->rx_packets != UINT64_MAX) {
2403 stats->rx_packets += ofproto->stats.tx_packets;
2406 if (stats->rx_bytes != UINT64_MAX) {
2407 stats->rx_bytes += ofproto->stats.tx_bytes;
2410 /* ofproto->stats.rx_packets represents packets that were received on
2411 * some port and we processed internally and dropped (e.g. STP).
2412 * Account fro them as if they had been forwarded to OFPP_LOCAL. */
2414 if (stats->tx_packets != UINT64_MAX) {
2415 stats->tx_packets += ofproto->stats.rx_packets;
2418 if (stats->tx_bytes != UINT64_MAX) {
2419 stats->tx_bytes += ofproto->stats.rx_bytes;
2426 /* Account packets for LOCAL port. */
2428 ofproto_update_local_port_stats(const struct ofproto *ofproto_,
2429 size_t tx_size, size_t rx_size)
2431 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2434 ofproto->stats.rx_packets++;
2435 ofproto->stats.rx_bytes += rx_size;
2438 ofproto->stats.tx_packets++;
2439 ofproto->stats.tx_bytes += tx_size;
2443 struct port_dump_state {
2444 struct dpif_port_dump dump;
2449 port_dump_start(const struct ofproto *ofproto_, void **statep)
2451 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2452 struct port_dump_state *state;
2454 *statep = state = xmalloc(sizeof *state);
2455 dpif_port_dump_start(&state->dump, ofproto->dpif);
2456 state->done = false;
2461 port_dump_next(const struct ofproto *ofproto_ OVS_UNUSED, void *state_,
2462 struct ofproto_port *port)
2464 struct port_dump_state *state = state_;
2465 struct dpif_port dpif_port;
2467 if (dpif_port_dump_next(&state->dump, &dpif_port)) {
2468 ofproto_port_from_dpif_port(port, &dpif_port);
2471 int error = dpif_port_dump_done(&state->dump);
2473 return error ? error : EOF;
2478 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
2480 struct port_dump_state *state = state_;
2483 dpif_port_dump_done(&state->dump);
2490 port_poll(const struct ofproto *ofproto_, char **devnamep)
2492 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2493 return dpif_port_poll(ofproto->dpif, devnamep);
2497 port_poll_wait(const struct ofproto *ofproto_)
2499 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2500 dpif_port_poll_wait(ofproto->dpif);
2504 port_is_lacp_current(const struct ofport *ofport_)
2506 const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2507 return (ofport->bundle && ofport->bundle->lacp
2508 ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
2512 /* Upcall handling. */
2514 /* Flow miss batching.
2516 * Some dpifs implement operations faster when you hand them off in a batch.
2517 * To allow batching, "struct flow_miss" queues the dpif-related work needed
2518 * for a given flow. Each "struct flow_miss" corresponds to sending one or
2519 * more packets, plus possibly installing the flow in the dpif.
2521 * So far we only batch the operations that affect flow setup time the most.
2522 * It's possible to batch more than that, but the benefit might be minimal. */
2524 struct hmap_node hmap_node;
2526 enum odp_key_fitness key_fitness;
2527 const struct nlattr *key;
2529 ovs_be16 initial_tci;
2530 struct list packets;
2533 struct flow_miss_op {
2534 struct dpif_op dpif_op;
2535 struct subfacet *subfacet; /* Subfacet */
2536 void *garbage; /* Pointer to pass to free(), NULL if none. */
2537 uint64_t stub[1024 / 8]; /* Temporary buffer. */
2540 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
2541 * OpenFlow controller as necessary according to their individual
2542 * configurations. */
2544 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
2545 const struct flow *flow)
2547 struct ofputil_packet_in pin;
2549 pin.packet = packet->data;
2550 pin.packet_len = packet->size;
2551 pin.reason = OFPR_NO_MATCH;
2552 pin.controller_id = 0;
2557 pin.send_len = 0; /* not used for flow table misses */
2559 flow_get_metadata(flow, &pin.fmd);
2561 /* Registers aren't meaningful on a miss. */
2562 memset(pin.fmd.reg_masks, 0, sizeof pin.fmd.reg_masks);
2564 connmgr_send_packet_in(ofproto->up.connmgr, &pin);
2568 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
2569 const struct ofpbuf *packet)
2571 struct ofport_dpif *ofport = get_ofp_port(ofproto, flow->in_port);
2577 if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
2579 cfm_process_heartbeat(ofport->cfm, packet);
2582 } else if (ofport->bundle && ofport->bundle->lacp
2583 && flow->dl_type == htons(ETH_TYPE_LACP)) {
2585 lacp_process_packet(ofport->bundle->lacp, ofport, packet);
2588 } else if (ofproto->stp && stp_should_process_flow(flow)) {
2590 stp_process_packet(ofport, packet);
2597 static struct flow_miss *
2598 flow_miss_find(struct hmap *todo, const struct flow *flow, uint32_t hash)
2600 struct flow_miss *miss;
2602 HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
2603 if (flow_equal(&miss->flow, flow)) {
2611 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
2612 * 'packet'. The caller must initialize op->actions and op->actions_len. If
2613 * 'miss' is associated with a subfacet the caller must also initialize the
2614 * returned op->subfacet, and if anything needs to be freed after processing
2615 * the op, the caller must initialize op->garbage also. */
2617 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
2618 struct flow_miss_op *op)
2620 if (miss->flow.vlan_tci != miss->initial_tci) {
2621 /* This packet was received on a VLAN splinter port. We
2622 * added a VLAN to the packet to make the packet resemble
2623 * the flow, but the actions were composed assuming that
2624 * the packet contained no VLAN. So, we must remove the
2625 * VLAN header from the packet before trying to execute the
2627 eth_pop_vlan(packet);
2630 op->subfacet = NULL;
2632 op->dpif_op.type = DPIF_OP_EXECUTE;
2633 op->dpif_op.u.execute.key = miss->key;
2634 op->dpif_op.u.execute.key_len = miss->key_len;
2635 op->dpif_op.u.execute.packet = packet;
2638 /* Helper for handle_flow_miss_without_facet() and
2639 * handle_flow_miss_with_facet(). */
2641 handle_flow_miss_common(struct rule_dpif *rule,
2642 struct ofpbuf *packet, const struct flow *flow)
2644 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2646 ofproto->n_matches++;
2648 if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
2650 * Extra-special case for fail-open mode.
2652 * We are in fail-open mode and the packet matched the fail-open
2653 * rule, but we are connected to a controller too. We should send
2654 * the packet up to the controller in the hope that it will try to
2655 * set up a flow and thereby allow us to exit fail-open.
2657 * See the top-level comment in fail-open.c for more information.
2659 send_packet_in_miss(ofproto, packet, flow);
2663 /* Figures out whether a flow that missed in 'ofproto', whose details are in
2664 * 'miss', is likely to be worth tracking in detail in userspace and (usually)
2665 * installing a datapath flow. The answer is usually "yes" (a return value of
2666 * true). However, for short flows the cost of bookkeeping is much higher than
2667 * the benefits, so when the datapath holds a large number of flows we impose
2668 * some heuristics to decide which flows are likely to be worth tracking. */
2670 flow_miss_should_make_facet(struct ofproto_dpif *ofproto,
2671 struct flow_miss *miss, uint32_t hash)
2673 if (!ofproto->governor) {
2676 n_subfacets = hmap_count(&ofproto->subfacets);
2677 if (n_subfacets * 2 <= ofproto->up.flow_eviction_threshold) {
2681 ofproto->governor = governor_create(ofproto->up.name);
2684 return governor_should_install_flow(ofproto->governor, hash,
2685 list_size(&miss->packets));
2688 /* Handles 'miss', which matches 'rule', without creating a facet or subfacet
2689 * or creating any datapath flow. May add an "execute" operation to 'ops' and
2690 * increment '*n_ops'. */
2692 handle_flow_miss_without_facet(struct flow_miss *miss,
2693 struct rule_dpif *rule,
2694 struct flow_miss_op *ops, size_t *n_ops)
2696 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
2697 struct action_xlate_ctx ctx;
2698 struct ofpbuf *packet;
2700 LIST_FOR_EACH (packet, list_node, &miss->packets) {
2701 struct flow_miss_op *op = &ops[*n_ops];
2702 struct dpif_flow_stats stats;
2703 struct ofpbuf odp_actions;
2705 COVERAGE_INC(facet_suppress);
2707 ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
2709 dpif_flow_stats_extract(&miss->flow, packet, &stats);
2710 rule_credit_stats(rule, &stats);
2712 action_xlate_ctx_init(&ctx, ofproto, &miss->flow, miss->initial_tci,
2714 ctx.resubmit_stats = &stats;
2715 xlate_actions(&ctx, rule->up.actions, rule->up.n_actions,
2718 if (odp_actions.size) {
2719 struct dpif_execute *execute = &op->dpif_op.u.execute;
2721 init_flow_miss_execute_op(miss, packet, op);
2722 execute->actions = odp_actions.data;
2723 execute->actions_len = odp_actions.size;
2724 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
2728 ofpbuf_uninit(&odp_actions);
2733 /* Handles 'miss', which matches 'facet'. May add any required datapath
2734 * operations to 'ops', incrementing '*n_ops' for each new op. */
2736 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
2737 struct flow_miss_op *ops, size_t *n_ops)
2739 struct subfacet *subfacet;
2740 struct ofpbuf *packet;
2742 subfacet = subfacet_create(facet,
2743 miss->key_fitness, miss->key, miss->key_len,
2746 LIST_FOR_EACH (packet, list_node, &miss->packets) {
2747 struct flow_miss_op *op = &ops[*n_ops];
2748 struct dpif_flow_stats stats;
2749 struct ofpbuf odp_actions;
2751 handle_flow_miss_common(facet->rule, packet, &miss->flow);
2753 ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
2754 if (!facet->may_install || !subfacet->actions) {
2755 subfacet_make_actions(subfacet, packet, &odp_actions);
2758 dpif_flow_stats_extract(&facet->flow, packet, &stats);
2759 subfacet_update_stats(subfacet, &stats);
2761 if (subfacet->actions_len) {
2762 struct dpif_execute *execute = &op->dpif_op.u.execute;
2764 init_flow_miss_execute_op(miss, packet, op);
2765 op->subfacet = subfacet;
2766 if (facet->may_install) {
2767 execute->actions = subfacet->actions;
2768 execute->actions_len = subfacet->actions_len;
2769 ofpbuf_uninit(&odp_actions);
2771 execute->actions = odp_actions.data;
2772 execute->actions_len = odp_actions.size;
2773 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
2778 ofpbuf_uninit(&odp_actions);
2782 if (facet->may_install && subfacet->key_fitness != ODP_FIT_TOO_LITTLE) {
2783 struct flow_miss_op *op = &ops[(*n_ops)++];
2784 struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
2786 op->subfacet = subfacet;
2788 op->dpif_op.type = DPIF_OP_FLOW_PUT;
2789 put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
2790 put->key = miss->key;
2791 put->key_len = miss->key_len;
2792 put->actions = subfacet->actions;
2793 put->actions_len = subfacet->actions_len;
2798 /* Handles flow miss 'miss' on 'ofproto'. The flow does not match any flow in
2799 * the OpenFlow flow table. */
2801 handle_flow_miss_no_rule(struct ofproto_dpif *ofproto, struct flow_miss *miss)
2803 uint16_t in_port = miss->flow.in_port;
2804 struct ofport_dpif *port = get_ofp_port(ofproto, in_port);
2807 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, in_port);
2810 if (port && port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
2811 /* XXX install 'drop' flow entry */
2812 COVERAGE_INC(ofproto_dpif_no_packet_in);
2814 const struct ofpbuf *packet;
2816 LIST_FOR_EACH (packet, list_node, &miss->packets) {
2817 send_packet_in_miss(ofproto, packet, &miss->flow);
2822 /* Handles flow miss 'miss' on 'ofproto'. May add any required datapath
2823 * operations to 'ops', incrementing '*n_ops' for each new op. */
2825 handle_flow_miss(struct ofproto_dpif *ofproto, struct flow_miss *miss,
2826 struct flow_miss_op *ops, size_t *n_ops)
2828 struct facet *facet;
2831 /* The caller must ensure that miss->hmap_node.hash contains
2832 * flow_hash(miss->flow, 0). */
2833 hash = miss->hmap_node.hash;
2835 facet = facet_lookup_valid(ofproto, &miss->flow, hash);
2837 struct rule_dpif *rule = rule_dpif_lookup(ofproto, &miss->flow, 0);
2839 handle_flow_miss_no_rule(ofproto, miss);
2841 } else if (!flow_miss_should_make_facet(ofproto, miss, hash)) {
2842 handle_flow_miss_without_facet(miss, rule, ops, n_ops);
2846 facet = facet_create(rule, &miss->flow, hash);
2848 handle_flow_miss_with_facet(miss, facet, ops, n_ops);
2851 /* Like odp_flow_key_to_flow(), this function converts the 'key_len' bytes of
2852 * OVS_KEY_ATTR_* attributes in 'key' to a flow structure in 'flow' and returns
2853 * an ODP_FIT_* value that indicates how well 'key' fits our expectations for
2854 * what a flow key should contain.
2856 * This function also includes some logic to help make VLAN splinters
2857 * transparent to the rest of the upcall processing logic. In particular, if
2858 * the extracted in_port is a VLAN splinter port, it replaces flow->in_port by
2859 * the "real" port, sets flow->vlan_tci correctly for the VLAN of the VLAN
2860 * splinter port, and pushes a VLAN header onto 'packet' (if it is nonnull).
2862 * Sets '*initial_tci' to the VLAN TCI with which the packet was really
2863 * received, that is, the actual VLAN TCI extracted by odp_flow_key_to_flow().
2864 * (This differs from the value returned in flow->vlan_tci only for packets
2865 * received on VLAN splinters.)
2867 static enum odp_key_fitness
2868 ofproto_dpif_extract_flow_key(const struct ofproto_dpif *ofproto,
2869 const struct nlattr *key, size_t key_len,
2870 struct flow *flow, ovs_be16 *initial_tci,
2871 struct ofpbuf *packet)
2873 enum odp_key_fitness fitness;
2875 fitness = odp_flow_key_to_flow(key, key_len, flow);
2876 if (fitness == ODP_FIT_ERROR) {
2879 *initial_tci = flow->vlan_tci;
2881 if (vsp_adjust_flow(ofproto, flow)) {
2883 /* Make the packet resemble the flow, so that it gets sent to an
2884 * OpenFlow controller properly, so that it looks correct for
2885 * sFlow, and so that flow_extract() will get the correct vlan_tci
2886 * if it is called on 'packet'.
2888 * The allocated space inside 'packet' probably also contains
2889 * 'key', that is, both 'packet' and 'key' are probably part of a
2890 * struct dpif_upcall (see the large comment on that structure
2891 * definition), so pushing data on 'packet' is in general not a
2892 * good idea since it could overwrite 'key' or free it as a side
2893 * effect. However, it's OK in this special case because we know
2894 * that 'packet' is inside a Netlink attribute: pushing 4 bytes
2895 * will just overwrite the 4-byte "struct nlattr", which is fine
2896 * since we don't need that header anymore. */
2897 eth_push_vlan(packet, flow->vlan_tci);
2900 /* Let the caller know that we can't reproduce 'key' from 'flow'. */
2901 if (fitness == ODP_FIT_PERFECT) {
2902 fitness = ODP_FIT_TOO_MUCH;
2910 handle_miss_upcalls(struct ofproto_dpif *ofproto, struct dpif_upcall *upcalls,
2913 struct dpif_upcall *upcall;
2914 struct flow_miss *miss;
2915 struct flow_miss misses[FLOW_MISS_MAX_BATCH];
2916 struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
2917 struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
2927 /* Construct the to-do list.
2929 * This just amounts to extracting the flow from each packet and sticking
2930 * the packets that have the same flow in the same "flow_miss" structure so
2931 * that we can process them together. */
2934 for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
2935 struct flow_miss *miss = &misses[n_misses];
2936 struct flow_miss *existing_miss;
2939 /* Obtain metadata and check userspace/kernel agreement on flow match,
2940 * then set 'flow''s header pointers. */
2941 miss->key_fitness = ofproto_dpif_extract_flow_key(
2942 ofproto, upcall->key, upcall->key_len,
2943 &miss->flow, &miss->initial_tci, upcall->packet);
2944 if (miss->key_fitness == ODP_FIT_ERROR) {
2947 flow_extract(upcall->packet, miss->flow.skb_priority,
2948 miss->flow.tun_id, miss->flow.in_port, &miss->flow);
2950 /* Handle 802.1ag, LACP, and STP specially. */
2951 if (process_special(ofproto, &miss->flow, upcall->packet)) {
2952 ofproto_update_local_port_stats(&ofproto->up,
2953 0, upcall->packet->size);
2954 ofproto->n_matches++;
2958 /* Add other packets to a to-do list. */
2959 hash = flow_hash(&miss->flow, 0);
2960 existing_miss = flow_miss_find(&todo, &miss->flow, hash);
2961 if (!existing_miss) {
2962 hmap_insert(&todo, &miss->hmap_node, hash);
2963 miss->key = upcall->key;
2964 miss->key_len = upcall->key_len;
2965 list_init(&miss->packets);
2969 miss = existing_miss;
2971 list_push_back(&miss->packets, &upcall->packet->list_node);
2974 /* Process each element in the to-do list, constructing the set of
2975 * operations to batch. */
2977 HMAP_FOR_EACH (miss, hmap_node, &todo) {
2978 handle_flow_miss(ofproto, miss, flow_miss_ops, &n_ops);
2980 assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
2982 /* Execute batch. */
2983 for (i = 0; i < n_ops; i++) {
2984 dpif_ops[i] = &flow_miss_ops[i].dpif_op;
2986 dpif_operate(ofproto->dpif, dpif_ops, n_ops);
2988 /* Free memory and update facets. */
2989 for (i = 0; i < n_ops; i++) {
2990 struct flow_miss_op *op = &flow_miss_ops[i];
2992 switch (op->dpif_op.type) {
2993 case DPIF_OP_EXECUTE:
2996 case DPIF_OP_FLOW_PUT:
2997 if (!op->dpif_op.error) {
2998 op->subfacet->installed = true;
3002 case DPIF_OP_FLOW_DEL:
3008 hmap_destroy(&todo);
3012 handle_userspace_upcall(struct ofproto_dpif *ofproto,
3013 struct dpif_upcall *upcall)
3015 union user_action_cookie cookie;
3016 enum odp_key_fitness fitness;
3017 ovs_be16 initial_tci;
3020 memcpy(&cookie, &upcall->userdata, sizeof(cookie));
3022 fitness = ofproto_dpif_extract_flow_key(ofproto, upcall->key,
3023 upcall->key_len, &flow,
3024 &initial_tci, upcall->packet);
3025 if (fitness == ODP_FIT_ERROR) {
3029 switch (cookie.type) {
3030 case USER_ACTION_COOKIE_SFLOW:
3031 if (ofproto->sflow) {
3032 dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
3037 case USER_ACTION_COOKIE_UNSPEC:
3039 VLOG_WARN_RL(&rl, "invalid user cookie : 0x%"PRIx64, upcall->userdata);
3045 handle_upcalls(struct ofproto_dpif *ofproto, unsigned int max_batch)
3047 struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
3048 struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
3049 uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
3054 assert(max_batch <= FLOW_MISS_MAX_BATCH);
3058 for (n_processed = 0; n_processed < max_batch; n_processed++) {
3059 struct dpif_upcall *upcall = &misses[n_misses];
3060 struct ofpbuf *buf = &miss_bufs[n_misses];
3063 ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
3064 sizeof miss_buf_stubs[n_misses]);
3065 error = dpif_recv(ofproto->dpif, upcall, buf);
3071 switch (upcall->type) {
3072 case DPIF_UC_ACTION:
3073 handle_userspace_upcall(ofproto, upcall);
3078 /* Handle it later. */
3082 case DPIF_N_UC_TYPES:
3084 VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32,
3090 handle_miss_upcalls(ofproto, misses, n_misses);
3091 for (i = 0; i < n_misses; i++) {
3092 ofpbuf_uninit(&miss_bufs[i]);
3098 /* Flow expiration. */
3100 static int subfacet_max_idle(const struct ofproto_dpif *);
3101 static void update_stats(struct ofproto_dpif *);
3102 static void rule_expire(struct rule_dpif *);
3103 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
3105 /* This function is called periodically by run(). Its job is to collect
3106 * updates for the flows that have been installed into the datapath, most
3107 * importantly when they last were used, and then use that information to
3108 * expire flows that have not been used recently.
3110 * Returns the number of milliseconds after which it should be called again. */
3112 expire(struct ofproto_dpif *ofproto)
3114 struct rule_dpif *rule, *next_rule;
3115 struct oftable *table;
3118 /* Update stats for each flow in the datapath. */
3119 update_stats(ofproto);
3121 /* Expire subfacets that have been idle too long. */
3122 dp_max_idle = subfacet_max_idle(ofproto);
3123 expire_subfacets(ofproto, dp_max_idle);
3125 /* Expire OpenFlow flows whose idle_timeout or hard_timeout has passed. */
3126 OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
3127 struct cls_cursor cursor;
3129 cls_cursor_init(&cursor, &table->cls, NULL);
3130 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
3135 /* All outstanding data in existing flows has been accounted, so it's a
3136 * good time to do bond rebalancing. */
3137 if (ofproto->has_bonded_bundles) {
3138 struct ofbundle *bundle;
3140 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3142 bond_rebalance(bundle->bond, &ofproto->revalidate_set);
3147 return MIN(dp_max_idle, 1000);
3150 /* Updates flow table statistics given that the datapath just reported 'stats'
3151 * as 'subfacet''s statistics. */
3153 update_subfacet_stats(struct subfacet *subfacet,
3154 const struct dpif_flow_stats *stats)
3156 struct facet *facet = subfacet->facet;
3158 if (stats->n_packets >= subfacet->dp_packet_count) {
3159 uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
3160 facet->packet_count += extra;
3162 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
3165 if (stats->n_bytes >= subfacet->dp_byte_count) {
3166 facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
3168 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
3171 subfacet->dp_packet_count = stats->n_packets;
3172 subfacet->dp_byte_count = stats->n_bytes;
3174 facet->tcp_flags |= stats->tcp_flags;
3176 subfacet_update_time(subfacet, stats->used);
3177 if (facet->accounted_bytes < facet->byte_count) {
3179 facet_account(facet);
3180 facet->accounted_bytes = facet->byte_count;
3182 facet_push_stats(facet);
3185 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
3186 * about, or a flow that shouldn't be installed but was anyway. Delete it. */
3188 delete_unexpected_flow(struct dpif *dpif,
3189 const struct nlattr *key, size_t key_len)
3191 if (!VLOG_DROP_WARN(&rl)) {
3195 odp_flow_key_format(key, key_len, &s);
3196 VLOG_WARN("unexpected flow from datapath %s", ds_cstr(&s));
3200 COVERAGE_INC(facet_unexpected);
3201 dpif_flow_del(dpif, key, key_len, NULL);
3204 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
3206 * This function also pushes statistics updates to rules which each facet
3207 * resubmits into. Generally these statistics will be accurate. However, if a
3208 * facet changes the rule it resubmits into at some time in between
3209 * update_stats() runs, it is possible that statistics accrued to the
3210 * old rule will be incorrectly attributed to the new rule. This could be
3211 * avoided by calling update_stats() whenever rules are created or
3212 * deleted. However, the performance impact of making so many calls to the
3213 * datapath do not justify the benefit of having perfectly accurate statistics.
3216 update_stats(struct ofproto_dpif *p)
3218 const struct dpif_flow_stats *stats;
3219 struct dpif_flow_dump dump;
3220 const struct nlattr *key;
3223 dpif_flow_dump_start(&dump, p->dpif);
3224 while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
3225 struct subfacet *subfacet;
3227 subfacet = subfacet_find(p, key, key_len);
3228 if (subfacet && subfacet->installed) {
3229 update_subfacet_stats(subfacet, stats);
3231 delete_unexpected_flow(p->dpif, key, key_len);
3234 dpif_flow_dump_done(&dump);
3237 /* Calculates and returns the number of milliseconds of idle time after which
3238 * subfacets should expire from the datapath. When a subfacet expires, we fold
3239 * its statistics into its facet, and when a facet's last subfacet expires, we
3240 * fold its statistic into its rule. */
3242 subfacet_max_idle(const struct ofproto_dpif *ofproto)
3245 * Idle time histogram.
3247 * Most of the time a switch has a relatively small number of subfacets.
3248 * When this is the case we might as well keep statistics for all of them
3249 * in userspace and to cache them in the kernel datapath for performance as
3252 * As the number of subfacets increases, the memory required to maintain
3253 * statistics about them in userspace and in the kernel becomes
3254 * significant. However, with a large number of subfacets it is likely
3255 * that only a few of them are "heavy hitters" that consume a large amount
3256 * of bandwidth. At this point, only heavy hitters are worth caching in
3257 * the kernel and maintaining in userspaces; other subfacets we can
3260 * The technique used to compute the idle time is to build a histogram with
3261 * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each. Each subfacet
3262 * that is installed in the kernel gets dropped in the appropriate bucket.
3263 * After the histogram has been built, we compute the cutoff so that only
3264 * the most-recently-used 1% of subfacets (but at least
3265 * ofproto->up.flow_eviction_threshold flows) are kept cached. At least
3266 * the most-recently-used bucket of subfacets is kept, so actually an
3267 * arbitrary number of subfacets can be kept in any given expiration run
3268 * (though the next run will delete most of those unless they receive
3271 * This requires a second pass through the subfacets, in addition to the
3272 * pass made by update_stats(), because the former function never looks at
3273 * uninstallable subfacets.
3275 enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
3276 enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
3277 int buckets[N_BUCKETS] = { 0 };
3278 int total, subtotal, bucket;
3279 struct subfacet *subfacet;
3283 total = hmap_count(&ofproto->subfacets);
3284 if (total <= ofproto->up.flow_eviction_threshold) {
3285 return N_BUCKETS * BUCKET_WIDTH;
3288 /* Build histogram. */
3290 HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
3291 long long int idle = now - subfacet->used;
3292 int bucket = (idle <= 0 ? 0
3293 : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
3294 : (unsigned int) idle / BUCKET_WIDTH);
3298 /* Find the first bucket whose flows should be expired. */
3299 subtotal = bucket = 0;
3301 subtotal += buckets[bucket++];
3302 } while (bucket < N_BUCKETS &&
3303 subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
3305 if (VLOG_IS_DBG_ENABLED()) {
3309 ds_put_cstr(&s, "keep");
3310 for (i = 0; i < N_BUCKETS; i++) {
3312 ds_put_cstr(&s, ", drop");
3315 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
3318 VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
3322 return bucket * BUCKET_WIDTH;
3325 enum { EXPIRE_MAX_BATCH = 50 };
3328 expire_batch(struct ofproto_dpif *ofproto, struct subfacet **subfacets, int n)
3330 struct odputil_keybuf keybufs[EXPIRE_MAX_BATCH];
3331 struct dpif_op ops[EXPIRE_MAX_BATCH];
3332 struct dpif_op *opsp[EXPIRE_MAX_BATCH];
3333 struct ofpbuf keys[EXPIRE_MAX_BATCH];
3334 struct dpif_flow_stats stats[EXPIRE_MAX_BATCH];
3337 for (i = 0; i < n; i++) {
3338 ops[i].type = DPIF_OP_FLOW_DEL;
3339 subfacet_get_key(subfacets[i], &keybufs[i], &keys[i]);
3340 ops[i].u.flow_del.key = keys[i].data;
3341 ops[i].u.flow_del.key_len = keys[i].size;
3342 ops[i].u.flow_del.stats = &stats[i];
3346 dpif_operate(ofproto->dpif, opsp, n);
3347 for (i = 0; i < n; i++) {
3348 subfacet_reset_dp_stats(subfacets[i], &stats[i]);
3349 subfacets[i]->installed = false;
3350 subfacet_destroy(subfacets[i]);
3355 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
3357 long long int cutoff = time_msec() - dp_max_idle;
3359 struct subfacet *subfacet, *next_subfacet;
3360 struct subfacet *batch[EXPIRE_MAX_BATCH];
3364 HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
3365 &ofproto->subfacets) {
3366 if (subfacet->used < cutoff) {
3367 if (subfacet->installed) {
3368 batch[n_batch++] = subfacet;
3369 if (n_batch >= EXPIRE_MAX_BATCH) {
3370 expire_batch(ofproto, batch, n_batch);
3374 subfacet_destroy(subfacet);
3380 expire_batch(ofproto, batch, n_batch);
3384 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
3385 * then delete it entirely. */
3387 rule_expire(struct rule_dpif *rule)
3389 struct facet *facet, *next_facet;
3393 /* Has 'rule' expired? */
3395 if (rule->up.hard_timeout
3396 && now > rule->up.modified + rule->up.hard_timeout * 1000) {
3397 reason = OFPRR_HARD_TIMEOUT;
3398 } else if (rule->up.idle_timeout
3399 && now > rule->up.used + rule->up.idle_timeout * 1000) {
3400 reason = OFPRR_IDLE_TIMEOUT;
3405 COVERAGE_INC(ofproto_dpif_expired);
3407 /* Update stats. (This is a no-op if the rule expired due to an idle
3408 * timeout, because that only happens when the rule has no facets left.) */
3409 LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
3410 facet_remove(facet);
3413 /* Get rid of the rule. */
3414 ofproto_rule_expire(&rule->up, reason);
3419 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
3421 * The caller must already have determined that no facet with an identical
3422 * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
3423 * the ofproto's classifier table.
3425 * 'hash' must be the return value of flow_hash(flow, 0).
3427 * The facet will initially have no subfacets. The caller should create (at
3428 * least) one subfacet with subfacet_create(). */
3429 static struct facet *
3430 facet_create(struct rule_dpif *rule, const struct flow *flow, uint32_t hash)
3432 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3433 struct facet *facet;
3435 facet = xzalloc(sizeof *facet);
3436 facet->used = time_msec();
3437 hmap_insert(&ofproto->facets, &facet->hmap_node, hash);
3438 list_push_back(&rule->facets, &facet->list_node);
3440 facet->flow = *flow;
3441 list_init(&facet->subfacets);
3442 netflow_flow_init(&facet->nf_flow);
3443 netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
3449 facet_free(struct facet *facet)
3454 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
3455 * 'packet', which arrived on 'in_port'.
3457 * Takes ownership of 'packet'. */
3459 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
3460 const struct nlattr *odp_actions, size_t actions_len,
3461 struct ofpbuf *packet)
3463 struct odputil_keybuf keybuf;
3467 ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
3468 odp_flow_key_from_flow(&key, flow);
3470 error = dpif_execute(ofproto->dpif, key.data, key.size,
3471 odp_actions, actions_len, packet);
3473 ofpbuf_delete(packet);
3477 /* Remove 'facet' from 'ofproto' and free up the associated memory:
3479 * - If 'facet' was installed in the datapath, uninstalls it and updates its
3480 * rule's statistics, via subfacet_uninstall().
3482 * - Removes 'facet' from its rule and from ofproto->facets.
3485 facet_remove(struct facet *facet)
3487 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3488 struct subfacet *subfacet, *next_subfacet;
3490 assert(!list_is_empty(&facet->subfacets));
3492 /* First uninstall all of the subfacets to get final statistics. */
3493 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3494 subfacet_uninstall(subfacet);
3497 /* Flush the final stats to the rule.
3499 * This might require us to have at least one subfacet around so that we
3500 * can use its actions for accounting in facet_account(), which is why we
3501 * have uninstalled but not yet destroyed the subfacets. */
3502 facet_flush_stats(facet);
3504 /* Now we're really all done so destroy everything. */
3505 LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
3506 &facet->subfacets) {
3507 subfacet_destroy__(subfacet);
3509 hmap_remove(&ofproto->facets, &facet->hmap_node);
3510 list_remove(&facet->list_node);
3514 /* Feed information from 'facet' back into the learning table to keep it in
3515 * sync with what is actually flowing through the datapath. */
3517 facet_learn(struct facet *facet)
3519 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3520 struct action_xlate_ctx ctx;
3522 if (!facet->has_learn
3523 && !facet->has_normal
3524 && (!facet->has_fin_timeout
3525 || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
3529 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3530 facet->flow.vlan_tci,
3531 facet->rule, facet->tcp_flags, NULL);
3532 ctx.may_learn = true;
3533 xlate_actions_for_side_effects(&ctx, facet->rule->up.actions,
3534 facet->rule->up.n_actions);
3538 facet_account(struct facet *facet)
3540 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3541 struct subfacet *subfacet;
3542 const struct nlattr *a;
3547 if (!facet->has_normal || !ofproto->has_bonded_bundles) {
3550 n_bytes = facet->byte_count - facet->accounted_bytes;
3552 /* This loop feeds byte counters to bond_account() for rebalancing to use
3553 * as a basis. We also need to track the actual VLAN on which the packet
3554 * is going to be sent to ensure that it matches the one passed to
3555 * bond_choose_output_slave(). (Otherwise, we will account to the wrong
3558 * We use the actions from an arbitrary subfacet because they should all
3559 * be equally valid for our purpose. */
3560 subfacet = CONTAINER_OF(list_front(&facet->subfacets),
3561 struct subfacet, list_node);
3562 vlan_tci = facet->flow.vlan_tci;
3563 NL_ATTR_FOR_EACH_UNSAFE (a, left,
3564 subfacet->actions, subfacet->actions_len) {
3565 const struct ovs_action_push_vlan *vlan;
3566 struct ofport_dpif *port;
3568 switch (nl_attr_type(a)) {
3569 case OVS_ACTION_ATTR_OUTPUT:
3570 port = get_odp_port(ofproto, nl_attr_get_u32(a));
3571 if (port && port->bundle && port->bundle->bond) {
3572 bond_account(port->bundle->bond, &facet->flow,
3573 vlan_tci_to_vid(vlan_tci), n_bytes);
3577 case OVS_ACTION_ATTR_POP_VLAN:
3578 vlan_tci = htons(0);
3581 case OVS_ACTION_ATTR_PUSH_VLAN:
3582 vlan = nl_attr_get(a);
3583 vlan_tci = vlan->vlan_tci;
3589 /* Returns true if the only action for 'facet' is to send to the controller.
3590 * (We don't report NetFlow expiration messages for such facets because they
3591 * are just part of the control logic for the network, not real traffic). */
3593 facet_is_controller_flow(struct facet *facet)
3596 && facet->rule->up.n_actions == 1
3597 && action_outputs_to_port(&facet->rule->up.actions[0],
3598 htons(OFPP_CONTROLLER)));
3601 /* Folds all of 'facet''s statistics into its rule. Also updates the
3602 * accounting ofhook and emits a NetFlow expiration if appropriate. All of
3603 * 'facet''s statistics in the datapath should have been zeroed and folded into
3604 * its packet and byte counts before this function is called. */
3606 facet_flush_stats(struct facet *facet)
3608 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3609 struct subfacet *subfacet;
3611 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3612 assert(!subfacet->dp_byte_count);
3613 assert(!subfacet->dp_packet_count);
3616 facet_push_stats(facet);
3617 if (facet->accounted_bytes < facet->byte_count) {
3618 facet_account(facet);
3619 facet->accounted_bytes = facet->byte_count;
3622 if (ofproto->netflow && !facet_is_controller_flow(facet)) {
3623 struct ofexpired expired;
3624 expired.flow = facet->flow;
3625 expired.packet_count = facet->packet_count;
3626 expired.byte_count = facet->byte_count;
3627 expired.used = facet->used;
3628 netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
3631 facet->rule->packet_count += facet->packet_count;
3632 facet->rule->byte_count += facet->byte_count;
3634 /* Reset counters to prevent double counting if 'facet' ever gets
3636 facet_reset_counters(facet);
3638 netflow_flow_clear(&facet->nf_flow);
3639 facet->tcp_flags = 0;
3642 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3643 * Returns it if found, otherwise a null pointer.
3645 * 'hash' must be the return value of flow_hash(flow, 0).
3647 * The returned facet might need revalidation; use facet_lookup_valid()
3648 * instead if that is important. */
3649 static struct facet *
3650 facet_find(struct ofproto_dpif *ofproto,
3651 const struct flow *flow, uint32_t hash)
3653 struct facet *facet;
3655 HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, hash, &ofproto->facets) {
3656 if (flow_equal(flow, &facet->flow)) {
3664 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
3665 * Returns it if found, otherwise a null pointer.
3667 * 'hash' must be the return value of flow_hash(flow, 0).
3669 * The returned facet is guaranteed to be valid. */
3670 static struct facet *
3671 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow,
3674 struct facet *facet = facet_find(ofproto, flow, hash);
3676 /* The facet we found might not be valid, since we could be in need of
3677 * revalidation. If it is not valid, don't return it. */
3679 && (ofproto->need_revalidate
3680 || tag_set_intersects(&ofproto->revalidate_set, facet->tags))
3681 && !facet_revalidate(facet)) {
3682 COVERAGE_INC(facet_invalidated);
3690 facet_check_consistency(struct facet *facet)
3692 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3694 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3696 uint64_t odp_actions_stub[1024 / 8];
3697 struct ofpbuf odp_actions;
3699 struct rule_dpif *rule;
3700 struct subfacet *subfacet;
3701 bool may_log = false;
3704 /* Check the rule for consistency. */
3705 rule = rule_dpif_lookup(ofproto, &facet->flow, 0);
3707 if (!VLOG_DROP_WARN(&rl)) {
3708 char *s = flow_to_string(&facet->flow);
3709 VLOG_WARN("%s: facet should not exist", s);
3713 } else if (rule != facet->rule) {
3714 may_log = !VLOG_DROP_WARN(&rl);
3720 flow_format(&s, &facet->flow);
3721 ds_put_format(&s, ": facet associated with wrong rule (was "
3722 "table=%"PRIu8",", facet->rule->up.table_id);
3723 cls_rule_format(&facet->rule->up.cr, &s);
3724 ds_put_format(&s, ") (should have been table=%"PRIu8",",
3726 cls_rule_format(&rule->up.cr, &s);
3727 ds_put_char(&s, ')');
3729 VLOG_WARN("%s", ds_cstr(&s));
3736 /* Check the datapath actions for consistency. */
3737 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
3738 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3739 struct action_xlate_ctx ctx;
3740 bool actions_changed;
3741 bool should_install;
3743 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3744 subfacet->initial_tci, rule, 0, NULL);
3745 xlate_actions(&ctx, rule->up.actions, rule->up.n_actions,
3748 should_install = (ctx.may_set_up_flow
3749 && subfacet->key_fitness != ODP_FIT_TOO_LITTLE);
3750 if (!should_install && !subfacet->installed) {
3751 /* The actions for uninstallable flows may vary from one packet to
3752 * the next, so don't compare the actions. */
3756 actions_changed = (subfacet->actions_len != odp_actions.size
3757 || memcmp(subfacet->actions, odp_actions.data,
3758 subfacet->actions_len));
3759 if (should_install != subfacet->installed || actions_changed) {
3761 may_log = !VLOG_DROP_WARN(&rl);
3766 struct odputil_keybuf keybuf;
3771 subfacet_get_key(subfacet, &keybuf, &key);
3772 odp_flow_key_format(key.data, key.size, &s);
3774 ds_put_cstr(&s, ": inconsistency in subfacet");
3775 if (should_install != subfacet->installed) {
3776 enum odp_key_fitness fitness = subfacet->key_fitness;
3778 ds_put_format(&s, " (should%s have been installed)",
3779 should_install ? "" : " not");
3780 ds_put_format(&s, " (may_set_up_flow=%s, fitness=%s)",
3781 ctx.may_set_up_flow ? "true" : "false",
3782 odp_key_fitness_to_string(fitness));
3784 if (actions_changed) {
3785 ds_put_cstr(&s, " (actions were: ");
3786 format_odp_actions(&s, subfacet->actions,
3787 subfacet->actions_len);
3788 ds_put_cstr(&s, ") (correct actions: ");
3789 format_odp_actions(&s, odp_actions.data, odp_actions.size);
3790 ds_put_char(&s, ')');
3792 ds_put_cstr(&s, " (actions: ");
3793 format_odp_actions(&s, subfacet->actions,
3794 subfacet->actions_len);
3795 ds_put_char(&s, ')');
3797 VLOG_WARN("%s", ds_cstr(&s));
3802 ofpbuf_uninit(&odp_actions);
3807 /* Re-searches the classifier for 'facet':
3809 * - If the rule found is different from 'facet''s current rule, moves
3810 * 'facet' to the new rule and recompiles its actions.
3812 * - If the rule found is the same as 'facet''s current rule, leaves 'facet'
3813 * where it is and recompiles its actions anyway.
3815 * - If there is none, destroys 'facet'.
3817 * Returns true if 'facet' still exists, false if it has been destroyed. */
3819 facet_revalidate(struct facet *facet)
3821 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3823 struct nlattr *odp_actions;
3826 struct actions *new_actions;
3828 struct action_xlate_ctx ctx;
3829 uint64_t odp_actions_stub[1024 / 8];
3830 struct ofpbuf odp_actions;
3832 struct rule_dpif *new_rule;
3833 struct subfacet *subfacet;
3834 bool actions_changed;
3837 COVERAGE_INC(facet_revalidate);
3839 /* Determine the new rule. */
3840 new_rule = rule_dpif_lookup(ofproto, &facet->flow, 0);
3842 /* No new rule, so delete the facet. */
3843 facet_remove(facet);
3847 /* Calculate new datapath actions.
3849 * We do not modify any 'facet' state yet, because we might need to, e.g.,
3850 * emit a NetFlow expiration and, if so, we need to have the old state
3851 * around to properly compose it. */
3853 /* If the datapath actions changed or the installability changed,
3854 * then we need to talk to the datapath. */
3857 memset(&ctx, 0, sizeof ctx);
3858 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
3859 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3860 bool should_install;
3862 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
3863 subfacet->initial_tci, new_rule, 0, NULL);
3864 xlate_actions(&ctx, new_rule->up.actions, new_rule->up.n_actions,
3866 actions_changed = (subfacet->actions_len != odp_actions.size
3867 || memcmp(subfacet->actions, odp_actions.data,
3868 subfacet->actions_len));
3870 should_install = (ctx.may_set_up_flow
3871 && subfacet->key_fitness != ODP_FIT_TOO_LITTLE);
3872 if (actions_changed || should_install != subfacet->installed) {
3873 if (should_install) {
3874 struct dpif_flow_stats stats;
3876 subfacet_install(subfacet,
3877 odp_actions.data, odp_actions.size, &stats);
3878 subfacet_update_stats(subfacet, &stats);
3880 subfacet_uninstall(subfacet);
3884 new_actions = xcalloc(list_size(&facet->subfacets),
3885 sizeof *new_actions);
3887 new_actions[i].odp_actions = xmemdup(odp_actions.data,
3889 new_actions[i].actions_len = odp_actions.size;
3894 ofpbuf_uninit(&odp_actions);
3897 facet_flush_stats(facet);
3900 /* Update 'facet' now that we've taken care of all the old state. */
3901 facet->tags = ctx.tags;
3902 facet->nf_flow.output_iface = ctx.nf_output_iface;
3903 facet->may_install = ctx.may_set_up_flow;
3904 facet->has_learn = ctx.has_learn;
3905 facet->has_normal = ctx.has_normal;
3906 facet->has_fin_timeout = ctx.has_fin_timeout;
3907 facet->mirrors = ctx.mirrors;
3910 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
3911 if (new_actions[i].odp_actions) {
3912 free(subfacet->actions);
3913 subfacet->actions = new_actions[i].odp_actions;
3914 subfacet->actions_len = new_actions[i].actions_len;
3920 if (facet->rule != new_rule) {
3921 COVERAGE_INC(facet_changed_rule);
3922 list_remove(&facet->list_node);
3923 list_push_back(&new_rule->facets, &facet->list_node);
3924 facet->rule = new_rule;
3925 facet->used = new_rule->up.created;
3926 facet->prev_used = facet->used;
3932 /* Updates 'facet''s used time. Caller is responsible for calling
3933 * facet_push_stats() to update the flows which 'facet' resubmits into. */
3935 facet_update_time(struct facet *facet, long long int used)
3937 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3938 if (used > facet->used) {
3940 ofproto_rule_update_used(&facet->rule->up, used);
3941 netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
3946 facet_reset_counters(struct facet *facet)
3948 facet->packet_count = 0;
3949 facet->byte_count = 0;
3950 facet->prev_packet_count = 0;
3951 facet->prev_byte_count = 0;
3952 facet->accounted_bytes = 0;
3956 facet_push_stats(struct facet *facet)
3958 struct dpif_flow_stats stats;
3960 assert(facet->packet_count >= facet->prev_packet_count);
3961 assert(facet->byte_count >= facet->prev_byte_count);
3962 assert(facet->used >= facet->prev_used);
3964 stats.n_packets = facet->packet_count - facet->prev_packet_count;
3965 stats.n_bytes = facet->byte_count - facet->prev_byte_count;
3966 stats.used = facet->used;
3967 stats.tcp_flags = 0;
3969 if (stats.n_packets || stats.n_bytes || facet->used > facet->prev_used) {
3970 facet->prev_packet_count = facet->packet_count;
3971 facet->prev_byte_count = facet->byte_count;
3972 facet->prev_used = facet->used;
3974 flow_push_stats(facet->rule, &facet->flow, &stats);
3976 update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
3977 facet->mirrors, stats.n_packets, stats.n_bytes);
3982 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
3984 rule->packet_count += stats->n_packets;
3985 rule->byte_count += stats->n_bytes;
3986 ofproto_rule_update_used(&rule->up, stats->used);
3989 /* Pushes flow statistics to the rules which 'flow' resubmits into given
3990 * 'rule''s actions and mirrors. */
3992 flow_push_stats(struct rule_dpif *rule,
3993 const struct flow *flow, const struct dpif_flow_stats *stats)
3995 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3996 struct action_xlate_ctx ctx;
3998 ofproto_rule_update_used(&rule->up, stats->used);
4000 action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci, rule,
4002 ctx.resubmit_stats = stats;
4003 xlate_actions_for_side_effects(&ctx, rule->up.actions, rule->up.n_actions);
4008 static struct subfacet *
4009 subfacet_find__(struct ofproto_dpif *ofproto,
4010 const struct nlattr *key, size_t key_len, uint32_t key_hash,
4011 const struct flow *flow)
4013 struct subfacet *subfacet;
4015 HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
4016 &ofproto->subfacets) {
4018 ? (subfacet->key_len == key_len
4019 && !memcmp(key, subfacet->key, key_len))
4020 : flow_equal(flow, &subfacet->facet->flow)) {
4028 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
4029 * 'key_fitness', 'key', and 'key_len'. Returns the existing subfacet if
4030 * there is one, otherwise creates and returns a new subfacet.
4032 * If the returned subfacet is new, then subfacet->actions will be NULL, in
4033 * which case the caller must populate the actions with
4034 * subfacet_make_actions(). */
4035 static struct subfacet *
4036 subfacet_create(struct facet *facet, enum odp_key_fitness key_fitness,
4037 const struct nlattr *key, size_t key_len, ovs_be16 initial_tci)
4039 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4040 uint32_t key_hash = odp_flow_key_hash(key, key_len);
4041 struct subfacet *subfacet;
4043 subfacet = subfacet_find__(ofproto, key, key_len, key_hash, &facet->flow);
4045 if (subfacet->facet == facet) {
4049 /* This shouldn't happen. */
4050 VLOG_ERR_RL(&rl, "subfacet with wrong facet");
4051 subfacet_destroy(subfacet);
4054 subfacet = (list_is_empty(&facet->subfacets)
4055 ? &facet->one_subfacet
4056 : xmalloc(sizeof *subfacet));
4057 hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
4058 list_push_back(&facet->subfacets, &subfacet->list_node);
4059 subfacet->facet = facet;
4060 subfacet->key_fitness = key_fitness;
4061 if (key_fitness != ODP_FIT_PERFECT) {
4062 subfacet->key = xmemdup(key, key_len);
4063 subfacet->key_len = key_len;
4065 subfacet->key = NULL;
4066 subfacet->key_len = 0;
4068 subfacet->used = time_msec();
4069 subfacet->dp_packet_count = 0;
4070 subfacet->dp_byte_count = 0;
4071 subfacet->actions_len = 0;
4072 subfacet->actions = NULL;
4073 subfacet->installed = false;
4074 subfacet->initial_tci = initial_tci;
4079 /* Searches 'ofproto' for a subfacet with the given 'key', 'key_len', and
4080 * 'flow'. Returns the subfacet if one exists, otherwise NULL. */
4081 static struct subfacet *
4082 subfacet_find(struct ofproto_dpif *ofproto,
4083 const struct nlattr *key, size_t key_len)
4085 uint32_t key_hash = odp_flow_key_hash(key, key_len);
4086 enum odp_key_fitness fitness;
4089 fitness = odp_flow_key_to_flow(key, key_len, &flow);
4090 if (fitness == ODP_FIT_ERROR) {
4094 return subfacet_find__(ofproto, key, key_len, key_hash, &flow);
4097 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
4098 * its facet within 'ofproto', and frees it. */
4100 subfacet_destroy__(struct subfacet *subfacet)
4102 struct facet *facet = subfacet->facet;
4103 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4105 subfacet_uninstall(subfacet);
4106 hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
4107 list_remove(&subfacet->list_node);
4108 free(subfacet->key);
4109 free(subfacet->actions);
4110 if (subfacet != &facet->one_subfacet) {
4115 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
4116 * last remaining subfacet in its facet destroys the facet too. */
4118 subfacet_destroy(struct subfacet *subfacet)
4120 struct facet *facet = subfacet->facet;
4122 if (list_is_singleton(&facet->subfacets)) {
4123 /* facet_remove() needs at least one subfacet (it will remove it). */
4124 facet_remove(facet);
4126 subfacet_destroy__(subfacet);
4130 /* Initializes 'key' with the sequence of OVS_KEY_ATTR_* Netlink attributes
4131 * that can be used to refer to 'subfacet'. The caller must provide 'keybuf'
4132 * for use as temporary storage. */
4134 subfacet_get_key(struct subfacet *subfacet, struct odputil_keybuf *keybuf,
4137 if (!subfacet->key) {
4138 ofpbuf_use_stack(key, keybuf, sizeof *keybuf);
4139 odp_flow_key_from_flow(key, &subfacet->facet->flow);
4141 ofpbuf_use_const(key, subfacet->key, subfacet->key_len);
4145 /* Composes the datapath actions for 'subfacet' based on its rule's actions.
4146 * Translates the actions into 'odp_actions', which the caller must have
4147 * initialized and is responsible for uninitializing. */
4149 subfacet_make_actions(struct subfacet *subfacet, const struct ofpbuf *packet,
4150 struct ofpbuf *odp_actions)
4152 struct facet *facet = subfacet->facet;
4153 struct rule_dpif *rule = facet->rule;
4154 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4156 struct action_xlate_ctx ctx;
4158 action_xlate_ctx_init(&ctx, ofproto, &facet->flow, subfacet->initial_tci,
4160 xlate_actions(&ctx, rule->up.actions, rule->up.n_actions, odp_actions);
4161 facet->tags = ctx.tags;
4162 facet->may_install = ctx.may_set_up_flow;
4163 facet->has_learn = ctx.has_learn;
4164 facet->has_normal = ctx.has_normal;
4165 facet->has_fin_timeout = ctx.has_fin_timeout;
4166 facet->nf_flow.output_iface = ctx.nf_output_iface;
4167 facet->mirrors = ctx.mirrors;
4169 if (subfacet->actions_len != odp_actions->size
4170 || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
4171 free(subfacet->actions);
4172 subfacet->actions_len = odp_actions->size;
4173 subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
4177 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
4178 * bytes of actions in 'actions'. If 'stats' is non-null, statistics counters
4179 * in the datapath will be zeroed and 'stats' will be updated with traffic new
4180 * since 'subfacet' was last updated.
4182 * Returns 0 if successful, otherwise a positive errno value. */
4184 subfacet_install(struct subfacet *subfacet,
4185 const struct nlattr *actions, size_t actions_len,
4186 struct dpif_flow_stats *stats)
4188 struct facet *facet = subfacet->facet;
4189 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4190 struct odputil_keybuf keybuf;
4191 enum dpif_flow_put_flags flags;
4195 flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
4197 flags |= DPIF_FP_ZERO_STATS;
4200 subfacet_get_key(subfacet, &keybuf, &key);
4201 ret = dpif_flow_put(ofproto->dpif, flags, key.data, key.size,
4202 actions, actions_len, stats);
4205 subfacet_reset_dp_stats(subfacet, stats);
4211 /* If 'subfacet' is installed in the datapath, uninstalls it. */
4213 subfacet_uninstall(struct subfacet *subfacet)
4215 if (subfacet->installed) {
4216 struct rule_dpif *rule = subfacet->facet->rule;
4217 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4218 struct odputil_keybuf keybuf;
4219 struct dpif_flow_stats stats;
4223 subfacet_get_key(subfacet, &keybuf, &key);
4224 error = dpif_flow_del(ofproto->dpif, key.data, key.size, &stats);
4225 subfacet_reset_dp_stats(subfacet, &stats);
4227 subfacet_update_stats(subfacet, &stats);
4229 subfacet->installed = false;
4231 assert(subfacet->dp_packet_count == 0);
4232 assert(subfacet->dp_byte_count == 0);
4236 /* Resets 'subfacet''s datapath statistics counters. This should be called
4237 * when 'subfacet''s statistics are cleared in the datapath. If 'stats' is
4238 * non-null, it should contain the statistics returned by dpif when 'subfacet'
4239 * was reset in the datapath. 'stats' will be modified to include only
4240 * statistics new since 'subfacet' was last updated. */
4242 subfacet_reset_dp_stats(struct subfacet *subfacet,
4243 struct dpif_flow_stats *stats)
4246 && subfacet->dp_packet_count <= stats->n_packets
4247 && subfacet->dp_byte_count <= stats->n_bytes) {
4248 stats->n_packets -= subfacet->dp_packet_count;
4249 stats->n_bytes -= subfacet->dp_byte_count;
4252 subfacet->dp_packet_count = 0;
4253 subfacet->dp_byte_count = 0;
4256 /* Updates 'subfacet''s used time. The caller is responsible for calling
4257 * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
4259 subfacet_update_time(struct subfacet *subfacet, long long int used)
4261 if (used > subfacet->used) {
4262 subfacet->used = used;
4263 facet_update_time(subfacet->facet, used);
4267 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
4269 * Because of the meaning of a subfacet's counters, it only makes sense to do
4270 * this if 'stats' are not tracked in the datapath, that is, if 'stats'
4271 * represents a packet that was sent by hand or if it represents statistics
4272 * that have been cleared out of the datapath. */
4274 subfacet_update_stats(struct subfacet *subfacet,
4275 const struct dpif_flow_stats *stats)
4277 if (stats->n_packets || stats->used > subfacet->used) {
4278 struct facet *facet = subfacet->facet;
4280 subfacet_update_time(subfacet, stats->used);
4281 facet->packet_count += stats->n_packets;
4282 facet->byte_count += stats->n_bytes;
4283 facet->tcp_flags |= stats->tcp_flags;
4284 facet_push_stats(facet);
4285 netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
4291 static struct rule_dpif *
4292 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow,
4295 struct cls_rule *cls_rule;
4296 struct classifier *cls;
4298 if (table_id >= N_TABLES) {
4302 cls = &ofproto->up.tables[table_id].cls;
4303 if (flow->nw_frag & FLOW_NW_FRAG_ANY
4304 && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
4305 /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
4306 * are unavailable. */
4307 struct flow ofpc_normal_flow = *flow;
4308 ofpc_normal_flow.tp_src = htons(0);
4309 ofpc_normal_flow.tp_dst = htons(0);
4310 cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
4312 cls_rule = classifier_lookup(cls, flow);
4314 return rule_dpif_cast(rule_from_cls_rule(cls_rule));
4318 complete_operation(struct rule_dpif *rule)
4320 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4322 rule_invalidate(rule);
4324 struct dpif_completion *c = xmalloc(sizeof *c);
4325 c->op = rule->up.pending;
4326 list_push_back(&ofproto->completions, &c->list_node);
4328 ofoperation_complete(rule->up.pending, 0);
4332 static struct rule *
4335 struct rule_dpif *rule = xmalloc(sizeof *rule);
4340 rule_dealloc(struct rule *rule_)
4342 struct rule_dpif *rule = rule_dpif_cast(rule_);
4347 rule_construct(struct rule *rule_)
4349 struct rule_dpif *rule = rule_dpif_cast(rule_);
4350 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4351 struct rule_dpif *victim;
4355 error = validate_actions(rule->up.actions, rule->up.n_actions,
4356 &rule->up.cr.flow, ofproto->max_ports);
4361 rule->packet_count = 0;
4362 rule->byte_count = 0;
4364 victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
4365 if (victim && !list_is_empty(&victim->facets)) {
4366 struct facet *facet;
4368 rule->facets = victim->facets;
4369 list_moved(&rule->facets);
4370 LIST_FOR_EACH (facet, list_node, &rule->facets) {
4371 /* XXX: We're only clearing our local counters here. It's possible
4372 * that quite a few packets are unaccounted for in the datapath
4373 * statistics. These will be accounted to the new rule instead of
4374 * cleared as required. This could be fixed by clearing out the
4375 * datapath statistics for this facet, but currently it doesn't
4377 facet_reset_counters(facet);
4381 /* Must avoid list_moved() in this case. */
4382 list_init(&rule->facets);
4385 table_id = rule->up.table_id;
4386 rule->tag = (victim ? victim->tag
4388 : rule_calculate_tag(&rule->up.cr.flow, &rule->up.cr.wc,
4389 ofproto->tables[table_id].basis));
4391 complete_operation(rule);
4396 rule_destruct(struct rule *rule_)
4398 struct rule_dpif *rule = rule_dpif_cast(rule_);
4399 struct facet *facet, *next_facet;
4401 LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4402 facet_revalidate(facet);
4405 complete_operation(rule);
4409 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
4411 struct rule_dpif *rule = rule_dpif_cast(rule_);
4412 struct facet *facet;
4414 /* Start from historical data for 'rule' itself that are no longer tracked
4415 * in facets. This counts, for example, facets that have expired. */
4416 *packets = rule->packet_count;
4417 *bytes = rule->byte_count;
4419 /* Add any statistics that are tracked by facets. This includes
4420 * statistical data recently updated by ofproto_update_stats() as well as
4421 * stats for packets that were executed "by hand" via dpif_execute(). */
4422 LIST_FOR_EACH (facet, list_node, &rule->facets) {
4423 *packets += facet->packet_count;
4424 *bytes += facet->byte_count;
4429 rule_execute(struct rule *rule_, const struct flow *flow,
4430 struct ofpbuf *packet)
4432 struct rule_dpif *rule = rule_dpif_cast(rule_);
4433 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4435 struct dpif_flow_stats stats;
4437 struct action_xlate_ctx ctx;
4438 uint64_t odp_actions_stub[1024 / 8];
4439 struct ofpbuf odp_actions;
4441 dpif_flow_stats_extract(flow, packet, &stats);
4442 rule_credit_stats(rule, &stats);
4444 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
4445 action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci,
4446 rule, stats.tcp_flags, packet);
4447 ctx.resubmit_stats = &stats;
4448 xlate_actions(&ctx, rule->up.actions, rule->up.n_actions, &odp_actions);
4450 execute_odp_actions(ofproto, flow, odp_actions.data,
4451 odp_actions.size, packet);
4453 ofpbuf_uninit(&odp_actions);
4459 rule_modify_actions(struct rule *rule_)
4461 struct rule_dpif *rule = rule_dpif_cast(rule_);
4462 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4465 error = validate_actions(rule->up.actions, rule->up.n_actions,
4466 &rule->up.cr.flow, ofproto->max_ports);
4468 ofoperation_complete(rule->up.pending, error);
4472 complete_operation(rule);
4475 /* Sends 'packet' out 'ofport'.
4476 * May modify 'packet'.
4477 * Returns 0 if successful, otherwise a positive errno value. */
4479 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
4481 const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
4482 struct ofpbuf key, odp_actions;
4483 struct odputil_keybuf keybuf;
4488 flow_extract((struct ofpbuf *) packet, 0, 0, 0, &flow);
4489 odp_port = vsp_realdev_to_vlandev(ofproto, ofport->odp_port,
4491 if (odp_port != ofport->odp_port) {
4492 eth_pop_vlan(packet);
4493 flow.vlan_tci = htons(0);
4496 ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4497 odp_flow_key_from_flow(&key, &flow);
4499 ofpbuf_init(&odp_actions, 32);
4500 compose_sflow_action(ofproto, &odp_actions, &flow, odp_port);
4502 nl_msg_put_u32(&odp_actions, OVS_ACTION_ATTR_OUTPUT, odp_port);
4503 error = dpif_execute(ofproto->dpif,
4505 odp_actions.data, odp_actions.size,
4507 ofpbuf_uninit(&odp_actions);
4510 VLOG_WARN_RL(&rl, "%s: failed to send packet on port %"PRIu32" (%s)",
4511 ofproto->up.name, odp_port, strerror(error));
4513 ofproto_update_local_port_stats(ofport->up.ofproto, packet->size, 0);
4517 /* OpenFlow to datapath action translation. */
4519 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
4520 struct action_xlate_ctx *ctx);
4521 static void xlate_normal(struct action_xlate_ctx *);
4524 put_userspace_action(const struct ofproto_dpif *ofproto,
4525 struct ofpbuf *odp_actions,
4526 const struct flow *flow,
4527 const union user_action_cookie *cookie)
4531 pid = dpif_port_get_pid(ofproto->dpif,
4532 ofp_port_to_odp_port(flow->in_port));
4534 return odp_put_userspace_action(pid, cookie, odp_actions);
4538 compose_sflow_cookie(const struct ofproto_dpif *ofproto,
4539 ovs_be16 vlan_tci, uint32_t odp_port,
4540 unsigned int n_outputs, union user_action_cookie *cookie)
4544 cookie->type = USER_ACTION_COOKIE_SFLOW;
4545 cookie->sflow.vlan_tci = vlan_tci;
4547 /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
4548 * port information") for the interpretation of cookie->output. */
4549 switch (n_outputs) {
4551 /* 0x40000000 | 256 means "packet dropped for unknown reason". */
4552 cookie->sflow.output = 0x40000000 | 256;
4556 ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
4558 cookie->sflow.output = ifindex;
4563 /* 0x80000000 means "multiple output ports. */
4564 cookie->sflow.output = 0x80000000 | n_outputs;
4569 /* Compose SAMPLE action for sFlow. */
4571 compose_sflow_action(const struct ofproto_dpif *ofproto,
4572 struct ofpbuf *odp_actions,
4573 const struct flow *flow,
4576 uint32_t probability;
4577 union user_action_cookie cookie;
4578 size_t sample_offset, actions_offset;
4581 if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
4585 sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
4587 /* Number of packets out of UINT_MAX to sample. */
4588 probability = dpif_sflow_get_probability(ofproto->sflow);
4589 nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
4591 actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
4592 compose_sflow_cookie(ofproto, htons(0), odp_port,
4593 odp_port == OVSP_NONE ? 0 : 1, &cookie);
4594 cookie_offset = put_userspace_action(ofproto, odp_actions, flow, &cookie);
4596 nl_msg_end_nested(odp_actions, actions_offset);
4597 nl_msg_end_nested(odp_actions, sample_offset);
4598 return cookie_offset;
4601 /* SAMPLE action must be first action in any given list of actions.
4602 * At this point we do not have all information required to build it. So try to
4603 * build sample action as complete as possible. */
4605 add_sflow_action(struct action_xlate_ctx *ctx)
4607 ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
4609 &ctx->flow, OVSP_NONE);
4610 ctx->sflow_odp_port = 0;
4611 ctx->sflow_n_outputs = 0;
4614 /* Fix SAMPLE action according to data collected while composing ODP actions.
4615 * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
4616 * USERSPACE action's user-cookie which is required for sflow. */
4618 fix_sflow_action(struct action_xlate_ctx *ctx)
4620 const struct flow *base = &ctx->base_flow;
4621 union user_action_cookie *cookie;
4623 if (!ctx->user_cookie_offset) {
4627 cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
4629 assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
4631 compose_sflow_cookie(ctx->ofproto, base->vlan_tci,
4632 ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
4636 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
4639 const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
4640 uint16_t odp_port = ofp_port_to_odp_port(ofp_port);
4641 ovs_be16 flow_vlan_tci = ctx->flow.vlan_tci;
4642 uint8_t flow_nw_tos = ctx->flow.nw_tos;
4646 struct priority_to_dscp *pdscp;
4648 if (ofport->up.pp.config & OFPUTIL_PC_NO_FWD
4649 || (check_stp && !stp_forward_in_state(ofport->stp_state))) {
4653 pdscp = get_priority(ofport, ctx->flow.skb_priority);
4655 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
4656 ctx->flow.nw_tos |= pdscp->dscp;
4659 /* We may not have an ofport record for this port, but it doesn't hurt
4660 * to allow forwarding to it anyhow. Maybe such a port will appear
4661 * later and we're pre-populating the flow table. */
4664 out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
4665 ctx->flow.vlan_tci);
4666 if (out_port != odp_port) {
4667 ctx->flow.vlan_tci = htons(0);
4669 commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
4670 nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
4672 ctx->sflow_odp_port = odp_port;
4673 ctx->sflow_n_outputs++;
4674 ctx->nf_output_iface = ofp_port;
4675 ctx->flow.vlan_tci = flow_vlan_tci;
4676 ctx->flow.nw_tos = flow_nw_tos;
4680 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
4682 compose_output_action__(ctx, ofp_port, true);
4686 xlate_table_action(struct action_xlate_ctx *ctx,
4687 uint16_t in_port, uint8_t table_id)
4689 if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
4690 struct ofproto_dpif *ofproto = ctx->ofproto;
4691 struct rule_dpif *rule;
4692 uint16_t old_in_port;
4693 uint8_t old_table_id;
4695 old_table_id = ctx->table_id;
4696 ctx->table_id = table_id;
4698 /* Look up a flow with 'in_port' as the input port. */
4699 old_in_port = ctx->flow.in_port;
4700 ctx->flow.in_port = in_port;
4701 rule = rule_dpif_lookup(ofproto, &ctx->flow, table_id);
4704 if (table_id > 0 && table_id < N_TABLES) {
4705 struct table_dpif *table = &ofproto->tables[table_id];
4706 if (table->other_table) {
4707 ctx->tags |= (rule && rule->tag
4709 : rule_calculate_tag(&ctx->flow,
4710 &table->other_table->wc,
4715 /* Restore the original input port. Otherwise OFPP_NORMAL and
4716 * OFPP_IN_PORT will have surprising behavior. */
4717 ctx->flow.in_port = old_in_port;
4719 if (ctx->resubmit_hook) {
4720 ctx->resubmit_hook(ctx, rule);
4724 struct rule_dpif *old_rule = ctx->rule;
4726 if (ctx->resubmit_stats) {
4727 rule_credit_stats(rule, ctx->resubmit_stats);
4732 do_xlate_actions(rule->up.actions, rule->up.n_actions, ctx);
4733 ctx->rule = old_rule;
4737 ctx->table_id = old_table_id;
4739 static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
4741 VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
4742 MAX_RESUBMIT_RECURSION);
4743 ctx->max_resubmit_trigger = true;
4748 xlate_resubmit_table(struct action_xlate_ctx *ctx,
4749 const struct nx_action_resubmit *nar)
4754 in_port = (nar->in_port == htons(OFPP_IN_PORT)
4756 : ntohs(nar->in_port));
4757 table_id = nar->table == 255 ? ctx->table_id : nar->table;
4759 xlate_table_action(ctx, in_port, table_id);
4763 flood_packets(struct action_xlate_ctx *ctx, bool all)
4765 struct ofport_dpif *ofport;
4767 HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
4768 uint16_t ofp_port = ofport->up.ofp_port;
4770 if (ofp_port == ctx->flow.in_port) {
4775 compose_output_action__(ctx, ofp_port, false);
4776 } else if (!(ofport->up.pp.config & OFPUTIL_PC_NO_FLOOD)) {
4777 compose_output_action(ctx, ofp_port);
4781 ctx->nf_output_iface = NF_OUT_FLOOD;
4785 execute_controller_action(struct action_xlate_ctx *ctx, int len,
4786 enum ofp_packet_in_reason reason,
4787 uint16_t controller_id)
4789 struct ofputil_packet_in pin;
4790 struct ofpbuf *packet;
4792 ctx->may_set_up_flow = false;
4797 packet = ofpbuf_clone(ctx->packet);
4799 if (packet->l2 && packet->l3) {
4800 struct eth_header *eh;
4802 eth_pop_vlan(packet);
4805 /* If the Ethernet type is less than ETH_TYPE_MIN, it's likely an 802.2
4806 * LLC frame. Calculating the Ethernet type of these frames is more
4807 * trouble than seems appropriate for a simple assertion. */
4808 assert(ntohs(eh->eth_type) < ETH_TYPE_MIN
4809 || eh->eth_type == ctx->flow.dl_type);
4811 memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
4812 memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
4814 if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
4815 eth_push_vlan(packet, ctx->flow.vlan_tci);
4819 if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
4820 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
4821 ctx->flow.nw_tos, ctx->flow.nw_ttl);
4825 if (ctx->flow.nw_proto == IPPROTO_TCP) {
4826 packet_set_tcp_port(packet, ctx->flow.tp_src,
4828 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
4829 packet_set_udp_port(packet, ctx->flow.tp_src,
4836 pin.packet = packet->data;
4837 pin.packet_len = packet->size;
4838 pin.reason = reason;
4839 pin.controller_id = controller_id;
4840 pin.table_id = ctx->table_id;
4841 pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
4844 flow_get_metadata(&ctx->flow, &pin.fmd);
4846 connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin);
4847 ofpbuf_delete(packet);
4851 compose_dec_ttl(struct action_xlate_ctx *ctx)
4853 if (ctx->flow.dl_type != htons(ETH_TYPE_IP) &&
4854 ctx->flow.dl_type != htons(ETH_TYPE_IPV6)) {
4858 if (ctx->flow.nw_ttl > 1) {
4862 execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
4864 /* Stop processing for current table. */
4870 xlate_output_action__(struct action_xlate_ctx *ctx,
4871 uint16_t port, uint16_t max_len)
4873 uint16_t prev_nf_output_iface = ctx->nf_output_iface;
4875 ctx->nf_output_iface = NF_OUT_DROP;
4879 compose_output_action(ctx, ctx->flow.in_port);
4882 xlate_table_action(ctx, ctx->flow.in_port, ctx->table_id);
4888 flood_packets(ctx, false);
4891 flood_packets(ctx, true);
4893 case OFPP_CONTROLLER:
4894 execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
4900 if (port != ctx->flow.in_port) {
4901 compose_output_action(ctx, port);
4906 if (prev_nf_output_iface == NF_OUT_FLOOD) {
4907 ctx->nf_output_iface = NF_OUT_FLOOD;
4908 } else if (ctx->nf_output_iface == NF_OUT_DROP) {
4909 ctx->nf_output_iface = prev_nf_output_iface;
4910 } else if (prev_nf_output_iface != NF_OUT_DROP &&
4911 ctx->nf_output_iface != NF_OUT_FLOOD) {
4912 ctx->nf_output_iface = NF_OUT_MULTI;
4917 xlate_output_reg_action(struct action_xlate_ctx *ctx,
4918 const struct nx_action_output_reg *naor)
4920 struct mf_subfield src;
4923 nxm_decode(&src, naor->src, naor->ofs_nbits);
4924 ofp_port = mf_get_subfield(&src, &ctx->flow);
4926 if (ofp_port <= UINT16_MAX) {
4927 xlate_output_action__(ctx, ofp_port, ntohs(naor->max_len));
4932 xlate_output_action(struct action_xlate_ctx *ctx,
4933 const struct ofp_action_output *oao)
4935 xlate_output_action__(ctx, ntohs(oao->port), ntohs(oao->max_len));
4939 xlate_enqueue_action(struct action_xlate_ctx *ctx,
4940 const struct ofp_action_enqueue *oae)
4943 uint32_t flow_priority, priority;
4946 error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(oae->queue_id),
4949 /* Fall back to ordinary output action. */
4950 xlate_output_action__(ctx, ntohs(oae->port), 0);
4954 /* Figure out datapath output port. */
4955 ofp_port = ntohs(oae->port);
4956 if (ofp_port == OFPP_IN_PORT) {
4957 ofp_port = ctx->flow.in_port;
4958 } else if (ofp_port == ctx->flow.in_port) {
4962 /* Add datapath actions. */
4963 flow_priority = ctx->flow.skb_priority;
4964 ctx->flow.skb_priority = priority;
4965 compose_output_action(ctx, ofp_port);
4966 ctx->flow.skb_priority = flow_priority;
4968 /* Update NetFlow output port. */
4969 if (ctx->nf_output_iface == NF_OUT_DROP) {
4970 ctx->nf_output_iface = ofp_port;
4971 } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
4972 ctx->nf_output_iface = NF_OUT_MULTI;
4977 xlate_set_queue_action(struct action_xlate_ctx *ctx,
4978 const struct nx_action_set_queue *nasq)
4983 error = dpif_queue_to_priority(ctx->ofproto->dpif, ntohl(nasq->queue_id),
4986 /* Couldn't translate queue to a priority, so ignore. A warning
4987 * has already been logged. */
4991 ctx->flow.skb_priority = priority;
4994 struct xlate_reg_state {
5000 xlate_autopath(struct action_xlate_ctx *ctx,
5001 const struct nx_action_autopath *naa)
5003 uint16_t ofp_port = ntohl(naa->id);
5004 struct ofport_dpif *port = get_ofp_port(ctx->ofproto, ofp_port);
5006 if (!port || !port->bundle) {
5007 ofp_port = OFPP_NONE;
5008 } else if (port->bundle->bond) {
5009 /* Autopath does not support VLAN hashing. */
5010 struct ofport_dpif *slave = bond_choose_output_slave(
5011 port->bundle->bond, &ctx->flow, 0, &ctx->tags);
5013 ofp_port = slave->up.ofp_port;
5016 autopath_execute(naa, &ctx->flow, ofp_port);
5020 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
5022 struct ofproto_dpif *ofproto = ofproto_;
5023 struct ofport_dpif *port;
5033 case OFPP_CONTROLLER: /* Not supported by the bundle action. */
5036 port = get_ofp_port(ofproto, ofp_port);
5037 return port ? port->may_enable : false;
5042 xlate_learn_action(struct action_xlate_ctx *ctx,
5043 const struct nx_action_learn *learn)
5045 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
5046 struct ofputil_flow_mod fm;
5049 learn_execute(learn, &ctx->flow, &fm);
5051 error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
5052 if (error && !VLOG_DROP_WARN(&rl)) {
5053 VLOG_WARN("learning action failed to modify flow table (%s)",
5054 ofperr_get_name(error));
5060 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5061 * means "infinite". */
5063 reduce_timeout(uint16_t max, uint16_t *timeout)
5065 if (max && (!*timeout || *timeout > max)) {
5071 xlate_fin_timeout(struct action_xlate_ctx *ctx,
5072 const struct nx_action_fin_timeout *naft)
5074 if (ctx->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
5075 struct rule_dpif *rule = ctx->rule;
5077 reduce_timeout(ntohs(naft->fin_idle_timeout), &rule->up.idle_timeout);
5078 reduce_timeout(ntohs(naft->fin_hard_timeout), &rule->up.hard_timeout);
5083 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
5085 if (port->up.pp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
5086 ? OFPUTIL_PC_NO_RECV_STP
5087 : OFPUTIL_PC_NO_RECV)) {
5091 /* Only drop packets here if both forwarding and learning are
5092 * disabled. If just learning is enabled, we need to have
5093 * OFPP_NORMAL and the learning action have a look at the packet
5094 * before we can drop it. */
5095 if (!stp_forward_in_state(port->stp_state)
5096 && !stp_learn_in_state(port->stp_state)) {
5104 do_xlate_actions(const union ofp_action *in, size_t n_in,
5105 struct action_xlate_ctx *ctx)
5107 const struct ofport_dpif *port;
5108 const union ofp_action *ia;
5109 bool was_evictable = true;
5112 port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
5113 if (port && !may_receive(port, ctx)) {
5114 /* Drop this flow. */
5119 /* Don't let the rule we're working on get evicted underneath us. */
5120 was_evictable = ctx->rule->up.evictable;
5121 ctx->rule->up.evictable = false;
5123 OFPUTIL_ACTION_FOR_EACH_UNSAFE (ia, left, in, n_in) {
5124 const struct ofp_action_dl_addr *oada;
5125 const struct nx_action_resubmit *nar;
5126 const struct nx_action_set_tunnel *nast;
5127 const struct nx_action_set_queue *nasq;
5128 const struct nx_action_multipath *nam;
5129 const struct nx_action_autopath *naa;
5130 const struct nx_action_bundle *nab;
5131 const struct nx_action_output_reg *naor;
5132 const struct nx_action_controller *nac;
5133 enum ofputil_action_code code;
5140 code = ofputil_decode_action_unsafe(ia);
5142 case OFPUTIL_OFPAT10_OUTPUT:
5143 xlate_output_action(ctx, &ia->output);
5146 case OFPUTIL_OFPAT10_SET_VLAN_VID:
5147 ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
5148 ctx->flow.vlan_tci |= ia->vlan_vid.vlan_vid | htons(VLAN_CFI);
5151 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
5152 ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
5153 ctx->flow.vlan_tci |= htons(
5154 (ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
5157 case OFPUTIL_OFPAT10_STRIP_VLAN:
5158 ctx->flow.vlan_tci = htons(0);
5161 case OFPUTIL_OFPAT10_SET_DL_SRC:
5162 oada = ((struct ofp_action_dl_addr *) ia);
5163 memcpy(ctx->flow.dl_src, oada->dl_addr, ETH_ADDR_LEN);
5166 case OFPUTIL_OFPAT10_SET_DL_DST:
5167 oada = ((struct ofp_action_dl_addr *) ia);
5168 memcpy(ctx->flow.dl_dst, oada->dl_addr, ETH_ADDR_LEN);
5171 case OFPUTIL_OFPAT10_SET_NW_SRC:
5172 ctx->flow.nw_src = ia->nw_addr.nw_addr;
5175 case OFPUTIL_OFPAT10_SET_NW_DST:
5176 ctx->flow.nw_dst = ia->nw_addr.nw_addr;
5179 case OFPUTIL_OFPAT10_SET_NW_TOS:
5180 /* OpenFlow 1.0 only supports IPv4. */
5181 if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
5182 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
5183 ctx->flow.nw_tos |= ia->nw_tos.nw_tos & IP_DSCP_MASK;
5187 case OFPUTIL_OFPAT10_SET_TP_SRC:
5188 ctx->flow.tp_src = ia->tp_port.tp_port;
5191 case OFPUTIL_OFPAT10_SET_TP_DST:
5192 ctx->flow.tp_dst = ia->tp_port.tp_port;
5195 case OFPUTIL_OFPAT10_ENQUEUE:
5196 xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
5199 case OFPUTIL_NXAST_RESUBMIT:
5200 nar = (const struct nx_action_resubmit *) ia;
5201 xlate_table_action(ctx, ntohs(nar->in_port), ctx->table_id);
5204 case OFPUTIL_NXAST_RESUBMIT_TABLE:
5205 xlate_resubmit_table(ctx, (const struct nx_action_resubmit *) ia);
5208 case OFPUTIL_NXAST_SET_TUNNEL:
5209 nast = (const struct nx_action_set_tunnel *) ia;
5210 tun_id = htonll(ntohl(nast->tun_id));
5211 ctx->flow.tun_id = tun_id;
5214 case OFPUTIL_NXAST_SET_QUEUE:
5215 nasq = (const struct nx_action_set_queue *) ia;
5216 xlate_set_queue_action(ctx, nasq);
5219 case OFPUTIL_NXAST_POP_QUEUE:
5220 ctx->flow.skb_priority = ctx->orig_skb_priority;
5223 case OFPUTIL_NXAST_REG_MOVE:
5224 nxm_execute_reg_move((const struct nx_action_reg_move *) ia,
5228 case OFPUTIL_NXAST_REG_LOAD:
5229 nxm_execute_reg_load((const struct nx_action_reg_load *) ia,
5233 case OFPUTIL_NXAST_NOTE:
5234 /* Nothing to do. */
5237 case OFPUTIL_NXAST_SET_TUNNEL64:
5238 tun_id = ((const struct nx_action_set_tunnel64 *) ia)->tun_id;
5239 ctx->flow.tun_id = tun_id;
5242 case OFPUTIL_NXAST_MULTIPATH:
5243 nam = (const struct nx_action_multipath *) ia;
5244 multipath_execute(nam, &ctx->flow);
5247 case OFPUTIL_NXAST_AUTOPATH:
5248 naa = (const struct nx_action_autopath *) ia;
5249 xlate_autopath(ctx, naa);
5252 case OFPUTIL_NXAST_BUNDLE:
5253 ctx->ofproto->has_bundle_action = true;
5254 nab = (const struct nx_action_bundle *) ia;
5255 xlate_output_action__(ctx, bundle_execute(nab, &ctx->flow,
5260 case OFPUTIL_NXAST_BUNDLE_LOAD:
5261 ctx->ofproto->has_bundle_action = true;
5262 nab = (const struct nx_action_bundle *) ia;
5263 bundle_execute_load(nab, &ctx->flow, slave_enabled_cb,
5267 case OFPUTIL_NXAST_OUTPUT_REG:
5268 naor = (const struct nx_action_output_reg *) ia;
5269 xlate_output_reg_action(ctx, naor);
5272 case OFPUTIL_NXAST_LEARN:
5273 ctx->has_learn = true;
5274 if (ctx->may_learn) {
5275 xlate_learn_action(ctx, (const struct nx_action_learn *) ia);
5279 case OFPUTIL_NXAST_DEC_TTL:
5280 if (compose_dec_ttl(ctx)) {
5285 case OFPUTIL_NXAST_EXIT:
5289 case OFPUTIL_NXAST_FIN_TIMEOUT:
5290 ctx->has_fin_timeout = true;
5291 xlate_fin_timeout(ctx, (const struct nx_action_fin_timeout *) ia);
5294 case OFPUTIL_NXAST_CONTROLLER:
5295 nac = (const struct nx_action_controller *) ia;
5296 execute_controller_action(ctx, ntohs(nac->max_len), nac->reason,
5297 ntohs(nac->controller_id));
5303 /* We've let OFPP_NORMAL and the learning action look at the packet,
5304 * so drop it now if forwarding is disabled. */
5305 if (port && !stp_forward_in_state(port->stp_state)) {
5306 ofpbuf_clear(ctx->odp_actions);
5307 add_sflow_action(ctx);
5310 ctx->rule->up.evictable = was_evictable;
5315 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
5316 struct ofproto_dpif *ofproto, const struct flow *flow,
5317 ovs_be16 initial_tci, struct rule_dpif *rule,
5318 uint8_t tcp_flags, const struct ofpbuf *packet)
5320 ctx->ofproto = ofproto;
5322 ctx->base_flow = ctx->flow;
5323 ctx->base_flow.tun_id = 0;
5324 ctx->base_flow.vlan_tci = initial_tci;
5326 ctx->packet = packet;
5327 ctx->may_learn = packet != NULL;
5328 ctx->tcp_flags = tcp_flags;
5329 ctx->resubmit_hook = NULL;
5330 ctx->resubmit_stats = NULL;
5333 /* Translates the 'n_in' "union ofp_action"s in 'in' into datapath actions in
5334 * 'odp_actions', using 'ctx'. */
5336 xlate_actions(struct action_xlate_ctx *ctx,
5337 const union ofp_action *in, size_t n_in,
5338 struct ofpbuf *odp_actions)
5340 /* Normally false. Set to true if we ever hit MAX_RESUBMIT_RECURSION, so
5341 * that in the future we always keep a copy of the original flow for
5342 * tracing purposes. */
5343 static bool hit_resubmit_limit;
5345 COVERAGE_INC(ofproto_dpif_xlate);
5347 ofpbuf_clear(odp_actions);
5348 ofpbuf_reserve(odp_actions, NL_A_U32_SIZE);
5350 ctx->odp_actions = odp_actions;
5352 ctx->may_set_up_flow = true;
5353 ctx->has_learn = false;
5354 ctx->has_normal = false;
5355 ctx->has_fin_timeout = false;
5356 ctx->nf_output_iface = NF_OUT_DROP;
5359 ctx->max_resubmit_trigger = false;
5360 ctx->orig_skb_priority = ctx->flow.skb_priority;
5364 if (ctx->ofproto->has_mirrors || hit_resubmit_limit) {
5365 /* Do this conditionally because the copy is expensive enough that it
5366 * shows up in profiles.
5368 * We keep orig_flow in 'ctx' only because I couldn't make GCC 4.4
5369 * believe that I wasn't using it without initializing it if I kept it
5370 * in a local variable. */
5371 ctx->orig_flow = ctx->flow;
5374 if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
5375 switch (ctx->ofproto->up.frag_handling) {
5376 case OFPC_FRAG_NORMAL:
5377 /* We must pretend that transport ports are unavailable. */
5378 ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
5379 ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
5382 case OFPC_FRAG_DROP:
5385 case OFPC_FRAG_REASM:
5388 case OFPC_FRAG_NX_MATCH:
5389 /* Nothing to do. */
5392 case OFPC_INVALID_TTL_TO_CONTROLLER:
5397 if (process_special(ctx->ofproto, &ctx->flow, ctx->packet)) {
5398 ctx->may_set_up_flow = false;
5400 static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
5401 ovs_be16 initial_tci = ctx->base_flow.vlan_tci;
5403 add_sflow_action(ctx);
5404 do_xlate_actions(in, n_in, ctx);
5406 if (ctx->max_resubmit_trigger && !ctx->resubmit_hook) {
5407 if (!hit_resubmit_limit) {
5408 /* We didn't record the original flow. Make sure we do from
5410 hit_resubmit_limit = true;
5411 } else if (!VLOG_DROP_ERR(&trace_rl)) {
5412 struct ds ds = DS_EMPTY_INITIALIZER;
5414 ofproto_trace(ctx->ofproto, &ctx->orig_flow, ctx->packet,
5416 VLOG_ERR("Trace triggered by excessive resubmit "
5417 "recursion:\n%s", ds_cstr(&ds));
5422 if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
5423 ctx->odp_actions->data,
5424 ctx->odp_actions->size)) {
5425 ctx->may_set_up_flow = false;
5427 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
5429 compose_output_action(ctx, OFPP_LOCAL);
5432 if (ctx->ofproto->has_mirrors) {
5433 add_mirror_actions(ctx, &ctx->orig_flow);
5435 fix_sflow_action(ctx);
5439 /* Translates the 'n_in' "union ofp_action"s in 'in' into datapath actions,
5440 * using 'ctx', and discards the datapath actions. */
5442 xlate_actions_for_side_effects(struct action_xlate_ctx *ctx,
5443 const union ofp_action *in, size_t n_in)
5445 uint64_t odp_actions_stub[1024 / 8];
5446 struct ofpbuf odp_actions;
5448 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5449 xlate_actions(ctx, in, n_in, &odp_actions);
5450 ofpbuf_uninit(&odp_actions);
5453 /* OFPP_NORMAL implementation. */
5455 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
5457 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
5458 * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
5459 * the bundle on which the packet was received, returns the VLAN to which the
5462 * Both 'vid' and the return value are in the range 0...4095. */
5464 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
5466 switch (in_bundle->vlan_mode) {
5467 case PORT_VLAN_ACCESS:
5468 return in_bundle->vlan;
5471 case PORT_VLAN_TRUNK:
5474 case PORT_VLAN_NATIVE_UNTAGGED:
5475 case PORT_VLAN_NATIVE_TAGGED:
5476 return vid ? vid : in_bundle->vlan;
5483 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
5484 * If so, returns true. Otherwise, returns false and, if 'warn' is true, logs
5487 * 'vid' should be the VID obtained from the 802.1Q header that was received as
5488 * part of a packet (specify 0 if there was no 802.1Q header), in the range
5491 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
5493 /* Allow any VID on the OFPP_NONE port. */
5494 if (in_bundle == &ofpp_none_bundle) {
5498 switch (in_bundle->vlan_mode) {
5499 case PORT_VLAN_ACCESS:
5502 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5503 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
5504 "packet received on port %s configured as VLAN "
5505 "%"PRIu16" access port",
5506 in_bundle->ofproto->up.name, vid,
5507 in_bundle->name, in_bundle->vlan);
5513 case PORT_VLAN_NATIVE_UNTAGGED:
5514 case PORT_VLAN_NATIVE_TAGGED:
5516 /* Port must always carry its native VLAN. */
5520 case PORT_VLAN_TRUNK:
5521 if (!ofbundle_includes_vlan(in_bundle, vid)) {
5523 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5524 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
5525 "received on port %s not configured for trunking "
5527 in_bundle->ofproto->up.name, vid,
5528 in_bundle->name, vid);
5540 /* Given 'vlan', the VLAN that a packet belongs to, and
5541 * 'out_bundle', a bundle on which the packet is to be output, returns the VID
5542 * that should be included in the 802.1Q header. (If the return value is 0,
5543 * then the 802.1Q header should only be included in the packet if there is a
5546 * Both 'vlan' and the return value are in the range 0...4095. */
5548 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
5550 switch (out_bundle->vlan_mode) {
5551 case PORT_VLAN_ACCESS:
5554 case PORT_VLAN_TRUNK:
5555 case PORT_VLAN_NATIVE_TAGGED:
5558 case PORT_VLAN_NATIVE_UNTAGGED:
5559 return vlan == out_bundle->vlan ? 0 : vlan;
5567 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
5570 struct ofport_dpif *port;
5572 ovs_be16 tci, old_tci;
5574 vid = output_vlan_to_vid(out_bundle, vlan);
5575 if (!out_bundle->bond) {
5576 port = ofbundle_get_a_port(out_bundle);
5578 port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
5581 /* No slaves enabled, so drop packet. */
5586 old_tci = ctx->flow.vlan_tci;
5588 if (tci || out_bundle->use_priority_tags) {
5589 tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
5591 tci |= htons(VLAN_CFI);
5594 ctx->flow.vlan_tci = tci;
5596 compose_output_action(ctx, port->up.ofp_port);
5597 ctx->flow.vlan_tci = old_tci;
5601 mirror_mask_ffs(mirror_mask_t mask)
5603 BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
5608 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
5610 return (bundle->vlan_mode != PORT_VLAN_ACCESS
5611 && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
5615 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
5617 return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
5620 /* Returns an arbitrary interface within 'bundle'. */
5621 static struct ofport_dpif *
5622 ofbundle_get_a_port(const struct ofbundle *bundle)
5624 return CONTAINER_OF(list_front(&bundle->ports),
5625 struct ofport_dpif, bundle_node);
5629 vlan_is_mirrored(const struct ofmirror *m, int vlan)
5631 return !m->vlans || bitmap_is_set(m->vlans, vlan);
5634 /* Returns true if a packet with Ethernet destination MAC 'dst' may be mirrored
5635 * to a VLAN. In general most packets may be mirrored but we want to drop
5636 * protocols that may confuse switches. */
5638 eth_dst_may_rspan(const uint8_t dst[ETH_ADDR_LEN])
5640 /* If you change this function's behavior, please update corresponding
5641 * documentation in vswitch.xml at the same time. */
5642 if (dst[0] != 0x01) {
5643 /* All the currently banned MACs happen to start with 01 currently, so
5644 * this is a quick way to eliminate most of the good ones. */
5646 if (eth_addr_is_reserved(dst)) {
5647 /* Drop STP, IEEE pause frames, and other reserved protocols
5648 * (01-80-c2-00-00-0x). */
5652 if (dst[0] == 0x01 && dst[1] == 0x00 && dst[2] == 0x0c) {
5654 if ((dst[3] & 0xfe) == 0xcc &&
5655 (dst[4] & 0xfe) == 0xcc &&
5656 (dst[5] & 0xfe) == 0xcc) {
5657 /* Drop the following protocols plus others following the same
5660 CDP, VTP, DTP, PAgP (01-00-0c-cc-cc-cc)
5661 Spanning Tree PVSTP+ (01-00-0c-cc-cc-cd)
5662 STP Uplink Fast (01-00-0c-cd-cd-cd) */
5666 if (!(dst[3] | dst[4] | dst[5])) {
5667 /* Drop Inter Switch Link packets (01-00-0c-00-00-00). */
5676 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
5678 struct ofproto_dpif *ofproto = ctx->ofproto;
5679 mirror_mask_t mirrors;
5680 struct ofbundle *in_bundle;
5683 const struct nlattr *a;
5686 in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
5687 ctx->packet != NULL, NULL);
5691 mirrors = in_bundle->src_mirrors;
5693 /* Drop frames on bundles reserved for mirroring. */
5694 if (in_bundle->mirror_out) {
5695 if (ctx->packet != NULL) {
5696 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5697 VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5698 "%s, which is reserved exclusively for mirroring",
5699 ctx->ofproto->up.name, in_bundle->name);
5705 vid = vlan_tci_to_vid(orig_flow->vlan_tci);
5706 if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5709 vlan = input_vid_to_vlan(in_bundle, vid);
5711 /* Look at the output ports to check for destination selections. */
5713 NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
5714 ctx->odp_actions->size) {
5715 enum ovs_action_attr type = nl_attr_type(a);
5716 struct ofport_dpif *ofport;
5718 if (type != OVS_ACTION_ATTR_OUTPUT) {
5722 ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
5723 if (ofport && ofport->bundle) {
5724 mirrors |= ofport->bundle->dst_mirrors;
5732 /* Restore the original packet before adding the mirror actions. */
5733 ctx->flow = *orig_flow;
5738 m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5740 if (!vlan_is_mirrored(m, vlan)) {
5741 mirrors &= mirrors - 1;
5745 mirrors &= ~m->dup_mirrors;
5746 ctx->mirrors |= m->dup_mirrors;
5748 output_normal(ctx, m->out, vlan);
5749 } else if (eth_dst_may_rspan(orig_flow->dl_dst)
5750 && vlan != m->out_vlan) {
5751 struct ofbundle *bundle;
5753 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
5754 if (ofbundle_includes_vlan(bundle, m->out_vlan)
5755 && !bundle->mirror_out) {
5756 output_normal(ctx, bundle, m->out_vlan);
5764 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
5765 uint64_t packets, uint64_t bytes)
5771 for (; mirrors; mirrors &= mirrors - 1) {
5774 m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
5777 /* In normal circumstances 'm' will not be NULL. However,
5778 * if mirrors are reconfigured, we can temporarily get out
5779 * of sync in facet_revalidate(). We could "correct" the
5780 * mirror list before reaching here, but doing that would
5781 * not properly account the traffic stats we've currently
5782 * accumulated for previous mirror configuration. */
5786 m->packet_count += packets;
5787 m->byte_count += bytes;
5791 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
5792 * migration. Older Citrix-patched Linux DomU used gratuitous ARP replies to
5793 * indicate this; newer upstream kernels use gratuitous ARP requests. */
5795 is_gratuitous_arp(const struct flow *flow)
5797 return (flow->dl_type == htons(ETH_TYPE_ARP)
5798 && eth_addr_is_broadcast(flow->dl_dst)
5799 && (flow->nw_proto == ARP_OP_REPLY
5800 || (flow->nw_proto == ARP_OP_REQUEST
5801 && flow->nw_src == flow->nw_dst)));
5805 update_learning_table(struct ofproto_dpif *ofproto,
5806 const struct flow *flow, int vlan,
5807 struct ofbundle *in_bundle)
5809 struct mac_entry *mac;
5811 /* Don't learn the OFPP_NONE port. */
5812 if (in_bundle == &ofpp_none_bundle) {
5816 if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
5820 mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
5821 if (is_gratuitous_arp(flow)) {
5822 /* We don't want to learn from gratuitous ARP packets that are
5823 * reflected back over bond slaves so we lock the learning table. */
5824 if (!in_bundle->bond) {
5825 mac_entry_set_grat_arp_lock(mac);
5826 } else if (mac_entry_is_grat_arp_locked(mac)) {
5831 if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
5832 /* The log messages here could actually be useful in debugging,
5833 * so keep the rate limit relatively high. */
5834 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
5835 VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
5836 "on port %s in VLAN %d",
5837 ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
5838 in_bundle->name, vlan);
5840 mac->port.p = in_bundle;
5841 tag_set_add(&ofproto->revalidate_set,
5842 mac_learning_changed(ofproto->ml, mac));
5846 static struct ofbundle *
5847 lookup_input_bundle(struct ofproto_dpif *ofproto, uint16_t in_port, bool warn,
5848 struct ofport_dpif **in_ofportp)
5850 struct ofport_dpif *ofport;
5852 /* Find the port and bundle for the received packet. */
5853 ofport = get_ofp_port(ofproto, in_port);
5855 *in_ofportp = ofport;
5857 if (ofport && ofport->bundle) {
5858 return ofport->bundle;
5861 /* Special-case OFPP_NONE, which a controller may use as the ingress
5862 * port for traffic that it is sourcing. */
5863 if (in_port == OFPP_NONE) {
5864 return &ofpp_none_bundle;
5867 /* Odd. A few possible reasons here:
5869 * - We deleted a port but there are still a few packets queued up
5872 * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
5873 * we don't know about.
5875 * - The ofproto client didn't configure the port as part of a bundle.
5878 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5880 VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
5881 "port %"PRIu16, ofproto->up.name, in_port);
5886 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
5887 * dropped. Returns true if they may be forwarded, false if they should be
5890 * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
5891 * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
5893 * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
5894 * returned by input_vid_to_vlan(). It must be a valid VLAN for 'in_port', as
5895 * checked by input_vid_is_valid().
5897 * May also add tags to '*tags', although the current implementation only does
5898 * so in one special case.
5901 is_admissible(struct ofproto_dpif *ofproto, const struct flow *flow,
5902 struct ofport_dpif *in_port, uint16_t vlan, tag_type *tags)
5904 struct ofbundle *in_bundle = in_port->bundle;
5906 /* Drop frames for reserved multicast addresses
5907 * only if forward_bpdu option is absent. */
5908 if (eth_addr_is_reserved(flow->dl_dst) && !ofproto->up.forward_bpdu) {
5912 if (in_bundle->bond) {
5913 struct mac_entry *mac;
5915 switch (bond_check_admissibility(in_bundle->bond, in_port,
5916 flow->dl_dst, tags)) {
5923 case BV_DROP_IF_MOVED:
5924 mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
5925 if (mac && mac->port.p != in_bundle &&
5926 (!is_gratuitous_arp(flow)
5927 || mac_entry_is_grat_arp_locked(mac))) {
5938 xlate_normal(struct action_xlate_ctx *ctx)
5940 struct ofport_dpif *in_port;
5941 struct ofbundle *in_bundle;
5942 struct mac_entry *mac;
5946 ctx->has_normal = true;
5948 in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
5949 ctx->packet != NULL, &in_port);
5954 /* Drop malformed frames. */
5955 if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
5956 !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
5957 if (ctx->packet != NULL) {
5958 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5959 VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
5960 "VLAN tag received on port %s",
5961 ctx->ofproto->up.name, in_bundle->name);
5966 /* Drop frames on bundles reserved for mirroring. */
5967 if (in_bundle->mirror_out) {
5968 if (ctx->packet != NULL) {
5969 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5970 VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
5971 "%s, which is reserved exclusively for mirroring",
5972 ctx->ofproto->up.name, in_bundle->name);
5978 vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
5979 if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
5982 vlan = input_vid_to_vlan(in_bundle, vid);
5984 /* Check other admissibility requirements. */
5986 !is_admissible(ctx->ofproto, &ctx->flow, in_port, vlan, &ctx->tags)) {
5990 /* Learn source MAC. */
5991 if (ctx->may_learn) {
5992 update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
5995 /* Determine output bundle. */
5996 mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
5999 if (mac->port.p != in_bundle) {
6000 output_normal(ctx, mac->port.p, vlan);
6003 struct ofbundle *bundle;
6005 HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
6006 if (bundle != in_bundle
6007 && ofbundle_includes_vlan(bundle, vlan)
6008 && bundle->floodable
6009 && !bundle->mirror_out) {
6010 output_normal(ctx, bundle, vlan);
6013 ctx->nf_output_iface = NF_OUT_FLOOD;
6017 /* Optimized flow revalidation.
6019 * It's a difficult problem, in general, to tell which facets need to have
6020 * their actions recalculated whenever the OpenFlow flow table changes. We
6021 * don't try to solve that general problem: for most kinds of OpenFlow flow
6022 * table changes, we recalculate the actions for every facet. This is
6023 * relatively expensive, but it's good enough if the OpenFlow flow table
6024 * doesn't change very often.
6026 * However, we can expect one particular kind of OpenFlow flow table change to
6027 * happen frequently: changes caused by MAC learning. To avoid wasting a lot
6028 * of CPU on revalidating every facet whenever MAC learning modifies the flow
6029 * table, we add a special case that applies to flow tables in which every rule
6030 * has the same form (that is, the same wildcards), except that the table is
6031 * also allowed to have a single "catch-all" flow that matches all packets. We
6032 * optimize this case by tagging all of the facets that resubmit into the table
6033 * and invalidating the same tag whenever a flow changes in that table. The
6034 * end result is that we revalidate just the facets that need it (and sometimes
6035 * a few more, but not all of the facets or even all of the facets that
6036 * resubmit to the table modified by MAC learning). */
6038 /* Calculates the tag to use for 'flow' and wildcards 'wc' when it is inserted
6039 * into an OpenFlow table with the given 'basis'. */
6041 rule_calculate_tag(const struct flow *flow, const struct flow_wildcards *wc,
6044 if (flow_wildcards_is_catchall(wc)) {
6047 struct flow tag_flow = *flow;
6048 flow_zero_wildcards(&tag_flow, wc);
6049 return tag_create_deterministic(flow_hash(&tag_flow, secret));
6053 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
6054 * taggability of that table.
6056 * This function must be called after *each* change to a flow table. If you
6057 * skip calling it on some changes then the pointer comparisons at the end can
6058 * be invalid if you get unlucky. For example, if a flow removal causes a
6059 * cls_table to be destroyed and then a flow insertion causes a cls_table with
6060 * different wildcards to be created with the same address, then this function
6061 * will incorrectly skip revalidation. */
6063 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
6065 struct table_dpif *table = &ofproto->tables[table_id];
6066 const struct oftable *oftable = &ofproto->up.tables[table_id];
6067 struct cls_table *catchall, *other;
6068 struct cls_table *t;
6070 catchall = other = NULL;
6072 switch (hmap_count(&oftable->cls.tables)) {
6074 /* We could tag this OpenFlow table but it would make the logic a
6075 * little harder and it's a corner case that doesn't seem worth it
6081 HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
6082 if (cls_table_is_catchall(t)) {
6084 } else if (!other) {
6087 /* Indicate that we can't tag this by setting both tables to
6088 * NULL. (We know that 'catchall' is already NULL.) */
6095 /* Can't tag this table. */
6099 if (table->catchall_table != catchall || table->other_table != other) {
6100 table->catchall_table = catchall;
6101 table->other_table = other;
6102 ofproto->need_revalidate = true;
6106 /* Given 'rule' that has changed in some way (either it is a rule being
6107 * inserted, a rule being deleted, or a rule whose actions are being
6108 * modified), marks facets for revalidation to ensure that packets will be
6109 * forwarded correctly according to the new state of the flow table.
6111 * This function must be called after *each* change to a flow table. See
6112 * the comment on table_update_taggable() for more information. */
6114 rule_invalidate(const struct rule_dpif *rule)
6116 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
6118 table_update_taggable(ofproto, rule->up.table_id);
6120 if (!ofproto->need_revalidate) {
6121 struct table_dpif *table = &ofproto->tables[rule->up.table_id];
6123 if (table->other_table && rule->tag) {
6124 tag_set_add(&ofproto->revalidate_set, rule->tag);
6126 ofproto->need_revalidate = true;
6132 set_frag_handling(struct ofproto *ofproto_,
6133 enum ofp_config_flags frag_handling)
6135 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6137 if (frag_handling != OFPC_FRAG_REASM) {
6138 ofproto->need_revalidate = true;
6146 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
6147 const struct flow *flow,
6148 const union ofp_action *ofp_actions, size_t n_ofp_actions)
6150 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6153 if (flow->in_port >= ofproto->max_ports && flow->in_port < OFPP_MAX) {
6154 return OFPERR_NXBRC_BAD_IN_PORT;
6157 error = validate_actions(ofp_actions, n_ofp_actions, flow,
6158 ofproto->max_ports);
6160 struct odputil_keybuf keybuf;
6161 struct dpif_flow_stats stats;
6165 struct action_xlate_ctx ctx;
6166 uint64_t odp_actions_stub[1024 / 8];
6167 struct ofpbuf odp_actions;
6169 ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
6170 odp_flow_key_from_flow(&key, flow);
6172 dpif_flow_stats_extract(flow, packet, &stats);
6174 action_xlate_ctx_init(&ctx, ofproto, flow, flow->vlan_tci, NULL,
6175 packet_get_tcp_flags(packet, flow), packet);
6176 ctx.resubmit_stats = &stats;
6178 ofpbuf_use_stub(&odp_actions,
6179 odp_actions_stub, sizeof odp_actions_stub);
6180 xlate_actions(&ctx, ofp_actions, n_ofp_actions, &odp_actions);
6181 dpif_execute(ofproto->dpif, key.data, key.size,
6182 odp_actions.data, odp_actions.size, packet);
6183 ofpbuf_uninit(&odp_actions);
6191 set_netflow(struct ofproto *ofproto_,
6192 const struct netflow_options *netflow_options)
6194 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6196 if (netflow_options) {
6197 if (!ofproto->netflow) {
6198 ofproto->netflow = netflow_create();
6200 return netflow_set_options(ofproto->netflow, netflow_options);
6202 netflow_destroy(ofproto->netflow);
6203 ofproto->netflow = NULL;
6209 get_netflow_ids(const struct ofproto *ofproto_,
6210 uint8_t *engine_type, uint8_t *engine_id)
6212 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
6214 dpif_get_netflow_ids(ofproto->dpif, engine_type, engine_id);
6218 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
6220 if (!facet_is_controller_flow(facet) &&
6221 netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
6222 struct subfacet *subfacet;
6223 struct ofexpired expired;
6225 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
6226 if (subfacet->installed) {
6227 struct dpif_flow_stats stats;
6229 subfacet_install(subfacet, subfacet->actions,
6230 subfacet->actions_len, &stats);
6231 subfacet_update_stats(subfacet, &stats);
6235 expired.flow = facet->flow;
6236 expired.packet_count = facet->packet_count;
6237 expired.byte_count = facet->byte_count;
6238 expired.used = facet->used;
6239 netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
6244 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
6246 struct facet *facet;
6248 HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
6249 send_active_timeout(ofproto, facet);
6253 static struct ofproto_dpif *
6254 ofproto_dpif_lookup(const char *name)
6256 struct ofproto_dpif *ofproto;
6258 HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
6259 hash_string(name, 0), &all_ofproto_dpifs) {
6260 if (!strcmp(ofproto->up.name, name)) {
6268 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
6269 const char *argv[], void *aux OVS_UNUSED)
6271 struct ofproto_dpif *ofproto;
6274 ofproto = ofproto_dpif_lookup(argv[1]);
6276 unixctl_command_reply_error(conn, "no such bridge");
6279 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
6281 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6282 mac_learning_flush(ofproto->ml, &ofproto->revalidate_set);
6286 unixctl_command_reply(conn, "table successfully flushed");
6290 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
6291 const char *argv[], void *aux OVS_UNUSED)
6293 struct ds ds = DS_EMPTY_INITIALIZER;
6294 const struct ofproto_dpif *ofproto;
6295 const struct mac_entry *e;
6297 ofproto = ofproto_dpif_lookup(argv[1]);
6299 unixctl_command_reply_error(conn, "no such bridge");
6303 ds_put_cstr(&ds, " port VLAN MAC Age\n");
6304 LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
6305 struct ofbundle *bundle = e->port.p;
6306 ds_put_format(&ds, "%5d %4d "ETH_ADDR_FMT" %3d\n",
6307 ofbundle_get_a_port(bundle)->odp_port,
6308 e->vlan, ETH_ADDR_ARGS(e->mac),
6309 mac_entry_age(ofproto->ml, e));
6311 unixctl_command_reply(conn, ds_cstr(&ds));
6316 struct action_xlate_ctx ctx;
6322 trace_format_rule(struct ds *result, uint8_t table_id, int level,
6323 const struct rule_dpif *rule)
6325 ds_put_char_multiple(result, '\t', level);
6327 ds_put_cstr(result, "No match\n");
6331 ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
6332 table_id, ntohll(rule->up.flow_cookie));
6333 cls_rule_format(&rule->up.cr, result);
6334 ds_put_char(result, '\n');
6336 ds_put_char_multiple(result, '\t', level);
6337 ds_put_cstr(result, "OpenFlow ");
6338 ofp_print_actions(result, rule->up.actions, rule->up.n_actions);
6339 ds_put_char(result, '\n');
6343 trace_format_flow(struct ds *result, int level, const char *title,
6344 struct trace_ctx *trace)
6346 ds_put_char_multiple(result, '\t', level);
6347 ds_put_format(result, "%s: ", title);
6348 if (flow_equal(&trace->ctx.flow, &trace->flow)) {
6349 ds_put_cstr(result, "unchanged");
6351 flow_format(result, &trace->ctx.flow);
6352 trace->flow = trace->ctx.flow;
6354 ds_put_char(result, '\n');
6358 trace_format_regs(struct ds *result, int level, const char *title,
6359 struct trace_ctx *trace)
6363 ds_put_char_multiple(result, '\t', level);
6364 ds_put_format(result, "%s:", title);
6365 for (i = 0; i < FLOW_N_REGS; i++) {
6366 ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
6368 ds_put_char(result, '\n');
6372 trace_format_odp(struct ds *result, int level, const char *title,
6373 struct trace_ctx *trace)
6375 struct ofpbuf *odp_actions = trace->ctx.odp_actions;
6377 ds_put_char_multiple(result, '\t', level);
6378 ds_put_format(result, "%s: ", title);
6379 format_odp_actions(result, odp_actions->data, odp_actions->size);
6380 ds_put_char(result, '\n');
6384 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
6386 struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
6387 struct ds *result = trace->result;
6389 ds_put_char(result, '\n');
6390 trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
6391 trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
6392 trace_format_odp(result, ctx->recurse + 1, "Resubmitted odp", trace);
6393 trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
6397 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
6398 void *aux OVS_UNUSED)
6400 const char *dpname = argv[1];
6401 struct ofproto_dpif *ofproto;
6402 struct ofpbuf odp_key;
6403 struct ofpbuf *packet;
6404 ovs_be16 initial_tci;
6410 ofpbuf_init(&odp_key, 0);
6413 ofproto = ofproto_dpif_lookup(dpname);
6415 unixctl_command_reply_error(conn, "Unknown ofproto (use ofproto/list "
6419 if (argc == 3 || (argc == 4 && !strcmp(argv[3], "-generate"))) {
6420 /* ofproto/trace dpname flow [-generate] */
6421 const char *flow_s = argv[2];
6422 const char *generate_s = argv[3];
6424 /* Allow 'flow_s' to be either a datapath flow or an OpenFlow-like
6425 * flow. We guess which type it is based on whether 'flow_s' contains
6426 * an '(', since a datapath flow always contains '(') but an
6427 * OpenFlow-like flow should not (in fact it's allowed but I believe
6428 * that's not documented anywhere).
6430 * An alternative would be to try to parse 'flow_s' both ways, but then
6431 * it would be tricky giving a sensible error message. After all, do
6432 * you just say "syntax error" or do you present both error messages?
6433 * Both choices seem lousy. */
6434 if (strchr(flow_s, '(')) {
6437 /* Convert string to datapath key. */
6438 ofpbuf_init(&odp_key, 0);
6439 error = odp_flow_key_from_string(flow_s, NULL, &odp_key);
6441 unixctl_command_reply_error(conn, "Bad flow syntax");
6445 /* Convert odp_key to flow. */
6446 error = ofproto_dpif_extract_flow_key(ofproto, odp_key.data,
6447 odp_key.size, &flow,
6448 &initial_tci, NULL);
6449 if (error == ODP_FIT_ERROR) {
6450 unixctl_command_reply_error(conn, "Invalid flow");
6456 error_s = parse_ofp_exact_flow(&flow, argv[2]);
6458 unixctl_command_reply_error(conn, error_s);
6463 initial_tci = flow.vlan_tci;
6464 vsp_adjust_flow(ofproto, &flow);
6467 /* Generate a packet, if requested. */
6469 packet = ofpbuf_new(0);
6470 flow_compose(packet, &flow);
6472 } else if (argc == 6) {
6473 /* ofproto/trace dpname priority tun_id in_port packet */
6474 const char *priority_s = argv[2];
6475 const char *tun_id_s = argv[3];
6476 const char *in_port_s = argv[4];
6477 const char *packet_s = argv[5];
6478 uint16_t in_port = ofp_port_to_odp_port(atoi(in_port_s));
6479 ovs_be64 tun_id = htonll(strtoull(tun_id_s, NULL, 0));
6480 uint32_t priority = atoi(priority_s);
6483 msg = eth_from_hex(packet_s, &packet);
6485 unixctl_command_reply_error(conn, msg);
6489 ds_put_cstr(&result, "Packet: ");
6490 s = ofp_packet_to_string(packet->data, packet->size);
6491 ds_put_cstr(&result, s);
6494 flow_extract(packet, priority, tun_id, in_port, &flow);
6495 initial_tci = flow.vlan_tci;
6497 unixctl_command_reply_error(conn, "Bad command syntax");
6501 ofproto_trace(ofproto, &flow, packet, initial_tci, &result);
6502 unixctl_command_reply(conn, ds_cstr(&result));
6505 ds_destroy(&result);
6506 ofpbuf_delete(packet);
6507 ofpbuf_uninit(&odp_key);
6511 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
6512 const struct ofpbuf *packet, ovs_be16 initial_tci,
6515 struct rule_dpif *rule;
6517 ds_put_cstr(ds, "Flow: ");
6518 flow_format(ds, flow);
6519 ds_put_char(ds, '\n');
6521 rule = rule_dpif_lookup(ofproto, flow, 0);
6522 trace_format_rule(ds, 0, 0, rule);
6524 uint64_t odp_actions_stub[1024 / 8];
6525 struct ofpbuf odp_actions;
6527 struct trace_ctx trace;
6530 tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
6533 ofpbuf_use_stub(&odp_actions,
6534 odp_actions_stub, sizeof odp_actions_stub);
6535 action_xlate_ctx_init(&trace.ctx, ofproto, flow, initial_tci,
6536 rule, tcp_flags, packet);
6537 trace.ctx.resubmit_hook = trace_resubmit;
6538 xlate_actions(&trace.ctx, rule->up.actions, rule->up.n_actions,
6541 ds_put_char(ds, '\n');
6542 trace_format_flow(ds, 0, "Final flow", &trace);
6543 ds_put_cstr(ds, "Datapath actions: ");
6544 format_odp_actions(ds, odp_actions.data, odp_actions.size);
6545 ofpbuf_uninit(&odp_actions);
6547 if (!trace.ctx.may_set_up_flow) {
6549 ds_put_cstr(ds, "\nThis flow is not cachable.");
6551 ds_put_cstr(ds, "\nThe datapath actions are incomplete--"
6552 "for complete actions, please supply a packet.");
6559 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6560 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6563 unixctl_command_reply(conn, NULL);
6567 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
6568 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6571 unixctl_command_reply(conn, NULL);
6574 /* Runs a self-check of flow translations in 'ofproto'. Appends a message to
6575 * 'reply' describing the results. */
6577 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
6579 struct facet *facet;
6583 HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
6584 if (!facet_check_consistency(facet)) {
6589 ofproto->need_revalidate = true;
6593 ds_put_format(reply, "%s: self-check failed (%d errors)\n",
6594 ofproto->up.name, errors);
6596 ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
6601 ofproto_dpif_self_check(struct unixctl_conn *conn,
6602 int argc, const char *argv[], void *aux OVS_UNUSED)
6604 struct ds reply = DS_EMPTY_INITIALIZER;
6605 struct ofproto_dpif *ofproto;
6608 ofproto = ofproto_dpif_lookup(argv[1]);
6610 unixctl_command_reply_error(conn, "Unknown ofproto (use "
6611 "ofproto/list for help)");
6614 ofproto_dpif_self_check__(ofproto, &reply);
6616 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
6617 ofproto_dpif_self_check__(ofproto, &reply);
6621 unixctl_command_reply(conn, ds_cstr(&reply));
6626 ofproto_dpif_unixctl_init(void)
6628 static bool registered;
6634 unixctl_command_register(
6636 "bridge {tun_id in_port packet | odp_flow [-generate]}",
6637 2, 5, ofproto_unixctl_trace, NULL);
6638 unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
6639 ofproto_unixctl_fdb_flush, NULL);
6640 unixctl_command_register("fdb/show", "bridge", 1, 1,
6641 ofproto_unixctl_fdb_show, NULL);
6642 unixctl_command_register("ofproto/clog", "", 0, 0,
6643 ofproto_dpif_clog, NULL);
6644 unixctl_command_register("ofproto/unclog", "", 0, 0,
6645 ofproto_dpif_unclog, NULL);
6646 unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
6647 ofproto_dpif_self_check, NULL);
6650 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6652 * This is deprecated. It is only for compatibility with broken device drivers
6653 * in old versions of Linux that do not properly support VLANs when VLAN
6654 * devices are not used. When broken device drivers are no longer in
6655 * widespread use, we will delete these interfaces. */
6658 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
6660 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
6661 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
6663 if (realdev_ofp_port == ofport->realdev_ofp_port
6664 && vid == ofport->vlandev_vid) {
6668 ofproto->need_revalidate = true;
6670 if (ofport->realdev_ofp_port) {
6673 if (realdev_ofp_port && ofport->bundle) {
6674 /* vlandevs are enslaved to their realdevs, so they are not allowed to
6675 * themselves be part of a bundle. */
6676 bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
6679 ofport->realdev_ofp_port = realdev_ofp_port;
6680 ofport->vlandev_vid = vid;
6682 if (realdev_ofp_port) {
6683 vsp_add(ofport, realdev_ofp_port, vid);
6690 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
6692 return hash_2words(realdev_ofp_port, vid);
6695 /* Returns the ODP port number of the Linux VLAN device that corresponds to
6696 * 'vlan_tci' on the network device with port number 'realdev_odp_port' in
6697 * 'ofproto'. For example, given 'realdev_odp_port' of eth0 and 'vlan_tci' 9,
6698 * it would return the port number of eth0.9.
6700 * Unless VLAN splinters are enabled for port 'realdev_odp_port', this
6701 * function just returns its 'realdev_odp_port' argument. */
6703 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
6704 uint32_t realdev_odp_port, ovs_be16 vlan_tci)
6706 if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
6707 uint16_t realdev_ofp_port = odp_port_to_ofp_port(realdev_odp_port);
6708 int vid = vlan_tci_to_vid(vlan_tci);
6709 const struct vlan_splinter *vsp;
6711 HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
6712 hash_realdev_vid(realdev_ofp_port, vid),
6713 &ofproto->realdev_vid_map) {
6714 if (vsp->realdev_ofp_port == realdev_ofp_port
6715 && vsp->vid == vid) {
6716 return ofp_port_to_odp_port(vsp->vlandev_ofp_port);
6720 return realdev_odp_port;
6723 static struct vlan_splinter *
6724 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
6726 struct vlan_splinter *vsp;
6728 HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
6729 &ofproto->vlandev_map) {
6730 if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
6738 /* Returns the OpenFlow port number of the "real" device underlying the Linux
6739 * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
6740 * VLAN VID of the Linux VLAN device in '*vid'. For example, given
6741 * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
6742 * eth0 and store 9 in '*vid'.
6744 * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
6745 * VLAN device. Unless VLAN splinters are enabled, this is what this function
6748 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
6749 uint16_t vlandev_ofp_port, int *vid)
6751 if (!hmap_is_empty(&ofproto->vlandev_map)) {
6752 const struct vlan_splinter *vsp;
6754 vsp = vlandev_find(ofproto, vlandev_ofp_port);
6759 return vsp->realdev_ofp_port;
6765 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
6766 * whether 'flow->in_port' represents a Linux VLAN device. If so, changes
6767 * 'flow->in_port' to the "real" device backing the VLAN device, sets
6768 * 'flow->vlan_tci' to the VLAN VID, and returns true. Otherwise (which is
6769 * always the case unless VLAN splinters are enabled), returns false without
6770 * making any changes. */
6772 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
6777 realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port, &vid);
6782 /* Cause the flow to be processed as if it came in on the real device with
6783 * the VLAN device's VLAN ID. */
6784 flow->in_port = realdev;
6785 flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
6790 vsp_remove(struct ofport_dpif *port)
6792 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6793 struct vlan_splinter *vsp;
6795 vsp = vlandev_find(ofproto, port->up.ofp_port);
6797 hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
6798 hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
6801 port->realdev_ofp_port = 0;
6803 VLOG_ERR("missing vlan device record");
6808 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
6810 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
6812 if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
6813 && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
6814 == realdev_ofp_port)) {
6815 struct vlan_splinter *vsp;
6817 vsp = xmalloc(sizeof *vsp);
6818 hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
6819 hash_int(port->up.ofp_port, 0));
6820 hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
6821 hash_realdev_vid(realdev_ofp_port, vid));
6822 vsp->realdev_ofp_port = realdev_ofp_port;
6823 vsp->vlandev_ofp_port = port->up.ofp_port;
6826 port->realdev_ofp_port = realdev_ofp_port;
6828 VLOG_ERR("duplicate vlan device record");
6832 const struct ofproto_class ofproto_dpif_class = {
6861 port_is_lacp_current,
6862 NULL, /* rule_choose_table */
6869 rule_modify_actions,
6877 get_cfm_remote_mpids,
6882 get_stp_port_status,
6889 is_mirror_output_bundle,
6890 forward_bpdu_changed,