2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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"
39 #include "netdev-vport.h"
46 #include "ofp-actions.h"
47 #include "ofp-parse.h"
48 #include "ofp-print.h"
49 #include "ofproto-dpif-governor.h"
50 #include "ofproto-dpif-ipfix.h"
51 #include "ofproto-dpif-sflow.h"
52 #include "poll-loop.h"
57 #include "unaligned.h"
59 #include "vlan-bitmap.h"
62 VLOG_DEFINE_THIS_MODULE(ofproto_dpif);
64 COVERAGE_DEFINE(ofproto_dpif_expired);
65 COVERAGE_DEFINE(ofproto_dpif_xlate);
66 COVERAGE_DEFINE(facet_changed_rule);
67 COVERAGE_DEFINE(facet_revalidate);
68 COVERAGE_DEFINE(facet_unexpected);
69 COVERAGE_DEFINE(facet_suppress);
71 /* Maximum depth of flow table recursion (due to resubmit actions) in a
72 * flow translation. */
73 #define MAX_RESUBMIT_RECURSION 64
75 /* Number of implemented OpenFlow tables. */
76 enum { N_TABLES = 255 };
77 enum { TBL_INTERNAL = N_TABLES - 1 }; /* Used for internal hidden rules. */
78 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
90 * - Do include packets and bytes from facets that have been deleted or
91 * whose own statistics have been folded into the rule.
93 * - Do include packets and bytes sent "by hand" that were accounted to
94 * the rule without any facet being involved (this is a rare corner
95 * case in rule_execute()).
97 * - Do not include packet or bytes that can be obtained from any facet's
98 * packet_count or byte_count member or that can be obtained from the
99 * datapath by, e.g., dpif_flow_get() for any subfacet.
101 uint64_t packet_count; /* Number of packets received. */
102 uint64_t byte_count; /* Number of bytes received. */
104 tag_type tag; /* Caches rule_calculate_tag() result. */
106 struct list facets; /* List of "struct facet"s. */
109 static struct rule_dpif *rule_dpif_cast(const struct rule *rule)
111 return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
114 static struct rule_dpif *rule_dpif_lookup(struct ofproto_dpif *,
115 const struct flow *);
116 static struct rule_dpif *rule_dpif_lookup__(struct ofproto_dpif *,
119 static struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
120 const struct flow *flow);
122 static void rule_credit_stats(struct rule_dpif *,
123 const struct dpif_flow_stats *);
124 static void flow_push_stats(struct facet *, const struct dpif_flow_stats *);
125 static tag_type rule_calculate_tag(const struct flow *,
126 const struct minimask *, uint32_t basis);
127 static void rule_invalidate(const struct rule_dpif *);
129 #define MAX_MIRRORS 32
130 typedef uint32_t mirror_mask_t;
131 #define MIRROR_MASK_C(X) UINT32_C(X)
132 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
134 struct ofproto_dpif *ofproto; /* Owning ofproto. */
135 size_t idx; /* In ofproto's "mirrors" array. */
136 void *aux; /* Key supplied by ofproto's client. */
137 char *name; /* Identifier for log messages. */
139 /* Selection criteria. */
140 struct hmapx srcs; /* Contains "struct ofbundle *"s. */
141 struct hmapx dsts; /* Contains "struct ofbundle *"s. */
142 unsigned long *vlans; /* Bitmap of chosen VLANs, NULL selects all. */
144 /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
145 struct ofbundle *out; /* Output port or NULL. */
146 int out_vlan; /* Output VLAN or -1. */
147 mirror_mask_t dup_mirrors; /* Bitmap of mirrors with the same output. */
150 int64_t packet_count; /* Number of packets sent. */
151 int64_t byte_count; /* Number of bytes sent. */
154 static void mirror_destroy(struct ofmirror *);
155 static void update_mirror_stats(struct ofproto_dpif *ofproto,
156 mirror_mask_t mirrors,
157 uint64_t packets, uint64_t bytes);
160 struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
161 struct ofproto_dpif *ofproto; /* Owning ofproto. */
162 void *aux; /* Key supplied by ofproto's client. */
163 char *name; /* Identifier for log messages. */
166 struct list ports; /* Contains "struct ofport"s. */
167 enum port_vlan_mode vlan_mode; /* VLAN mode */
168 int vlan; /* -1=trunk port, else a 12-bit VLAN ID. */
169 unsigned long *trunks; /* Bitmap of trunked VLANs, if 'vlan' == -1.
170 * NULL if all VLANs are trunked. */
171 struct lacp *lacp; /* LACP if LACP is enabled, otherwise NULL. */
172 struct bond *bond; /* Nonnull iff more than one port. */
173 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
176 bool floodable; /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
178 /* Port mirroring info. */
179 mirror_mask_t src_mirrors; /* Mirrors triggered when packet received. */
180 mirror_mask_t dst_mirrors; /* Mirrors triggered when packet sent. */
181 mirror_mask_t mirror_out; /* Mirrors that output to this bundle. */
184 static void bundle_remove(struct ofport *);
185 static void bundle_update(struct ofbundle *);
186 static void bundle_destroy(struct ofbundle *);
187 static void bundle_del_port(struct ofport_dpif *);
188 static void bundle_run(struct ofbundle *);
189 static void bundle_wait(struct ofbundle *);
190 static struct ofbundle *lookup_input_bundle(const struct ofproto_dpif *,
191 uint16_t in_port, bool warn,
192 struct ofport_dpif **in_ofportp);
194 /* A controller may use OFPP_NONE as the ingress port to indicate that
195 * it did not arrive on a "real" port. 'ofpp_none_bundle' exists for
196 * when an input bundle is needed for validation (e.g., mirroring or
197 * OFPP_NORMAL processing). It is not connected to an 'ofproto' or have
198 * any 'port' structs, so care must be taken when dealing with it. */
199 static struct ofbundle ofpp_none_bundle = {
201 .vlan_mode = PORT_VLAN_TRUNK
204 static void stp_run(struct ofproto_dpif *ofproto);
205 static void stp_wait(struct ofproto_dpif *ofproto);
206 static int set_stp_port(struct ofport *,
207 const struct ofproto_port_stp_settings *);
209 static bool ofbundle_includes_vlan(const struct ofbundle *, uint16_t vlan);
211 struct action_xlate_ctx {
212 /* action_xlate_ctx_init() initializes these members. */
215 struct ofproto_dpif *ofproto;
217 /* Flow to which the OpenFlow actions apply. xlate_actions() will modify
218 * this flow when actions change header fields. */
221 /* Flow at the last commit. */
222 struct flow base_flow;
224 /* Tunnel IP destination address as received. This is stored separately
225 * as the base_flow.tunnel is cleared on init to reflect the datapath
226 * behavior. Used to make sure not to send tunneled output to ourselves,
227 * which might lead to an infinite loop. This could happen easily
228 * if a tunnel is marked as 'ip_remote=flow', and the flow does not
229 * actually set the tun_dst field. */
230 ovs_be32 orig_tunnel_ip_dst;
232 /* stack for the push and pop actions.
233 * Each stack element is of the type "union mf_subvalue". */
235 union mf_subvalue init_stack[1024 / sizeof(union mf_subvalue)];
237 /* The packet corresponding to 'flow', or a null pointer if we are
238 * revalidating without a packet to refer to. */
239 const struct ofpbuf *packet;
241 /* Should OFPP_NORMAL update the MAC learning table? Should "learn"
242 * actions update the flow table?
244 * We want to update these tables if we are actually processing a packet,
245 * or if we are accounting for packets that the datapath has processed, but
246 * not if we are just revalidating. */
249 /* The rule that we are currently translating, or NULL. */
250 struct rule_dpif *rule;
252 /* Union of the set of TCP flags seen so far in this flow. (Used only by
253 * NXAST_FIN_TIMEOUT. Set to zero to avoid updating updating rules'
257 /* If nonnull, flow translation calls this function just before executing a
258 * resubmit or OFPP_TABLE action. In addition, disables logging of traces
259 * when the recursion depth is exceeded.
261 * 'rule' is the rule being submitted into. It will be null if the
262 * resubmit or OFPP_TABLE action didn't find a matching rule.
264 * This is normally null so the client has to set it manually after
265 * calling action_xlate_ctx_init(). */
266 void (*resubmit_hook)(struct action_xlate_ctx *, struct rule_dpif *rule);
268 /* If nonnull, flow translation calls this function to report some
269 * significant decision, e.g. to explain why OFPP_NORMAL translation
270 * dropped a packet. */
271 void (*report_hook)(struct action_xlate_ctx *, const char *s);
273 /* If nonnull, flow translation credits the specified statistics to each
274 * rule reached through a resubmit or OFPP_TABLE action.
276 * This is normally null so the client has to set it manually after
277 * calling action_xlate_ctx_init(). */
278 const struct dpif_flow_stats *resubmit_stats;
280 /* xlate_actions() initializes and uses these members. The client might want
281 * to look at them after it returns. */
283 struct ofpbuf *odp_actions; /* Datapath actions. */
284 tag_type tags; /* Tags associated with actions. */
285 enum slow_path_reason slow; /* 0 if fast path may be used. */
286 bool has_learn; /* Actions include NXAST_LEARN? */
287 bool has_normal; /* Actions output to OFPP_NORMAL? */
288 bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
289 uint16_t nf_output_iface; /* Output interface index for NetFlow. */
290 mirror_mask_t mirrors; /* Bitmap of associated mirrors. */
292 /* xlate_actions() initializes and uses these members, but the client has no
293 * reason to look at them. */
295 int recurse; /* Recursion level, via xlate_table_action. */
296 bool max_resubmit_trigger; /* Recursed too deeply during translation. */
297 uint32_t orig_skb_priority; /* Priority when packet arrived. */
298 uint8_t table_id; /* OpenFlow table ID where flow was found. */
299 uint32_t sflow_n_outputs; /* Number of output ports. */
300 uint32_t sflow_odp_port; /* Output port for composing sFlow action. */
301 uint16_t user_cookie_offset;/* Used for user_action_cookie fixup. */
302 bool exit; /* No further actions should be processed. */
305 /* Initial values of fields of the packet that may be changed during
306 * flow processing and needed later. */
307 struct initial_vals {
308 /* This is the value of vlan_tci in the packet as actually received from
309 * dpif. This is the same as the facet's flow.vlan_tci unless the packet
310 * was received via a VLAN splinter. In that case, this value is 0
311 * (because the packet as actually received from the dpif had no 802.1Q
312 * tag) but the facet's flow.vlan_tci is set to the VLAN that the splinter
315 * This member should be removed when the VLAN splinters feature is no
320 static void action_xlate_ctx_init(struct action_xlate_ctx *,
321 struct ofproto_dpif *, const struct flow *,
322 const struct initial_vals *initial_vals,
324 uint8_t tcp_flags, const struct ofpbuf *);
325 static void xlate_actions(struct action_xlate_ctx *,
326 const struct ofpact *ofpacts, size_t ofpacts_len,
327 struct ofpbuf *odp_actions);
328 static void xlate_actions_for_side_effects(struct action_xlate_ctx *,
329 const struct ofpact *ofpacts,
331 static void xlate_table_action(struct action_xlate_ctx *, uint16_t in_port,
332 uint8_t table_id, bool may_packet_in);
334 static size_t put_userspace_action(const struct ofproto_dpif *,
335 struct ofpbuf *odp_actions,
337 const union user_action_cookie *,
340 static void compose_slow_path(const struct ofproto_dpif *, const struct flow *,
341 enum slow_path_reason,
342 uint64_t *stub, size_t stub_size,
343 const struct nlattr **actionsp,
344 size_t *actions_lenp);
346 static void xlate_report(struct action_xlate_ctx *ctx, const char *s);
348 /* A subfacet (see "struct subfacet" below) has three possible installation
351 * - SF_NOT_INSTALLED: Not installed in the datapath. This will only be the
352 * case just after the subfacet is created, just before the subfacet is
353 * destroyed, or if the datapath returns an error when we try to install a
356 * - SF_FAST_PATH: The subfacet's actions are installed in the datapath.
358 * - SF_SLOW_PATH: An action that sends every packet for the subfacet through
359 * ofproto_dpif is installed in the datapath.
362 SF_NOT_INSTALLED, /* No datapath flow for this subfacet. */
363 SF_FAST_PATH, /* Full actions are installed. */
364 SF_SLOW_PATH, /* Send-to-userspace action is installed. */
367 static const char *subfacet_path_to_string(enum subfacet_path);
369 /* A dpif flow and actions associated with a facet.
371 * See also the large comment on struct facet. */
374 struct hmap_node hmap_node; /* In struct ofproto_dpif 'subfacets' list. */
375 struct list list_node; /* In struct facet's 'facets' list. */
376 struct facet *facet; /* Owning facet. */
378 enum odp_key_fitness key_fitness;
382 long long int used; /* Time last used; time created if not used. */
383 long long int created; /* Time created. */
385 uint64_t dp_packet_count; /* Last known packet count in the datapath. */
386 uint64_t dp_byte_count; /* Last known byte count in the datapath. */
390 * These should be essentially identical for every subfacet in a facet, but
391 * may differ in trivial ways due to VLAN splinters. */
392 size_t actions_len; /* Number of bytes in actions[]. */
393 struct nlattr *actions; /* Datapath actions. */
395 enum slow_path_reason slow; /* 0 if fast path may be used. */
396 enum subfacet_path path; /* Installed in datapath? */
398 /* Initial values of the packet that may be needed later. */
399 struct initial_vals initial_vals;
401 /* Datapath port the packet arrived on. This is needed to remove
402 * flows for ports that are no longer part of the bridge. Since the
403 * flow definition only has the OpenFlow port number and the port is
404 * no longer part of the bridge, we can't determine the datapath port
405 * number needed to delete the flow from the datapath. */
406 uint32_t odp_in_port;
409 #define SUBFACET_DESTROY_MAX_BATCH 50
411 static struct subfacet *subfacet_create(struct facet *, struct flow_miss *miss,
413 static struct subfacet *subfacet_find(struct ofproto_dpif *,
414 const struct nlattr *key, size_t key_len,
416 static void subfacet_destroy(struct subfacet *);
417 static void subfacet_destroy__(struct subfacet *);
418 static void subfacet_destroy_batch(struct ofproto_dpif *,
419 struct subfacet **, int n);
420 static void subfacet_reset_dp_stats(struct subfacet *,
421 struct dpif_flow_stats *);
422 static void subfacet_update_time(struct subfacet *, long long int used);
423 static void subfacet_update_stats(struct subfacet *,
424 const struct dpif_flow_stats *);
425 static void subfacet_make_actions(struct subfacet *,
426 const struct ofpbuf *packet,
427 struct ofpbuf *odp_actions);
428 static int subfacet_install(struct subfacet *,
429 const struct nlattr *actions, size_t actions_len,
430 struct dpif_flow_stats *, enum slow_path_reason);
431 static void subfacet_uninstall(struct subfacet *);
433 static enum subfacet_path subfacet_want_path(enum slow_path_reason);
435 /* An exact-match instantiation of an OpenFlow flow.
437 * A facet associates a "struct flow", which represents the Open vSwitch
438 * userspace idea of an exact-match flow, with one or more subfacets. Each
439 * subfacet tracks the datapath's idea of the exact-match flow equivalent to
440 * the facet. When the kernel module (or other dpif implementation) and Open
441 * vSwitch userspace agree on the definition of a flow key, there is exactly
442 * one subfacet per facet. If the dpif implementation supports more-specific
443 * flow matching than userspace, however, a facet can have more than one
444 * subfacet, each of which corresponds to some distinction in flow that
445 * userspace simply doesn't understand.
447 * Flow expiration works in terms of subfacets, so a facet must have at least
448 * one subfacet or it will never expire, leaking memory. */
451 struct hmap_node hmap_node; /* In owning ofproto's 'facets' hmap. */
452 struct list list_node; /* In owning rule's 'facets' list. */
453 struct rule_dpif *rule; /* Owning rule. */
456 struct list subfacets;
457 long long int used; /* Time last used; time created if not used. */
464 * - Do include packets and bytes sent "by hand", e.g. with
467 * - Do include packets and bytes that were obtained from the datapath
468 * when a subfacet's statistics were reset (e.g. dpif_flow_put() with
469 * DPIF_FP_ZERO_STATS).
471 * - Do not include packets or bytes that can be obtained from the
472 * datapath for any existing subfacet.
474 uint64_t packet_count; /* Number of packets received. */
475 uint64_t byte_count; /* Number of bytes received. */
477 /* Resubmit statistics. */
478 uint64_t prev_packet_count; /* Number of packets from last stats push. */
479 uint64_t prev_byte_count; /* Number of bytes from last stats push. */
480 long long int prev_used; /* Used time from last stats push. */
483 uint64_t accounted_bytes; /* Bytes processed by facet_account(). */
484 struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
485 uint8_t tcp_flags; /* TCP flags seen for this 'rule'. */
487 /* Properties of datapath actions.
489 * Every subfacet has its own actions because actions can differ slightly
490 * between splintered and non-splintered subfacets due to the VLAN tag
491 * being initially different (present vs. absent). All of them have these
492 * properties in common so we just store one copy of them here. */
493 bool has_learn; /* Actions include NXAST_LEARN? */
494 bool has_normal; /* Actions output to OFPP_NORMAL? */
495 bool has_fin_timeout; /* Actions include NXAST_FIN_TIMEOUT? */
496 tag_type tags; /* Tags that would require revalidation. */
497 mirror_mask_t mirrors; /* Bitmap of dependent mirrors. */
499 /* Storage for a single subfacet, to reduce malloc() time and space
500 * overhead. (A facet always has at least one subfacet and in the common
501 * case has exactly one subfacet. However, 'one_subfacet' may not
502 * always be valid, since it could have been removed after newer
503 * subfacets were pushed onto the 'subfacets' list.) */
504 struct subfacet one_subfacet;
506 long long int learn_rl; /* Rate limiter for facet_learn(). */
509 static struct facet *facet_create(struct rule_dpif *,
510 const struct flow *, uint32_t hash);
511 static void facet_remove(struct facet *);
512 static void facet_free(struct facet *);
514 static struct facet *facet_find(struct ofproto_dpif *,
515 const struct flow *, uint32_t hash);
516 static struct facet *facet_lookup_valid(struct ofproto_dpif *,
517 const struct flow *, uint32_t hash);
518 static bool facet_revalidate(struct facet *);
519 static bool facet_check_consistency(struct facet *);
521 static void facet_flush_stats(struct facet *);
523 static void facet_update_time(struct facet *, long long int used);
524 static void facet_reset_counters(struct facet *);
525 static void facet_push_stats(struct facet *);
526 static void facet_learn(struct facet *);
527 static void facet_account(struct facet *);
528 static void push_all_stats(void);
530 static struct subfacet *facet_get_subfacet(struct facet *);
532 static bool facet_is_controller_flow(struct facet *);
535 struct hmap_node odp_port_node; /* In dpif_backer's "odp_to_ofport_map". */
539 struct ofbundle *bundle; /* Bundle that contains this port, if any. */
540 struct list bundle_node; /* In struct ofbundle's "ports" list. */
541 struct cfm *cfm; /* Connectivity Fault Management, if any. */
542 struct bfd *bfd; /* BFD, if any. */
543 tag_type tag; /* Tag associated with this port. */
544 bool may_enable; /* May be enabled in bonds. */
545 long long int carrier_seq; /* Carrier status changes. */
546 struct tnl_port *tnl_port; /* Tunnel handle, or null. */
549 struct stp_port *stp_port; /* Spanning Tree Protocol, if any. */
550 enum stp_state stp_state; /* Always STP_DISABLED if STP not in use. */
551 long long int stp_state_entered;
553 struct hmap priorities; /* Map of attached 'priority_to_dscp's. */
555 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
557 * This is deprecated. It is only for compatibility with broken device
558 * drivers in old versions of Linux that do not properly support VLANs when
559 * VLAN devices are not used. When broken device drivers are no longer in
560 * widespread use, we will delete these interfaces. */
561 uint16_t realdev_ofp_port;
565 /* Node in 'ofport_dpif''s 'priorities' map. Used to maintain a map from
566 * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
567 * traffic egressing the 'ofport' with that priority should be marked with. */
568 struct priority_to_dscp {
569 struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
570 uint32_t priority; /* Priority of this queue (see struct flow). */
572 uint8_t dscp; /* DSCP bits to mark outgoing traffic with. */
575 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
577 * This is deprecated. It is only for compatibility with broken device drivers
578 * in old versions of Linux that do not properly support VLANs when VLAN
579 * devices are not used. When broken device drivers are no longer in
580 * widespread use, we will delete these interfaces. */
581 struct vlan_splinter {
582 struct hmap_node realdev_vid_node;
583 struct hmap_node vlandev_node;
584 uint16_t realdev_ofp_port;
585 uint16_t vlandev_ofp_port;
589 static uint32_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
590 uint32_t realdev, ovs_be16 vlan_tci);
591 static bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
592 static void vsp_remove(struct ofport_dpif *);
593 static void vsp_add(struct ofport_dpif *, uint16_t realdev_ofp_port, int vid);
595 static uint32_t ofp_port_to_odp_port(const struct ofproto_dpif *,
597 static uint16_t odp_port_to_ofp_port(const struct ofproto_dpif *,
600 static struct ofport_dpif *
601 ofport_dpif_cast(const struct ofport *ofport)
603 return ofport ? CONTAINER_OF(ofport, struct ofport_dpif, up) : NULL;
606 static void port_run(struct ofport_dpif *);
607 static void port_run_fast(struct ofport_dpif *);
608 static void port_wait(struct ofport_dpif *);
609 static int set_bfd(struct ofport *, const struct smap *);
610 static int set_cfm(struct ofport *, const struct cfm_settings *);
611 static void ofport_clear_priorities(struct ofport_dpif *);
612 static void run_fast_rl(void);
614 struct dpif_completion {
615 struct list list_node;
616 struct ofoperation *op;
619 /* Extra information about a classifier table.
620 * Currently used just for optimized flow revalidation. */
622 /* If either of these is nonnull, then this table has a form that allows
623 * flows to be tagged to avoid revalidating most flows for the most common
624 * kinds of flow table changes. */
625 struct cls_table *catchall_table; /* Table that wildcards all fields. */
626 struct cls_table *other_table; /* Table with any other wildcard set. */
627 uint32_t basis; /* Keeps each table's tags separate. */
630 /* Reasons that we might need to revalidate every facet, and corresponding
633 * A value of 0 means that there is no need to revalidate.
635 * It would be nice to have some cleaner way to integrate with coverage
636 * counters, but with only a few reasons I guess this is good enough for
638 enum revalidate_reason {
639 REV_RECONFIGURE = 1, /* Switch configuration changed. */
640 REV_STP, /* Spanning tree protocol port status change. */
641 REV_PORT_TOGGLED, /* Port enabled or disabled by CFM, LACP, ...*/
642 REV_FLOW_TABLE, /* Flow table changed. */
643 REV_INCONSISTENCY /* Facet self-check failed. */
645 COVERAGE_DEFINE(rev_reconfigure);
646 COVERAGE_DEFINE(rev_stp);
647 COVERAGE_DEFINE(rev_port_toggled);
648 COVERAGE_DEFINE(rev_flow_table);
649 COVERAGE_DEFINE(rev_inconsistency);
651 /* Drop keys are odp flow keys which have drop flows installed in the kernel.
652 * These are datapath flows which have no associated ofproto, if they did we
653 * would use facets. */
655 struct hmap_node hmap_node;
660 /* All datapaths of a given type share a single dpif backer instance. */
665 struct timer next_expiration;
666 struct hmap odp_to_ofport_map; /* ODP port to ofport mapping. */
668 struct simap tnl_backers; /* Set of dpif ports backing tunnels. */
670 /* Facet revalidation flags applying to facets which use this backer. */
671 enum revalidate_reason need_revalidate; /* Revalidate every facet. */
672 struct tag_set revalidate_set; /* Revalidate only matching facets. */
674 struct hmap drop_keys; /* Set of dropped odp keys. */
677 /* All existing ofproto_backer instances, indexed by ofproto->up.type. */
678 static struct shash all_dpif_backers = SHASH_INITIALIZER(&all_dpif_backers);
680 static void drop_key_clear(struct dpif_backer *);
681 static struct ofport_dpif *
682 odp_port_to_ofport(const struct dpif_backer *, uint32_t odp_port);
684 static void dpif_stats_update_hit_count(struct ofproto_dpif *ofproto,
686 struct avg_subfacet_rates {
687 double add_rate; /* Moving average of new flows created per minute. */
688 double del_rate; /* Moving average of flows deleted per minute. */
690 static void show_dp_rates(struct ds *ds, const char *heading,
691 const struct avg_subfacet_rates *rates);
692 static void exp_mavg(double *avg, int base, double new);
694 struct ofproto_dpif {
695 struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
697 struct dpif_backer *backer;
699 /* Special OpenFlow rules. */
700 struct rule_dpif *miss_rule; /* Sends flow table misses to controller. */
701 struct rule_dpif *no_packet_in_rule; /* Drops flow table misses. */
707 struct netflow *netflow;
708 struct dpif_sflow *sflow;
709 struct dpif_ipfix *ipfix;
710 struct hmap bundles; /* Contains "struct ofbundle"s. */
711 struct mac_learning *ml;
712 struct ofmirror *mirrors[MAX_MIRRORS];
714 bool has_bonded_bundles;
718 struct hmap subfacets;
719 struct governor *governor;
720 long long int consistency_rl;
723 struct table_dpif tables[N_TABLES];
725 /* Support for debugging async flow mods. */
726 struct list completions;
728 bool has_bundle_action; /* True when the first bundle action appears. */
729 struct netdev_stats stats; /* To account packets generated and consumed in
734 long long int stp_last_tick;
736 /* VLAN splinters. */
737 struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
738 struct hmap vlandev_map; /* vlandev -> (realdev,vid). */
741 struct sset ports; /* Set of standard port names. */
742 struct sset ghost_ports; /* Ports with no datapath port. */
743 struct sset port_poll_set; /* Queued names for port_poll() reply. */
744 int port_poll_errno; /* Last errno for port_poll() reply. */
746 /* Per ofproto's dpif stats. */
750 /* Subfacet statistics.
752 * These keep track of the total number of subfacets added and deleted and
753 * flow life span. They are useful for computing the flow rates stats
754 * exposed via "ovs-appctl dpif/show". The goal is to learn about
755 * traffic patterns in ways that we can use later to improve Open vSwitch
756 * performance in new situations. */
757 long long int created; /* Time when it is created. */
758 unsigned int max_n_subfacet; /* Maximum number of flows */
760 /* The average number of subfacets... */
761 struct avg_subfacet_rates hourly; /* ...over the last hour. */
762 struct avg_subfacet_rates daily; /* ...over the last day. */
763 long long int last_minute; /* Last time 'hourly' was updated. */
765 /* Number of subfacets added or deleted since 'last_minute'. */
766 unsigned int subfacet_add_count;
767 unsigned int subfacet_del_count;
769 /* Number of subfacets added or deleted from 'created' to 'last_minute.' */
770 unsigned long long int total_subfacet_add_count;
771 unsigned long long int total_subfacet_del_count;
773 /* Sum of the number of milliseconds that each subfacet existed,
774 * over the subfacets that have been added and then later deleted. */
775 unsigned long long int total_subfacet_life_span;
777 /* Incremented by the number of currently existing subfacets, each
778 * time we pull statistics from the kernel. */
779 unsigned long long int total_subfacet_count;
781 /* Number of times we pull statistics from the kernel. */
782 unsigned long long int n_update_stats;
784 static unsigned long long int avg_subfacet_life_span(
785 const struct ofproto_dpif *);
786 static double avg_subfacet_count(const struct ofproto_dpif *ofproto);
787 static void update_moving_averages(struct ofproto_dpif *ofproto);
788 static void dpif_stats_update_hit_count(struct ofproto_dpif *ofproto,
790 static void update_max_subfacet_count(struct ofproto_dpif *ofproto);
792 /* Defer flow mod completion until "ovs-appctl ofproto/unclog"? (Useful only
793 * for debugging the asynchronous flow_mod implementation.) */
796 /* All existing ofproto_dpif instances, indexed by ->up.name. */
797 static struct hmap all_ofproto_dpifs = HMAP_INITIALIZER(&all_ofproto_dpifs);
799 static void ofproto_dpif_unixctl_init(void);
801 static struct ofproto_dpif *
802 ofproto_dpif_cast(const struct ofproto *ofproto)
804 ovs_assert(ofproto->ofproto_class == &ofproto_dpif_class);
805 return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
808 static struct ofport_dpif *get_ofp_port(const struct ofproto_dpif *,
810 static struct ofport_dpif *get_odp_port(const struct ofproto_dpif *,
812 static void ofproto_trace(struct ofproto_dpif *, const struct flow *,
813 const struct ofpbuf *,
814 const struct initial_vals *, struct ds *);
816 /* Packet processing. */
817 static void update_learning_table(struct ofproto_dpif *,
818 const struct flow *, int vlan,
821 #define FLOW_MISS_MAX_BATCH 50
822 static int handle_upcalls(struct dpif_backer *, unsigned int max_batch);
824 /* Flow expiration. */
825 static int expire(struct dpif_backer *);
828 static void send_netflow_active_timeouts(struct ofproto_dpif *);
831 static int send_packet(const struct ofport_dpif *, struct ofpbuf *packet);
832 static size_t compose_sflow_action(const struct ofproto_dpif *,
833 struct ofpbuf *odp_actions,
834 const struct flow *, uint32_t odp_port);
835 static void compose_ipfix_action(const struct ofproto_dpif *,
836 struct ofpbuf *odp_actions,
837 const struct flow *);
838 static void add_mirror_actions(struct action_xlate_ctx *ctx,
839 const struct flow *flow);
840 /* Global variables. */
841 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
843 /* Initial mappings of port to bridge mappings. */
844 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
846 /* Factory functions. */
849 init(const struct shash *iface_hints)
851 struct shash_node *node;
853 /* Make a local copy, since we don't own 'iface_hints' elements. */
854 SHASH_FOR_EACH(node, iface_hints) {
855 const struct iface_hint *orig_hint = node->data;
856 struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
858 new_hint->br_name = xstrdup(orig_hint->br_name);
859 new_hint->br_type = xstrdup(orig_hint->br_type);
860 new_hint->ofp_port = orig_hint->ofp_port;
862 shash_add(&init_ofp_ports, node->name, new_hint);
867 enumerate_types(struct sset *types)
869 dp_enumerate_types(types);
873 enumerate_names(const char *type, struct sset *names)
875 struct ofproto_dpif *ofproto;
878 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
879 if (strcmp(type, ofproto->up.type)) {
882 sset_add(names, ofproto->up.name);
889 del(const char *type, const char *name)
894 error = dpif_open(name, type, &dpif);
896 error = dpif_delete(dpif);
903 port_open_type(const char *datapath_type, const char *port_type)
905 return dpif_port_open_type(datapath_type, port_type);
908 /* Type functions. */
910 static struct ofproto_dpif *
911 lookup_ofproto_dpif_by_port_name(const char *name)
913 struct ofproto_dpif *ofproto;
915 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
916 if (sset_contains(&ofproto->ports, name)) {
925 type_run(const char *type)
927 static long long int push_timer = LLONG_MIN;
928 struct dpif_backer *backer;
932 backer = shash_find_data(&all_dpif_backers, type);
934 /* This is not necessarily a problem, since backers are only
935 * created on demand. */
939 dpif_run(backer->dpif);
941 /* The most natural place to push facet statistics is when they're pulled
942 * from the datapath. However, when there are many flows in the datapath,
943 * this expensive operation can occur so frequently, that it reduces our
944 * ability to quickly set up flows. To reduce the cost, we push statistics
946 if (time_msec() > push_timer) {
947 push_timer = time_msec() + 2000;
951 if (backer->need_revalidate
952 || !tag_set_is_empty(&backer->revalidate_set)) {
953 struct tag_set revalidate_set = backer->revalidate_set;
954 bool need_revalidate = backer->need_revalidate;
955 struct ofproto_dpif *ofproto;
956 struct simap_node *node;
957 struct simap tmp_backers;
959 /* Handle tunnel garbage collection. */
960 simap_init(&tmp_backers);
961 simap_swap(&backer->tnl_backers, &tmp_backers);
963 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
964 struct ofport_dpif *iter;
966 if (backer != ofproto->backer) {
970 HMAP_FOR_EACH (iter, up.hmap_node, &ofproto->up.ports) {
973 if (!iter->tnl_port) {
977 dp_port = netdev_vport_get_dpif_port(iter->up.netdev);
978 node = simap_find(&tmp_backers, dp_port);
980 simap_put(&backer->tnl_backers, dp_port, node->data);
981 simap_delete(&tmp_backers, node);
982 node = simap_find(&backer->tnl_backers, dp_port);
984 node = simap_find(&backer->tnl_backers, dp_port);
986 uint32_t odp_port = UINT32_MAX;
988 if (!dpif_port_add(backer->dpif, iter->up.netdev,
990 simap_put(&backer->tnl_backers, dp_port, odp_port);
991 node = simap_find(&backer->tnl_backers, dp_port);
996 iter->odp_port = node ? node->data : OVSP_NONE;
997 if (tnl_port_reconfigure(&iter->up, iter->odp_port,
999 backer->need_revalidate = REV_RECONFIGURE;
1004 SIMAP_FOR_EACH (node, &tmp_backers) {
1005 dpif_port_del(backer->dpif, node->data);
1007 simap_destroy(&tmp_backers);
1009 switch (backer->need_revalidate) {
1010 case REV_RECONFIGURE: COVERAGE_INC(rev_reconfigure); break;
1011 case REV_STP: COVERAGE_INC(rev_stp); break;
1012 case REV_PORT_TOGGLED: COVERAGE_INC(rev_port_toggled); break;
1013 case REV_FLOW_TABLE: COVERAGE_INC(rev_flow_table); break;
1014 case REV_INCONSISTENCY: COVERAGE_INC(rev_inconsistency); break;
1017 if (backer->need_revalidate) {
1018 /* Clear the drop_keys in case we should now be accepting some
1019 * formerly dropped flows. */
1020 drop_key_clear(backer);
1023 /* Clear the revalidation flags. */
1024 tag_set_init(&backer->revalidate_set);
1025 backer->need_revalidate = 0;
1027 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1028 struct facet *facet, *next;
1030 if (ofproto->backer != backer) {
1034 HMAP_FOR_EACH_SAFE (facet, next, hmap_node, &ofproto->facets) {
1036 || tag_set_intersects(&revalidate_set, facet->tags)) {
1037 facet_revalidate(facet);
1044 if (timer_expired(&backer->next_expiration)) {
1045 int delay = expire(backer);
1046 timer_set_duration(&backer->next_expiration, delay);
1049 /* Check for port changes in the dpif. */
1050 while ((error = dpif_port_poll(backer->dpif, &devname)) == 0) {
1051 struct ofproto_dpif *ofproto;
1052 struct dpif_port port;
1054 /* Don't report on the datapath's device. */
1055 if (!strcmp(devname, dpif_base_name(backer->dpif))) {
1059 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
1060 &all_ofproto_dpifs) {
1061 if (simap_contains(&ofproto->backer->tnl_backers, devname)) {
1066 ofproto = lookup_ofproto_dpif_by_port_name(devname);
1067 if (dpif_port_query_by_name(backer->dpif, devname, &port)) {
1068 /* The port was removed. If we know the datapath,
1069 * report it through poll_set(). If we don't, it may be
1070 * notifying us of a removal we initiated, so ignore it.
1071 * If there's a pending ENOBUFS, let it stand, since
1072 * everything will be reevaluated. */
1073 if (ofproto && ofproto->port_poll_errno != ENOBUFS) {
1074 sset_add(&ofproto->port_poll_set, devname);
1075 ofproto->port_poll_errno = 0;
1077 } else if (!ofproto) {
1078 /* The port was added, but we don't know with which
1079 * ofproto we should associate it. Delete it. */
1080 dpif_port_del(backer->dpif, port.port_no);
1082 dpif_port_destroy(&port);
1088 if (error != EAGAIN) {
1089 struct ofproto_dpif *ofproto;
1091 /* There was some sort of error, so propagate it to all
1092 * ofprotos that use this backer. */
1093 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node,
1094 &all_ofproto_dpifs) {
1095 if (ofproto->backer == backer) {
1096 sset_clear(&ofproto->port_poll_set);
1097 ofproto->port_poll_errno = error;
1106 dpif_backer_run_fast(struct dpif_backer *backer, int max_batch)
1110 /* Handle one or more batches of upcalls, until there's nothing left to do
1111 * or until we do a fixed total amount of work.
1113 * We do work in batches because it can be much cheaper to set up a number
1114 * of flows and fire off their patches all at once. We do multiple batches
1115 * because in some cases handling a packet can cause another packet to be
1116 * queued almost immediately as part of the return flow. Both
1117 * optimizations can make major improvements on some benchmarks and
1118 * presumably for real traffic as well. */
1120 while (work < max_batch) {
1121 int retval = handle_upcalls(backer, max_batch - work);
1132 type_run_fast(const char *type)
1134 struct dpif_backer *backer;
1136 backer = shash_find_data(&all_dpif_backers, type);
1138 /* This is not necessarily a problem, since backers are only
1139 * created on demand. */
1143 return dpif_backer_run_fast(backer, FLOW_MISS_MAX_BATCH);
1149 static long long int port_rl = LLONG_MIN;
1150 static unsigned int backer_rl = 0;
1152 if (time_msec() >= port_rl) {
1153 struct ofproto_dpif *ofproto;
1154 struct ofport_dpif *ofport;
1156 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
1158 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1159 port_run_fast(ofport);
1162 port_rl = time_msec() + 200;
1165 /* XXX: We have to be careful not to do too much work in this function. If
1166 * we call dpif_backer_run_fast() too often, or with too large a batch,
1167 * performance improves signifcantly, but at a cost. It's possible for the
1168 * number of flows in the datapath to increase without bound, and for poll
1169 * loops to take 10s of seconds. The correct solution to this problem,
1170 * long term, is to separate flow miss handling into it's own thread so it
1171 * isn't affected by revalidations, and expirations. Until then, this is
1172 * the best we can do. */
1173 if (++backer_rl >= 10) {
1174 struct shash_node *node;
1177 SHASH_FOR_EACH (node, &all_dpif_backers) {
1178 dpif_backer_run_fast(node->data, 1);
1184 type_wait(const char *type)
1186 struct dpif_backer *backer;
1188 backer = shash_find_data(&all_dpif_backers, type);
1190 /* This is not necessarily a problem, since backers are only
1191 * created on demand. */
1195 timer_wait(&backer->next_expiration);
1198 /* Basic life-cycle. */
1200 static int add_internal_flows(struct ofproto_dpif *);
1202 static struct ofproto *
1205 struct ofproto_dpif *ofproto = xmalloc(sizeof *ofproto);
1206 return &ofproto->up;
1210 dealloc(struct ofproto *ofproto_)
1212 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1217 close_dpif_backer(struct dpif_backer *backer)
1219 struct shash_node *node;
1221 ovs_assert(backer->refcount > 0);
1223 if (--backer->refcount) {
1227 drop_key_clear(backer);
1228 hmap_destroy(&backer->drop_keys);
1230 simap_destroy(&backer->tnl_backers);
1231 hmap_destroy(&backer->odp_to_ofport_map);
1232 node = shash_find(&all_dpif_backers, backer->type);
1234 shash_delete(&all_dpif_backers, node);
1235 dpif_close(backer->dpif);
1240 /* Datapath port slated for removal from datapath. */
1241 struct odp_garbage {
1242 struct list list_node;
1247 open_dpif_backer(const char *type, struct dpif_backer **backerp)
1249 struct dpif_backer *backer;
1250 struct dpif_port_dump port_dump;
1251 struct dpif_port port;
1252 struct shash_node *node;
1253 struct list garbage_list;
1254 struct odp_garbage *garbage, *next;
1260 backer = shash_find_data(&all_dpif_backers, type);
1267 backer_name = xasprintf("ovs-%s", type);
1269 /* Remove any existing datapaths, since we assume we're the only
1270 * userspace controlling the datapath. */
1272 dp_enumerate_names(type, &names);
1273 SSET_FOR_EACH(name, &names) {
1274 struct dpif *old_dpif;
1276 /* Don't remove our backer if it exists. */
1277 if (!strcmp(name, backer_name)) {
1281 if (dpif_open(name, type, &old_dpif)) {
1282 VLOG_WARN("couldn't open old datapath %s to remove it", name);
1284 dpif_delete(old_dpif);
1285 dpif_close(old_dpif);
1288 sset_destroy(&names);
1290 backer = xmalloc(sizeof *backer);
1292 error = dpif_create_and_open(backer_name, type, &backer->dpif);
1295 VLOG_ERR("failed to open datapath of type %s: %s", type,
1301 backer->type = xstrdup(type);
1302 backer->refcount = 1;
1303 hmap_init(&backer->odp_to_ofport_map);
1304 hmap_init(&backer->drop_keys);
1305 timer_set_duration(&backer->next_expiration, 1000);
1306 backer->need_revalidate = 0;
1307 simap_init(&backer->tnl_backers);
1308 tag_set_init(&backer->revalidate_set);
1311 dpif_flow_flush(backer->dpif);
1313 /* Loop through the ports already on the datapath and remove any
1314 * that we don't need anymore. */
1315 list_init(&garbage_list);
1316 dpif_port_dump_start(&port_dump, backer->dpif);
1317 while (dpif_port_dump_next(&port_dump, &port)) {
1318 node = shash_find(&init_ofp_ports, port.name);
1319 if (!node && strcmp(port.name, dpif_base_name(backer->dpif))) {
1320 garbage = xmalloc(sizeof *garbage);
1321 garbage->odp_port = port.port_no;
1322 list_push_front(&garbage_list, &garbage->list_node);
1325 dpif_port_dump_done(&port_dump);
1327 LIST_FOR_EACH_SAFE (garbage, next, list_node, &garbage_list) {
1328 dpif_port_del(backer->dpif, garbage->odp_port);
1329 list_remove(&garbage->list_node);
1333 shash_add(&all_dpif_backers, type, backer);
1335 error = dpif_recv_set(backer->dpif, true);
1337 VLOG_ERR("failed to listen on datapath of type %s: %s",
1338 type, strerror(error));
1339 close_dpif_backer(backer);
1347 construct(struct ofproto *ofproto_)
1349 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1350 struct shash_node *node, *next;
1355 error = open_dpif_backer(ofproto->up.type, &ofproto->backer);
1360 max_ports = dpif_get_max_ports(ofproto->backer->dpif);
1361 ofproto_init_max_ports(ofproto_, MIN(max_ports, OFPP_MAX));
1363 ofproto->n_matches = 0;
1365 ofproto->netflow = NULL;
1366 ofproto->sflow = NULL;
1367 ofproto->ipfix = NULL;
1368 ofproto->stp = NULL;
1369 hmap_init(&ofproto->bundles);
1370 ofproto->ml = mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME);
1371 for (i = 0; i < MAX_MIRRORS; i++) {
1372 ofproto->mirrors[i] = NULL;
1374 ofproto->has_bonded_bundles = false;
1376 hmap_init(&ofproto->facets);
1377 hmap_init(&ofproto->subfacets);
1378 ofproto->governor = NULL;
1379 ofproto->consistency_rl = LLONG_MIN;
1381 for (i = 0; i < N_TABLES; i++) {
1382 struct table_dpif *table = &ofproto->tables[i];
1384 table->catchall_table = NULL;
1385 table->other_table = NULL;
1386 table->basis = random_uint32();
1389 list_init(&ofproto->completions);
1391 ofproto_dpif_unixctl_init();
1393 ofproto->has_mirrors = false;
1394 ofproto->has_bundle_action = false;
1396 hmap_init(&ofproto->vlandev_map);
1397 hmap_init(&ofproto->realdev_vid_map);
1399 sset_init(&ofproto->ports);
1400 sset_init(&ofproto->ghost_ports);
1401 sset_init(&ofproto->port_poll_set);
1402 ofproto->port_poll_errno = 0;
1404 SHASH_FOR_EACH_SAFE (node, next, &init_ofp_ports) {
1405 struct iface_hint *iface_hint = node->data;
1407 if (!strcmp(iface_hint->br_name, ofproto->up.name)) {
1408 /* Check if the datapath already has this port. */
1409 if (dpif_port_exists(ofproto->backer->dpif, node->name)) {
1410 sset_add(&ofproto->ports, node->name);
1413 free(iface_hint->br_name);
1414 free(iface_hint->br_type);
1416 shash_delete(&init_ofp_ports, node);
1420 hmap_insert(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node,
1421 hash_string(ofproto->up.name, 0));
1422 memset(&ofproto->stats, 0, sizeof ofproto->stats);
1424 ofproto_init_tables(ofproto_, N_TABLES);
1425 error = add_internal_flows(ofproto);
1426 ofproto->up.tables[TBL_INTERNAL].flags = OFTABLE_HIDDEN | OFTABLE_READONLY;
1429 ofproto->n_missed = 0;
1431 ofproto->max_n_subfacet = 0;
1432 ofproto->created = time_msec();
1433 ofproto->last_minute = ofproto->created;
1434 memset(&ofproto->hourly, 0, sizeof ofproto->hourly);
1435 memset(&ofproto->daily, 0, sizeof ofproto->daily);
1436 ofproto->subfacet_add_count = 0;
1437 ofproto->subfacet_del_count = 0;
1438 ofproto->total_subfacet_add_count = 0;
1439 ofproto->total_subfacet_del_count = 0;
1440 ofproto->total_subfacet_life_span = 0;
1441 ofproto->total_subfacet_count = 0;
1442 ofproto->n_update_stats = 0;
1448 add_internal_flow(struct ofproto_dpif *ofproto, int id,
1449 const struct ofpbuf *ofpacts, struct rule_dpif **rulep)
1451 struct ofputil_flow_mod fm;
1454 match_init_catchall(&fm.match);
1456 match_set_reg(&fm.match, 0, id);
1457 fm.new_cookie = htonll(0);
1458 fm.cookie = htonll(0);
1459 fm.cookie_mask = htonll(0);
1460 fm.table_id = TBL_INTERNAL;
1461 fm.command = OFPFC_ADD;
1462 fm.idle_timeout = 0;
1463 fm.hard_timeout = 0;
1467 fm.ofpacts = ofpacts->data;
1468 fm.ofpacts_len = ofpacts->size;
1470 error = ofproto_flow_mod(&ofproto->up, &fm);
1472 VLOG_ERR_RL(&rl, "failed to add internal flow %d (%s)",
1473 id, ofperr_to_string(error));
1477 *rulep = rule_dpif_lookup__(ofproto, &fm.match.flow, TBL_INTERNAL);
1478 ovs_assert(*rulep != NULL);
1484 add_internal_flows(struct ofproto_dpif *ofproto)
1486 struct ofpact_controller *controller;
1487 uint64_t ofpacts_stub[128 / 8];
1488 struct ofpbuf ofpacts;
1492 ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1495 controller = ofpact_put_CONTROLLER(&ofpacts);
1496 controller->max_len = UINT16_MAX;
1497 controller->controller_id = 0;
1498 controller->reason = OFPR_NO_MATCH;
1499 ofpact_pad(&ofpacts);
1501 error = add_internal_flow(ofproto, id++, &ofpacts, &ofproto->miss_rule);
1506 ofpbuf_clear(&ofpacts);
1507 error = add_internal_flow(ofproto, id++, &ofpacts,
1508 &ofproto->no_packet_in_rule);
1513 complete_operations(struct ofproto_dpif *ofproto)
1515 struct dpif_completion *c, *next;
1517 LIST_FOR_EACH_SAFE (c, next, list_node, &ofproto->completions) {
1518 ofoperation_complete(c->op, 0);
1519 list_remove(&c->list_node);
1525 destruct(struct ofproto *ofproto_)
1527 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1528 struct rule_dpif *rule, *next_rule;
1529 struct oftable *table;
1532 hmap_remove(&all_ofproto_dpifs, &ofproto->all_ofproto_dpifs_node);
1533 complete_operations(ofproto);
1535 OFPROTO_FOR_EACH_TABLE (table, &ofproto->up) {
1536 struct cls_cursor cursor;
1538 cls_cursor_init(&cursor, &table->cls, NULL);
1539 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, up.cr, &cursor) {
1540 ofproto_rule_destroy(&rule->up);
1544 for (i = 0; i < MAX_MIRRORS; i++) {
1545 mirror_destroy(ofproto->mirrors[i]);
1548 netflow_destroy(ofproto->netflow);
1549 dpif_sflow_destroy(ofproto->sflow);
1550 hmap_destroy(&ofproto->bundles);
1551 mac_learning_destroy(ofproto->ml);
1553 hmap_destroy(&ofproto->facets);
1554 hmap_destroy(&ofproto->subfacets);
1555 governor_destroy(ofproto->governor);
1557 hmap_destroy(&ofproto->vlandev_map);
1558 hmap_destroy(&ofproto->realdev_vid_map);
1560 sset_destroy(&ofproto->ports);
1561 sset_destroy(&ofproto->ghost_ports);
1562 sset_destroy(&ofproto->port_poll_set);
1564 close_dpif_backer(ofproto->backer);
1568 run_fast(struct ofproto *ofproto_)
1570 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1571 struct ofport_dpif *ofport;
1573 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1574 port_run_fast(ofport);
1581 run(struct ofproto *ofproto_)
1583 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1584 struct ofport_dpif *ofport;
1585 struct ofbundle *bundle;
1589 complete_operations(ofproto);
1592 error = run_fast(ofproto_);
1597 if (ofproto->netflow) {
1598 if (netflow_run(ofproto->netflow)) {
1599 send_netflow_active_timeouts(ofproto);
1602 if (ofproto->sflow) {
1603 dpif_sflow_run(ofproto->sflow);
1606 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1609 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1614 mac_learning_run(ofproto->ml, &ofproto->backer->revalidate_set);
1616 /* Check the consistency of a random facet, to aid debugging. */
1617 if (time_msec() >= ofproto->consistency_rl
1618 && !hmap_is_empty(&ofproto->facets)
1619 && !ofproto->backer->need_revalidate) {
1620 struct facet *facet;
1622 ofproto->consistency_rl = time_msec() + 250;
1624 facet = CONTAINER_OF(hmap_random_node(&ofproto->facets),
1625 struct facet, hmap_node);
1626 if (!tag_set_intersects(&ofproto->backer->revalidate_set,
1628 if (!facet_check_consistency(facet)) {
1629 ofproto->backer->need_revalidate = REV_INCONSISTENCY;
1634 if (ofproto->governor) {
1637 governor_run(ofproto->governor);
1639 /* If the governor has shrunk to its minimum size and the number of
1640 * subfacets has dwindled, then drop the governor entirely.
1642 * For hysteresis, the number of subfacets to drop the governor is
1643 * smaller than the number needed to trigger its creation. */
1644 n_subfacets = hmap_count(&ofproto->subfacets);
1645 if (n_subfacets * 4 < ofproto->up.flow_eviction_threshold
1646 && governor_is_idle(ofproto->governor)) {
1647 governor_destroy(ofproto->governor);
1648 ofproto->governor = NULL;
1656 wait(struct ofproto *ofproto_)
1658 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1659 struct ofport_dpif *ofport;
1660 struct ofbundle *bundle;
1662 if (!clogged && !list_is_empty(&ofproto->completions)) {
1663 poll_immediate_wake();
1666 dpif_wait(ofproto->backer->dpif);
1667 dpif_recv_wait(ofproto->backer->dpif);
1668 if (ofproto->sflow) {
1669 dpif_sflow_wait(ofproto->sflow);
1671 if (!tag_set_is_empty(&ofproto->backer->revalidate_set)) {
1672 poll_immediate_wake();
1674 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1677 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
1678 bundle_wait(bundle);
1680 if (ofproto->netflow) {
1681 netflow_wait(ofproto->netflow);
1683 mac_learning_wait(ofproto->ml);
1685 if (ofproto->backer->need_revalidate) {
1686 /* Shouldn't happen, but if it does just go around again. */
1687 VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
1688 poll_immediate_wake();
1690 if (ofproto->governor) {
1691 governor_wait(ofproto->governor);
1696 get_memory_usage(const struct ofproto *ofproto_, struct simap *usage)
1698 const struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1700 simap_increase(usage, "facets", hmap_count(&ofproto->facets));
1701 simap_increase(usage, "subfacets", hmap_count(&ofproto->subfacets));
1705 flush(struct ofproto *ofproto_)
1707 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1708 struct subfacet *subfacet, *next_subfacet;
1709 struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
1713 HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
1714 &ofproto->subfacets) {
1715 if (subfacet->path != SF_NOT_INSTALLED) {
1716 batch[n_batch++] = subfacet;
1717 if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
1718 subfacet_destroy_batch(ofproto, batch, n_batch);
1722 subfacet_destroy(subfacet);
1727 subfacet_destroy_batch(ofproto, batch, n_batch);
1732 get_features(struct ofproto *ofproto_ OVS_UNUSED,
1733 bool *arp_match_ip, enum ofputil_action_bitmap *actions)
1735 *arp_match_ip = true;
1736 *actions = (OFPUTIL_A_OUTPUT |
1737 OFPUTIL_A_SET_VLAN_VID |
1738 OFPUTIL_A_SET_VLAN_PCP |
1739 OFPUTIL_A_STRIP_VLAN |
1740 OFPUTIL_A_SET_DL_SRC |
1741 OFPUTIL_A_SET_DL_DST |
1742 OFPUTIL_A_SET_NW_SRC |
1743 OFPUTIL_A_SET_NW_DST |
1744 OFPUTIL_A_SET_NW_TOS |
1745 OFPUTIL_A_SET_TP_SRC |
1746 OFPUTIL_A_SET_TP_DST |
1751 get_tables(struct ofproto *ofproto_, struct ofp12_table_stats *ots)
1753 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1754 struct dpif_dp_stats s;
1756 strcpy(ots->name, "classifier");
1758 dpif_get_dp_stats(ofproto->backer->dpif, &s);
1760 ots->lookup_count = htonll(s.n_hit + s.n_missed);
1761 ots->matched_count = htonll(s.n_hit + ofproto->n_matches);
1764 static struct ofport *
1767 struct ofport_dpif *port = xmalloc(sizeof *port);
1772 port_dealloc(struct ofport *port_)
1774 struct ofport_dpif *port = ofport_dpif_cast(port_);
1779 port_construct(struct ofport *port_)
1781 struct ofport_dpif *port = ofport_dpif_cast(port_);
1782 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1783 const struct netdev *netdev = port->up.netdev;
1784 struct dpif_port dpif_port;
1787 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1788 port->bundle = NULL;
1791 port->tag = tag_create_random();
1792 port->may_enable = true;
1793 port->stp_port = NULL;
1794 port->stp_state = STP_DISABLED;
1795 port->tnl_port = NULL;
1796 hmap_init(&port->priorities);
1797 port->realdev_ofp_port = 0;
1798 port->vlandev_vid = 0;
1799 port->carrier_seq = netdev_get_carrier_resets(netdev);
1801 if (netdev_vport_is_patch(netdev)) {
1802 /* By bailing out here, we don't submit the port to the sFlow module
1803 * to be considered for counter polling export. This is correct
1804 * because the patch port represents an interface that sFlow considers
1805 * to be "internal" to the switch as a whole, and therefore not an
1806 * candidate for counter polling. */
1807 port->odp_port = OVSP_NONE;
1811 error = dpif_port_query_by_name(ofproto->backer->dpif,
1812 netdev_vport_get_dpif_port(netdev),
1818 port->odp_port = dpif_port.port_no;
1820 if (netdev_get_tunnel_config(netdev)) {
1821 port->tnl_port = tnl_port_add(&port->up, port->odp_port);
1823 /* Sanity-check that a mapping doesn't already exist. This
1824 * shouldn't happen for non-tunnel ports. */
1825 if (odp_port_to_ofp_port(ofproto, port->odp_port) != OFPP_NONE) {
1826 VLOG_ERR("port %s already has an OpenFlow port number",
1828 dpif_port_destroy(&dpif_port);
1832 hmap_insert(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node,
1833 hash_int(port->odp_port, 0));
1835 dpif_port_destroy(&dpif_port);
1837 if (ofproto->sflow) {
1838 dpif_sflow_add_port(ofproto->sflow, port_, port->odp_port);
1845 port_destruct(struct ofport *port_)
1847 struct ofport_dpif *port = ofport_dpif_cast(port_);
1848 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1849 const char *dp_port_name = netdev_vport_get_dpif_port(port->up.netdev);
1850 const char *devname = netdev_get_name(port->up.netdev);
1852 if (dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
1853 /* The underlying device is still there, so delete it. This
1854 * happens when the ofproto is being destroyed, since the caller
1855 * assumes that removal of attached ports will happen as part of
1857 if (!port->tnl_port) {
1858 dpif_port_del(ofproto->backer->dpif, port->odp_port);
1860 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1863 if (port->odp_port != OVSP_NONE && !port->tnl_port) {
1864 hmap_remove(&ofproto->backer->odp_to_ofport_map, &port->odp_port_node);
1867 tnl_port_del(port->tnl_port);
1868 sset_find_and_delete(&ofproto->ports, devname);
1869 sset_find_and_delete(&ofproto->ghost_ports, devname);
1870 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1871 bundle_remove(port_);
1872 set_cfm(port_, NULL);
1873 set_bfd(port_, NULL);
1874 if (ofproto->sflow) {
1875 dpif_sflow_del_port(ofproto->sflow, port->odp_port);
1878 ofport_clear_priorities(port);
1879 hmap_destroy(&port->priorities);
1883 port_modified(struct ofport *port_)
1885 struct ofport_dpif *port = ofport_dpif_cast(port_);
1887 if (port->bundle && port->bundle->bond) {
1888 bond_slave_set_netdev(port->bundle->bond, port, port->up.netdev);
1893 port_reconfigured(struct ofport *port_, enum ofputil_port_config old_config)
1895 struct ofport_dpif *port = ofport_dpif_cast(port_);
1896 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
1897 enum ofputil_port_config changed = old_config ^ port->up.pp.config;
1899 if (changed & (OFPUTIL_PC_NO_RECV | OFPUTIL_PC_NO_RECV_STP |
1900 OFPUTIL_PC_NO_FWD | OFPUTIL_PC_NO_FLOOD |
1901 OFPUTIL_PC_NO_PACKET_IN)) {
1902 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1904 if (changed & OFPUTIL_PC_NO_FLOOD && port->bundle) {
1905 bundle_update(port->bundle);
1911 set_sflow(struct ofproto *ofproto_,
1912 const struct ofproto_sflow_options *sflow_options)
1914 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1915 struct dpif_sflow *ds = ofproto->sflow;
1917 if (sflow_options) {
1919 struct ofport_dpif *ofport;
1921 ds = ofproto->sflow = dpif_sflow_create();
1922 HMAP_FOR_EACH (ofport, up.hmap_node, &ofproto->up.ports) {
1923 dpif_sflow_add_port(ds, &ofport->up, ofport->odp_port);
1925 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1927 dpif_sflow_set_options(ds, sflow_options);
1930 dpif_sflow_destroy(ds);
1931 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1932 ofproto->sflow = NULL;
1940 struct ofproto *ofproto_,
1941 const struct ofproto_ipfix_bridge_exporter_options *bridge_exporter_options,
1942 const struct ofproto_ipfix_flow_exporter_options *flow_exporters_options,
1943 size_t n_flow_exporters_options)
1945 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
1946 struct dpif_ipfix *di = ofproto->ipfix;
1948 if (bridge_exporter_options || flow_exporters_options) {
1950 di = ofproto->ipfix = dpif_ipfix_create();
1952 dpif_ipfix_set_options(
1953 di, bridge_exporter_options, flow_exporters_options,
1954 n_flow_exporters_options);
1957 dpif_ipfix_destroy(di);
1958 ofproto->ipfix = NULL;
1965 set_cfm(struct ofport *ofport_, const struct cfm_settings *s)
1967 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1974 struct ofproto_dpif *ofproto;
1976 ofproto = ofproto_dpif_cast(ofport->up.ofproto);
1977 ofproto->backer->need_revalidate = REV_RECONFIGURE;
1978 ofport->cfm = cfm_create(ofport->up.netdev);
1981 if (cfm_configure(ofport->cfm, s)) {
1987 cfm_destroy(ofport->cfm);
1993 get_cfm_status(const struct ofport *ofport_,
1994 struct ofproto_cfm_status *status)
1996 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
1999 status->faults = cfm_get_fault(ofport->cfm);
2000 status->remote_opstate = cfm_get_opup(ofport->cfm);
2001 status->health = cfm_get_health(ofport->cfm);
2002 cfm_get_remote_mpids(ofport->cfm, &status->rmps, &status->n_rmps);
2010 set_bfd(struct ofport *ofport_, const struct smap *cfg)
2012 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
2013 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2017 ofport->bfd = bfd_configure(old, netdev_get_name(ofport->up.netdev), cfg);
2018 if (ofport->bfd != old) {
2019 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2026 get_bfd_status(struct ofport *ofport_, struct smap *smap)
2028 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2031 bfd_get_status(ofport->bfd, smap);
2038 /* Spanning Tree. */
2041 send_bpdu_cb(struct ofpbuf *pkt, int port_num, void *ofproto_)
2043 struct ofproto_dpif *ofproto = ofproto_;
2044 struct stp_port *sp = stp_get_port(ofproto->stp, port_num);
2045 struct ofport_dpif *ofport;
2047 ofport = stp_port_get_aux(sp);
2049 VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
2050 ofproto->up.name, port_num);
2052 struct eth_header *eth = pkt->l2;
2054 netdev_get_etheraddr(ofport->up.netdev, eth->eth_src);
2055 if (eth_addr_is_zero(eth->eth_src)) {
2056 VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d "
2057 "with unknown MAC", ofproto->up.name, port_num);
2059 send_packet(ofport, pkt);
2065 /* Configures STP on 'ofproto_' using the settings defined in 's'. */
2067 set_stp(struct ofproto *ofproto_, const struct ofproto_stp_settings *s)
2069 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2071 /* Only revalidate flows if the configuration changed. */
2072 if (!s != !ofproto->stp) {
2073 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2077 if (!ofproto->stp) {
2078 ofproto->stp = stp_create(ofproto_->name, s->system_id,
2079 send_bpdu_cb, ofproto);
2080 ofproto->stp_last_tick = time_msec();
2083 stp_set_bridge_id(ofproto->stp, s->system_id);
2084 stp_set_bridge_priority(ofproto->stp, s->priority);
2085 stp_set_hello_time(ofproto->stp, s->hello_time);
2086 stp_set_max_age(ofproto->stp, s->max_age);
2087 stp_set_forward_delay(ofproto->stp, s->fwd_delay);
2089 struct ofport *ofport;
2091 HMAP_FOR_EACH (ofport, hmap_node, &ofproto->up.ports) {
2092 set_stp_port(ofport, NULL);
2095 stp_destroy(ofproto->stp);
2096 ofproto->stp = NULL;
2103 get_stp_status(struct ofproto *ofproto_, struct ofproto_stp_status *s)
2105 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2109 s->bridge_id = stp_get_bridge_id(ofproto->stp);
2110 s->designated_root = stp_get_designated_root(ofproto->stp);
2111 s->root_path_cost = stp_get_root_path_cost(ofproto->stp);
2120 update_stp_port_state(struct ofport_dpif *ofport)
2122 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2123 enum stp_state state;
2125 /* Figure out new state. */
2126 state = ofport->stp_port ? stp_port_get_state(ofport->stp_port)
2130 if (ofport->stp_state != state) {
2131 enum ofputil_port_state of_state;
2134 VLOG_DBG_RL(&rl, "port %s: STP state changed from %s to %s",
2135 netdev_get_name(ofport->up.netdev),
2136 stp_state_name(ofport->stp_state),
2137 stp_state_name(state));
2138 if (stp_learn_in_state(ofport->stp_state)
2139 != stp_learn_in_state(state)) {
2140 /* xxx Learning action flows should also be flushed. */
2141 mac_learning_flush(ofproto->ml,
2142 &ofproto->backer->revalidate_set);
2144 fwd_change = stp_forward_in_state(ofport->stp_state)
2145 != stp_forward_in_state(state);
2147 ofproto->backer->need_revalidate = REV_STP;
2148 ofport->stp_state = state;
2149 ofport->stp_state_entered = time_msec();
2151 if (fwd_change && ofport->bundle) {
2152 bundle_update(ofport->bundle);
2155 /* Update the STP state bits in the OpenFlow port description. */
2156 of_state = ofport->up.pp.state & ~OFPUTIL_PS_STP_MASK;
2157 of_state |= (state == STP_LISTENING ? OFPUTIL_PS_STP_LISTEN
2158 : state == STP_LEARNING ? OFPUTIL_PS_STP_LEARN
2159 : state == STP_FORWARDING ? OFPUTIL_PS_STP_FORWARD
2160 : state == STP_BLOCKING ? OFPUTIL_PS_STP_BLOCK
2162 ofproto_port_set_state(&ofport->up, of_state);
2166 /* Configures STP on 'ofport_' using the settings defined in 's'. The
2167 * caller is responsible for assigning STP port numbers and ensuring
2168 * there are no duplicates. */
2170 set_stp_port(struct ofport *ofport_,
2171 const struct ofproto_port_stp_settings *s)
2173 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2174 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2175 struct stp_port *sp = ofport->stp_port;
2177 if (!s || !s->enable) {
2179 ofport->stp_port = NULL;
2180 stp_port_disable(sp);
2181 update_stp_port_state(ofport);
2184 } else if (sp && stp_port_no(sp) != s->port_num
2185 && ofport == stp_port_get_aux(sp)) {
2186 /* The port-id changed, so disable the old one if it's not
2187 * already in use by another port. */
2188 stp_port_disable(sp);
2191 sp = ofport->stp_port = stp_get_port(ofproto->stp, s->port_num);
2192 stp_port_enable(sp);
2194 stp_port_set_aux(sp, ofport);
2195 stp_port_set_priority(sp, s->priority);
2196 stp_port_set_path_cost(sp, s->path_cost);
2198 update_stp_port_state(ofport);
2204 get_stp_port_status(struct ofport *ofport_,
2205 struct ofproto_port_stp_status *s)
2207 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2208 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2209 struct stp_port *sp = ofport->stp_port;
2211 if (!ofproto->stp || !sp) {
2217 s->port_id = stp_port_get_id(sp);
2218 s->state = stp_port_get_state(sp);
2219 s->sec_in_state = (time_msec() - ofport->stp_state_entered) / 1000;
2220 s->role = stp_port_get_role(sp);
2221 stp_port_get_counts(sp, &s->tx_count, &s->rx_count, &s->error_count);
2227 stp_run(struct ofproto_dpif *ofproto)
2230 long long int now = time_msec();
2231 long long int elapsed = now - ofproto->stp_last_tick;
2232 struct stp_port *sp;
2235 stp_tick(ofproto->stp, MIN(INT_MAX, elapsed));
2236 ofproto->stp_last_tick = now;
2238 while (stp_get_changed_port(ofproto->stp, &sp)) {
2239 struct ofport_dpif *ofport = stp_port_get_aux(sp);
2242 update_stp_port_state(ofport);
2246 if (stp_check_and_reset_fdb_flush(ofproto->stp)) {
2247 mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
2253 stp_wait(struct ofproto_dpif *ofproto)
2256 poll_timer_wait(1000);
2260 /* Returns true if STP should process 'flow'. */
2262 stp_should_process_flow(const struct flow *flow)
2264 return eth_addr_equals(flow->dl_dst, eth_addr_stp);
2268 stp_process_packet(const struct ofport_dpif *ofport,
2269 const struct ofpbuf *packet)
2271 struct ofpbuf payload = *packet;
2272 struct eth_header *eth = payload.data;
2273 struct stp_port *sp = ofport->stp_port;
2275 /* Sink packets on ports that have STP disabled when the bridge has
2277 if (!sp || stp_port_get_state(sp) == STP_DISABLED) {
2281 /* Trim off padding on payload. */
2282 if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
2283 payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
2286 if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
2287 stp_received_bpdu(sp, payload.data, payload.size);
2291 static struct priority_to_dscp *
2292 get_priority(const struct ofport_dpif *ofport, uint32_t priority)
2294 struct priority_to_dscp *pdscp;
2297 hash = hash_int(priority, 0);
2298 HMAP_FOR_EACH_IN_BUCKET (pdscp, hmap_node, hash, &ofport->priorities) {
2299 if (pdscp->priority == priority) {
2307 ofport_clear_priorities(struct ofport_dpif *ofport)
2309 struct priority_to_dscp *pdscp, *next;
2311 HMAP_FOR_EACH_SAFE (pdscp, next, hmap_node, &ofport->priorities) {
2312 hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2318 set_queues(struct ofport *ofport_,
2319 const struct ofproto_port_queue *qdscp_list,
2322 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
2323 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
2324 struct hmap new = HMAP_INITIALIZER(&new);
2327 for (i = 0; i < n_qdscp; i++) {
2328 struct priority_to_dscp *pdscp;
2332 dscp = (qdscp_list[i].dscp << 2) & IP_DSCP_MASK;
2333 if (dpif_queue_to_priority(ofproto->backer->dpif, qdscp_list[i].queue,
2338 pdscp = get_priority(ofport, priority);
2340 hmap_remove(&ofport->priorities, &pdscp->hmap_node);
2342 pdscp = xmalloc(sizeof *pdscp);
2343 pdscp->priority = priority;
2345 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2348 if (pdscp->dscp != dscp) {
2350 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2353 hmap_insert(&new, &pdscp->hmap_node, hash_int(pdscp->priority, 0));
2356 if (!hmap_is_empty(&ofport->priorities)) {
2357 ofport_clear_priorities(ofport);
2358 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2361 hmap_swap(&new, &ofport->priorities);
2369 /* Expires all MAC learning entries associated with 'bundle' and forces its
2370 * ofproto to revalidate every flow.
2372 * Normally MAC learning entries are removed only from the ofproto associated
2373 * with 'bundle', but if 'all_ofprotos' is true, then the MAC learning entries
2374 * are removed from every ofproto. When patch ports and SLB bonds are in use
2375 * and a VM migration happens and the gratuitous ARPs are somehow lost, this
2376 * avoids a MAC_ENTRY_IDLE_TIME delay before the migrated VM can communicate
2377 * with the host from which it migrated. */
2379 bundle_flush_macs(struct ofbundle *bundle, bool all_ofprotos)
2381 struct ofproto_dpif *ofproto = bundle->ofproto;
2382 struct mac_learning *ml = ofproto->ml;
2383 struct mac_entry *mac, *next_mac;
2385 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2386 LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
2387 if (mac->port.p == bundle) {
2389 struct ofproto_dpif *o;
2391 HMAP_FOR_EACH (o, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
2393 struct mac_entry *e;
2395 e = mac_learning_lookup(o->ml, mac->mac, mac->vlan,
2398 mac_learning_expire(o->ml, e);
2404 mac_learning_expire(ml, mac);
2409 static struct ofbundle *
2410 bundle_lookup(const struct ofproto_dpif *ofproto, void *aux)
2412 struct ofbundle *bundle;
2414 HMAP_FOR_EACH_IN_BUCKET (bundle, hmap_node, hash_pointer(aux, 0),
2415 &ofproto->bundles) {
2416 if (bundle->aux == aux) {
2423 /* Looks up each of the 'n_auxes' pointers in 'auxes' as bundles and adds the
2424 * ones that are found to 'bundles'. */
2426 bundle_lookup_multiple(struct ofproto_dpif *ofproto,
2427 void **auxes, size_t n_auxes,
2428 struct hmapx *bundles)
2432 hmapx_init(bundles);
2433 for (i = 0; i < n_auxes; i++) {
2434 struct ofbundle *bundle = bundle_lookup(ofproto, auxes[i]);
2436 hmapx_add(bundles, bundle);
2442 bundle_update(struct ofbundle *bundle)
2444 struct ofport_dpif *port;
2446 bundle->floodable = true;
2447 LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2448 if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2449 || !stp_forward_in_state(port->stp_state)) {
2450 bundle->floodable = false;
2457 bundle_del_port(struct ofport_dpif *port)
2459 struct ofbundle *bundle = port->bundle;
2461 bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2463 list_remove(&port->bundle_node);
2464 port->bundle = NULL;
2467 lacp_slave_unregister(bundle->lacp, port);
2470 bond_slave_unregister(bundle->bond, port);
2473 bundle_update(bundle);
2477 bundle_add_port(struct ofbundle *bundle, uint16_t ofp_port,
2478 struct lacp_slave_settings *lacp)
2480 struct ofport_dpif *port;
2482 port = get_ofp_port(bundle->ofproto, ofp_port);
2487 if (port->bundle != bundle) {
2488 bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2490 bundle_del_port(port);
2493 port->bundle = bundle;
2494 list_push_back(&bundle->ports, &port->bundle_node);
2495 if (port->up.pp.config & OFPUTIL_PC_NO_FLOOD
2496 || !stp_forward_in_state(port->stp_state)) {
2497 bundle->floodable = false;
2501 bundle->ofproto->backer->need_revalidate = REV_RECONFIGURE;
2502 lacp_slave_register(bundle->lacp, port, lacp);
2509 bundle_destroy(struct ofbundle *bundle)
2511 struct ofproto_dpif *ofproto;
2512 struct ofport_dpif *port, *next_port;
2519 ofproto = bundle->ofproto;
2520 for (i = 0; i < MAX_MIRRORS; i++) {
2521 struct ofmirror *m = ofproto->mirrors[i];
2523 if (m->out == bundle) {
2525 } else if (hmapx_find_and_delete(&m->srcs, bundle)
2526 || hmapx_find_and_delete(&m->dsts, bundle)) {
2527 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2532 LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2533 bundle_del_port(port);
2536 bundle_flush_macs(bundle, true);
2537 hmap_remove(&ofproto->bundles, &bundle->hmap_node);
2539 free(bundle->trunks);
2540 lacp_destroy(bundle->lacp);
2541 bond_destroy(bundle->bond);
2546 bundle_set(struct ofproto *ofproto_, void *aux,
2547 const struct ofproto_bundle_settings *s)
2549 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2550 bool need_flush = false;
2551 struct ofport_dpif *port;
2552 struct ofbundle *bundle;
2553 unsigned long *trunks;
2559 bundle_destroy(bundle_lookup(ofproto, aux));
2563 ovs_assert(s->n_slaves == 1 || s->bond != NULL);
2564 ovs_assert((s->lacp != NULL) == (s->lacp_slaves != NULL));
2566 bundle = bundle_lookup(ofproto, aux);
2568 bundle = xmalloc(sizeof *bundle);
2570 bundle->ofproto = ofproto;
2571 hmap_insert(&ofproto->bundles, &bundle->hmap_node,
2572 hash_pointer(aux, 0));
2574 bundle->name = NULL;
2576 list_init(&bundle->ports);
2577 bundle->vlan_mode = PORT_VLAN_TRUNK;
2579 bundle->trunks = NULL;
2580 bundle->use_priority_tags = s->use_priority_tags;
2581 bundle->lacp = NULL;
2582 bundle->bond = NULL;
2584 bundle->floodable = true;
2586 bundle->src_mirrors = 0;
2587 bundle->dst_mirrors = 0;
2588 bundle->mirror_out = 0;
2591 if (!bundle->name || strcmp(s->name, bundle->name)) {
2593 bundle->name = xstrdup(s->name);
2598 if (!bundle->lacp) {
2599 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2600 bundle->lacp = lacp_create();
2602 lacp_configure(bundle->lacp, s->lacp);
2604 lacp_destroy(bundle->lacp);
2605 bundle->lacp = NULL;
2608 /* Update set of ports. */
2610 for (i = 0; i < s->n_slaves; i++) {
2611 if (!bundle_add_port(bundle, s->slaves[i],
2612 s->lacp ? &s->lacp_slaves[i] : NULL)) {
2616 if (!ok || list_size(&bundle->ports) != s->n_slaves) {
2617 struct ofport_dpif *next_port;
2619 LIST_FOR_EACH_SAFE (port, next_port, bundle_node, &bundle->ports) {
2620 for (i = 0; i < s->n_slaves; i++) {
2621 if (s->slaves[i] == port->up.ofp_port) {
2626 bundle_del_port(port);
2630 ovs_assert(list_size(&bundle->ports) <= s->n_slaves);
2632 if (list_is_empty(&bundle->ports)) {
2633 bundle_destroy(bundle);
2637 /* Set VLAN tagging mode */
2638 if (s->vlan_mode != bundle->vlan_mode
2639 || s->use_priority_tags != bundle->use_priority_tags) {
2640 bundle->vlan_mode = s->vlan_mode;
2641 bundle->use_priority_tags = s->use_priority_tags;
2646 vlan = (s->vlan_mode == PORT_VLAN_TRUNK ? -1
2647 : s->vlan >= 0 && s->vlan <= 4095 ? s->vlan
2649 if (vlan != bundle->vlan) {
2650 bundle->vlan = vlan;
2654 /* Get trunked VLANs. */
2655 switch (s->vlan_mode) {
2656 case PORT_VLAN_ACCESS:
2660 case PORT_VLAN_TRUNK:
2661 trunks = CONST_CAST(unsigned long *, s->trunks);
2664 case PORT_VLAN_NATIVE_UNTAGGED:
2665 case PORT_VLAN_NATIVE_TAGGED:
2666 if (vlan != 0 && (!s->trunks
2667 || !bitmap_is_set(s->trunks, vlan)
2668 || bitmap_is_set(s->trunks, 0))) {
2669 /* Force trunking the native VLAN and prohibit trunking VLAN 0. */
2671 trunks = bitmap_clone(s->trunks, 4096);
2673 trunks = bitmap_allocate1(4096);
2675 bitmap_set1(trunks, vlan);
2676 bitmap_set0(trunks, 0);
2678 trunks = CONST_CAST(unsigned long *, s->trunks);
2685 if (!vlan_bitmap_equal(trunks, bundle->trunks)) {
2686 free(bundle->trunks);
2687 if (trunks == s->trunks) {
2688 bundle->trunks = vlan_bitmap_clone(trunks);
2690 bundle->trunks = trunks;
2695 if (trunks != s->trunks) {
2700 if (!list_is_short(&bundle->ports)) {
2701 bundle->ofproto->has_bonded_bundles = true;
2703 if (bond_reconfigure(bundle->bond, s->bond)) {
2704 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2707 bundle->bond = bond_create(s->bond);
2708 ofproto->backer->need_revalidate = REV_RECONFIGURE;
2711 LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2712 bond_slave_register(bundle->bond, port, port->up.netdev);
2715 bond_destroy(bundle->bond);
2716 bundle->bond = NULL;
2719 /* If we changed something that would affect MAC learning, un-learn
2720 * everything on this port and force flow revalidation. */
2722 bundle_flush_macs(bundle, false);
2729 bundle_remove(struct ofport *port_)
2731 struct ofport_dpif *port = ofport_dpif_cast(port_);
2732 struct ofbundle *bundle = port->bundle;
2735 bundle_del_port(port);
2736 if (list_is_empty(&bundle->ports)) {
2737 bundle_destroy(bundle);
2738 } else if (list_is_short(&bundle->ports)) {
2739 bond_destroy(bundle->bond);
2740 bundle->bond = NULL;
2746 send_pdu_cb(void *port_, const void *pdu, size_t pdu_size)
2748 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
2749 struct ofport_dpif *port = port_;
2750 uint8_t ea[ETH_ADDR_LEN];
2753 error = netdev_get_etheraddr(port->up.netdev, ea);
2755 struct ofpbuf packet;
2758 ofpbuf_init(&packet, 0);
2759 packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
2761 memcpy(packet_pdu, pdu, pdu_size);
2763 send_packet(port, &packet);
2764 ofpbuf_uninit(&packet);
2766 VLOG_ERR_RL(&rl, "port %s: cannot obtain Ethernet address of iface "
2767 "%s (%s)", port->bundle->name,
2768 netdev_get_name(port->up.netdev), strerror(error));
2773 bundle_send_learning_packets(struct ofbundle *bundle)
2775 struct ofproto_dpif *ofproto = bundle->ofproto;
2776 int error, n_packets, n_errors;
2777 struct mac_entry *e;
2779 error = n_packets = n_errors = 0;
2780 LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
2781 if (e->port.p != bundle) {
2782 struct ofpbuf *learning_packet;
2783 struct ofport_dpif *port;
2787 /* The assignment to "port" is unnecessary but makes "grep"ing for
2788 * struct ofport_dpif more effective. */
2789 learning_packet = bond_compose_learning_packet(bundle->bond,
2793 ret = send_packet(port, learning_packet);
2794 ofpbuf_delete(learning_packet);
2804 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2805 VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2806 "packets, last error was: %s",
2807 bundle->name, n_errors, n_packets, strerror(error));
2809 VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2810 bundle->name, n_packets);
2815 bundle_run(struct ofbundle *bundle)
2818 lacp_run(bundle->lacp, send_pdu_cb);
2821 struct ofport_dpif *port;
2823 LIST_FOR_EACH (port, bundle_node, &bundle->ports) {
2824 bond_slave_set_may_enable(bundle->bond, port, port->may_enable);
2827 bond_run(bundle->bond, &bundle->ofproto->backer->revalidate_set,
2828 lacp_status(bundle->lacp));
2829 if (bond_should_send_learning_packets(bundle->bond)) {
2830 bundle_send_learning_packets(bundle);
2836 bundle_wait(struct ofbundle *bundle)
2839 lacp_wait(bundle->lacp);
2842 bond_wait(bundle->bond);
2849 mirror_scan(struct ofproto_dpif *ofproto)
2853 for (idx = 0; idx < MAX_MIRRORS; idx++) {
2854 if (!ofproto->mirrors[idx]) {
2861 static struct ofmirror *
2862 mirror_lookup(struct ofproto_dpif *ofproto, void *aux)
2866 for (i = 0; i < MAX_MIRRORS; i++) {
2867 struct ofmirror *mirror = ofproto->mirrors[i];
2868 if (mirror && mirror->aux == aux) {
2876 /* Update the 'dup_mirrors' member of each of the ofmirrors in 'ofproto'. */
2878 mirror_update_dups(struct ofproto_dpif *ofproto)
2882 for (i = 0; i < MAX_MIRRORS; i++) {
2883 struct ofmirror *m = ofproto->mirrors[i];
2886 m->dup_mirrors = MIRROR_MASK_C(1) << i;
2890 for (i = 0; i < MAX_MIRRORS; i++) {
2891 struct ofmirror *m1 = ofproto->mirrors[i];
2898 for (j = i + 1; j < MAX_MIRRORS; j++) {
2899 struct ofmirror *m2 = ofproto->mirrors[j];
2901 if (m2 && m1->out == m2->out && m1->out_vlan == m2->out_vlan) {
2902 m1->dup_mirrors |= MIRROR_MASK_C(1) << j;
2903 m2->dup_mirrors |= m1->dup_mirrors;
2910 mirror_set(struct ofproto *ofproto_, void *aux,
2911 const struct ofproto_mirror_settings *s)
2913 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
2914 mirror_mask_t mirror_bit;
2915 struct ofbundle *bundle;
2916 struct ofmirror *mirror;
2917 struct ofbundle *out;
2918 struct hmapx srcs; /* Contains "struct ofbundle *"s. */
2919 struct hmapx dsts; /* Contains "struct ofbundle *"s. */
2922 mirror = mirror_lookup(ofproto, aux);
2924 mirror_destroy(mirror);
2930 idx = mirror_scan(ofproto);
2932 VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
2934 ofproto->up.name, MAX_MIRRORS, s->name);
2938 mirror = ofproto->mirrors[idx] = xzalloc(sizeof *mirror);
2939 mirror->ofproto = ofproto;
2942 mirror->out_vlan = -1;
2943 mirror->name = NULL;
2946 if (!mirror->name || strcmp(s->name, mirror->name)) {
2948 mirror->name = xstrdup(s->name);
2951 /* Get the new configuration. */
2952 if (s->out_bundle) {
2953 out = bundle_lookup(ofproto, s->out_bundle);
2955 mirror_destroy(mirror);
2961 out_vlan = s->out_vlan;
2963 bundle_lookup_multiple(ofproto, s->srcs, s->n_srcs, &srcs);
2964 bundle_lookup_multiple(ofproto, s->dsts, s->n_dsts, &dsts);
2966 /* If the configuration has not changed, do nothing. */
2967 if (hmapx_equals(&srcs, &mirror->srcs)
2968 && hmapx_equals(&dsts, &mirror->dsts)
2969 && vlan_bitmap_equal(mirror->vlans, s->src_vlans)
2970 && mirror->out == out
2971 && mirror->out_vlan == out_vlan)
2973 hmapx_destroy(&srcs);
2974 hmapx_destroy(&dsts);
2978 hmapx_swap(&srcs, &mirror->srcs);
2979 hmapx_destroy(&srcs);
2981 hmapx_swap(&dsts, &mirror->dsts);
2982 hmapx_destroy(&dsts);
2984 free(mirror->vlans);
2985 mirror->vlans = vlan_bitmap_clone(s->src_vlans);
2988 mirror->out_vlan = out_vlan;
2990 /* Update bundles. */
2991 mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
2992 HMAP_FOR_EACH (bundle, hmap_node, &mirror->ofproto->bundles) {
2993 if (hmapx_contains(&mirror->srcs, bundle)) {
2994 bundle->src_mirrors |= mirror_bit;
2996 bundle->src_mirrors &= ~mirror_bit;
2999 if (hmapx_contains(&mirror->dsts, bundle)) {
3000 bundle->dst_mirrors |= mirror_bit;
3002 bundle->dst_mirrors &= ~mirror_bit;
3005 if (mirror->out == bundle) {
3006 bundle->mirror_out |= mirror_bit;
3008 bundle->mirror_out &= ~mirror_bit;
3012 ofproto->backer->need_revalidate = REV_RECONFIGURE;
3013 ofproto->has_mirrors = true;
3014 mac_learning_flush(ofproto->ml,
3015 &ofproto->backer->revalidate_set);
3016 mirror_update_dups(ofproto);
3022 mirror_destroy(struct ofmirror *mirror)
3024 struct ofproto_dpif *ofproto;
3025 mirror_mask_t mirror_bit;
3026 struct ofbundle *bundle;
3033 ofproto = mirror->ofproto;
3034 ofproto->backer->need_revalidate = REV_RECONFIGURE;
3035 mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
3037 mirror_bit = MIRROR_MASK_C(1) << mirror->idx;
3038 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
3039 bundle->src_mirrors &= ~mirror_bit;
3040 bundle->dst_mirrors &= ~mirror_bit;
3041 bundle->mirror_out &= ~mirror_bit;
3044 hmapx_destroy(&mirror->srcs);
3045 hmapx_destroy(&mirror->dsts);
3046 free(mirror->vlans);
3048 ofproto->mirrors[mirror->idx] = NULL;
3052 mirror_update_dups(ofproto);
3054 ofproto->has_mirrors = false;
3055 for (i = 0; i < MAX_MIRRORS; i++) {
3056 if (ofproto->mirrors[i]) {
3057 ofproto->has_mirrors = true;
3064 mirror_get_stats(struct ofproto *ofproto_, void *aux,
3065 uint64_t *packets, uint64_t *bytes)
3067 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3068 struct ofmirror *mirror = mirror_lookup(ofproto, aux);
3071 *packets = *bytes = UINT64_MAX;
3077 *packets = mirror->packet_count;
3078 *bytes = mirror->byte_count;
3084 set_flood_vlans(struct ofproto *ofproto_, unsigned long *flood_vlans)
3086 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3087 if (mac_learning_set_flood_vlans(ofproto->ml, flood_vlans)) {
3088 mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
3094 is_mirror_output_bundle(const struct ofproto *ofproto_, void *aux)
3096 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3097 struct ofbundle *bundle = bundle_lookup(ofproto, aux);
3098 return bundle && bundle->mirror_out != 0;
3102 forward_bpdu_changed(struct ofproto *ofproto_)
3104 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3105 ofproto->backer->need_revalidate = REV_RECONFIGURE;
3109 set_mac_table_config(struct ofproto *ofproto_, unsigned int idle_time,
3112 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3113 mac_learning_set_idle_time(ofproto->ml, idle_time);
3114 mac_learning_set_max_entries(ofproto->ml, max_entries);
3119 static struct ofport_dpif *
3120 get_ofp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
3122 struct ofport *ofport = ofproto_get_port(&ofproto->up, ofp_port);
3123 return ofport ? ofport_dpif_cast(ofport) : NULL;
3126 static struct ofport_dpif *
3127 get_odp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
3129 struct ofport_dpif *port = odp_port_to_ofport(ofproto->backer, odp_port);
3130 return port && &ofproto->up == port->up.ofproto ? port : NULL;
3134 ofproto_port_from_dpif_port(struct ofproto_dpif *ofproto,
3135 struct ofproto_port *ofproto_port,
3136 struct dpif_port *dpif_port)
3138 ofproto_port->name = dpif_port->name;
3139 ofproto_port->type = dpif_port->type;
3140 ofproto_port->ofp_port = odp_port_to_ofp_port(ofproto, dpif_port->port_no);
3143 static struct ofport_dpif *
3144 ofport_get_peer(const struct ofport_dpif *ofport_dpif)
3146 const struct ofproto_dpif *ofproto;
3149 peer = netdev_vport_patch_peer(ofport_dpif->up.netdev);
3154 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
3155 struct ofport *ofport;
3157 ofport = shash_find_data(&ofproto->up.port_by_name, peer);
3158 if (ofport && ofport->ofproto->ofproto_class == &ofproto_dpif_class) {
3159 return ofport_dpif_cast(ofport);
3166 port_run_fast(struct ofport_dpif *ofport)
3168 if (ofport->cfm && cfm_should_send_ccm(ofport->cfm)) {
3169 struct ofpbuf packet;
3171 ofpbuf_init(&packet, 0);
3172 cfm_compose_ccm(ofport->cfm, &packet, ofport->up.pp.hw_addr);
3173 send_packet(ofport, &packet);
3174 ofpbuf_uninit(&packet);
3177 if (ofport->bfd && bfd_should_send_packet(ofport->bfd)) {
3178 struct ofpbuf packet;
3180 ofpbuf_init(&packet, 0);
3181 bfd_put_packet(ofport->bfd, &packet, ofport->up.pp.hw_addr);
3182 send_packet(ofport, &packet);
3183 ofpbuf_uninit(&packet);
3188 port_run(struct ofport_dpif *ofport)
3190 long long int carrier_seq = netdev_get_carrier_resets(ofport->up.netdev);
3191 bool carrier_changed = carrier_seq != ofport->carrier_seq;
3192 bool enable = netdev_get_carrier(ofport->up.netdev);
3194 ofport->carrier_seq = carrier_seq;
3196 port_run_fast(ofport);
3198 if (ofport->tnl_port
3199 && tnl_port_reconfigure(&ofport->up, ofport->odp_port,
3200 &ofport->tnl_port)) {
3201 ofproto_dpif_cast(ofport->up.ofproto)->backer->need_revalidate = true;
3205 int cfm_opup = cfm_get_opup(ofport->cfm);
3207 cfm_run(ofport->cfm);
3208 enable = enable && !cfm_get_fault(ofport->cfm);
3210 if (cfm_opup >= 0) {
3211 enable = enable && cfm_opup;
3216 bfd_run(ofport->bfd);
3217 enable = enable && bfd_forwarding(ofport->bfd);
3220 if (ofport->bundle) {
3221 enable = enable && lacp_slave_may_enable(ofport->bundle->lacp, ofport);
3222 if (carrier_changed) {
3223 lacp_slave_carrier_changed(ofport->bundle->lacp, ofport);
3227 if (ofport->may_enable != enable) {
3228 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3230 if (ofproto->has_bundle_action) {
3231 ofproto->backer->need_revalidate = REV_PORT_TOGGLED;
3235 ofport->may_enable = enable;
3239 port_wait(struct ofport_dpif *ofport)
3242 cfm_wait(ofport->cfm);
3246 bfd_wait(ofport->bfd);
3251 port_query_by_name(const struct ofproto *ofproto_, const char *devname,
3252 struct ofproto_port *ofproto_port)
3254 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3255 struct dpif_port dpif_port;
3258 if (sset_contains(&ofproto->ghost_ports, devname)) {
3259 const char *type = netdev_get_type_from_name(devname);
3261 /* We may be called before ofproto->up.port_by_name is populated with
3262 * the appropriate ofport. For this reason, we must get the name and
3263 * type from the netdev layer directly. */
3265 const struct ofport *ofport;
3267 ofport = shash_find_data(&ofproto->up.port_by_name, devname);
3268 ofproto_port->ofp_port = ofport ? ofport->ofp_port : OFPP_NONE;
3269 ofproto_port->name = xstrdup(devname);
3270 ofproto_port->type = xstrdup(type);
3276 if (!sset_contains(&ofproto->ports, devname)) {
3279 error = dpif_port_query_by_name(ofproto->backer->dpif,
3280 devname, &dpif_port);
3282 ofproto_port_from_dpif_port(ofproto, ofproto_port, &dpif_port);
3288 port_add(struct ofproto *ofproto_, struct netdev *netdev)
3290 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3291 const char *dp_port_name = netdev_vport_get_dpif_port(netdev);
3292 const char *devname = netdev_get_name(netdev);
3294 if (netdev_vport_is_patch(netdev)) {
3295 sset_add(&ofproto->ghost_ports, netdev_get_name(netdev));
3299 if (!dpif_port_exists(ofproto->backer->dpif, dp_port_name)) {
3300 uint32_t port_no = UINT32_MAX;
3303 error = dpif_port_add(ofproto->backer->dpif, netdev, &port_no);
3307 if (netdev_get_tunnel_config(netdev)) {
3308 simap_put(&ofproto->backer->tnl_backers, dp_port_name, port_no);
3312 if (netdev_get_tunnel_config(netdev)) {
3313 sset_add(&ofproto->ghost_ports, devname);
3315 sset_add(&ofproto->ports, devname);
3321 port_del(struct ofproto *ofproto_, uint16_t ofp_port)
3323 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3324 struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
3331 sset_find_and_delete(&ofproto->ghost_ports,
3332 netdev_get_name(ofport->up.netdev));
3333 ofproto->backer->need_revalidate = REV_RECONFIGURE;
3334 if (!ofport->tnl_port) {
3335 error = dpif_port_del(ofproto->backer->dpif, ofport->odp_port);
3337 /* The caller is going to close ofport->up.netdev. If this is a
3338 * bonded port, then the bond is using that netdev, so remove it
3339 * from the bond. The client will need to reconfigure everything
3340 * after deleting ports, so then the slave will get re-added. */
3341 bundle_remove(&ofport->up);
3348 port_get_stats(const struct ofport *ofport_, struct netdev_stats *stats)
3350 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3355 error = netdev_get_stats(ofport->up.netdev, stats);
3357 if (!error && ofport_->ofp_port == OFPP_LOCAL) {
3358 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
3360 /* ofproto->stats.tx_packets represents packets that we created
3361 * internally and sent to some port (e.g. packets sent with
3362 * send_packet()). Account for them as if they had come from
3363 * OFPP_LOCAL and got forwarded. */
3365 if (stats->rx_packets != UINT64_MAX) {
3366 stats->rx_packets += ofproto->stats.tx_packets;
3369 if (stats->rx_bytes != UINT64_MAX) {
3370 stats->rx_bytes += ofproto->stats.tx_bytes;
3373 /* ofproto->stats.rx_packets represents packets that were received on
3374 * some port and we processed internally and dropped (e.g. STP).
3375 * Account for them as if they had been forwarded to OFPP_LOCAL. */
3377 if (stats->tx_packets != UINT64_MAX) {
3378 stats->tx_packets += ofproto->stats.rx_packets;
3381 if (stats->tx_bytes != UINT64_MAX) {
3382 stats->tx_bytes += ofproto->stats.rx_bytes;
3389 struct port_dump_state {
3394 struct ofproto_port port;
3399 port_dump_start(const struct ofproto *ofproto_ OVS_UNUSED, void **statep)
3401 *statep = xzalloc(sizeof(struct port_dump_state));
3406 port_dump_next(const struct ofproto *ofproto_, void *state_,
3407 struct ofproto_port *port)
3409 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3410 struct port_dump_state *state = state_;
3411 const struct sset *sset;
3412 struct sset_node *node;
3414 if (state->has_port) {
3415 ofproto_port_destroy(&state->port);
3416 state->has_port = false;
3418 sset = state->ghost ? &ofproto->ghost_ports : &ofproto->ports;
3419 while ((node = sset_at_position(sset, &state->bucket, &state->offset))) {
3422 error = port_query_by_name(ofproto_, node->name, &state->port);
3424 *port = state->port;
3425 state->has_port = true;
3427 } else if (error != ENODEV) {
3432 if (!state->ghost) {
3433 state->ghost = true;
3436 return port_dump_next(ofproto_, state_, port);
3443 port_dump_done(const struct ofproto *ofproto_ OVS_UNUSED, void *state_)
3445 struct port_dump_state *state = state_;
3447 if (state->has_port) {
3448 ofproto_port_destroy(&state->port);
3455 port_poll(const struct ofproto *ofproto_, char **devnamep)
3457 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3459 if (ofproto->port_poll_errno) {
3460 int error = ofproto->port_poll_errno;
3461 ofproto->port_poll_errno = 0;
3465 if (sset_is_empty(&ofproto->port_poll_set)) {
3469 *devnamep = sset_pop(&ofproto->port_poll_set);
3474 port_poll_wait(const struct ofproto *ofproto_)
3476 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
3477 dpif_port_poll_wait(ofproto->backer->dpif);
3481 port_is_lacp_current(const struct ofport *ofport_)
3483 const struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
3484 return (ofport->bundle && ofport->bundle->lacp
3485 ? lacp_slave_is_current(ofport->bundle->lacp, ofport)
3489 /* Upcall handling. */
3491 /* Flow miss batching.
3493 * Some dpifs implement operations faster when you hand them off in a batch.
3494 * To allow batching, "struct flow_miss" queues the dpif-related work needed
3495 * for a given flow. Each "struct flow_miss" corresponds to sending one or
3496 * more packets, plus possibly installing the flow in the dpif.
3498 * So far we only batch the operations that affect flow setup time the most.
3499 * It's possible to batch more than that, but the benefit might be minimal. */
3501 struct hmap_node hmap_node;
3502 struct ofproto_dpif *ofproto;
3504 enum odp_key_fitness key_fitness;
3505 const struct nlattr *key;
3507 struct initial_vals initial_vals;
3508 struct list packets;
3509 enum dpif_upcall_type upcall_type;
3510 uint32_t odp_in_port;
3513 struct flow_miss_op {
3514 struct dpif_op dpif_op;
3515 void *garbage; /* Pointer to pass to free(), NULL if none. */
3516 uint64_t stub[1024 / 8]; /* Temporary buffer. */
3519 /* Sends an OFPT_PACKET_IN message for 'packet' of type OFPR_NO_MATCH to each
3520 * OpenFlow controller as necessary according to their individual
3521 * configurations. */
3523 send_packet_in_miss(struct ofproto_dpif *ofproto, const struct ofpbuf *packet,
3524 const struct flow *flow)
3526 struct ofputil_packet_in pin;
3528 pin.packet = packet->data;
3529 pin.packet_len = packet->size;
3530 pin.reason = OFPR_NO_MATCH;
3531 pin.controller_id = 0;
3536 pin.send_len = 0; /* not used for flow table misses */
3538 flow_get_metadata(flow, &pin.fmd);
3540 connmgr_send_packet_in(ofproto->up.connmgr, &pin);
3543 static enum slow_path_reason
3544 process_special(struct ofproto_dpif *ofproto, const struct flow *flow,
3545 const struct ofport_dpif *ofport, const struct ofpbuf *packet)
3549 } else if (ofport->cfm && cfm_should_process_flow(ofport->cfm, flow)) {
3551 cfm_process_heartbeat(ofport->cfm, packet);
3554 } else if (ofport->bfd && bfd_should_process_flow(flow)) {
3556 bfd_process_packet(ofport->bfd, flow, packet);
3559 } else if (ofport->bundle && ofport->bundle->lacp
3560 && flow->dl_type == htons(ETH_TYPE_LACP)) {
3562 lacp_process_packet(ofport->bundle->lacp, ofport, packet);
3565 } else if (ofproto->stp && stp_should_process_flow(flow)) {
3567 stp_process_packet(ofport, packet);
3575 static struct flow_miss *
3576 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
3577 const struct flow *flow, uint32_t hash)
3579 struct flow_miss *miss;
3581 HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
3582 if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
3590 /* Partially Initializes 'op' as an "execute" operation for 'miss' and
3591 * 'packet'. The caller must initialize op->actions and op->actions_len. If
3592 * 'miss' is associated with a subfacet the caller must also initialize the
3593 * returned op->subfacet, and if anything needs to be freed after processing
3594 * the op, the caller must initialize op->garbage also. */
3596 init_flow_miss_execute_op(struct flow_miss *miss, struct ofpbuf *packet,
3597 struct flow_miss_op *op)
3599 if (miss->flow.vlan_tci != miss->initial_vals.vlan_tci) {
3600 /* This packet was received on a VLAN splinter port. We
3601 * added a VLAN to the packet to make the packet resemble
3602 * the flow, but the actions were composed assuming that
3603 * the packet contained no VLAN. So, we must remove the
3604 * VLAN header from the packet before trying to execute the
3606 eth_pop_vlan(packet);
3610 op->dpif_op.type = DPIF_OP_EXECUTE;
3611 op->dpif_op.u.execute.key = miss->key;
3612 op->dpif_op.u.execute.key_len = miss->key_len;
3613 op->dpif_op.u.execute.packet = packet;
3616 /* Helper for handle_flow_miss_without_facet() and
3617 * handle_flow_miss_with_facet(). */
3619 handle_flow_miss_common(struct rule_dpif *rule,
3620 struct ofpbuf *packet, const struct flow *flow)
3622 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3624 ofproto->n_matches++;
3626 if (rule->up.cr.priority == FAIL_OPEN_PRIORITY) {
3628 * Extra-special case for fail-open mode.
3630 * We are in fail-open mode and the packet matched the fail-open
3631 * rule, but we are connected to a controller too. We should send
3632 * the packet up to the controller in the hope that it will try to
3633 * set up a flow and thereby allow us to exit fail-open.
3635 * See the top-level comment in fail-open.c for more information.
3637 send_packet_in_miss(ofproto, packet, flow);
3641 /* Figures out whether a flow that missed in 'ofproto', whose details are in
3642 * 'miss', is likely to be worth tracking in detail in userspace and (usually)
3643 * installing a datapath flow. The answer is usually "yes" (a return value of
3644 * true). However, for short flows the cost of bookkeeping is much higher than
3645 * the benefits, so when the datapath holds a large number of flows we impose
3646 * some heuristics to decide which flows are likely to be worth tracking. */
3648 flow_miss_should_make_facet(struct ofproto_dpif *ofproto,
3649 struct flow_miss *miss, uint32_t hash)
3651 if (!ofproto->governor) {
3654 n_subfacets = hmap_count(&ofproto->subfacets);
3655 if (n_subfacets * 2 <= ofproto->up.flow_eviction_threshold) {
3659 ofproto->governor = governor_create(ofproto->up.name);
3662 return governor_should_install_flow(ofproto->governor, hash,
3663 list_size(&miss->packets));
3666 /* Handles 'miss', which matches 'rule', without creating a facet or subfacet
3667 * or creating any datapath flow. May add an "execute" operation to 'ops' and
3668 * increment '*n_ops'. */
3670 handle_flow_miss_without_facet(struct flow_miss *miss,
3671 struct rule_dpif *rule,
3672 struct flow_miss_op *ops, size_t *n_ops)
3674 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
3675 long long int now = time_msec();
3676 struct action_xlate_ctx ctx;
3677 struct ofpbuf *packet;
3679 LIST_FOR_EACH (packet, list_node, &miss->packets) {
3680 struct flow_miss_op *op = &ops[*n_ops];
3681 struct dpif_flow_stats stats;
3682 struct ofpbuf odp_actions;
3684 COVERAGE_INC(facet_suppress);
3686 handle_flow_miss_common(rule, packet, &miss->flow);
3688 ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
3690 dpif_flow_stats_extract(&miss->flow, packet, now, &stats);
3691 rule_credit_stats(rule, &stats);
3693 action_xlate_ctx_init(&ctx, ofproto, &miss->flow, &miss->initial_vals,
3694 rule, stats.tcp_flags, packet);
3695 ctx.resubmit_stats = &stats;
3696 xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
3699 if (odp_actions.size) {
3700 struct dpif_execute *execute = &op->dpif_op.u.execute;
3702 init_flow_miss_execute_op(miss, packet, op);
3703 execute->actions = odp_actions.data;
3704 execute->actions_len = odp_actions.size;
3705 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
3709 ofpbuf_uninit(&odp_actions);
3714 /* Handles 'miss', which matches 'facet'. May add any required datapath
3715 * operations to 'ops', incrementing '*n_ops' for each new op.
3717 * All of the packets in 'miss' are considered to have arrived at time 'now'.
3718 * This is really important only for new facets: if we just called time_msec()
3719 * here, then the new subfacet or its packets could look (occasionally) as
3720 * though it was used some time after the facet was used. That can make a
3721 * one-packet flow look like it has a nonzero duration, which looks odd in
3722 * e.g. NetFlow statistics. */
3724 handle_flow_miss_with_facet(struct flow_miss *miss, struct facet *facet,
3726 struct flow_miss_op *ops, size_t *n_ops)
3728 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
3729 enum subfacet_path want_path;
3730 struct subfacet *subfacet;
3731 struct ofpbuf *packet;
3733 subfacet = subfacet_create(facet, miss, now);
3735 LIST_FOR_EACH (packet, list_node, &miss->packets) {
3736 struct flow_miss_op *op = &ops[*n_ops];
3737 struct dpif_flow_stats stats;
3738 struct ofpbuf odp_actions;
3740 handle_flow_miss_common(facet->rule, packet, &miss->flow);
3742 ofpbuf_use_stub(&odp_actions, op->stub, sizeof op->stub);
3743 if (!subfacet->actions || subfacet->slow) {
3744 subfacet_make_actions(subfacet, packet, &odp_actions);
3747 dpif_flow_stats_extract(&facet->flow, packet, now, &stats);
3748 subfacet_update_stats(subfacet, &stats);
3750 if (subfacet->actions_len) {
3751 struct dpif_execute *execute = &op->dpif_op.u.execute;
3753 init_flow_miss_execute_op(miss, packet, op);
3754 if (!subfacet->slow) {
3755 execute->actions = subfacet->actions;
3756 execute->actions_len = subfacet->actions_len;
3757 ofpbuf_uninit(&odp_actions);
3759 execute->actions = odp_actions.data;
3760 execute->actions_len = odp_actions.size;
3761 op->garbage = ofpbuf_get_uninit_pointer(&odp_actions);
3766 ofpbuf_uninit(&odp_actions);
3770 want_path = subfacet_want_path(subfacet->slow);
3771 if (miss->upcall_type == DPIF_UC_MISS || subfacet->path != want_path) {
3772 struct flow_miss_op *op = &ops[(*n_ops)++];
3773 struct dpif_flow_put *put = &op->dpif_op.u.flow_put;
3775 subfacet->path = want_path;
3778 op->dpif_op.type = DPIF_OP_FLOW_PUT;
3779 put->flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
3780 put->key = miss->key;
3781 put->key_len = miss->key_len;
3782 if (want_path == SF_FAST_PATH) {
3783 put->actions = subfacet->actions;
3784 put->actions_len = subfacet->actions_len;
3786 compose_slow_path(ofproto, &facet->flow, subfacet->slow,
3787 op->stub, sizeof op->stub,
3788 &put->actions, &put->actions_len);
3794 /* Handles flow miss 'miss'. May add any required datapath operations
3795 * to 'ops', incrementing '*n_ops' for each new op. */
3797 handle_flow_miss(struct flow_miss *miss, struct flow_miss_op *ops,
3800 struct ofproto_dpif *ofproto = miss->ofproto;
3801 struct facet *facet;
3805 /* The caller must ensure that miss->hmap_node.hash contains
3806 * flow_hash(miss->flow, 0). */
3807 hash = miss->hmap_node.hash;
3809 facet = facet_lookup_valid(ofproto, &miss->flow, hash);
3811 struct rule_dpif *rule = rule_dpif_lookup(ofproto, &miss->flow);
3813 /* There does not exist a bijection between 'struct flow' and datapath
3814 * flow keys with fitness ODP_FIT_TO_LITTLE. This breaks a fundamental
3815 * assumption used throughout the facet and subfacet handling code.
3816 * Since we have to handle these misses in userspace anyway, we simply
3817 * skip facet creation, avoiding the problem alltogether. */
3818 if (miss->key_fitness == ODP_FIT_TOO_LITTLE
3819 || !flow_miss_should_make_facet(ofproto, miss, hash)) {
3820 handle_flow_miss_without_facet(miss, rule, ops, n_ops);
3824 facet = facet_create(rule, &miss->flow, hash);
3829 handle_flow_miss_with_facet(miss, facet, now, ops, n_ops);
3832 static struct drop_key *
3833 drop_key_lookup(const struct dpif_backer *backer, const struct nlattr *key,
3836 struct drop_key *drop_key;
3838 HMAP_FOR_EACH_WITH_HASH (drop_key, hmap_node, hash_bytes(key, key_len, 0),
3839 &backer->drop_keys) {
3840 if (drop_key->key_len == key_len
3841 && !memcmp(drop_key->key, key, key_len)) {
3849 drop_key_clear(struct dpif_backer *backer)
3851 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
3852 struct drop_key *drop_key, *next;
3854 HMAP_FOR_EACH_SAFE (drop_key, next, hmap_node, &backer->drop_keys) {
3857 error = dpif_flow_del(backer->dpif, drop_key->key, drop_key->key_len,
3859 if (error && !VLOG_DROP_WARN(&rl)) {
3860 struct ds ds = DS_EMPTY_INITIALIZER;
3861 odp_flow_key_format(drop_key->key, drop_key->key_len, &ds);
3862 VLOG_WARN("Failed to delete drop key (%s) (%s)", strerror(error),
3867 hmap_remove(&backer->drop_keys, &drop_key->hmap_node);
3868 free(drop_key->key);
3873 /* Given a datpath, packet, and flow metadata ('backer', 'packet', and 'key'
3874 * respectively), populates 'flow' with the result of odp_flow_key_to_flow().
3875 * Optionally, if nonnull, populates 'fitnessp' with the fitness of 'flow' as
3876 * returned by odp_flow_key_to_flow(). Also, optionally populates 'ofproto'
3877 * with the ofproto_dpif, and 'odp_in_port' with the datapath in_port, that
3878 * 'packet' ingressed.
3880 * If 'ofproto' is nonnull, requires 'flow''s in_port to exist. Otherwise sets
3881 * 'flow''s in_port to OFPP_NONE.
3883 * This function does post-processing on data returned from
3884 * odp_flow_key_to_flow() to help make VLAN splinters transparent to the rest
3885 * of the upcall processing logic. In particular, if the extracted in_port is
3886 * a VLAN splinter port, it replaces flow->in_port by the "real" port, sets
3887 * flow->vlan_tci correctly for the VLAN of the VLAN splinter port, and pushes
3888 * a VLAN header onto 'packet' (if it is nonnull).
3890 * Optionally, if 'initial_vals' is nonnull, sets 'initial_vals->vlan_tci'
3891 * to the VLAN TCI with which the packet was really received, that is, the
3892 * actual VLAN TCI extracted by odp_flow_key_to_flow(). (This differs from
3893 * the value returned in flow->vlan_tci only for packets received on
3896 * Similarly, this function also includes some logic to help with tunnels. It
3897 * may modify 'flow' as necessary to make the tunneling implementation
3898 * transparent to the upcall processing logic.
3900 * Returns 0 if successful, ENODEV if the parsed flow has no associated ofport,
3901 * or some other positive errno if there are other problems. */
3903 ofproto_receive(const struct dpif_backer *backer, struct ofpbuf *packet,
3904 const struct nlattr *key, size_t key_len,
3905 struct flow *flow, enum odp_key_fitness *fitnessp,
3906 struct ofproto_dpif **ofproto, uint32_t *odp_in_port,
3907 struct initial_vals *initial_vals)
3909 const struct ofport_dpif *port;
3910 enum odp_key_fitness fitness;
3913 fitness = odp_flow_key_to_flow(key, key_len, flow);
3914 if (fitness == ODP_FIT_ERROR) {
3920 initial_vals->vlan_tci = flow->vlan_tci;
3924 *odp_in_port = flow->in_port;
3927 port = (tnl_port_should_receive(flow)
3928 ? ofport_dpif_cast(tnl_port_receive(flow))
3929 : odp_port_to_ofport(backer, flow->in_port));
3930 flow->in_port = port ? port->up.ofp_port : OFPP_NONE;
3935 /* XXX: Since the tunnel module is not scoped per backer, for a tunnel port
3936 * it's theoretically possible that we'll receive an ofport belonging to an
3937 * entirely different datapath. In practice, this can't happen because no
3938 * platforms has two separate datapaths which each support tunneling. */
3939 ovs_assert(ofproto_dpif_cast(port->up.ofproto)->backer == backer);
3941 if (vsp_adjust_flow(ofproto_dpif_cast(port->up.ofproto), flow)) {
3943 /* Make the packet resemble the flow, so that it gets sent to
3944 * an OpenFlow controller properly, so that it looks correct
3945 * for sFlow, and so that flow_extract() will get the correct
3946 * vlan_tci if it is called on 'packet'.
3948 * The allocated space inside 'packet' probably also contains
3949 * 'key', that is, both 'packet' and 'key' are probably part of
3950 * a struct dpif_upcall (see the large comment on that
3951 * structure definition), so pushing data on 'packet' is in
3952 * general not a good idea since it could overwrite 'key' or
3953 * free it as a side effect. However, it's OK in this special
3954 * case because we know that 'packet' is inside a Netlink
3955 * attribute: pushing 4 bytes will just overwrite the 4-byte
3956 * "struct nlattr", which is fine since we don't need that
3957 * header anymore. */
3958 eth_push_vlan(packet, flow->vlan_tci);
3960 /* We can't reproduce 'key' from 'flow'. */
3961 fitness = fitness == ODP_FIT_PERFECT ? ODP_FIT_TOO_MUCH : fitness;
3966 *ofproto = ofproto_dpif_cast(port->up.ofproto);
3971 *fitnessp = fitness;
3977 handle_miss_upcalls(struct dpif_backer *backer, struct dpif_upcall *upcalls,
3980 struct dpif_upcall *upcall;
3981 struct flow_miss *miss;
3982 struct flow_miss misses[FLOW_MISS_MAX_BATCH];
3983 struct flow_miss_op flow_miss_ops[FLOW_MISS_MAX_BATCH * 2];
3984 struct dpif_op *dpif_ops[FLOW_MISS_MAX_BATCH * 2];
3994 /* Construct the to-do list.
3996 * This just amounts to extracting the flow from each packet and sticking
3997 * the packets that have the same flow in the same "flow_miss" structure so
3998 * that we can process them together. */
4001 for (upcall = upcalls; upcall < &upcalls[n_upcalls]; upcall++) {
4002 struct flow_miss *miss = &misses[n_misses];
4003 struct flow_miss *existing_miss;
4004 struct ofproto_dpif *ofproto;
4005 uint32_t odp_in_port;
4010 error = ofproto_receive(backer, upcall->packet, upcall->key,
4011 upcall->key_len, &flow, &miss->key_fitness,
4012 &ofproto, &odp_in_port, &miss->initial_vals);
4013 if (error == ENODEV) {
4014 struct drop_key *drop_key;
4016 /* Received packet on port for which we couldn't associate
4017 * an ofproto. This can happen if a port is removed while
4018 * traffic is being received. Print a rate-limited message
4019 * in case it happens frequently. Install a drop flow so
4020 * that future packets of the flow are inexpensively dropped
4022 VLOG_INFO_RL(&rl, "received packet on unassociated port %"PRIu32,
4025 drop_key = drop_key_lookup(backer, upcall->key, upcall->key_len);
4027 drop_key = xmalloc(sizeof *drop_key);
4028 drop_key->key = xmemdup(upcall->key, upcall->key_len);
4029 drop_key->key_len = upcall->key_len;
4031 hmap_insert(&backer->drop_keys, &drop_key->hmap_node,
4032 hash_bytes(drop_key->key, drop_key->key_len, 0));
4033 dpif_flow_put(backer->dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY,
4034 drop_key->key, drop_key->key_len, NULL, 0, NULL);
4042 ofproto->n_missed++;
4043 flow_extract(upcall->packet, flow.skb_priority, flow.skb_mark,
4044 &flow.tunnel, flow.in_port, &miss->flow);
4046 /* Add other packets to a to-do list. */
4047 hash = flow_hash(&miss->flow, 0);
4048 existing_miss = flow_miss_find(&todo, ofproto, &miss->flow, hash);
4049 if (!existing_miss) {
4050 hmap_insert(&todo, &miss->hmap_node, hash);
4051 miss->ofproto = ofproto;
4052 miss->key = upcall->key;
4053 miss->key_len = upcall->key_len;
4054 miss->upcall_type = upcall->type;
4055 miss->odp_in_port = odp_in_port;
4056 list_init(&miss->packets);
4060 miss = existing_miss;
4062 list_push_back(&miss->packets, &upcall->packet->list_node);
4065 /* Process each element in the to-do list, constructing the set of
4066 * operations to batch. */
4068 HMAP_FOR_EACH (miss, hmap_node, &todo) {
4069 handle_flow_miss(miss, flow_miss_ops, &n_ops);
4071 ovs_assert(n_ops <= ARRAY_SIZE(flow_miss_ops));
4073 /* Execute batch. */
4074 for (i = 0; i < n_ops; i++) {
4075 dpif_ops[i] = &flow_miss_ops[i].dpif_op;
4077 dpif_operate(backer->dpif, dpif_ops, n_ops);
4080 for (i = 0; i < n_ops; i++) {
4081 free(flow_miss_ops[i].garbage);
4083 hmap_destroy(&todo);
4086 static enum { SFLOW_UPCALL, MISS_UPCALL, BAD_UPCALL, FLOW_SAMPLE_UPCALL,
4088 classify_upcall(const struct dpif_upcall *upcall)
4090 size_t userdata_len;
4091 union user_action_cookie cookie;
4093 /* First look at the upcall type. */
4094 switch (upcall->type) {
4095 case DPIF_UC_ACTION:
4101 case DPIF_N_UC_TYPES:
4103 VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, upcall->type);
4107 /* "action" upcalls need a closer look. */
4108 if (!upcall->userdata) {
4109 VLOG_WARN_RL(&rl, "action upcall missing cookie");
4112 userdata_len = nl_attr_get_size(upcall->userdata);
4113 if (userdata_len < sizeof cookie.type
4114 || userdata_len > sizeof cookie) {
4115 VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %zu",
4119 memset(&cookie, 0, sizeof cookie);
4120 memcpy(&cookie, nl_attr_get(upcall->userdata), userdata_len);
4121 if (userdata_len == sizeof cookie.sflow
4122 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
4123 return SFLOW_UPCALL;
4124 } else if (userdata_len == sizeof cookie.slow_path
4125 && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
4127 } else if (userdata_len == sizeof cookie.flow_sample
4128 && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
4129 return FLOW_SAMPLE_UPCALL;
4130 } else if (userdata_len == sizeof cookie.ipfix
4131 && cookie.type == USER_ACTION_COOKIE_IPFIX) {
4132 return IPFIX_UPCALL;
4134 VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
4135 " and size %zu", cookie.type, userdata_len);
4141 handle_sflow_upcall(struct dpif_backer *backer,
4142 const struct dpif_upcall *upcall)
4144 struct ofproto_dpif *ofproto;
4145 union user_action_cookie cookie;
4147 uint32_t odp_in_port;
4149 if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4150 &flow, NULL, &ofproto, &odp_in_port, NULL)
4151 || !ofproto->sflow) {
4155 memset(&cookie, 0, sizeof cookie);
4156 memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.sflow);
4157 dpif_sflow_received(ofproto->sflow, upcall->packet, &flow,
4158 odp_in_port, &cookie);
4162 handle_flow_sample_upcall(struct dpif_backer *backer,
4163 const struct dpif_upcall *upcall)
4165 struct ofproto_dpif *ofproto;
4166 union user_action_cookie cookie;
4169 if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4170 &flow, NULL, &ofproto, NULL, NULL)
4171 || !ofproto->ipfix) {
4175 memset(&cookie, 0, sizeof cookie);
4176 memcpy(&cookie, nl_attr_get(upcall->userdata), sizeof cookie.flow_sample);
4178 /* The flow reflects exactly the contents of the packet. Sample
4179 * the packet using it. */
4180 dpif_ipfix_flow_sample(ofproto->ipfix, upcall->packet, &flow,
4181 cookie.flow_sample.collector_set_id,
4182 cookie.flow_sample.probability,
4183 cookie.flow_sample.obs_domain_id,
4184 cookie.flow_sample.obs_point_id);
4188 handle_ipfix_upcall(struct dpif_backer *backer,
4189 const struct dpif_upcall *upcall)
4191 struct ofproto_dpif *ofproto;
4194 if (ofproto_receive(backer, upcall->packet, upcall->key, upcall->key_len,
4195 &flow, NULL, &ofproto, NULL, NULL)
4196 || !ofproto->ipfix) {
4200 /* The flow reflects exactly the contents of the packet. Sample
4201 * the packet using it. */
4202 dpif_ipfix_bridge_sample(ofproto->ipfix, upcall->packet, &flow);
4206 handle_upcalls(struct dpif_backer *backer, unsigned int max_batch)
4208 struct dpif_upcall misses[FLOW_MISS_MAX_BATCH];
4209 struct ofpbuf miss_bufs[FLOW_MISS_MAX_BATCH];
4210 uint64_t miss_buf_stubs[FLOW_MISS_MAX_BATCH][4096 / 8];
4215 ovs_assert(max_batch <= FLOW_MISS_MAX_BATCH);
4218 for (n_processed = 0; n_processed < max_batch; n_processed++) {
4219 struct dpif_upcall *upcall = &misses[n_misses];
4220 struct ofpbuf *buf = &miss_bufs[n_misses];
4223 ofpbuf_use_stub(buf, miss_buf_stubs[n_misses],
4224 sizeof miss_buf_stubs[n_misses]);
4225 error = dpif_recv(backer->dpif, upcall, buf);
4231 switch (classify_upcall(upcall)) {
4233 /* Handle it later. */
4238 handle_sflow_upcall(backer, upcall);
4242 case FLOW_SAMPLE_UPCALL:
4243 handle_flow_sample_upcall(backer, upcall);
4248 handle_ipfix_upcall(backer, upcall);
4258 /* Handle deferred MISS_UPCALL processing. */
4259 handle_miss_upcalls(backer, misses, n_misses);
4260 for (i = 0; i < n_misses; i++) {
4261 ofpbuf_uninit(&miss_bufs[i]);
4267 /* Flow expiration. */
4269 static int subfacet_max_idle(const struct ofproto_dpif *);
4270 static void update_stats(struct dpif_backer *);
4271 static void rule_expire(struct rule_dpif *);
4272 static void expire_subfacets(struct ofproto_dpif *, int dp_max_idle);
4274 /* This function is called periodically by run(). Its job is to collect
4275 * updates for the flows that have been installed into the datapath, most
4276 * importantly when they last were used, and then use that information to
4277 * expire flows that have not been used recently.
4279 * Returns the number of milliseconds after which it should be called again. */
4281 expire(struct dpif_backer *backer)
4283 struct ofproto_dpif *ofproto;
4284 int max_idle = INT32_MAX;
4286 /* Periodically clear out the drop keys in an effort to keep them
4287 * relatively few. */
4288 drop_key_clear(backer);
4290 /* Update stats for each flow in the backer. */
4291 update_stats(backer);
4293 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4294 struct rule *rule, *next_rule;
4297 if (ofproto->backer != backer) {
4301 /* Keep track of the max number of flows per ofproto_dpif. */
4302 update_max_subfacet_count(ofproto);
4304 /* Expire subfacets that have been idle too long. */
4305 dp_max_idle = subfacet_max_idle(ofproto);
4306 expire_subfacets(ofproto, dp_max_idle);
4308 max_idle = MIN(max_idle, dp_max_idle);
4310 /* Expire OpenFlow flows whose idle_timeout or hard_timeout
4312 LIST_FOR_EACH_SAFE (rule, next_rule, expirable,
4313 &ofproto->up.expirable) {
4314 rule_expire(rule_dpif_cast(rule));
4317 /* All outstanding data in existing flows has been accounted, so it's a
4318 * good time to do bond rebalancing. */
4319 if (ofproto->has_bonded_bundles) {
4320 struct ofbundle *bundle;
4322 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
4324 bond_rebalance(bundle->bond, &backer->revalidate_set);
4330 return MIN(max_idle, 1000);
4333 /* Updates flow table statistics given that the datapath just reported 'stats'
4334 * as 'subfacet''s statistics. */
4336 update_subfacet_stats(struct subfacet *subfacet,
4337 const struct dpif_flow_stats *stats)
4339 struct facet *facet = subfacet->facet;
4341 if (stats->n_packets >= subfacet->dp_packet_count) {
4342 uint64_t extra = stats->n_packets - subfacet->dp_packet_count;
4343 facet->packet_count += extra;
4345 VLOG_WARN_RL(&rl, "unexpected packet count from the datapath");
4348 if (stats->n_bytes >= subfacet->dp_byte_count) {
4349 facet->byte_count += stats->n_bytes - subfacet->dp_byte_count;
4351 VLOG_WARN_RL(&rl, "unexpected byte count from datapath");
4354 subfacet->dp_packet_count = stats->n_packets;
4355 subfacet->dp_byte_count = stats->n_bytes;
4357 facet->tcp_flags |= stats->tcp_flags;
4359 subfacet_update_time(subfacet, stats->used);
4360 if (facet->accounted_bytes < facet->byte_count) {
4362 facet_account(facet);
4363 facet->accounted_bytes = facet->byte_count;
4367 /* 'key' with length 'key_len' bytes is a flow in 'dpif' that we know nothing
4368 * about, or a flow that shouldn't be installed but was anyway. Delete it. */
4370 delete_unexpected_flow(struct ofproto_dpif *ofproto,
4371 const struct nlattr *key, size_t key_len)
4373 if (!VLOG_DROP_WARN(&rl)) {
4377 odp_flow_key_format(key, key_len, &s);
4378 VLOG_WARN("unexpected flow on %s: %s", ofproto->up.name, ds_cstr(&s));
4382 COVERAGE_INC(facet_unexpected);
4383 dpif_flow_del(ofproto->backer->dpif, key, key_len, NULL);
4386 /* Update 'packet_count', 'byte_count', and 'used' members of installed facets.
4388 * This function also pushes statistics updates to rules which each facet
4389 * resubmits into. Generally these statistics will be accurate. However, if a
4390 * facet changes the rule it resubmits into at some time in between
4391 * update_stats() runs, it is possible that statistics accrued to the
4392 * old rule will be incorrectly attributed to the new rule. This could be
4393 * avoided by calling update_stats() whenever rules are created or
4394 * deleted. However, the performance impact of making so many calls to the
4395 * datapath do not justify the benefit of having perfectly accurate statistics.
4397 * In addition, this function maintains per ofproto flow hit counts. The patch
4398 * port is not treated specially. e.g. A packet ingress from br0 patched into
4399 * br1 will increase the hit count of br0 by 1, however, does not affect
4400 * the hit or miss counts of br1.
4403 update_stats(struct dpif_backer *backer)
4405 const struct dpif_flow_stats *stats;
4406 struct dpif_flow_dump dump;
4407 const struct nlattr *key;
4408 struct ofproto_dpif *ofproto;
4411 dpif_flow_dump_start(&dump, backer->dpif);
4412 while (dpif_flow_dump_next(&dump, &key, &key_len, NULL, NULL, &stats)) {
4414 struct subfacet *subfacet;
4415 struct ofport_dpif *ofport;
4418 if (ofproto_receive(backer, NULL, key, key_len, &flow, NULL, &ofproto,
4423 ofproto->total_subfacet_count += hmap_count(&ofproto->subfacets);
4424 ofproto->n_update_stats++;
4426 ofport = get_ofp_port(ofproto, flow.in_port);
4427 if (ofport && ofport->tnl_port) {
4428 netdev_vport_inc_rx(ofport->up.netdev, stats);
4431 key_hash = odp_flow_key_hash(key, key_len);
4432 subfacet = subfacet_find(ofproto, key, key_len, key_hash);
4433 switch (subfacet ? subfacet->path : SF_NOT_INSTALLED) {
4435 /* Update ofproto_dpif's hit count. */
4436 if (stats->n_packets > subfacet->dp_packet_count) {
4437 uint64_t delta = stats->n_packets - subfacet->dp_packet_count;
4438 dpif_stats_update_hit_count(ofproto, delta);
4441 update_subfacet_stats(subfacet, stats);
4445 /* Stats are updated per-packet. */
4448 case SF_NOT_INSTALLED:
4450 delete_unexpected_flow(ofproto, key, key_len);
4455 dpif_flow_dump_done(&dump);
4457 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
4458 update_moving_averages(ofproto);
4463 /* Calculates and returns the number of milliseconds of idle time after which
4464 * subfacets should expire from the datapath. When a subfacet expires, we fold
4465 * its statistics into its facet, and when a facet's last subfacet expires, we
4466 * fold its statistic into its rule. */
4468 subfacet_max_idle(const struct ofproto_dpif *ofproto)
4471 * Idle time histogram.
4473 * Most of the time a switch has a relatively small number of subfacets.
4474 * When this is the case we might as well keep statistics for all of them
4475 * in userspace and to cache them in the kernel datapath for performance as
4478 * As the number of subfacets increases, the memory required to maintain
4479 * statistics about them in userspace and in the kernel becomes
4480 * significant. However, with a large number of subfacets it is likely
4481 * that only a few of them are "heavy hitters" that consume a large amount
4482 * of bandwidth. At this point, only heavy hitters are worth caching in
4483 * the kernel and maintaining in userspaces; other subfacets we can
4486 * The technique used to compute the idle time is to build a histogram with
4487 * N_BUCKETS buckets whose width is BUCKET_WIDTH msecs each. Each subfacet
4488 * that is installed in the kernel gets dropped in the appropriate bucket.
4489 * After the histogram has been built, we compute the cutoff so that only
4490 * the most-recently-used 1% of subfacets (but at least
4491 * ofproto->up.flow_eviction_threshold flows) are kept cached. At least
4492 * the most-recently-used bucket of subfacets is kept, so actually an
4493 * arbitrary number of subfacets can be kept in any given expiration run
4494 * (though the next run will delete most of those unless they receive
4497 * This requires a second pass through the subfacets, in addition to the
4498 * pass made by update_stats(), because the former function never looks at
4499 * uninstallable subfacets.
4501 enum { BUCKET_WIDTH = ROUND_UP(100, TIME_UPDATE_INTERVAL) };
4502 enum { N_BUCKETS = 5000 / BUCKET_WIDTH };
4503 int buckets[N_BUCKETS] = { 0 };
4504 int total, subtotal, bucket;
4505 struct subfacet *subfacet;
4509 total = hmap_count(&ofproto->subfacets);
4510 if (total <= ofproto->up.flow_eviction_threshold) {
4511 return N_BUCKETS * BUCKET_WIDTH;
4514 /* Build histogram. */
4516 HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
4517 long long int idle = now - subfacet->used;
4518 int bucket = (idle <= 0 ? 0
4519 : idle >= BUCKET_WIDTH * N_BUCKETS ? N_BUCKETS - 1
4520 : (unsigned int) idle / BUCKET_WIDTH);
4524 /* Find the first bucket whose flows should be expired. */
4525 subtotal = bucket = 0;
4527 subtotal += buckets[bucket++];
4528 } while (bucket < N_BUCKETS &&
4529 subtotal < MAX(ofproto->up.flow_eviction_threshold, total / 100));
4531 if (VLOG_IS_DBG_ENABLED()) {
4535 ds_put_cstr(&s, "keep");
4536 for (i = 0; i < N_BUCKETS; i++) {
4538 ds_put_cstr(&s, ", drop");
4541 ds_put_format(&s, " %d:%d", i * BUCKET_WIDTH, buckets[i]);
4544 VLOG_INFO("%s: %s (msec:count)", ofproto->up.name, ds_cstr(&s));
4548 return bucket * BUCKET_WIDTH;
4552 expire_subfacets(struct ofproto_dpif *ofproto, int dp_max_idle)
4554 /* Cutoff time for most flows. */
4555 long long int normal_cutoff = time_msec() - dp_max_idle;
4557 /* We really want to keep flows for special protocols around, so use a more
4558 * conservative cutoff. */
4559 long long int special_cutoff = time_msec() - 10000;
4561 struct subfacet *subfacet, *next_subfacet;
4562 struct subfacet *batch[SUBFACET_DESTROY_MAX_BATCH];
4566 HMAP_FOR_EACH_SAFE (subfacet, next_subfacet, hmap_node,
4567 &ofproto->subfacets) {
4568 long long int cutoff;
4570 cutoff = (subfacet->slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)
4573 if (subfacet->used < cutoff) {
4574 if (subfacet->path != SF_NOT_INSTALLED) {
4575 batch[n_batch++] = subfacet;
4576 if (n_batch >= SUBFACET_DESTROY_MAX_BATCH) {
4577 subfacet_destroy_batch(ofproto, batch, n_batch);
4581 subfacet_destroy(subfacet);
4587 subfacet_destroy_batch(ofproto, batch, n_batch);
4591 /* If 'rule' is an OpenFlow rule, that has expired according to OpenFlow rules,
4592 * then delete it entirely. */
4594 rule_expire(struct rule_dpif *rule)
4596 struct facet *facet, *next_facet;
4600 if (rule->up.pending) {
4601 /* We'll have to expire it later. */
4605 /* Has 'rule' expired? */
4607 if (rule->up.hard_timeout
4608 && now > rule->up.modified + rule->up.hard_timeout * 1000) {
4609 reason = OFPRR_HARD_TIMEOUT;
4610 } else if (rule->up.idle_timeout
4611 && now > rule->up.used + rule->up.idle_timeout * 1000) {
4612 reason = OFPRR_IDLE_TIMEOUT;
4617 COVERAGE_INC(ofproto_dpif_expired);
4619 /* Update stats. (This is a no-op if the rule expired due to an idle
4620 * timeout, because that only happens when the rule has no facets left.) */
4621 LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
4622 facet_remove(facet);
4625 /* Get rid of the rule. */
4626 ofproto_rule_expire(&rule->up, reason);
4631 /* Creates and returns a new facet owned by 'rule', given a 'flow'.
4633 * The caller must already have determined that no facet with an identical
4634 * 'flow' exists in 'ofproto' and that 'flow' is the best match for 'rule' in
4635 * the ofproto's classifier table.
4637 * 'hash' must be the return value of flow_hash(flow, 0).
4639 * The facet will initially have no subfacets. The caller should create (at
4640 * least) one subfacet with subfacet_create(). */
4641 static struct facet *
4642 facet_create(struct rule_dpif *rule, const struct flow *flow, uint32_t hash)
4644 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
4645 struct facet *facet;
4647 facet = xzalloc(sizeof *facet);
4648 facet->used = time_msec();
4649 hmap_insert(&ofproto->facets, &facet->hmap_node, hash);
4650 list_push_back(&rule->facets, &facet->list_node);
4652 facet->flow = *flow;
4653 list_init(&facet->subfacets);
4654 netflow_flow_init(&facet->nf_flow);
4655 netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, facet->used);
4657 facet->learn_rl = time_msec() + 500;
4663 facet_free(struct facet *facet)
4668 /* Executes, within 'ofproto', the 'n_actions' actions in 'actions' on
4669 * 'packet', which arrived on 'in_port'. */
4671 execute_odp_actions(struct ofproto_dpif *ofproto, const struct flow *flow,
4672 const struct nlattr *odp_actions, size_t actions_len,
4673 struct ofpbuf *packet)
4675 struct odputil_keybuf keybuf;
4679 ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
4680 odp_flow_key_from_flow(&key, flow,
4681 ofp_port_to_odp_port(ofproto, flow->in_port));
4683 error = dpif_execute(ofproto->backer->dpif, key.data, key.size,
4684 odp_actions, actions_len, packet);
4688 /* Remove 'facet' from 'ofproto' and free up the associated memory:
4690 * - If 'facet' was installed in the datapath, uninstalls it and updates its
4691 * rule's statistics, via subfacet_uninstall().
4693 * - Removes 'facet' from its rule and from ofproto->facets.
4696 facet_remove(struct facet *facet)
4698 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4699 struct subfacet *subfacet, *next_subfacet;
4701 ovs_assert(!list_is_empty(&facet->subfacets));
4703 /* First uninstall all of the subfacets to get final statistics. */
4704 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4705 subfacet_uninstall(subfacet);
4708 /* Flush the final stats to the rule.
4710 * This might require us to have at least one subfacet around so that we
4711 * can use its actions for accounting in facet_account(), which is why we
4712 * have uninstalled but not yet destroyed the subfacets. */
4713 facet_flush_stats(facet);
4715 /* Now we're really all done so destroy everything. */
4716 LIST_FOR_EACH_SAFE (subfacet, next_subfacet, list_node,
4717 &facet->subfacets) {
4718 subfacet_destroy__(subfacet);
4720 hmap_remove(&ofproto->facets, &facet->hmap_node);
4721 list_remove(&facet->list_node);
4725 /* Feed information from 'facet' back into the learning table to keep it in
4726 * sync with what is actually flowing through the datapath. */
4728 facet_learn(struct facet *facet)
4730 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4731 struct subfacet *subfacet= CONTAINER_OF(list_front(&facet->subfacets),
4732 struct subfacet, list_node);
4733 long long int now = time_msec();
4734 struct action_xlate_ctx ctx;
4736 if (!facet->has_fin_timeout && now < facet->learn_rl) {
4740 facet->learn_rl = now + 500;
4742 if (!facet->has_learn
4743 && !facet->has_normal
4744 && (!facet->has_fin_timeout
4745 || !(facet->tcp_flags & (TCP_FIN | TCP_RST)))) {
4749 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
4750 &subfacet->initial_vals,
4751 facet->rule, facet->tcp_flags, NULL);
4752 ctx.may_learn = true;
4753 xlate_actions_for_side_effects(&ctx, facet->rule->up.ofpacts,
4754 facet->rule->up.ofpacts_len);
4758 facet_account(struct facet *facet)
4760 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4761 struct subfacet *subfacet = facet_get_subfacet(facet);
4762 const struct nlattr *a;
4767 if (!facet->has_normal || !ofproto->has_bonded_bundles) {
4770 n_bytes = facet->byte_count - facet->accounted_bytes;
4772 /* This loop feeds byte counters to bond_account() for rebalancing to use
4773 * as a basis. We also need to track the actual VLAN on which the packet
4774 * is going to be sent to ensure that it matches the one passed to
4775 * bond_choose_output_slave(). (Otherwise, we will account to the wrong
4778 * We use the actions from an arbitrary subfacet because they should all
4779 * be equally valid for our purpose. */
4780 vlan_tci = facet->flow.vlan_tci;
4781 NL_ATTR_FOR_EACH_UNSAFE (a, left,
4782 subfacet->actions, subfacet->actions_len) {
4783 const struct ovs_action_push_vlan *vlan;
4784 struct ofport_dpif *port;
4786 switch (nl_attr_type(a)) {
4787 case OVS_ACTION_ATTR_OUTPUT:
4788 port = get_odp_port(ofproto, nl_attr_get_u32(a));
4789 if (port && port->bundle && port->bundle->bond) {
4790 bond_account(port->bundle->bond, &facet->flow,
4791 vlan_tci_to_vid(vlan_tci), n_bytes);
4795 case OVS_ACTION_ATTR_POP_VLAN:
4796 vlan_tci = htons(0);
4799 case OVS_ACTION_ATTR_PUSH_VLAN:
4800 vlan = nl_attr_get(a);
4801 vlan_tci = vlan->vlan_tci;
4807 /* Returns true if the only action for 'facet' is to send to the controller.
4808 * (We don't report NetFlow expiration messages for such facets because they
4809 * are just part of the control logic for the network, not real traffic). */
4811 facet_is_controller_flow(struct facet *facet)
4814 const struct rule *rule = &facet->rule->up;
4815 const struct ofpact *ofpacts = rule->ofpacts;
4816 size_t ofpacts_len = rule->ofpacts_len;
4818 if (ofpacts_len > 0 &&
4819 ofpacts->type == OFPACT_CONTROLLER &&
4820 ofpact_next(ofpacts) >= ofpact_end(ofpacts, ofpacts_len)) {
4827 /* Folds all of 'facet''s statistics into its rule. Also updates the
4828 * accounting ofhook and emits a NetFlow expiration if appropriate. All of
4829 * 'facet''s statistics in the datapath should have been zeroed and folded into
4830 * its packet and byte counts before this function is called. */
4832 facet_flush_stats(struct facet *facet)
4834 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4835 struct subfacet *subfacet;
4837 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4838 ovs_assert(!subfacet->dp_byte_count);
4839 ovs_assert(!subfacet->dp_packet_count);
4842 facet_push_stats(facet);
4843 if (facet->accounted_bytes < facet->byte_count) {
4844 facet_account(facet);
4845 facet->accounted_bytes = facet->byte_count;
4848 if (ofproto->netflow && !facet_is_controller_flow(facet)) {
4849 struct ofexpired expired;
4850 expired.flow = facet->flow;
4851 expired.packet_count = facet->packet_count;
4852 expired.byte_count = facet->byte_count;
4853 expired.used = facet->used;
4854 netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
4857 /* Reset counters to prevent double counting if 'facet' ever gets
4859 facet_reset_counters(facet);
4861 netflow_flow_clear(&facet->nf_flow);
4862 facet->tcp_flags = 0;
4865 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
4866 * Returns it if found, otherwise a null pointer.
4868 * 'hash' must be the return value of flow_hash(flow, 0).
4870 * The returned facet might need revalidation; use facet_lookup_valid()
4871 * instead if that is important. */
4872 static struct facet *
4873 facet_find(struct ofproto_dpif *ofproto,
4874 const struct flow *flow, uint32_t hash)
4876 struct facet *facet;
4878 HMAP_FOR_EACH_WITH_HASH (facet, hmap_node, hash, &ofproto->facets) {
4879 if (flow_equal(flow, &facet->flow)) {
4887 /* Searches 'ofproto''s table of facets for one exactly equal to 'flow'.
4888 * Returns it if found, otherwise a null pointer.
4890 * 'hash' must be the return value of flow_hash(flow, 0).
4892 * The returned facet is guaranteed to be valid. */
4893 static struct facet *
4894 facet_lookup_valid(struct ofproto_dpif *ofproto, const struct flow *flow,
4897 struct facet *facet;
4899 facet = facet_find(ofproto, flow, hash);
4901 && (ofproto->backer->need_revalidate
4902 || tag_set_intersects(&ofproto->backer->revalidate_set,
4904 && !facet_revalidate(facet)) {
4905 facet = facet_find(ofproto, flow, hash);
4911 /* Return a subfacet from 'facet'. A facet consists of one or more
4912 * subfacets, and this function returns one of them. */
4913 static struct subfacet *facet_get_subfacet(struct facet *facet)
4915 return CONTAINER_OF(list_front(&facet->subfacets), struct subfacet,
4920 subfacet_path_to_string(enum subfacet_path path)
4923 case SF_NOT_INSTALLED:
4924 return "not installed";
4926 return "in fast path";
4928 return "in slow path";
4934 /* Returns the path in which a subfacet should be installed if its 'slow'
4935 * member has the specified value. */
4936 static enum subfacet_path
4937 subfacet_want_path(enum slow_path_reason slow)
4939 return slow ? SF_SLOW_PATH : SF_FAST_PATH;
4942 /* Returns true if 'subfacet' needs to have its datapath flow updated,
4943 * supposing that its actions have been recalculated as 'want_actions' and that
4944 * 'slow' is nonzero iff 'subfacet' should be in the slow path. */
4946 subfacet_should_install(struct subfacet *subfacet, enum slow_path_reason slow,
4947 const struct ofpbuf *want_actions)
4949 enum subfacet_path want_path = subfacet_want_path(slow);
4950 return (want_path != subfacet->path
4951 || (want_path == SF_FAST_PATH
4952 && (subfacet->actions_len != want_actions->size
4953 || memcmp(subfacet->actions, want_actions->data,
4954 subfacet->actions_len))));
4958 facet_check_consistency(struct facet *facet)
4960 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 15);
4962 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
4964 uint64_t odp_actions_stub[1024 / 8];
4965 struct ofpbuf odp_actions;
4967 struct rule_dpif *rule;
4968 struct subfacet *subfacet;
4969 bool may_log = false;
4972 /* Check the rule for consistency. */
4973 rule = rule_dpif_lookup(ofproto, &facet->flow);
4974 ok = rule == facet->rule;
4976 may_log = !VLOG_DROP_WARN(&rl);
4981 flow_format(&s, &facet->flow);
4982 ds_put_format(&s, ": facet associated with wrong rule (was "
4983 "table=%"PRIu8",", facet->rule->up.table_id);
4984 cls_rule_format(&facet->rule->up.cr, &s);
4985 ds_put_format(&s, ") (should have been table=%"PRIu8",",
4987 cls_rule_format(&rule->up.cr, &s);
4988 ds_put_char(&s, ')');
4990 VLOG_WARN("%s", ds_cstr(&s));
4995 /* Check the datapath actions for consistency. */
4996 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
4997 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
4998 enum subfacet_path want_path;
4999 struct action_xlate_ctx ctx;
5002 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5003 &subfacet->initial_vals, rule, 0, NULL);
5004 xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len,
5007 if (subfacet->path == SF_NOT_INSTALLED) {
5008 /* This only happens if the datapath reported an error when we
5009 * tried to install the flow. Don't flag another error here. */
5013 want_path = subfacet_want_path(subfacet->slow);
5014 if (want_path == SF_SLOW_PATH && subfacet->path == SF_SLOW_PATH) {
5015 /* The actions for slow-path flows may legitimately vary from one
5016 * packet to the next. We're done. */
5020 if (!subfacet_should_install(subfacet, subfacet->slow, &odp_actions)) {
5024 /* Inconsistency! */
5026 may_log = !VLOG_DROP_WARN(&rl);
5030 /* Rate-limited, skip reporting. */
5035 odp_flow_key_format(subfacet->key, subfacet->key_len, &s);
5037 ds_put_cstr(&s, ": inconsistency in subfacet");
5038 if (want_path != subfacet->path) {
5039 enum odp_key_fitness fitness = subfacet->key_fitness;
5041 ds_put_format(&s, " (%s, fitness=%s)",
5042 subfacet_path_to_string(subfacet->path),
5043 odp_key_fitness_to_string(fitness));
5044 ds_put_format(&s, " (should have been %s)",
5045 subfacet_path_to_string(want_path));
5046 } else if (want_path == SF_FAST_PATH) {
5047 ds_put_cstr(&s, " (actions were: ");
5048 format_odp_actions(&s, subfacet->actions,
5049 subfacet->actions_len);
5050 ds_put_cstr(&s, ") (correct actions: ");
5051 format_odp_actions(&s, odp_actions.data, odp_actions.size);
5052 ds_put_char(&s, ')');
5054 ds_put_cstr(&s, " (actions: ");
5055 format_odp_actions(&s, subfacet->actions,
5056 subfacet->actions_len);
5057 ds_put_char(&s, ')');
5059 VLOG_WARN("%s", ds_cstr(&s));
5062 ofpbuf_uninit(&odp_actions);
5067 /* Re-searches the classifier for 'facet':
5069 * - If the rule found is different from 'facet''s current rule, moves
5070 * 'facet' to the new rule and recompiles its actions.
5072 * - If the rule found is the same as 'facet''s current rule, leaves 'facet'
5073 * where it is and recompiles its actions anyway.
5075 * - If any of 'facet''s subfacets correspond to a new flow according to
5076 * ofproto_receive(), 'facet' is removed.
5078 * Returns true if 'facet' is still valid. False if 'facet' was removed. */
5080 facet_revalidate(struct facet *facet)
5082 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5084 struct nlattr *odp_actions;
5087 struct actions *new_actions;
5089 struct action_xlate_ctx ctx;
5090 uint64_t odp_actions_stub[1024 / 8];
5091 struct ofpbuf odp_actions;
5093 struct rule_dpif *new_rule;
5094 struct subfacet *subfacet;
5097 COVERAGE_INC(facet_revalidate);
5099 /* Check that child subfacets still correspond to this facet. Tunnel
5100 * configuration changes could cause a subfacet's OpenFlow in_port to
5102 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5103 struct ofproto_dpif *recv_ofproto;
5104 struct flow recv_flow;
5107 error = ofproto_receive(ofproto->backer, NULL, subfacet->key,
5108 subfacet->key_len, &recv_flow, NULL,
5109 &recv_ofproto, NULL, NULL);
5111 || recv_ofproto != ofproto
5112 || memcmp(&recv_flow, &facet->flow, sizeof recv_flow)) {
5113 facet_remove(facet);
5118 new_rule = rule_dpif_lookup(ofproto, &facet->flow);
5120 /* Calculate new datapath actions.
5122 * We do not modify any 'facet' state yet, because we might need to, e.g.,
5123 * emit a NetFlow expiration and, if so, we need to have the old state
5124 * around to properly compose it. */
5126 /* If the datapath actions changed or the installability changed,
5127 * then we need to talk to the datapath. */
5130 memset(&ctx, 0, sizeof ctx);
5131 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5132 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5133 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5134 &subfacet->initial_vals, new_rule, 0, NULL);
5135 xlate_actions(&ctx, new_rule->up.ofpacts, new_rule->up.ofpacts_len,
5138 if (subfacet_should_install(subfacet, ctx.slow, &odp_actions)) {
5139 struct dpif_flow_stats stats;
5141 subfacet_install(subfacet, odp_actions.data, odp_actions.size,
5143 subfacet_update_stats(subfacet, &stats);
5146 new_actions = xcalloc(list_size(&facet->subfacets),
5147 sizeof *new_actions);
5149 new_actions[i].odp_actions = xmemdup(odp_actions.data,
5151 new_actions[i].actions_len = odp_actions.size;
5156 ofpbuf_uninit(&odp_actions);
5159 facet_flush_stats(facet);
5162 /* Update 'facet' now that we've taken care of all the old state. */
5163 facet->tags = ctx.tags;
5164 facet->nf_flow.output_iface = ctx.nf_output_iface;
5165 facet->has_learn = ctx.has_learn;
5166 facet->has_normal = ctx.has_normal;
5167 facet->has_fin_timeout = ctx.has_fin_timeout;
5168 facet->mirrors = ctx.mirrors;
5171 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
5172 subfacet->slow = ctx.slow;
5174 if (new_actions && new_actions[i].odp_actions) {
5175 free(subfacet->actions);
5176 subfacet->actions = new_actions[i].odp_actions;
5177 subfacet->actions_len = new_actions[i].actions_len;
5183 if (facet->rule != new_rule) {
5184 COVERAGE_INC(facet_changed_rule);
5185 list_remove(&facet->list_node);
5186 list_push_back(&new_rule->facets, &facet->list_node);
5187 facet->rule = new_rule;
5188 facet->used = new_rule->up.created;
5189 facet->prev_used = facet->used;
5195 /* Updates 'facet''s used time. Caller is responsible for calling
5196 * facet_push_stats() to update the flows which 'facet' resubmits into. */
5198 facet_update_time(struct facet *facet, long long int used)
5200 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5201 if (used > facet->used) {
5203 ofproto_rule_update_used(&facet->rule->up, used);
5204 netflow_flow_update_time(ofproto->netflow, &facet->nf_flow, used);
5209 facet_reset_counters(struct facet *facet)
5211 facet->packet_count = 0;
5212 facet->byte_count = 0;
5213 facet->prev_packet_count = 0;
5214 facet->prev_byte_count = 0;
5215 facet->accounted_bytes = 0;
5219 facet_push_stats(struct facet *facet)
5221 struct dpif_flow_stats stats;
5223 ovs_assert(facet->packet_count >= facet->prev_packet_count);
5224 ovs_assert(facet->byte_count >= facet->prev_byte_count);
5225 ovs_assert(facet->used >= facet->prev_used);
5227 stats.n_packets = facet->packet_count - facet->prev_packet_count;
5228 stats.n_bytes = facet->byte_count - facet->prev_byte_count;
5229 stats.used = facet->used;
5230 stats.tcp_flags = 0;
5232 if (stats.n_packets || stats.n_bytes || facet->used > facet->prev_used) {
5233 facet->prev_packet_count = facet->packet_count;
5234 facet->prev_byte_count = facet->byte_count;
5235 facet->prev_used = facet->used;
5237 rule_credit_stats(facet->rule, &stats);
5238 flow_push_stats(facet, &stats);
5240 update_mirror_stats(ofproto_dpif_cast(facet->rule->up.ofproto),
5241 facet->mirrors, stats.n_packets, stats.n_bytes);
5246 push_all_stats__(bool run_fast)
5248 static long long int rl = LLONG_MIN;
5249 struct ofproto_dpif *ofproto;
5251 if (time_msec() < rl) {
5255 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
5256 struct facet *facet;
5258 HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
5259 facet_push_stats(facet);
5266 rl = time_msec() + 100;
5270 push_all_stats(void)
5272 push_all_stats__(true);
5276 rule_credit_stats(struct rule_dpif *rule, const struct dpif_flow_stats *stats)
5278 rule->packet_count += stats->n_packets;
5279 rule->byte_count += stats->n_bytes;
5280 ofproto_rule_update_used(&rule->up, stats->used);
5283 /* Pushes flow statistics to the rules which 'facet->flow' resubmits
5284 * into given 'facet->rule''s actions and mirrors. */
5286 flow_push_stats(struct facet *facet, const struct dpif_flow_stats *stats)
5288 struct rule_dpif *rule = facet->rule;
5289 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5290 struct subfacet *subfacet = facet_get_subfacet(facet);
5291 struct action_xlate_ctx ctx;
5293 ofproto_rule_update_used(&rule->up, stats->used);
5295 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5296 &subfacet->initial_vals, rule, 0, NULL);
5297 ctx.resubmit_stats = stats;
5298 xlate_actions_for_side_effects(&ctx, rule->up.ofpacts,
5299 rule->up.ofpacts_len);
5304 static struct subfacet *
5305 subfacet_find(struct ofproto_dpif *ofproto,
5306 const struct nlattr *key, size_t key_len, uint32_t key_hash)
5308 struct subfacet *subfacet;
5310 HMAP_FOR_EACH_WITH_HASH (subfacet, hmap_node, key_hash,
5311 &ofproto->subfacets) {
5312 if (subfacet->key_len == key_len
5313 && !memcmp(key, subfacet->key, key_len)) {
5321 /* Searches 'facet' (within 'ofproto') for a subfacet with the specified
5322 * 'key_fitness', 'key', and 'key_len' members in 'miss'. Returns the
5323 * existing subfacet if there is one, otherwise creates and returns a
5326 * If the returned subfacet is new, then subfacet->actions will be NULL, in
5327 * which case the caller must populate the actions with
5328 * subfacet_make_actions(). */
5329 static struct subfacet *
5330 subfacet_create(struct facet *facet, struct flow_miss *miss,
5333 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5334 enum odp_key_fitness key_fitness = miss->key_fitness;
5335 const struct nlattr *key = miss->key;
5336 size_t key_len = miss->key_len;
5338 struct subfacet *subfacet;
5340 key_hash = odp_flow_key_hash(key, key_len);
5342 if (list_is_empty(&facet->subfacets)) {
5343 subfacet = &facet->one_subfacet;
5345 subfacet = subfacet_find(ofproto, key, key_len, key_hash);
5347 if (subfacet->facet == facet) {
5351 /* This shouldn't happen. */
5352 VLOG_ERR_RL(&rl, "subfacet with wrong facet");
5353 subfacet_destroy(subfacet);
5356 subfacet = xmalloc(sizeof *subfacet);
5359 hmap_insert(&ofproto->subfacets, &subfacet->hmap_node, key_hash);
5360 list_push_back(&facet->subfacets, &subfacet->list_node);
5361 subfacet->facet = facet;
5362 subfacet->key_fitness = key_fitness;
5363 subfacet->key = xmemdup(key, key_len);
5364 subfacet->key_len = key_len;
5365 subfacet->used = now;
5366 subfacet->created = now;
5367 subfacet->dp_packet_count = 0;
5368 subfacet->dp_byte_count = 0;
5369 subfacet->actions_len = 0;
5370 subfacet->actions = NULL;
5372 subfacet->path = SF_NOT_INSTALLED;
5373 subfacet->initial_vals = miss->initial_vals;
5374 subfacet->odp_in_port = miss->odp_in_port;
5376 ofproto->subfacet_add_count++;
5380 /* Uninstalls 'subfacet' from the datapath, if it is installed, removes it from
5381 * its facet within 'ofproto', and frees it. */
5383 subfacet_destroy__(struct subfacet *subfacet)
5385 struct facet *facet = subfacet->facet;
5386 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5388 /* Update ofproto stats before uninstall the subfacet. */
5389 ofproto->subfacet_del_count++;
5390 ofproto->total_subfacet_life_span += (time_msec() - subfacet->created);
5392 subfacet_uninstall(subfacet);
5393 hmap_remove(&ofproto->subfacets, &subfacet->hmap_node);
5394 list_remove(&subfacet->list_node);
5395 free(subfacet->key);
5396 free(subfacet->actions);
5397 if (subfacet != &facet->one_subfacet) {
5402 /* Destroys 'subfacet', as with subfacet_destroy__(), and then if this was the
5403 * last remaining subfacet in its facet destroys the facet too. */
5405 subfacet_destroy(struct subfacet *subfacet)
5407 struct facet *facet = subfacet->facet;
5409 if (list_is_singleton(&facet->subfacets)) {
5410 /* facet_remove() needs at least one subfacet (it will remove it). */
5411 facet_remove(facet);
5413 subfacet_destroy__(subfacet);
5418 subfacet_destroy_batch(struct ofproto_dpif *ofproto,
5419 struct subfacet **subfacets, int n)
5421 struct dpif_op ops[SUBFACET_DESTROY_MAX_BATCH];
5422 struct dpif_op *opsp[SUBFACET_DESTROY_MAX_BATCH];
5423 struct dpif_flow_stats stats[SUBFACET_DESTROY_MAX_BATCH];
5426 for (i = 0; i < n; i++) {
5427 ops[i].type = DPIF_OP_FLOW_DEL;
5428 ops[i].u.flow_del.key = subfacets[i]->key;
5429 ops[i].u.flow_del.key_len = subfacets[i]->key_len;
5430 ops[i].u.flow_del.stats = &stats[i];
5434 dpif_operate(ofproto->backer->dpif, opsp, n);
5435 for (i = 0; i < n; i++) {
5436 subfacet_reset_dp_stats(subfacets[i], &stats[i]);
5437 subfacets[i]->path = SF_NOT_INSTALLED;
5438 subfacet_destroy(subfacets[i]);
5443 /* Composes the datapath actions for 'subfacet' based on its rule's actions.
5444 * Translates the actions into 'odp_actions', which the caller must have
5445 * initialized and is responsible for uninitializing. */
5447 subfacet_make_actions(struct subfacet *subfacet, const struct ofpbuf *packet,
5448 struct ofpbuf *odp_actions)
5450 struct facet *facet = subfacet->facet;
5451 struct rule_dpif *rule = facet->rule;
5452 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5454 struct action_xlate_ctx ctx;
5456 action_xlate_ctx_init(&ctx, ofproto, &facet->flow,
5457 &subfacet->initial_vals, rule, 0, packet);
5458 xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, odp_actions);
5459 facet->tags = ctx.tags;
5460 facet->has_learn = ctx.has_learn;
5461 facet->has_normal = ctx.has_normal;
5462 facet->has_fin_timeout = ctx.has_fin_timeout;
5463 facet->nf_flow.output_iface = ctx.nf_output_iface;
5464 facet->mirrors = ctx.mirrors;
5466 subfacet->slow = ctx.slow;
5467 if (subfacet->actions_len != odp_actions->size
5468 || memcmp(subfacet->actions, odp_actions->data, odp_actions->size)) {
5469 free(subfacet->actions);
5470 subfacet->actions_len = odp_actions->size;
5471 subfacet->actions = xmemdup(odp_actions->data, odp_actions->size);
5475 /* Updates 'subfacet''s datapath flow, setting its actions to 'actions_len'
5476 * bytes of actions in 'actions'. If 'stats' is non-null, statistics counters
5477 * in the datapath will be zeroed and 'stats' will be updated with traffic new
5478 * since 'subfacet' was last updated.
5480 * Returns 0 if successful, otherwise a positive errno value. */
5482 subfacet_install(struct subfacet *subfacet,
5483 const struct nlattr *actions, size_t actions_len,
5484 struct dpif_flow_stats *stats,
5485 enum slow_path_reason slow)
5487 struct facet *facet = subfacet->facet;
5488 struct ofproto_dpif *ofproto = ofproto_dpif_cast(facet->rule->up.ofproto);
5489 enum subfacet_path path = subfacet_want_path(slow);
5490 uint64_t slow_path_stub[128 / 8];
5491 enum dpif_flow_put_flags flags;
5494 flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
5496 flags |= DPIF_FP_ZERO_STATS;
5499 if (path == SF_SLOW_PATH) {
5500 compose_slow_path(ofproto, &facet->flow, slow,
5501 slow_path_stub, sizeof slow_path_stub,
5502 &actions, &actions_len);
5505 ret = dpif_flow_put(ofproto->backer->dpif, flags, subfacet->key,
5506 subfacet->key_len, actions, actions_len, stats);
5509 subfacet_reset_dp_stats(subfacet, stats);
5513 subfacet->path = path;
5519 subfacet_reinstall(struct subfacet *subfacet, struct dpif_flow_stats *stats)
5521 return subfacet_install(subfacet, subfacet->actions, subfacet->actions_len,
5522 stats, subfacet->slow);
5525 /* If 'subfacet' is installed in the datapath, uninstalls it. */
5527 subfacet_uninstall(struct subfacet *subfacet)
5529 if (subfacet->path != SF_NOT_INSTALLED) {
5530 struct rule_dpif *rule = subfacet->facet->rule;
5531 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5532 struct dpif_flow_stats stats;
5535 error = dpif_flow_del(ofproto->backer->dpif, subfacet->key,
5536 subfacet->key_len, &stats);
5537 subfacet_reset_dp_stats(subfacet, &stats);
5539 subfacet_update_stats(subfacet, &stats);
5541 subfacet->path = SF_NOT_INSTALLED;
5543 ovs_assert(subfacet->dp_packet_count == 0);
5544 ovs_assert(subfacet->dp_byte_count == 0);
5548 /* Resets 'subfacet''s datapath statistics counters. This should be called
5549 * when 'subfacet''s statistics are cleared in the datapath. If 'stats' is
5550 * non-null, it should contain the statistics returned by dpif when 'subfacet'
5551 * was reset in the datapath. 'stats' will be modified to include only
5552 * statistics new since 'subfacet' was last updated. */
5554 subfacet_reset_dp_stats(struct subfacet *subfacet,
5555 struct dpif_flow_stats *stats)
5558 && subfacet->dp_packet_count <= stats->n_packets
5559 && subfacet->dp_byte_count <= stats->n_bytes) {
5560 stats->n_packets -= subfacet->dp_packet_count;
5561 stats->n_bytes -= subfacet->dp_byte_count;
5564 subfacet->dp_packet_count = 0;
5565 subfacet->dp_byte_count = 0;
5568 /* Updates 'subfacet''s used time. The caller is responsible for calling
5569 * facet_push_stats() to update the flows which 'subfacet' resubmits into. */
5571 subfacet_update_time(struct subfacet *subfacet, long long int used)
5573 if (used > subfacet->used) {
5574 subfacet->used = used;
5575 facet_update_time(subfacet->facet, used);
5579 /* Folds the statistics from 'stats' into the counters in 'subfacet'.
5581 * Because of the meaning of a subfacet's counters, it only makes sense to do
5582 * this if 'stats' are not tracked in the datapath, that is, if 'stats'
5583 * represents a packet that was sent by hand or if it represents statistics
5584 * that have been cleared out of the datapath. */
5586 subfacet_update_stats(struct subfacet *subfacet,
5587 const struct dpif_flow_stats *stats)
5589 if (stats->n_packets || stats->used > subfacet->used) {
5590 struct facet *facet = subfacet->facet;
5592 subfacet_update_time(subfacet, stats->used);
5593 facet->packet_count += stats->n_packets;
5594 facet->byte_count += stats->n_bytes;
5595 facet->tcp_flags |= stats->tcp_flags;
5596 netflow_flow_update_flags(&facet->nf_flow, stats->tcp_flags);
5602 static struct rule_dpif *
5603 rule_dpif_lookup(struct ofproto_dpif *ofproto, const struct flow *flow)
5605 struct rule_dpif *rule;
5607 rule = rule_dpif_lookup__(ofproto, flow, 0);
5612 return rule_dpif_miss_rule(ofproto, flow);
5615 static struct rule_dpif *
5616 rule_dpif_lookup__(struct ofproto_dpif *ofproto, const struct flow *flow,
5619 struct cls_rule *cls_rule;
5620 struct classifier *cls;
5622 if (table_id >= N_TABLES) {
5626 cls = &ofproto->up.tables[table_id].cls;
5627 if (flow->nw_frag & FLOW_NW_FRAG_ANY
5628 && ofproto->up.frag_handling == OFPC_FRAG_NORMAL) {
5629 /* For OFPC_NORMAL frag_handling, we must pretend that transport ports
5630 * are unavailable. */
5631 struct flow ofpc_normal_flow = *flow;
5632 ofpc_normal_flow.tp_src = htons(0);
5633 ofpc_normal_flow.tp_dst = htons(0);
5634 cls_rule = classifier_lookup(cls, &ofpc_normal_flow);
5636 cls_rule = classifier_lookup(cls, flow);
5638 return rule_dpif_cast(rule_from_cls_rule(cls_rule));
5641 static struct rule_dpif *
5642 rule_dpif_miss_rule(struct ofproto_dpif *ofproto, const struct flow *flow)
5644 struct ofport_dpif *port;
5646 port = get_ofp_port(ofproto, flow->in_port);
5648 VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, flow->in_port);
5649 return ofproto->miss_rule;
5652 if (port->up.pp.config & OFPUTIL_PC_NO_PACKET_IN) {
5653 return ofproto->no_packet_in_rule;
5655 return ofproto->miss_rule;
5659 complete_operation(struct rule_dpif *rule)
5661 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5663 rule_invalidate(rule);
5665 struct dpif_completion *c = xmalloc(sizeof *c);
5666 c->op = rule->up.pending;
5667 list_push_back(&ofproto->completions, &c->list_node);
5669 ofoperation_complete(rule->up.pending, 0);
5673 static struct rule *
5676 struct rule_dpif *rule = xmalloc(sizeof *rule);
5681 rule_dealloc(struct rule *rule_)
5683 struct rule_dpif *rule = rule_dpif_cast(rule_);
5688 rule_construct(struct rule *rule_)
5690 struct rule_dpif *rule = rule_dpif_cast(rule_);
5691 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5692 struct rule_dpif *victim;
5695 rule->packet_count = 0;
5696 rule->byte_count = 0;
5698 victim = rule_dpif_cast(ofoperation_get_victim(rule->up.pending));
5699 if (victim && !list_is_empty(&victim->facets)) {
5700 struct facet *facet;
5702 rule->facets = victim->facets;
5703 list_moved(&rule->facets);
5704 LIST_FOR_EACH (facet, list_node, &rule->facets) {
5705 /* XXX: We're only clearing our local counters here. It's possible
5706 * that quite a few packets are unaccounted for in the datapath
5707 * statistics. These will be accounted to the new rule instead of
5708 * cleared as required. This could be fixed by clearing out the
5709 * datapath statistics for this facet, but currently it doesn't
5711 facet_reset_counters(facet);
5715 /* Must avoid list_moved() in this case. */
5716 list_init(&rule->facets);
5719 table_id = rule->up.table_id;
5721 rule->tag = victim->tag;
5722 } else if (table_id == 0) {
5727 miniflow_expand(&rule->up.cr.match.flow, &flow);
5728 rule->tag = rule_calculate_tag(&flow, &rule->up.cr.match.mask,
5729 ofproto->tables[table_id].basis);
5732 complete_operation(rule);
5737 rule_destruct(struct rule *rule_)
5739 struct rule_dpif *rule = rule_dpif_cast(rule_);
5740 struct facet *facet, *next_facet;
5742 LIST_FOR_EACH_SAFE (facet, next_facet, list_node, &rule->facets) {
5743 facet_revalidate(facet);
5746 complete_operation(rule);
5750 rule_get_stats(struct rule *rule_, uint64_t *packets, uint64_t *bytes)
5752 struct rule_dpif *rule = rule_dpif_cast(rule_);
5754 /* push_all_stats() can handle flow misses which, when using the learn
5755 * action, can cause rules to be added and deleted. This can corrupt our
5756 * caller's datastructures which assume that rule_get_stats() doesn't have
5757 * an impact on the flow table. To be safe, we disable miss handling. */
5758 push_all_stats__(false);
5760 /* Start from historical data for 'rule' itself that are no longer tracked
5761 * in facets. This counts, for example, facets that have expired. */
5762 *packets = rule->packet_count;
5763 *bytes = rule->byte_count;
5767 rule_dpif_execute(struct rule_dpif *rule, const struct flow *flow,
5768 struct ofpbuf *packet)
5770 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
5771 struct initial_vals initial_vals;
5772 struct dpif_flow_stats stats;
5773 struct action_xlate_ctx ctx;
5774 uint64_t odp_actions_stub[1024 / 8];
5775 struct ofpbuf odp_actions;
5777 dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
5778 rule_credit_stats(rule, &stats);
5780 initial_vals.vlan_tci = flow->vlan_tci;
5781 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5782 action_xlate_ctx_init(&ctx, ofproto, flow, &initial_vals,
5783 rule, stats.tcp_flags, packet);
5784 ctx.resubmit_stats = &stats;
5785 xlate_actions(&ctx, rule->up.ofpacts, rule->up.ofpacts_len, &odp_actions);
5787 execute_odp_actions(ofproto, flow, odp_actions.data,
5788 odp_actions.size, packet);
5790 ofpbuf_uninit(&odp_actions);
5794 rule_execute(struct rule *rule, const struct flow *flow,
5795 struct ofpbuf *packet)
5797 rule_dpif_execute(rule_dpif_cast(rule), flow, packet);
5798 ofpbuf_delete(packet);
5803 rule_modify_actions(struct rule *rule_)
5805 struct rule_dpif *rule = rule_dpif_cast(rule_);
5807 complete_operation(rule);
5810 /* Sends 'packet' out 'ofport'.
5811 * May modify 'packet'.
5812 * Returns 0 if successful, otherwise a positive errno value. */
5814 send_packet(const struct ofport_dpif *ofport, struct ofpbuf *packet)
5816 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport->up.ofproto);
5817 uint64_t odp_actions_stub[1024 / 8];
5818 struct ofpbuf key, odp_actions;
5819 struct dpif_flow_stats stats;
5820 struct odputil_keybuf keybuf;
5821 struct ofpact_output output;
5822 struct action_xlate_ctx ctx;
5826 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
5827 ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
5829 /* Use OFPP_NONE as the in_port to avoid special packet processing. */
5830 flow_extract(packet, 0, 0, NULL, OFPP_NONE, &flow);
5831 odp_flow_key_from_flow(&key, &flow, ofp_port_to_odp_port(ofproto,
5833 dpif_flow_stats_extract(&flow, packet, time_msec(), &stats);
5835 ofpact_init(&output.ofpact, OFPACT_OUTPUT, sizeof output);
5836 output.port = ofport->up.ofp_port;
5839 action_xlate_ctx_init(&ctx, ofproto, &flow, NULL, NULL, 0, packet);
5840 ctx.resubmit_stats = &stats;
5841 xlate_actions(&ctx, &output.ofpact, sizeof output, &odp_actions);
5843 error = dpif_execute(ofproto->backer->dpif,
5845 odp_actions.data, odp_actions.size,
5847 ofpbuf_uninit(&odp_actions);
5850 VLOG_WARN_RL(&rl, "%s: failed to send packet on port %s (%s)",
5851 ofproto->up.name, netdev_get_name(ofport->up.netdev),
5855 ofproto->stats.tx_packets++;
5856 ofproto->stats.tx_bytes += packet->size;
5860 /* OpenFlow to datapath action translation. */
5862 static bool may_receive(const struct ofport_dpif *, struct action_xlate_ctx *);
5863 static void do_xlate_actions(const struct ofpact *, size_t ofpacts_len,
5864 struct action_xlate_ctx *);
5865 static void xlate_normal(struct action_xlate_ctx *);
5867 /* Composes an ODP action for a "slow path" action for 'flow' within 'ofproto'.
5868 * The action will state 'slow' as the reason that the action is in the slow
5869 * path. (This is purely informational: it allows a human viewing "ovs-dpctl
5870 * dump-flows" output to see why a flow is in the slow path.)
5872 * The 'stub_size' bytes in 'stub' will be used to store the action.
5873 * 'stub_size' must be large enough for the action.
5875 * The action and its size will be stored in '*actionsp' and '*actions_lenp',
5878 compose_slow_path(const struct ofproto_dpif *ofproto, const struct flow *flow,
5879 enum slow_path_reason slow,
5880 uint64_t *stub, size_t stub_size,
5881 const struct nlattr **actionsp, size_t *actions_lenp)
5883 union user_action_cookie cookie;
5886 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
5887 cookie.slow_path.unused = 0;
5888 cookie.slow_path.reason = slow;
5890 ofpbuf_use_stack(&buf, stub, stub_size);
5891 if (slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)) {
5892 uint32_t pid = dpif_port_get_pid(ofproto->backer->dpif, UINT32_MAX);
5893 odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, &buf);
5895 put_userspace_action(ofproto, &buf, flow, &cookie,
5896 sizeof cookie.slow_path);
5898 *actionsp = buf.data;
5899 *actions_lenp = buf.size;
5903 put_userspace_action(const struct ofproto_dpif *ofproto,
5904 struct ofpbuf *odp_actions,
5905 const struct flow *flow,
5906 const union user_action_cookie *cookie,
5907 const size_t cookie_size)
5911 pid = dpif_port_get_pid(ofproto->backer->dpif,
5912 ofp_port_to_odp_port(ofproto, flow->in_port));
5914 return odp_put_userspace_action(pid, cookie, cookie_size, odp_actions);
5917 /* Compose SAMPLE action for sFlow or IPFIX. The given probability is
5918 * the number of packets out of UINT32_MAX to sample. The given
5919 * cookie is passed back in the callback for each sampled packet.
5922 compose_sample_action(const struct ofproto_dpif *ofproto,
5923 struct ofpbuf *odp_actions,
5924 const struct flow *flow,
5925 const uint32_t probability,
5926 const union user_action_cookie *cookie,
5927 const size_t cookie_size)
5929 size_t sample_offset, actions_offset;
5932 sample_offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SAMPLE);
5934 nl_msg_put_u32(odp_actions, OVS_SAMPLE_ATTR_PROBABILITY, probability);
5936 actions_offset = nl_msg_start_nested(odp_actions, OVS_SAMPLE_ATTR_ACTIONS);
5937 cookie_offset = put_userspace_action(ofproto, odp_actions, flow, cookie,
5940 nl_msg_end_nested(odp_actions, actions_offset);
5941 nl_msg_end_nested(odp_actions, sample_offset);
5942 return cookie_offset;
5946 compose_sflow_cookie(const struct ofproto_dpif *ofproto,
5947 ovs_be16 vlan_tci, uint32_t odp_port,
5948 unsigned int n_outputs, union user_action_cookie *cookie)
5952 cookie->type = USER_ACTION_COOKIE_SFLOW;
5953 cookie->sflow.vlan_tci = vlan_tci;
5955 /* See http://www.sflow.org/sflow_version_5.txt (search for "Input/output
5956 * port information") for the interpretation of cookie->output. */
5957 switch (n_outputs) {
5959 /* 0x40000000 | 256 means "packet dropped for unknown reason". */
5960 cookie->sflow.output = 0x40000000 | 256;
5964 ifindex = dpif_sflow_odp_port_to_ifindex(ofproto->sflow, odp_port);
5966 cookie->sflow.output = ifindex;
5971 /* 0x80000000 means "multiple output ports. */
5972 cookie->sflow.output = 0x80000000 | n_outputs;
5977 /* Compose SAMPLE action for sFlow bridge sampling. */
5979 compose_sflow_action(const struct ofproto_dpif *ofproto,
5980 struct ofpbuf *odp_actions,
5981 const struct flow *flow,
5984 uint32_t probability;
5985 union user_action_cookie cookie;
5987 if (!ofproto->sflow || flow->in_port == OFPP_NONE) {
5991 probability = dpif_sflow_get_probability(ofproto->sflow);
5992 compose_sflow_cookie(ofproto, htons(0), odp_port,
5993 odp_port == OVSP_NONE ? 0 : 1, &cookie);
5995 return compose_sample_action(ofproto, odp_actions, flow, probability,
5996 &cookie, sizeof cookie.sflow);
6000 compose_flow_sample_cookie(uint16_t probability, uint32_t collector_set_id,
6001 uint32_t obs_domain_id, uint32_t obs_point_id,
6002 union user_action_cookie *cookie)
6004 cookie->type = USER_ACTION_COOKIE_FLOW_SAMPLE;
6005 cookie->flow_sample.probability = probability;
6006 cookie->flow_sample.collector_set_id = collector_set_id;
6007 cookie->flow_sample.obs_domain_id = obs_domain_id;
6008 cookie->flow_sample.obs_point_id = obs_point_id;
6012 compose_ipfix_cookie(union user_action_cookie *cookie)
6014 cookie->type = USER_ACTION_COOKIE_IPFIX;
6017 /* Compose SAMPLE action for IPFIX bridge sampling. */
6019 compose_ipfix_action(const struct ofproto_dpif *ofproto,
6020 struct ofpbuf *odp_actions,
6021 const struct flow *flow)
6023 uint32_t probability;
6024 union user_action_cookie cookie;
6026 if (!ofproto->ipfix || flow->in_port == OFPP_NONE) {
6030 probability = dpif_ipfix_get_bridge_exporter_probability(ofproto->ipfix);
6031 compose_ipfix_cookie(&cookie);
6033 compose_sample_action(ofproto, odp_actions, flow, probability,
6034 &cookie, sizeof cookie.ipfix);
6037 /* SAMPLE action for sFlow must be first action in any given list of
6038 * actions. At this point we do not have all information required to
6039 * build it. So try to build sample action as complete as possible. */
6041 add_sflow_action(struct action_xlate_ctx *ctx)
6043 ctx->user_cookie_offset = compose_sflow_action(ctx->ofproto,
6045 &ctx->flow, OVSP_NONE);
6046 ctx->sflow_odp_port = 0;
6047 ctx->sflow_n_outputs = 0;
6050 /* SAMPLE action for IPFIX must be 1st or 2nd action in any given list
6051 * of actions, eventually after the SAMPLE action for sFlow. */
6053 add_ipfix_action(struct action_xlate_ctx *ctx)
6055 compose_ipfix_action(ctx->ofproto, ctx->odp_actions, &ctx->flow);
6058 /* Fix SAMPLE action according to data collected while composing ODP actions.
6059 * We need to fix SAMPLE actions OVS_SAMPLE_ATTR_ACTIONS attribute, i.e. nested
6060 * USERSPACE action's user-cookie which is required for sflow. */
6062 fix_sflow_action(struct action_xlate_ctx *ctx)
6064 const struct flow *base = &ctx->base_flow;
6065 union user_action_cookie *cookie;
6067 if (!ctx->user_cookie_offset) {
6071 cookie = ofpbuf_at(ctx->odp_actions, ctx->user_cookie_offset,
6072 sizeof cookie->sflow);
6073 ovs_assert(cookie->type == USER_ACTION_COOKIE_SFLOW);
6075 compose_sflow_cookie(ctx->ofproto, base->vlan_tci,
6076 ctx->sflow_odp_port, ctx->sflow_n_outputs, cookie);
6080 compose_output_action__(struct action_xlate_ctx *ctx, uint16_t ofp_port,
6083 const struct ofport_dpif *ofport = get_ofp_port(ctx->ofproto, ofp_port);
6084 ovs_be16 flow_vlan_tci;
6085 uint32_t flow_skb_mark;
6086 uint8_t flow_nw_tos;
6087 struct priority_to_dscp *pdscp;
6088 uint32_t out_port, odp_port;
6090 /* If 'struct flow' gets additional metadata, we'll need to zero it out
6091 * before traversing a patch port. */
6092 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 20);
6095 xlate_report(ctx, "Nonexistent output port");
6097 } else if (ofport->up.pp.config & OFPUTIL_PC_NO_FWD) {
6098 xlate_report(ctx, "OFPPC_NO_FWD set, skipping output");
6100 } else if (check_stp && !stp_forward_in_state(ofport->stp_state)) {
6101 xlate_report(ctx, "STP not in forwarding state, skipping output");
6105 if (netdev_vport_is_patch(ofport->up.netdev)) {
6106 struct ofport_dpif *peer = ofport_get_peer(ofport);
6107 struct flow old_flow = ctx->flow;
6108 const struct ofproto_dpif *peer_ofproto;
6109 enum slow_path_reason special;
6110 struct ofport_dpif *in_port;
6113 xlate_report(ctx, "Nonexistent patch port peer");
6117 peer_ofproto = ofproto_dpif_cast(peer->up.ofproto);
6118 if (peer_ofproto->backer != ctx->ofproto->backer) {
6119 xlate_report(ctx, "Patch port peer on a different datapath");
6123 ctx->ofproto = ofproto_dpif_cast(peer->up.ofproto);
6124 ctx->flow.in_port = peer->up.ofp_port;
6125 ctx->flow.metadata = htonll(0);
6126 memset(&ctx->flow.tunnel, 0, sizeof ctx->flow.tunnel);
6127 memset(ctx->flow.regs, 0, sizeof ctx->flow.regs);
6129 in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
6130 special = process_special(ctx->ofproto, &ctx->flow, in_port,
6133 ctx->slow |= special;
6134 } else if (!in_port || may_receive(in_port, ctx)) {
6135 if (!in_port || stp_forward_in_state(in_port->stp_state)) {
6136 xlate_table_action(ctx, ctx->flow.in_port, 0, true);
6138 /* Forwarding is disabled by STP. Let OFPP_NORMAL and the
6139 * learning action look at the packet, then drop it. */
6140 struct flow old_base_flow = ctx->base_flow;
6141 size_t old_size = ctx->odp_actions->size;
6142 xlate_table_action(ctx, ctx->flow.in_port, 0, true);
6143 ctx->base_flow = old_base_flow;
6144 ctx->odp_actions->size = old_size;
6148 ctx->flow = old_flow;
6149 ctx->ofproto = ofproto_dpif_cast(ofport->up.ofproto);
6151 if (ctx->resubmit_stats) {
6152 netdev_vport_inc_tx(ofport->up.netdev, ctx->resubmit_stats);
6153 netdev_vport_inc_rx(peer->up.netdev, ctx->resubmit_stats);
6159 flow_vlan_tci = ctx->flow.vlan_tci;
6160 flow_skb_mark = ctx->flow.skb_mark;
6161 flow_nw_tos = ctx->flow.nw_tos;
6163 pdscp = get_priority(ofport, ctx->flow.skb_priority);
6165 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
6166 ctx->flow.nw_tos |= pdscp->dscp;
6169 if (ofport->tnl_port) {
6170 /* Save tunnel metadata so that changes made due to
6171 * the Logical (tunnel) Port are not visible for any further
6172 * matches, while explicit set actions on tunnel metadata are.
6174 struct flow_tnl flow_tnl = ctx->flow.tunnel;
6175 odp_port = tnl_port_send(ofport->tnl_port, &ctx->flow);
6176 if (odp_port == OVSP_NONE) {
6177 xlate_report(ctx, "Tunneling decided against output");
6178 goto out; /* restore flow_nw_tos */
6180 if (ctx->flow.tunnel.ip_dst == ctx->orig_tunnel_ip_dst) {
6181 xlate_report(ctx, "Not tunneling to our own address");
6182 goto out; /* restore flow_nw_tos */
6184 if (ctx->resubmit_stats) {
6185 netdev_vport_inc_tx(ofport->up.netdev, ctx->resubmit_stats);
6187 out_port = odp_port;
6188 commit_odp_tunnel_action(&ctx->flow, &ctx->base_flow,
6190 ctx->flow.tunnel = flow_tnl; /* Restore tunnel metadata */
6192 odp_port = ofport->odp_port;
6193 out_port = vsp_realdev_to_vlandev(ctx->ofproto, odp_port,
6194 ctx->flow.vlan_tci);
6195 if (out_port != odp_port) {
6196 ctx->flow.vlan_tci = htons(0);
6198 ctx->flow.skb_mark &= ~IPSEC_MARK;
6200 commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
6201 nl_msg_put_u32(ctx->odp_actions, OVS_ACTION_ATTR_OUTPUT, out_port);
6203 ctx->sflow_odp_port = odp_port;
6204 ctx->sflow_n_outputs++;
6205 ctx->nf_output_iface = ofp_port;
6208 ctx->flow.vlan_tci = flow_vlan_tci;
6209 ctx->flow.skb_mark = flow_skb_mark;
6211 ctx->flow.nw_tos = flow_nw_tos;
6215 compose_output_action(struct action_xlate_ctx *ctx, uint16_t ofp_port)
6217 compose_output_action__(ctx, ofp_port, true);
6221 tag_the_flow(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
6223 struct ofproto_dpif *ofproto = ctx->ofproto;
6224 uint8_t table_id = ctx->table_id;
6226 if (table_id > 0 && table_id < N_TABLES) {
6227 struct table_dpif *table = &ofproto->tables[table_id];
6228 if (table->other_table) {
6229 ctx->tags |= (rule && rule->tag
6231 : rule_calculate_tag(&ctx->flow,
6232 &table->other_table->mask,
6238 /* Common rule processing in one place to avoid duplicating code. */
6239 static struct rule_dpif *
6240 ctx_rule_hooks(struct action_xlate_ctx *ctx, struct rule_dpif *rule,
6243 if (ctx->resubmit_hook) {
6244 ctx->resubmit_hook(ctx, rule);
6246 if (rule == NULL && may_packet_in) {
6248 * check if table configuration flags
6249 * OFPTC_TABLE_MISS_CONTROLLER, default.
6250 * OFPTC_TABLE_MISS_CONTINUE,
6251 * OFPTC_TABLE_MISS_DROP
6252 * When OF1.0, OFPTC_TABLE_MISS_CONTINUE is used. What to do?
6254 rule = rule_dpif_miss_rule(ctx->ofproto, &ctx->flow);
6256 if (rule && ctx->resubmit_stats) {
6257 rule_credit_stats(rule, ctx->resubmit_stats);
6263 xlate_table_action(struct action_xlate_ctx *ctx,
6264 uint16_t in_port, uint8_t table_id, bool may_packet_in)
6266 if (ctx->recurse < MAX_RESUBMIT_RECURSION) {
6267 struct rule_dpif *rule;
6268 uint16_t old_in_port = ctx->flow.in_port;
6269 uint8_t old_table_id = ctx->table_id;
6271 ctx->table_id = table_id;
6273 /* Look up a flow with 'in_port' as the input port. */
6274 ctx->flow.in_port = in_port;
6275 rule = rule_dpif_lookup__(ctx->ofproto, &ctx->flow, table_id);
6277 tag_the_flow(ctx, rule);
6279 /* Restore the original input port. Otherwise OFPP_NORMAL and
6280 * OFPP_IN_PORT will have surprising behavior. */
6281 ctx->flow.in_port = old_in_port;
6283 rule = ctx_rule_hooks(ctx, rule, may_packet_in);
6286 struct rule_dpif *old_rule = ctx->rule;
6290 do_xlate_actions(rule->up.ofpacts, rule->up.ofpacts_len, ctx);
6291 ctx->rule = old_rule;
6295 ctx->table_id = old_table_id;
6297 static struct vlog_rate_limit recurse_rl = VLOG_RATE_LIMIT_INIT(1, 1);
6299 VLOG_ERR_RL(&recurse_rl, "resubmit actions recursed over %d times",
6300 MAX_RESUBMIT_RECURSION);
6301 ctx->max_resubmit_trigger = true;
6306 xlate_ofpact_resubmit(struct action_xlate_ctx *ctx,
6307 const struct ofpact_resubmit *resubmit)
6312 in_port = resubmit->in_port;
6313 if (in_port == OFPP_IN_PORT) {
6314 in_port = ctx->flow.in_port;
6317 table_id = resubmit->table_id;
6318 if (table_id == 255) {
6319 table_id = ctx->table_id;
6322 xlate_table_action(ctx, in_port, table_id, false);
6326 flood_packets(struct action_xlate_ctx *ctx, bool all)
6328 struct ofport_dpif *ofport;
6330 HMAP_FOR_EACH (ofport, up.hmap_node, &ctx->ofproto->up.ports) {
6331 uint16_t ofp_port = ofport->up.ofp_port;
6333 if (ofp_port == ctx->flow.in_port) {
6338 compose_output_action__(ctx, ofp_port, false);
6339 } else if (!(ofport->up.pp.config & OFPUTIL_PC_NO_FLOOD)) {
6340 compose_output_action(ctx, ofp_port);
6344 ctx->nf_output_iface = NF_OUT_FLOOD;
6348 execute_controller_action(struct action_xlate_ctx *ctx, int len,
6349 enum ofp_packet_in_reason reason,
6350 uint16_t controller_id)
6352 struct ofputil_packet_in pin;
6353 struct ofpbuf *packet;
6355 ctx->slow |= SLOW_CONTROLLER;
6360 packet = ofpbuf_clone(ctx->packet);
6362 if (packet->l2 && packet->l3) {
6363 struct eth_header *eh;
6364 uint16_t mpls_depth;
6366 eth_pop_vlan(packet);
6369 memcpy(eh->eth_src, ctx->flow.dl_src, sizeof eh->eth_src);
6370 memcpy(eh->eth_dst, ctx->flow.dl_dst, sizeof eh->eth_dst);
6372 if (ctx->flow.vlan_tci & htons(VLAN_CFI)) {
6373 eth_push_vlan(packet, ctx->flow.vlan_tci);
6376 mpls_depth = eth_mpls_depth(packet);
6378 if (mpls_depth < ctx->flow.mpls_depth) {
6379 push_mpls(packet, ctx->flow.dl_type, ctx->flow.mpls_lse);
6380 } else if (mpls_depth > ctx->flow.mpls_depth) {
6381 pop_mpls(packet, ctx->flow.dl_type);
6382 } else if (mpls_depth) {
6383 set_mpls_lse(packet, ctx->flow.mpls_lse);
6387 if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6388 packet_set_ipv4(packet, ctx->flow.nw_src, ctx->flow.nw_dst,
6389 ctx->flow.nw_tos, ctx->flow.nw_ttl);
6393 if (ctx->flow.nw_proto == IPPROTO_TCP) {
6394 packet_set_tcp_port(packet, ctx->flow.tp_src,
6396 } else if (ctx->flow.nw_proto == IPPROTO_UDP) {
6397 packet_set_udp_port(packet, ctx->flow.tp_src,
6404 pin.packet = packet->data;
6405 pin.packet_len = packet->size;
6406 pin.reason = reason;
6407 pin.controller_id = controller_id;
6408 pin.table_id = ctx->table_id;
6409 pin.cookie = ctx->rule ? ctx->rule->up.flow_cookie : 0;
6412 flow_get_metadata(&ctx->flow, &pin.fmd);
6414 connmgr_send_packet_in(ctx->ofproto->up.connmgr, &pin);
6415 ofpbuf_delete(packet);
6419 execute_mpls_push_action(struct action_xlate_ctx *ctx, ovs_be16 eth_type)
6421 ovs_assert(eth_type_mpls(eth_type));
6423 if (ctx->base_flow.mpls_depth) {
6424 ctx->flow.mpls_lse &= ~htonl(MPLS_BOS_MASK);
6425 ctx->flow.mpls_depth++;
6430 if (ctx->flow.dl_type == htons(ETH_TYPE_IPV6)) {
6431 label = htonl(0x2); /* IPV6 Explicit Null. */
6433 label = htonl(0x0); /* IPV4 Explicit Null. */
6435 tc = (ctx->flow.nw_tos & IP_DSCP_MASK) >> 2;
6436 ttl = ctx->flow.nw_ttl ? ctx->flow.nw_ttl : 0x40;
6437 ctx->flow.mpls_lse = set_mpls_lse_values(ttl, tc, 1, label);
6438 ctx->flow.mpls_depth = 1;
6440 ctx->flow.dl_type = eth_type;
6444 execute_mpls_pop_action(struct action_xlate_ctx *ctx, ovs_be16 eth_type)
6446 ovs_assert(eth_type_mpls(ctx->flow.dl_type));
6447 ovs_assert(!eth_type_mpls(eth_type));
6449 if (ctx->flow.mpls_depth) {
6450 ctx->flow.mpls_depth--;
6451 ctx->flow.mpls_lse = htonl(0);
6452 if (!ctx->flow.mpls_depth) {
6453 ctx->flow.dl_type = eth_type;
6459 compose_dec_ttl(struct action_xlate_ctx *ctx, struct ofpact_cnt_ids *ids)
6461 if (ctx->flow.dl_type != htons(ETH_TYPE_IP) &&
6462 ctx->flow.dl_type != htons(ETH_TYPE_IPV6)) {
6466 if (ctx->flow.nw_ttl > 1) {
6472 for (i = 0; i < ids->n_controllers; i++) {
6473 execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL,
6477 /* Stop processing for current table. */
6483 execute_set_mpls_ttl_action(struct action_xlate_ctx *ctx, uint8_t ttl)
6485 if (!eth_type_mpls(ctx->flow.dl_type)) {
6489 set_mpls_lse_ttl(&ctx->flow.mpls_lse, ttl);
6494 execute_dec_mpls_ttl_action(struct action_xlate_ctx *ctx)
6496 uint8_t ttl = mpls_lse_to_ttl(ctx->flow.mpls_lse);
6498 if (!eth_type_mpls(ctx->flow.dl_type)) {
6504 set_mpls_lse_ttl(&ctx->flow.mpls_lse, ttl);
6507 execute_controller_action(ctx, UINT16_MAX, OFPR_INVALID_TTL, 0);
6509 /* Stop processing for current table. */
6515 xlate_output_action(struct action_xlate_ctx *ctx,
6516 uint16_t port, uint16_t max_len, bool may_packet_in)
6518 uint16_t prev_nf_output_iface = ctx->nf_output_iface;
6520 ctx->nf_output_iface = NF_OUT_DROP;
6524 compose_output_action(ctx, ctx->flow.in_port);
6527 xlate_table_action(ctx, ctx->flow.in_port, 0, may_packet_in);
6533 flood_packets(ctx, false);
6536 flood_packets(ctx, true);
6538 case OFPP_CONTROLLER:
6539 execute_controller_action(ctx, max_len, OFPR_ACTION, 0);
6545 if (port != ctx->flow.in_port) {
6546 compose_output_action(ctx, port);
6548 xlate_report(ctx, "skipping output to input port");
6553 if (prev_nf_output_iface == NF_OUT_FLOOD) {
6554 ctx->nf_output_iface = NF_OUT_FLOOD;
6555 } else if (ctx->nf_output_iface == NF_OUT_DROP) {
6556 ctx->nf_output_iface = prev_nf_output_iface;
6557 } else if (prev_nf_output_iface != NF_OUT_DROP &&
6558 ctx->nf_output_iface != NF_OUT_FLOOD) {
6559 ctx->nf_output_iface = NF_OUT_MULTI;
6564 xlate_output_reg_action(struct action_xlate_ctx *ctx,
6565 const struct ofpact_output_reg *or)
6567 uint64_t port = mf_get_subfield(&or->src, &ctx->flow);
6568 if (port <= UINT16_MAX) {
6569 xlate_output_action(ctx, port, or->max_len, false);
6574 xlate_enqueue_action(struct action_xlate_ctx *ctx,
6575 const struct ofpact_enqueue *enqueue)
6577 uint16_t ofp_port = enqueue->port;
6578 uint32_t queue_id = enqueue->queue;
6579 uint32_t flow_priority, priority;
6582 /* Translate queue to priority. */
6583 error = dpif_queue_to_priority(ctx->ofproto->backer->dpif,
6584 queue_id, &priority);
6586 /* Fall back to ordinary output action. */
6587 xlate_output_action(ctx, enqueue->port, 0, false);
6591 /* Check output port. */
6592 if (ofp_port == OFPP_IN_PORT) {
6593 ofp_port = ctx->flow.in_port;
6594 } else if (ofp_port == ctx->flow.in_port) {
6598 /* Add datapath actions. */
6599 flow_priority = ctx->flow.skb_priority;
6600 ctx->flow.skb_priority = priority;
6601 compose_output_action(ctx, ofp_port);
6602 ctx->flow.skb_priority = flow_priority;
6604 /* Update NetFlow output port. */
6605 if (ctx->nf_output_iface == NF_OUT_DROP) {
6606 ctx->nf_output_iface = ofp_port;
6607 } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
6608 ctx->nf_output_iface = NF_OUT_MULTI;
6613 xlate_set_queue_action(struct action_xlate_ctx *ctx, uint32_t queue_id)
6615 uint32_t skb_priority;
6617 if (!dpif_queue_to_priority(ctx->ofproto->backer->dpif,
6618 queue_id, &skb_priority)) {
6619 ctx->flow.skb_priority = skb_priority;
6621 /* Couldn't translate queue to a priority. Nothing to do. A warning
6622 * has already been logged. */
6627 slave_enabled_cb(uint16_t ofp_port, void *ofproto_)
6629 struct ofproto_dpif *ofproto = ofproto_;
6630 struct ofport_dpif *port;
6640 case OFPP_CONTROLLER: /* Not supported by the bundle action. */
6643 port = get_ofp_port(ofproto, ofp_port);
6644 return port ? port->may_enable : false;
6649 xlate_bundle_action(struct action_xlate_ctx *ctx,
6650 const struct ofpact_bundle *bundle)
6654 port = bundle_execute(bundle, &ctx->flow, slave_enabled_cb, ctx->ofproto);
6655 if (bundle->dst.field) {
6656 nxm_reg_load(&bundle->dst, port, &ctx->flow);
6658 xlate_output_action(ctx, port, 0, false);
6663 xlate_learn_action(struct action_xlate_ctx *ctx,
6664 const struct ofpact_learn *learn)
6666 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 1);
6667 struct ofputil_flow_mod fm;
6668 uint64_t ofpacts_stub[1024 / 8];
6669 struct ofpbuf ofpacts;
6672 ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
6673 learn_execute(learn, &ctx->flow, &fm, &ofpacts);
6675 error = ofproto_flow_mod(&ctx->ofproto->up, &fm);
6676 if (error && !VLOG_DROP_WARN(&rl)) {
6677 VLOG_WARN("learning action failed to modify flow table (%s)",
6678 ofperr_get_name(error));
6681 ofpbuf_uninit(&ofpacts);
6684 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
6685 * means "infinite". */
6687 reduce_timeout(uint16_t max, uint16_t *timeout)
6689 if (max && (!*timeout || *timeout > max)) {
6695 xlate_fin_timeout(struct action_xlate_ctx *ctx,
6696 const struct ofpact_fin_timeout *oft)
6698 if (ctx->tcp_flags & (TCP_FIN | TCP_RST) && ctx->rule) {
6699 struct rule_dpif *rule = ctx->rule;
6701 reduce_timeout(oft->fin_idle_timeout, &rule->up.idle_timeout);
6702 reduce_timeout(oft->fin_hard_timeout, &rule->up.hard_timeout);
6707 xlate_sample_action(struct action_xlate_ctx *ctx,
6708 const struct ofpact_sample *os)
6710 union user_action_cookie cookie;
6711 /* Scale the probability from 16-bit to 32-bit while representing
6712 * the same percentage. */
6713 uint32_t probability = (os->probability << 16) | os->probability;
6715 commit_odp_actions(&ctx->flow, &ctx->base_flow, ctx->odp_actions);
6717 compose_flow_sample_cookie(os->probability, os->collector_set_id,
6718 os->obs_domain_id, os->obs_point_id, &cookie);
6719 compose_sample_action(ctx->ofproto, ctx->odp_actions, &ctx->flow,
6720 probability, &cookie, sizeof cookie.flow_sample);
6724 may_receive(const struct ofport_dpif *port, struct action_xlate_ctx *ctx)
6726 if (port->up.pp.config & (eth_addr_equals(ctx->flow.dl_dst, eth_addr_stp)
6727 ? OFPUTIL_PC_NO_RECV_STP
6728 : OFPUTIL_PC_NO_RECV)) {
6732 /* Only drop packets here if both forwarding and learning are
6733 * disabled. If just learning is enabled, we need to have
6734 * OFPP_NORMAL and the learning action have a look at the packet
6735 * before we can drop it. */
6736 if (!stp_forward_in_state(port->stp_state)
6737 && !stp_learn_in_state(port->stp_state)) {
6745 tunnel_ecn_ok(struct action_xlate_ctx *ctx)
6747 if (is_ip_any(&ctx->base_flow)
6748 && (ctx->flow.tunnel.ip_tos & IP_ECN_MASK) == IP_ECN_CE) {
6749 if ((ctx->base_flow.nw_tos & IP_ECN_MASK) == IP_ECN_NOT_ECT) {
6750 VLOG_WARN_RL(&rl, "dropping tunnel packet marked ECN CE"
6751 " but is not ECN capable");
6754 /* Set the ECN CE value in the tunneled packet. */
6755 ctx->flow.nw_tos |= IP_ECN_CE;
6763 do_xlate_actions(const struct ofpact *ofpacts, size_t ofpacts_len,
6764 struct action_xlate_ctx *ctx)
6766 bool was_evictable = true;
6767 const struct ofpact *a;
6770 /* Don't let the rule we're working on get evicted underneath us. */
6771 was_evictable = ctx->rule->up.evictable;
6772 ctx->rule->up.evictable = false;
6775 do_xlate_actions_again:
6776 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
6777 struct ofpact_controller *controller;
6778 const struct ofpact_metadata *metadata;
6786 xlate_output_action(ctx, ofpact_get_OUTPUT(a)->port,
6787 ofpact_get_OUTPUT(a)->max_len, true);
6790 case OFPACT_CONTROLLER:
6791 controller = ofpact_get_CONTROLLER(a);
6792 execute_controller_action(ctx, controller->max_len,
6794 controller->controller_id);
6797 case OFPACT_ENQUEUE:
6798 xlate_enqueue_action(ctx, ofpact_get_ENQUEUE(a));
6801 case OFPACT_SET_VLAN_VID:
6802 ctx->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
6803 ctx->flow.vlan_tci |= (htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid)
6807 case OFPACT_SET_VLAN_PCP:
6808 ctx->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
6809 ctx->flow.vlan_tci |= htons((ofpact_get_SET_VLAN_PCP(a)->vlan_pcp
6814 case OFPACT_STRIP_VLAN:
6815 ctx->flow.vlan_tci = htons(0);
6818 case OFPACT_PUSH_VLAN:
6819 /* XXX 802.1AD(QinQ) */
6820 ctx->flow.vlan_tci = htons(VLAN_CFI);
6823 case OFPACT_SET_ETH_SRC:
6824 memcpy(ctx->flow.dl_src, ofpact_get_SET_ETH_SRC(a)->mac,
6828 case OFPACT_SET_ETH_DST:
6829 memcpy(ctx->flow.dl_dst, ofpact_get_SET_ETH_DST(a)->mac,
6833 case OFPACT_SET_IPV4_SRC:
6834 if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6835 ctx->flow.nw_src = ofpact_get_SET_IPV4_SRC(a)->ipv4;
6839 case OFPACT_SET_IPV4_DST:
6840 if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6841 ctx->flow.nw_dst = ofpact_get_SET_IPV4_DST(a)->ipv4;
6845 case OFPACT_SET_IPV4_DSCP:
6846 /* OpenFlow 1.0 only supports IPv4. */
6847 if (ctx->flow.dl_type == htons(ETH_TYPE_IP)) {
6848 ctx->flow.nw_tos &= ~IP_DSCP_MASK;
6849 ctx->flow.nw_tos |= ofpact_get_SET_IPV4_DSCP(a)->dscp;
6853 case OFPACT_SET_L4_SRC_PORT:
6854 if (is_ip_any(&ctx->flow)) {
6855 ctx->flow.tp_src = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
6859 case OFPACT_SET_L4_DST_PORT:
6860 if (is_ip_any(&ctx->flow)) {
6861 ctx->flow.tp_dst = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
6865 case OFPACT_RESUBMIT:
6866 xlate_ofpact_resubmit(ctx, ofpact_get_RESUBMIT(a));
6869 case OFPACT_SET_TUNNEL:
6870 ctx->flow.tunnel.tun_id = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
6873 case OFPACT_SET_QUEUE:
6874 xlate_set_queue_action(ctx, ofpact_get_SET_QUEUE(a)->queue_id);
6877 case OFPACT_POP_QUEUE:
6878 ctx->flow.skb_priority = ctx->orig_skb_priority;
6881 case OFPACT_REG_MOVE:
6882 nxm_execute_reg_move(ofpact_get_REG_MOVE(a), &ctx->flow);
6885 case OFPACT_REG_LOAD:
6886 nxm_execute_reg_load(ofpact_get_REG_LOAD(a), &ctx->flow);
6889 case OFPACT_STACK_PUSH:
6890 nxm_execute_stack_push(ofpact_get_STACK_PUSH(a), &ctx->flow,
6894 case OFPACT_STACK_POP:
6895 nxm_execute_stack_pop(ofpact_get_STACK_POP(a), &ctx->flow,
6899 case OFPACT_PUSH_MPLS:
6900 execute_mpls_push_action(ctx, ofpact_get_PUSH_MPLS(a)->ethertype);
6903 case OFPACT_POP_MPLS:
6904 execute_mpls_pop_action(ctx, ofpact_get_POP_MPLS(a)->ethertype);
6907 case OFPACT_SET_MPLS_TTL:
6908 if (execute_set_mpls_ttl_action(ctx, ofpact_get_SET_MPLS_TTL(a)->ttl)) {
6913 case OFPACT_DEC_MPLS_TTL:
6914 if (execute_dec_mpls_ttl_action(ctx)) {
6919 case OFPACT_DEC_TTL:
6920 if (compose_dec_ttl(ctx, ofpact_get_DEC_TTL(a))) {
6926 /* Nothing to do. */
6929 case OFPACT_MULTIPATH:
6930 multipath_execute(ofpact_get_MULTIPATH(a), &ctx->flow);
6934 ctx->ofproto->has_bundle_action = true;
6935 xlate_bundle_action(ctx, ofpact_get_BUNDLE(a));
6938 case OFPACT_OUTPUT_REG:
6939 xlate_output_reg_action(ctx, ofpact_get_OUTPUT_REG(a));
6943 ctx->has_learn = true;
6944 if (ctx->may_learn) {
6945 xlate_learn_action(ctx, ofpact_get_LEARN(a));
6953 case OFPACT_FIN_TIMEOUT:
6954 ctx->has_fin_timeout = true;
6955 xlate_fin_timeout(ctx, ofpact_get_FIN_TIMEOUT(a));
6958 case OFPACT_CLEAR_ACTIONS:
6960 * Nothing to do because writa-actions is not supported for now.
6961 * When writa-actions is supported, clear-actions also must
6962 * be supported at the same time.
6966 case OFPACT_WRITE_METADATA:
6967 metadata = ofpact_get_WRITE_METADATA(a);
6968 ctx->flow.metadata &= ~metadata->mask;
6969 ctx->flow.metadata |= metadata->metadata & metadata->mask;
6972 case OFPACT_GOTO_TABLE: {
6973 /* It is assumed that goto-table is the last action. */
6974 struct ofpact_goto_table *ogt = ofpact_get_GOTO_TABLE(a);
6975 struct rule_dpif *rule;
6977 ovs_assert(ctx->table_id < ogt->table_id);
6979 ctx->table_id = ogt->table_id;
6981 /* Look up a flow from the new table. */
6982 rule = rule_dpif_lookup__(ctx->ofproto, &ctx->flow, ctx->table_id);
6984 tag_the_flow(ctx, rule);
6986 rule = ctx_rule_hooks(ctx, rule, true);
6990 ctx->rule->up.evictable = was_evictable;
6993 was_evictable = rule->up.evictable;
6994 rule->up.evictable = false;
6996 /* Tail recursion removal. */
6997 ofpacts = rule->up.ofpacts;
6998 ofpacts_len = rule->up.ofpacts_len;
6999 goto do_xlate_actions_again;
7005 xlate_sample_action(ctx, ofpact_get_SAMPLE(a));
7012 ctx->rule->up.evictable = was_evictable;
7017 action_xlate_ctx_init(struct action_xlate_ctx *ctx,
7018 struct ofproto_dpif *ofproto, const struct flow *flow,
7019 const struct initial_vals *initial_vals,
7020 struct rule_dpif *rule,
7021 uint8_t tcp_flags, const struct ofpbuf *packet)
7023 /* Flow initialization rules:
7024 * - 'base_flow' must match the kernel's view of the packet at the
7025 * time that action processing starts. 'flow' represents any
7026 * transformations we wish to make through actions.
7027 * - By default 'base_flow' and 'flow' are the same since the input
7028 * packet matches the output before any actions are applied.
7029 * - When using VLAN splinters, 'base_flow''s VLAN is set to the value
7030 * of the received packet as seen by the kernel. If we later output
7031 * to another device without any modifications this will cause us to
7032 * insert a new tag since the original one was stripped off by the
7034 * - Tunnel metadata as received is retained in 'flow'. This allows
7035 * tunnel metadata matching also in later tables.
7036 * Since a kernel action for setting the tunnel metadata will only be
7037 * generated with actual tunnel output, changing the tunnel metadata
7038 * values in 'flow' (such as tun_id) will only have effect with a later
7039 * tunnel output action.
7040 * - Tunnel 'base_flow' is completely cleared since that is what the
7041 * kernel does. If we wish to maintain the original values an action
7042 * needs to be generated. */
7044 ctx->ofproto = ofproto;
7046 ctx->base_flow = ctx->flow;
7047 memset(&ctx->base_flow.tunnel, 0, sizeof ctx->base_flow.tunnel);
7048 ctx->orig_tunnel_ip_dst = flow->tunnel.ip_dst;
7050 ctx->packet = packet;
7051 ctx->may_learn = packet != NULL;
7052 ctx->tcp_flags = tcp_flags;
7053 ctx->resubmit_hook = NULL;
7054 ctx->report_hook = NULL;
7055 ctx->resubmit_stats = NULL;
7058 ctx->base_flow.vlan_tci = initial_vals->vlan_tci;
7062 /* Translates the 'ofpacts_len' bytes of "struct ofpacts" starting at 'ofpacts'
7063 * into datapath actions in 'odp_actions', using 'ctx'. */
7065 xlate_actions(struct action_xlate_ctx *ctx,
7066 const struct ofpact *ofpacts, size_t ofpacts_len,
7067 struct ofpbuf *odp_actions)
7069 /* Normally false. Set to true if we ever hit MAX_RESUBMIT_RECURSION, so
7070 * that in the future we always keep a copy of the original flow for
7071 * tracing purposes. */
7072 static bool hit_resubmit_limit;
7074 enum slow_path_reason special;
7075 struct ofport_dpif *in_port;
7076 struct flow orig_flow;
7078 COVERAGE_INC(ofproto_dpif_xlate);
7080 ofpbuf_clear(odp_actions);
7081 ofpbuf_reserve(odp_actions, NL_A_U32_SIZE);
7083 ctx->odp_actions = odp_actions;
7086 ctx->has_learn = false;
7087 ctx->has_normal = false;
7088 ctx->has_fin_timeout = false;
7089 ctx->nf_output_iface = NF_OUT_DROP;
7092 ctx->max_resubmit_trigger = false;
7093 ctx->orig_skb_priority = ctx->flow.skb_priority;
7097 ofpbuf_use_stub(&ctx->stack, ctx->init_stack, sizeof ctx->init_stack);
7099 if (ctx->ofproto->has_mirrors || hit_resubmit_limit) {
7100 /* Do this conditionally because the copy is expensive enough that it
7101 * shows up in profiles. */
7102 orig_flow = ctx->flow;
7105 if (ctx->flow.nw_frag & FLOW_NW_FRAG_ANY) {
7106 switch (ctx->ofproto->up.frag_handling) {
7107 case OFPC_FRAG_NORMAL:
7108 /* We must pretend that transport ports are unavailable. */
7109 ctx->flow.tp_src = ctx->base_flow.tp_src = htons(0);
7110 ctx->flow.tp_dst = ctx->base_flow.tp_dst = htons(0);
7113 case OFPC_FRAG_DROP:
7116 case OFPC_FRAG_REASM:
7119 case OFPC_FRAG_NX_MATCH:
7120 /* Nothing to do. */
7123 case OFPC_INVALID_TTL_TO_CONTROLLER:
7128 in_port = get_ofp_port(ctx->ofproto, ctx->flow.in_port);
7129 special = process_special(ctx->ofproto, &ctx->flow, in_port, ctx->packet);
7131 ctx->slow |= special;
7133 static struct vlog_rate_limit trace_rl = VLOG_RATE_LIMIT_INIT(1, 1);
7134 struct initial_vals initial_vals;
7135 size_t sample_actions_len;
7136 uint32_t local_odp_port;
7138 initial_vals.vlan_tci = ctx->base_flow.vlan_tci;
7140 add_sflow_action(ctx);
7141 add_ipfix_action(ctx);
7142 sample_actions_len = ctx->odp_actions->size;
7144 if (tunnel_ecn_ok(ctx) && (!in_port || may_receive(in_port, ctx))) {
7145 do_xlate_actions(ofpacts, ofpacts_len, ctx);
7147 /* We've let OFPP_NORMAL and the learning action look at the
7148 * packet, so drop it now if forwarding is disabled. */
7149 if (in_port && !stp_forward_in_state(in_port->stp_state)) {
7150 ctx->odp_actions->size = sample_actions_len;
7154 if (ctx->max_resubmit_trigger && !ctx->resubmit_hook) {
7155 if (!hit_resubmit_limit) {
7156 /* We didn't record the original flow. Make sure we do from
7158 hit_resubmit_limit = true;
7159 } else if (!VLOG_DROP_ERR(&trace_rl)) {
7160 struct ds ds = DS_EMPTY_INITIALIZER;
7162 ofproto_trace(ctx->ofproto, &orig_flow, ctx->packet,
7163 &initial_vals, &ds);
7164 VLOG_ERR("Trace triggered by excessive resubmit "
7165 "recursion:\n%s", ds_cstr(&ds));
7170 local_odp_port = ofp_port_to_odp_port(ctx->ofproto, OFPP_LOCAL);
7171 if (!connmgr_may_set_up_flow(ctx->ofproto->up.connmgr, &ctx->flow,
7173 ctx->odp_actions->data,
7174 ctx->odp_actions->size)) {
7175 ctx->slow |= SLOW_IN_BAND;
7177 && connmgr_msg_in_hook(ctx->ofproto->up.connmgr, &ctx->flow,
7179 compose_output_action(ctx, OFPP_LOCAL);
7182 if (ctx->ofproto->has_mirrors) {
7183 add_mirror_actions(ctx, &orig_flow);
7185 fix_sflow_action(ctx);
7188 ofpbuf_uninit(&ctx->stack);
7191 /* Translates the 'ofpacts_len' bytes of "struct ofpact"s starting at 'ofpacts'
7192 * into datapath actions, using 'ctx', and discards the datapath actions. */
7194 xlate_actions_for_side_effects(struct action_xlate_ctx *ctx,
7195 const struct ofpact *ofpacts,
7198 uint64_t odp_actions_stub[1024 / 8];
7199 struct ofpbuf odp_actions;
7201 ofpbuf_use_stub(&odp_actions, odp_actions_stub, sizeof odp_actions_stub);
7202 xlate_actions(ctx, ofpacts, ofpacts_len, &odp_actions);
7203 ofpbuf_uninit(&odp_actions);
7207 xlate_report(struct action_xlate_ctx *ctx, const char *s)
7209 if (ctx->report_hook) {
7210 ctx->report_hook(ctx, s);
7214 /* OFPP_NORMAL implementation. */
7216 static struct ofport_dpif *ofbundle_get_a_port(const struct ofbundle *);
7218 /* Given 'vid', the VID obtained from the 802.1Q header that was received as
7219 * part of a packet (specify 0 if there was no 802.1Q header), and 'in_bundle',
7220 * the bundle on which the packet was received, returns the VLAN to which the
7223 * Both 'vid' and the return value are in the range 0...4095. */
7225 input_vid_to_vlan(const struct ofbundle *in_bundle, uint16_t vid)
7227 switch (in_bundle->vlan_mode) {
7228 case PORT_VLAN_ACCESS:
7229 return in_bundle->vlan;
7232 case PORT_VLAN_TRUNK:
7235 case PORT_VLAN_NATIVE_UNTAGGED:
7236 case PORT_VLAN_NATIVE_TAGGED:
7237 return vid ? vid : in_bundle->vlan;
7244 /* Checks whether a packet with the given 'vid' may ingress on 'in_bundle'.
7245 * If so, returns true. Otherwise, returns false and, if 'warn' is true, logs
7248 * 'vid' should be the VID obtained from the 802.1Q header that was received as
7249 * part of a packet (specify 0 if there was no 802.1Q header), in the range
7252 input_vid_is_valid(uint16_t vid, struct ofbundle *in_bundle, bool warn)
7254 /* Allow any VID on the OFPP_NONE port. */
7255 if (in_bundle == &ofpp_none_bundle) {
7259 switch (in_bundle->vlan_mode) {
7260 case PORT_VLAN_ACCESS:
7263 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7264 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
7265 "packet received on port %s configured as VLAN "
7266 "%"PRIu16" access port",
7267 in_bundle->ofproto->up.name, vid,
7268 in_bundle->name, in_bundle->vlan);
7274 case PORT_VLAN_NATIVE_UNTAGGED:
7275 case PORT_VLAN_NATIVE_TAGGED:
7277 /* Port must always carry its native VLAN. */
7281 case PORT_VLAN_TRUNK:
7282 if (!ofbundle_includes_vlan(in_bundle, vid)) {
7284 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7285 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" packet "
7286 "received on port %s not configured for trunking "
7288 in_bundle->ofproto->up.name, vid,
7289 in_bundle->name, vid);
7301 /* Given 'vlan', the VLAN that a packet belongs to, and
7302 * 'out_bundle', a bundle on which the packet is to be output, returns the VID
7303 * that should be included in the 802.1Q header. (If the return value is 0,
7304 * then the 802.1Q header should only be included in the packet if there is a
7307 * Both 'vlan' and the return value are in the range 0...4095. */
7309 output_vlan_to_vid(const struct ofbundle *out_bundle, uint16_t vlan)
7311 switch (out_bundle->vlan_mode) {
7312 case PORT_VLAN_ACCESS:
7315 case PORT_VLAN_TRUNK:
7316 case PORT_VLAN_NATIVE_TAGGED:
7319 case PORT_VLAN_NATIVE_UNTAGGED:
7320 return vlan == out_bundle->vlan ? 0 : vlan;
7328 output_normal(struct action_xlate_ctx *ctx, const struct ofbundle *out_bundle,
7331 struct ofport_dpif *port;
7333 ovs_be16 tci, old_tci;
7335 vid = output_vlan_to_vid(out_bundle, vlan);
7336 if (!out_bundle->bond) {
7337 port = ofbundle_get_a_port(out_bundle);
7339 port = bond_choose_output_slave(out_bundle->bond, &ctx->flow,
7342 /* No slaves enabled, so drop packet. */
7347 old_tci = ctx->flow.vlan_tci;
7349 if (tci || out_bundle->use_priority_tags) {
7350 tci |= ctx->flow.vlan_tci & htons(VLAN_PCP_MASK);
7352 tci |= htons(VLAN_CFI);
7355 ctx->flow.vlan_tci = tci;
7357 compose_output_action(ctx, port->up.ofp_port);
7358 ctx->flow.vlan_tci = old_tci;
7362 mirror_mask_ffs(mirror_mask_t mask)
7364 BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
7369 ofbundle_trunks_vlan(const struct ofbundle *bundle, uint16_t vlan)
7371 return (bundle->vlan_mode != PORT_VLAN_ACCESS
7372 && (!bundle->trunks || bitmap_is_set(bundle->trunks, vlan)));
7376 ofbundle_includes_vlan(const struct ofbundle *bundle, uint16_t vlan)
7378 return vlan == bundle->vlan || ofbundle_trunks_vlan(bundle, vlan);
7381 /* Returns an arbitrary interface within 'bundle'. */
7382 static struct ofport_dpif *
7383 ofbundle_get_a_port(const struct ofbundle *bundle)
7385 return CONTAINER_OF(list_front(&bundle->ports),
7386 struct ofport_dpif, bundle_node);
7390 vlan_is_mirrored(const struct ofmirror *m, int vlan)
7392 return !m->vlans || bitmap_is_set(m->vlans, vlan);
7396 add_mirror_actions(struct action_xlate_ctx *ctx, const struct flow *orig_flow)
7398 struct ofproto_dpif *ofproto = ctx->ofproto;
7399 mirror_mask_t mirrors;
7400 struct ofbundle *in_bundle;
7403 const struct nlattr *a;
7406 in_bundle = lookup_input_bundle(ctx->ofproto, orig_flow->in_port,
7407 ctx->packet != NULL, NULL);
7411 mirrors = in_bundle->src_mirrors;
7413 /* Drop frames on bundles reserved for mirroring. */
7414 if (in_bundle->mirror_out) {
7415 if (ctx->packet != NULL) {
7416 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7417 VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
7418 "%s, which is reserved exclusively for mirroring",
7419 ctx->ofproto->up.name, in_bundle->name);
7425 vid = vlan_tci_to_vid(orig_flow->vlan_tci);
7426 if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
7429 vlan = input_vid_to_vlan(in_bundle, vid);
7431 /* Look at the output ports to check for destination selections. */
7433 NL_ATTR_FOR_EACH (a, left, ctx->odp_actions->data,
7434 ctx->odp_actions->size) {
7435 enum ovs_action_attr type = nl_attr_type(a);
7436 struct ofport_dpif *ofport;
7438 if (type != OVS_ACTION_ATTR_OUTPUT) {
7442 ofport = get_odp_port(ofproto, nl_attr_get_u32(a));
7443 if (ofport && ofport->bundle) {
7444 mirrors |= ofport->bundle->dst_mirrors;
7452 /* Restore the original packet before adding the mirror actions. */
7453 ctx->flow = *orig_flow;
7458 m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
7460 if (!vlan_is_mirrored(m, vlan)) {
7461 mirrors = zero_rightmost_1bit(mirrors);
7465 mirrors &= ~m->dup_mirrors;
7466 ctx->mirrors |= m->dup_mirrors;
7468 output_normal(ctx, m->out, vlan);
7469 } else if (vlan != m->out_vlan
7470 && !eth_addr_is_reserved(orig_flow->dl_dst)) {
7471 struct ofbundle *bundle;
7473 HMAP_FOR_EACH (bundle, hmap_node, &ofproto->bundles) {
7474 if (ofbundle_includes_vlan(bundle, m->out_vlan)
7475 && !bundle->mirror_out) {
7476 output_normal(ctx, bundle, m->out_vlan);
7484 update_mirror_stats(struct ofproto_dpif *ofproto, mirror_mask_t mirrors,
7485 uint64_t packets, uint64_t bytes)
7491 for (; mirrors; mirrors = zero_rightmost_1bit(mirrors)) {
7494 m = ofproto->mirrors[mirror_mask_ffs(mirrors) - 1];
7497 /* In normal circumstances 'm' will not be NULL. However,
7498 * if mirrors are reconfigured, we can temporarily get out
7499 * of sync in facet_revalidate(). We could "correct" the
7500 * mirror list before reaching here, but doing that would
7501 * not properly account the traffic stats we've currently
7502 * accumulated for previous mirror configuration. */
7506 m->packet_count += packets;
7507 m->byte_count += bytes;
7511 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
7512 * migration. Older Citrix-patched Linux DomU used gratuitous ARP replies to
7513 * indicate this; newer upstream kernels use gratuitous ARP requests. */
7515 is_gratuitous_arp(const struct flow *flow)
7517 return (flow->dl_type == htons(ETH_TYPE_ARP)
7518 && eth_addr_is_broadcast(flow->dl_dst)
7519 && (flow->nw_proto == ARP_OP_REPLY
7520 || (flow->nw_proto == ARP_OP_REQUEST
7521 && flow->nw_src == flow->nw_dst)));
7525 update_learning_table(struct ofproto_dpif *ofproto,
7526 const struct flow *flow, int vlan,
7527 struct ofbundle *in_bundle)
7529 struct mac_entry *mac;
7531 /* Don't learn the OFPP_NONE port. */
7532 if (in_bundle == &ofpp_none_bundle) {
7536 if (!mac_learning_may_learn(ofproto->ml, flow->dl_src, vlan)) {
7540 mac = mac_learning_insert(ofproto->ml, flow->dl_src, vlan);
7541 if (is_gratuitous_arp(flow)) {
7542 /* We don't want to learn from gratuitous ARP packets that are
7543 * reflected back over bond slaves so we lock the learning table. */
7544 if (!in_bundle->bond) {
7545 mac_entry_set_grat_arp_lock(mac);
7546 } else if (mac_entry_is_grat_arp_locked(mac)) {
7551 if (mac_entry_is_new(mac) || mac->port.p != in_bundle) {
7552 /* The log messages here could actually be useful in debugging,
7553 * so keep the rate limit relatively high. */
7554 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
7555 VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
7556 "on port %s in VLAN %d",
7557 ofproto->up.name, ETH_ADDR_ARGS(flow->dl_src),
7558 in_bundle->name, vlan);
7560 mac->port.p = in_bundle;
7561 tag_set_add(&ofproto->backer->revalidate_set,
7562 mac_learning_changed(ofproto->ml, mac));
7566 static struct ofbundle *
7567 lookup_input_bundle(const struct ofproto_dpif *ofproto, uint16_t in_port,
7568 bool warn, struct ofport_dpif **in_ofportp)
7570 struct ofport_dpif *ofport;
7572 /* Find the port and bundle for the received packet. */
7573 ofport = get_ofp_port(ofproto, in_port);
7575 *in_ofportp = ofport;
7577 if (ofport && ofport->bundle) {
7578 return ofport->bundle;
7581 /* Special-case OFPP_NONE, which a controller may use as the ingress
7582 * port for traffic that it is sourcing. */
7583 if (in_port == OFPP_NONE) {
7584 return &ofpp_none_bundle;
7587 /* Odd. A few possible reasons here:
7589 * - We deleted a port but there are still a few packets queued up
7592 * - Someone externally added a port (e.g. "ovs-dpctl add-if") that
7593 * we don't know about.
7595 * - The ofproto client didn't configure the port as part of a bundle.
7596 * This is particularly likely to happen if a packet was received on the
7597 * port after it was created, but before the client had a chance to
7598 * configure its bundle.
7601 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7603 VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
7604 "port %"PRIu16, ofproto->up.name, in_port);
7609 /* Determines whether packets in 'flow' within 'ofproto' should be forwarded or
7610 * dropped. Returns true if they may be forwarded, false if they should be
7613 * 'in_port' must be the ofport_dpif that corresponds to flow->in_port.
7614 * 'in_port' must be part of a bundle (e.g. in_port->bundle must be nonnull).
7616 * 'vlan' must be the VLAN that corresponds to flow->vlan_tci on 'in_port', as
7617 * returned by input_vid_to_vlan(). It must be a valid VLAN for 'in_port', as
7618 * checked by input_vid_is_valid().
7620 * May also add tags to '*tags', although the current implementation only does
7621 * so in one special case.
7624 is_admissible(struct action_xlate_ctx *ctx, struct ofport_dpif *in_port,
7627 struct ofproto_dpif *ofproto = ctx->ofproto;
7628 struct flow *flow = &ctx->flow;
7629 struct ofbundle *in_bundle = in_port->bundle;
7631 /* Drop frames for reserved multicast addresses
7632 * only if forward_bpdu option is absent. */
7633 if (!ofproto->up.forward_bpdu && eth_addr_is_reserved(flow->dl_dst)) {
7634 xlate_report(ctx, "packet has reserved destination MAC, dropping");
7638 if (in_bundle->bond) {
7639 struct mac_entry *mac;
7641 switch (bond_check_admissibility(in_bundle->bond, in_port,
7642 flow->dl_dst, &ctx->tags)) {
7647 xlate_report(ctx, "bonding refused admissibility, dropping");
7650 case BV_DROP_IF_MOVED:
7651 mac = mac_learning_lookup(ofproto->ml, flow->dl_src, vlan, NULL);
7652 if (mac && mac->port.p != in_bundle &&
7653 (!is_gratuitous_arp(flow)
7654 || mac_entry_is_grat_arp_locked(mac))) {
7655 xlate_report(ctx, "SLB bond thinks this packet looped back, "
7667 xlate_normal(struct action_xlate_ctx *ctx)
7669 struct ofport_dpif *in_port;
7670 struct ofbundle *in_bundle;
7671 struct mac_entry *mac;
7675 ctx->has_normal = true;
7677 in_bundle = lookup_input_bundle(ctx->ofproto, ctx->flow.in_port,
7678 ctx->packet != NULL, &in_port);
7680 xlate_report(ctx, "no input bundle, dropping");
7684 /* Drop malformed frames. */
7685 if (ctx->flow.dl_type == htons(ETH_TYPE_VLAN) &&
7686 !(ctx->flow.vlan_tci & htons(VLAN_CFI))) {
7687 if (ctx->packet != NULL) {
7688 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7689 VLOG_WARN_RL(&rl, "bridge %s: dropping packet with partial "
7690 "VLAN tag received on port %s",
7691 ctx->ofproto->up.name, in_bundle->name);
7693 xlate_report(ctx, "partial VLAN tag, dropping");
7697 /* Drop frames on bundles reserved for mirroring. */
7698 if (in_bundle->mirror_out) {
7699 if (ctx->packet != NULL) {
7700 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
7701 VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
7702 "%s, which is reserved exclusively for mirroring",
7703 ctx->ofproto->up.name, in_bundle->name);
7705 xlate_report(ctx, "input port is mirror output port, dropping");
7710 vid = vlan_tci_to_vid(ctx->flow.vlan_tci);
7711 if (!input_vid_is_valid(vid, in_bundle, ctx->packet != NULL)) {
7712 xlate_report(ctx, "disallowed VLAN VID for this input port, dropping");
7715 vlan = input_vid_to_vlan(in_bundle, vid);
7717 /* Check other admissibility requirements. */
7718 if (in_port && !is_admissible(ctx, in_port, vlan)) {
7722 /* Learn source MAC. */
7723 if (ctx->may_learn) {
7724 update_learning_table(ctx->ofproto, &ctx->flow, vlan, in_bundle);
7727 /* Determine output bundle. */
7728 mac = mac_learning_lookup(ctx->ofproto->ml, ctx->flow.dl_dst, vlan,
7731 if (mac->port.p != in_bundle) {
7732 xlate_report(ctx, "forwarding to learned port");
7733 output_normal(ctx, mac->port.p, vlan);
7735 xlate_report(ctx, "learned port is input port, dropping");
7738 struct ofbundle *bundle;
7740 xlate_report(ctx, "no learned MAC for destination, flooding");
7741 HMAP_FOR_EACH (bundle, hmap_node, &ctx->ofproto->bundles) {
7742 if (bundle != in_bundle
7743 && ofbundle_includes_vlan(bundle, vlan)
7744 && bundle->floodable
7745 && !bundle->mirror_out) {
7746 output_normal(ctx, bundle, vlan);
7749 ctx->nf_output_iface = NF_OUT_FLOOD;
7753 /* Optimized flow revalidation.
7755 * It's a difficult problem, in general, to tell which facets need to have
7756 * their actions recalculated whenever the OpenFlow flow table changes. We
7757 * don't try to solve that general problem: for most kinds of OpenFlow flow
7758 * table changes, we recalculate the actions for every facet. This is
7759 * relatively expensive, but it's good enough if the OpenFlow flow table
7760 * doesn't change very often.
7762 * However, we can expect one particular kind of OpenFlow flow table change to
7763 * happen frequently: changes caused by MAC learning. To avoid wasting a lot
7764 * of CPU on revalidating every facet whenever MAC learning modifies the flow
7765 * table, we add a special case that applies to flow tables in which every rule
7766 * has the same form (that is, the same wildcards), except that the table is
7767 * also allowed to have a single "catch-all" flow that matches all packets. We
7768 * optimize this case by tagging all of the facets that resubmit into the table
7769 * and invalidating the same tag whenever a flow changes in that table. The
7770 * end result is that we revalidate just the facets that need it (and sometimes
7771 * a few more, but not all of the facets or even all of the facets that
7772 * resubmit to the table modified by MAC learning). */
7774 /* Calculates the tag to use for 'flow' and mask 'mask' when it is inserted
7775 * into an OpenFlow table with the given 'basis'. */
7777 rule_calculate_tag(const struct flow *flow, const struct minimask *mask,
7780 if (minimask_is_catchall(mask)) {
7783 uint32_t hash = flow_hash_in_minimask(flow, mask, secret);
7784 return tag_create_deterministic(hash);
7788 /* Following a change to OpenFlow table 'table_id' in 'ofproto', update the
7789 * taggability of that table.
7791 * This function must be called after *each* change to a flow table. If you
7792 * skip calling it on some changes then the pointer comparisons at the end can
7793 * be invalid if you get unlucky. For example, if a flow removal causes a
7794 * cls_table to be destroyed and then a flow insertion causes a cls_table with
7795 * different wildcards to be created with the same address, then this function
7796 * will incorrectly skip revalidation. */
7798 table_update_taggable(struct ofproto_dpif *ofproto, uint8_t table_id)
7800 struct table_dpif *table = &ofproto->tables[table_id];
7801 const struct oftable *oftable = &ofproto->up.tables[table_id];
7802 struct cls_table *catchall, *other;
7803 struct cls_table *t;
7805 catchall = other = NULL;
7807 switch (hmap_count(&oftable->cls.tables)) {
7809 /* We could tag this OpenFlow table but it would make the logic a
7810 * little harder and it's a corner case that doesn't seem worth it
7816 HMAP_FOR_EACH (t, hmap_node, &oftable->cls.tables) {
7817 if (cls_table_is_catchall(t)) {
7819 } else if (!other) {
7822 /* Indicate that we can't tag this by setting both tables to
7823 * NULL. (We know that 'catchall' is already NULL.) */
7830 /* Can't tag this table. */
7834 if (table->catchall_table != catchall || table->other_table != other) {
7835 table->catchall_table = catchall;
7836 table->other_table = other;
7837 ofproto->backer->need_revalidate = REV_FLOW_TABLE;
7841 /* Given 'rule' that has changed in some way (either it is a rule being
7842 * inserted, a rule being deleted, or a rule whose actions are being
7843 * modified), marks facets for revalidation to ensure that packets will be
7844 * forwarded correctly according to the new state of the flow table.
7846 * This function must be called after *each* change to a flow table. See
7847 * the comment on table_update_taggable() for more information. */
7849 rule_invalidate(const struct rule_dpif *rule)
7851 struct ofproto_dpif *ofproto = ofproto_dpif_cast(rule->up.ofproto);
7853 table_update_taggable(ofproto, rule->up.table_id);
7855 if (!ofproto->backer->need_revalidate) {
7856 struct table_dpif *table = &ofproto->tables[rule->up.table_id];
7858 if (table->other_table && rule->tag) {
7859 tag_set_add(&ofproto->backer->revalidate_set, rule->tag);
7861 ofproto->backer->need_revalidate = REV_FLOW_TABLE;
7867 set_frag_handling(struct ofproto *ofproto_,
7868 enum ofp_config_flags frag_handling)
7870 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7871 if (frag_handling != OFPC_FRAG_REASM) {
7872 ofproto->backer->need_revalidate = REV_RECONFIGURE;
7880 packet_out(struct ofproto *ofproto_, struct ofpbuf *packet,
7881 const struct flow *flow,
7882 const struct ofpact *ofpacts, size_t ofpacts_len)
7884 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7885 struct initial_vals initial_vals;
7886 struct odputil_keybuf keybuf;
7887 struct dpif_flow_stats stats;
7891 struct action_xlate_ctx ctx;
7892 uint64_t odp_actions_stub[1024 / 8];
7893 struct ofpbuf odp_actions;
7895 ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
7896 odp_flow_key_from_flow(&key, flow,
7897 ofp_port_to_odp_port(ofproto, flow->in_port));
7899 dpif_flow_stats_extract(flow, packet, time_msec(), &stats);
7901 initial_vals.vlan_tci = flow->vlan_tci;
7902 action_xlate_ctx_init(&ctx, ofproto, flow, &initial_vals, NULL,
7903 packet_get_tcp_flags(packet, flow), packet);
7904 ctx.resubmit_stats = &stats;
7906 ofpbuf_use_stub(&odp_actions,
7907 odp_actions_stub, sizeof odp_actions_stub);
7908 xlate_actions(&ctx, ofpacts, ofpacts_len, &odp_actions);
7909 dpif_execute(ofproto->backer->dpif, key.data, key.size,
7910 odp_actions.data, odp_actions.size, packet);
7911 ofpbuf_uninit(&odp_actions);
7919 set_netflow(struct ofproto *ofproto_,
7920 const struct netflow_options *netflow_options)
7922 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7924 if (netflow_options) {
7925 if (!ofproto->netflow) {
7926 ofproto->netflow = netflow_create();
7928 return netflow_set_options(ofproto->netflow, netflow_options);
7930 netflow_destroy(ofproto->netflow);
7931 ofproto->netflow = NULL;
7937 get_netflow_ids(const struct ofproto *ofproto_,
7938 uint8_t *engine_type, uint8_t *engine_id)
7940 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofproto_);
7942 dpif_get_netflow_ids(ofproto->backer->dpif, engine_type, engine_id);
7946 send_active_timeout(struct ofproto_dpif *ofproto, struct facet *facet)
7948 if (!facet_is_controller_flow(facet) &&
7949 netflow_active_timeout_expired(ofproto->netflow, &facet->nf_flow)) {
7950 struct subfacet *subfacet;
7951 struct ofexpired expired;
7953 LIST_FOR_EACH (subfacet, list_node, &facet->subfacets) {
7954 if (subfacet->path == SF_FAST_PATH) {
7955 struct dpif_flow_stats stats;
7957 subfacet_reinstall(subfacet, &stats);
7958 subfacet_update_stats(subfacet, &stats);
7962 expired.flow = facet->flow;
7963 expired.packet_count = facet->packet_count;
7964 expired.byte_count = facet->byte_count;
7965 expired.used = facet->used;
7966 netflow_expire(ofproto->netflow, &facet->nf_flow, &expired);
7971 send_netflow_active_timeouts(struct ofproto_dpif *ofproto)
7973 struct facet *facet;
7975 HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
7976 send_active_timeout(ofproto, facet);
7980 static struct ofproto_dpif *
7981 ofproto_dpif_lookup(const char *name)
7983 struct ofproto_dpif *ofproto;
7985 HMAP_FOR_EACH_WITH_HASH (ofproto, all_ofproto_dpifs_node,
7986 hash_string(name, 0), &all_ofproto_dpifs) {
7987 if (!strcmp(ofproto->up.name, name)) {
7995 ofproto_unixctl_fdb_flush(struct unixctl_conn *conn, int argc,
7996 const char *argv[], void *aux OVS_UNUSED)
7998 struct ofproto_dpif *ofproto;
8001 ofproto = ofproto_dpif_lookup(argv[1]);
8003 unixctl_command_reply_error(conn, "no such bridge");
8006 mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
8008 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8009 mac_learning_flush(ofproto->ml, &ofproto->backer->revalidate_set);
8013 unixctl_command_reply(conn, "table successfully flushed");
8017 ofproto_unixctl_fdb_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
8018 const char *argv[], void *aux OVS_UNUSED)
8020 struct ds ds = DS_EMPTY_INITIALIZER;
8021 const struct ofproto_dpif *ofproto;
8022 const struct mac_entry *e;
8024 ofproto = ofproto_dpif_lookup(argv[1]);
8026 unixctl_command_reply_error(conn, "no such bridge");
8030 ds_put_cstr(&ds, " port VLAN MAC Age\n");
8031 LIST_FOR_EACH (e, lru_node, &ofproto->ml->lrus) {
8032 struct ofbundle *bundle = e->port.p;
8033 ds_put_format(&ds, "%5d %4d "ETH_ADDR_FMT" %3d\n",
8034 ofbundle_get_a_port(bundle)->odp_port,
8035 e->vlan, ETH_ADDR_ARGS(e->mac),
8036 mac_entry_age(ofproto->ml, e));
8038 unixctl_command_reply(conn, ds_cstr(&ds));
8043 struct action_xlate_ctx ctx;
8049 trace_format_rule(struct ds *result, uint8_t table_id, int level,
8050 const struct rule_dpif *rule)
8052 ds_put_char_multiple(result, '\t', level);
8054 ds_put_cstr(result, "No match\n");
8058 ds_put_format(result, "Rule: table=%"PRIu8" cookie=%#"PRIx64" ",
8059 table_id, ntohll(rule->up.flow_cookie));
8060 cls_rule_format(&rule->up.cr, result);
8061 ds_put_char(result, '\n');
8063 ds_put_char_multiple(result, '\t', level);
8064 ds_put_cstr(result, "OpenFlow ");
8065 ofpacts_format(rule->up.ofpacts, rule->up.ofpacts_len, result);
8066 ds_put_char(result, '\n');
8070 trace_format_flow(struct ds *result, int level, const char *title,
8071 struct trace_ctx *trace)
8073 ds_put_char_multiple(result, '\t', level);
8074 ds_put_format(result, "%s: ", title);
8075 if (flow_equal(&trace->ctx.flow, &trace->flow)) {
8076 ds_put_cstr(result, "unchanged");
8078 flow_format(result, &trace->ctx.flow);
8079 trace->flow = trace->ctx.flow;
8081 ds_put_char(result, '\n');
8085 trace_format_regs(struct ds *result, int level, const char *title,
8086 struct trace_ctx *trace)
8090 ds_put_char_multiple(result, '\t', level);
8091 ds_put_format(result, "%s:", title);
8092 for (i = 0; i < FLOW_N_REGS; i++) {
8093 ds_put_format(result, " reg%zu=0x%"PRIx32, i, trace->flow.regs[i]);
8095 ds_put_char(result, '\n');
8099 trace_format_odp(struct ds *result, int level, const char *title,
8100 struct trace_ctx *trace)
8102 struct ofpbuf *odp_actions = trace->ctx.odp_actions;
8104 ds_put_char_multiple(result, '\t', level);
8105 ds_put_format(result, "%s: ", title);
8106 format_odp_actions(result, odp_actions->data, odp_actions->size);
8107 ds_put_char(result, '\n');
8111 trace_resubmit(struct action_xlate_ctx *ctx, struct rule_dpif *rule)
8113 struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
8114 struct ds *result = trace->result;
8116 ds_put_char(result, '\n');
8117 trace_format_flow(result, ctx->recurse + 1, "Resubmitted flow", trace);
8118 trace_format_regs(result, ctx->recurse + 1, "Resubmitted regs", trace);
8119 trace_format_odp(result, ctx->recurse + 1, "Resubmitted odp", trace);
8120 trace_format_rule(result, ctx->table_id, ctx->recurse + 1, rule);
8124 trace_report(struct action_xlate_ctx *ctx, const char *s)
8126 struct trace_ctx *trace = CONTAINER_OF(ctx, struct trace_ctx, ctx);
8127 struct ds *result = trace->result;
8129 ds_put_char_multiple(result, '\t', ctx->recurse);
8130 ds_put_cstr(result, s);
8131 ds_put_char(result, '\n');
8135 ofproto_unixctl_trace(struct unixctl_conn *conn, int argc, const char *argv[],
8136 void *aux OVS_UNUSED)
8138 const struct dpif_backer *backer;
8139 struct ofproto_dpif *ofproto;
8140 struct ofpbuf odp_key;
8141 struct ofpbuf *packet;
8142 struct initial_vals initial_vals;
8150 ofpbuf_init(&odp_key, 0);
8152 /* Handle "-generate" or a hex string as the last argument. */
8153 if (!strcmp(argv[argc - 1], "-generate")) {
8154 packet = ofpbuf_new(0);
8157 const char *error = eth_from_hex(argv[argc - 1], &packet);
8160 } else if (argc == 4) {
8161 /* The 3-argument form must end in "-generate' or a hex string. */
8162 unixctl_command_reply_error(conn, error);
8167 /* Parse the flow and determine whether a datapath or
8168 * bridge is specified. If function odp_flow_key_from_string()
8169 * returns 0, the flow is a odp_flow. If function
8170 * parse_ofp_exact_flow() returns 0, the flow is a br_flow. */
8171 if (!odp_flow_key_from_string(argv[argc - 1], NULL, &odp_key)) {
8172 /* If the odp_flow is the second argument,
8173 * the datapath name is the first argument. */
8175 const char *dp_type;
8176 if (!strncmp(argv[1], "ovs-", 4)) {
8177 dp_type = argv[1] + 4;
8181 backer = shash_find_data(&all_dpif_backers, dp_type);
8183 unixctl_command_reply_error(conn, "Cannot find datapath "
8188 /* No datapath name specified, so there should be only one
8190 struct shash_node *node;
8191 if (shash_count(&all_dpif_backers) != 1) {
8192 unixctl_command_reply_error(conn, "Must specify datapath "
8193 "name, there is more than one type of datapath");
8196 node = shash_first(&all_dpif_backers);
8197 backer = node->data;
8200 /* Extract the ofproto_dpif object from the ofproto_receive()
8202 if (ofproto_receive(backer, NULL, odp_key.data,
8203 odp_key.size, &flow, NULL, &ofproto, NULL,
8205 unixctl_command_reply_error(conn, "Invalid datapath flow");
8208 ds_put_format(&result, "Bridge: %s\n", ofproto->up.name);
8209 } else if (!parse_ofp_exact_flow(&flow, argv[argc - 1])) {
8211 unixctl_command_reply_error(conn, "Must specify bridge name");
8215 ofproto = ofproto_dpif_lookup(argv[1]);
8217 unixctl_command_reply_error(conn, "Unknown bridge name");
8220 initial_vals.vlan_tci = flow.vlan_tci;
8222 unixctl_command_reply_error(conn, "Bad flow syntax");
8226 /* Generate a packet, if requested. */
8228 if (!packet->size) {
8229 flow_compose(packet, &flow);
8231 ds_put_cstr(&result, "Packet: ");
8232 s = ofp_packet_to_string(packet->data, packet->size);
8233 ds_put_cstr(&result, s);
8236 /* Use the metadata from the flow and the packet argument
8237 * to reconstruct the flow. */
8238 flow_extract(packet, flow.skb_priority, flow.skb_mark, NULL,
8239 flow.in_port, &flow);
8240 initial_vals.vlan_tci = flow.vlan_tci;
8244 ofproto_trace(ofproto, &flow, packet, &initial_vals, &result);
8245 unixctl_command_reply(conn, ds_cstr(&result));
8248 ds_destroy(&result);
8249 ofpbuf_delete(packet);
8250 ofpbuf_uninit(&odp_key);
8254 ofproto_trace(struct ofproto_dpif *ofproto, const struct flow *flow,
8255 const struct ofpbuf *packet,
8256 const struct initial_vals *initial_vals, struct ds *ds)
8258 struct rule_dpif *rule;
8260 ds_put_cstr(ds, "Flow: ");
8261 flow_format(ds, flow);
8262 ds_put_char(ds, '\n');
8264 rule = rule_dpif_lookup(ofproto, flow);
8266 trace_format_rule(ds, 0, 0, rule);
8267 if (rule == ofproto->miss_rule) {
8268 ds_put_cstr(ds, "\nNo match, flow generates \"packet in\"s.\n");
8269 } else if (rule == ofproto->no_packet_in_rule) {
8270 ds_put_cstr(ds, "\nNo match, packets dropped because "
8271 "OFPPC_NO_PACKET_IN is set on in_port.\n");
8275 uint64_t odp_actions_stub[1024 / 8];
8276 struct ofpbuf odp_actions;
8278 struct trace_ctx trace;
8281 tcp_flags = packet ? packet_get_tcp_flags(packet, flow) : 0;
8284 ofpbuf_use_stub(&odp_actions,
8285 odp_actions_stub, sizeof odp_actions_stub);
8286 action_xlate_ctx_init(&trace.ctx, ofproto, flow, initial_vals,
8287 rule, tcp_flags, packet);
8288 trace.ctx.resubmit_hook = trace_resubmit;
8289 trace.ctx.report_hook = trace_report;
8290 xlate_actions(&trace.ctx, rule->up.ofpacts, rule->up.ofpacts_len,
8293 ds_put_char(ds, '\n');
8294 trace_format_flow(ds, 0, "Final flow", &trace);
8295 ds_put_cstr(ds, "Datapath actions: ");
8296 format_odp_actions(ds, odp_actions.data, odp_actions.size);
8297 ofpbuf_uninit(&odp_actions);
8299 if (trace.ctx.slow) {
8300 enum slow_path_reason slow;
8302 ds_put_cstr(ds, "\nThis flow is handled by the userspace "
8303 "slow path because it:");
8304 for (slow = trace.ctx.slow; slow; ) {
8305 enum slow_path_reason bit = rightmost_1bit(slow);
8309 ds_put_cstr(ds, "\n\t- Consists of CFM packets.");
8312 ds_put_cstr(ds, "\n\t- Consists of LACP packets.");
8315 ds_put_cstr(ds, "\n\t- Consists of STP packets.");
8318 ds_put_cstr(ds, "\n\t- Consists of BFD packets.");
8321 ds_put_cstr(ds, "\n\t- Needs in-band special case "
8324 ds_put_cstr(ds, "\n\t (The datapath actions are "
8325 "incomplete--for complete actions, "
8326 "please supply a packet.)");
8329 case SLOW_CONTROLLER:
8330 ds_put_cstr(ds, "\n\t- Sends \"packet-in\" messages "
8331 "to the OpenFlow controller.");
8342 ofproto_dpif_clog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
8343 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
8346 unixctl_command_reply(conn, NULL);
8350 ofproto_dpif_unclog(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
8351 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
8354 unixctl_command_reply(conn, NULL);
8357 /* Runs a self-check of flow translations in 'ofproto'. Appends a message to
8358 * 'reply' describing the results. */
8360 ofproto_dpif_self_check__(struct ofproto_dpif *ofproto, struct ds *reply)
8362 struct facet *facet;
8366 HMAP_FOR_EACH (facet, hmap_node, &ofproto->facets) {
8367 if (!facet_check_consistency(facet)) {
8372 ofproto->backer->need_revalidate = REV_INCONSISTENCY;
8376 ds_put_format(reply, "%s: self-check failed (%d errors)\n",
8377 ofproto->up.name, errors);
8379 ds_put_format(reply, "%s: self-check passed\n", ofproto->up.name);
8384 ofproto_dpif_self_check(struct unixctl_conn *conn,
8385 int argc, const char *argv[], void *aux OVS_UNUSED)
8387 struct ds reply = DS_EMPTY_INITIALIZER;
8388 struct ofproto_dpif *ofproto;
8391 ofproto = ofproto_dpif_lookup(argv[1]);
8393 unixctl_command_reply_error(conn, "Unknown ofproto (use "
8394 "ofproto/list for help)");
8397 ofproto_dpif_self_check__(ofproto, &reply);
8399 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8400 ofproto_dpif_self_check__(ofproto, &reply);
8404 unixctl_command_reply(conn, ds_cstr(&reply));
8408 /* Store the current ofprotos in 'ofproto_shash'. Returns a sorted list
8409 * of the 'ofproto_shash' nodes. It is the responsibility of the caller
8410 * to destroy 'ofproto_shash' and free the returned value. */
8411 static const struct shash_node **
8412 get_ofprotos(struct shash *ofproto_shash)
8414 const struct ofproto_dpif *ofproto;
8416 HMAP_FOR_EACH (ofproto, all_ofproto_dpifs_node, &all_ofproto_dpifs) {
8417 char *name = xasprintf("%s@%s", ofproto->up.type, ofproto->up.name);
8418 shash_add_nocopy(ofproto_shash, name, ofproto);
8421 return shash_sort(ofproto_shash);
8425 ofproto_unixctl_dpif_dump_dps(struct unixctl_conn *conn, int argc OVS_UNUSED,
8426 const char *argv[] OVS_UNUSED,
8427 void *aux OVS_UNUSED)
8429 struct ds ds = DS_EMPTY_INITIALIZER;
8430 struct shash ofproto_shash;
8431 const struct shash_node **sorted_ofprotos;
8434 shash_init(&ofproto_shash);
8435 sorted_ofprotos = get_ofprotos(&ofproto_shash);
8436 for (i = 0; i < shash_count(&ofproto_shash); i++) {
8437 const struct shash_node *node = sorted_ofprotos[i];
8438 ds_put_format(&ds, "%s\n", node->name);
8441 shash_destroy(&ofproto_shash);
8442 free(sorted_ofprotos);
8444 unixctl_command_reply(conn, ds_cstr(&ds));
8449 show_dp_format(const struct ofproto_dpif *ofproto, struct ds *ds)
8451 const struct shash_node **ports;
8453 struct avg_subfacet_rates lifetime;
8454 unsigned long long int minutes;
8455 const int min_ms = 60 * 1000; /* milliseconds in one minute. */
8457 minutes = (time_msec() - ofproto->created) / min_ms;
8460 lifetime.add_rate = (double)ofproto->total_subfacet_add_count
8462 lifetime.del_rate = (double)ofproto->total_subfacet_del_count
8465 lifetime.add_rate = 0.0;
8466 lifetime.del_rate = 0.0;
8469 ds_put_format(ds, "%s (%s):\n", ofproto->up.name,
8470 dpif_name(ofproto->backer->dpif));
8472 "\tlookups: hit:%"PRIu64" missed:%"PRIu64"\n",
8473 ofproto->n_hit, ofproto->n_missed);
8474 ds_put_format(ds, "\tflows: cur: %zu, avg: %5.3f, max: %d,"
8475 " life span: %llu(ms)\n",
8476 hmap_count(&ofproto->subfacets),
8477 avg_subfacet_count(ofproto),
8478 ofproto->max_n_subfacet,
8479 avg_subfacet_life_span(ofproto));
8480 if (minutes >= 60) {
8481 show_dp_rates(ds, "\t\thourly avg:", &ofproto->hourly);
8483 if (minutes >= 60 * 24) {
8484 show_dp_rates(ds, "\t\tdaily avg:", &ofproto->daily);
8486 show_dp_rates(ds, "\t\toverall avg:", &lifetime);
8488 ports = shash_sort(&ofproto->up.port_by_name);
8489 for (i = 0; i < shash_count(&ofproto->up.port_by_name); i++) {
8490 const struct shash_node *node = ports[i];
8491 struct ofport *ofport = node->data;
8492 const char *name = netdev_get_name(ofport->netdev);
8493 const char *type = netdev_get_type(ofport->netdev);
8496 ds_put_format(ds, "\t%s %u/", name, ofport->ofp_port);
8498 odp_port = ofp_port_to_odp_port(ofproto, ofport->ofp_port);
8499 if (odp_port != OVSP_NONE) {
8500 ds_put_format(ds, "%"PRIu32":", odp_port);
8502 ds_put_cstr(ds, "none:");
8505 if (strcmp(type, "system")) {
8506 struct netdev *netdev;
8509 ds_put_format(ds, " (%s", type);
8511 error = netdev_open(name, type, &netdev);
8516 error = netdev_get_config(netdev, &config);
8518 const struct smap_node **nodes;
8521 nodes = smap_sort(&config);
8522 for (i = 0; i < smap_count(&config); i++) {
8523 const struct smap_node *node = nodes[i];
8524 ds_put_format(ds, "%c %s=%s", i ? ',' : ':',
8525 node->key, node->value);
8529 smap_destroy(&config);
8531 netdev_close(netdev);
8533 ds_put_char(ds, ')');
8535 ds_put_char(ds, '\n');
8541 ofproto_unixctl_dpif_show(struct unixctl_conn *conn, int argc,
8542 const char *argv[], void *aux OVS_UNUSED)
8544 struct ds ds = DS_EMPTY_INITIALIZER;
8545 const struct ofproto_dpif *ofproto;
8549 for (i = 1; i < argc; i++) {
8550 ofproto = ofproto_dpif_lookup(argv[i]);
8552 ds_put_format(&ds, "Unknown bridge %s (use dpif/dump-dps "
8553 "for help)", argv[i]);
8554 unixctl_command_reply_error(conn, ds_cstr(&ds));
8557 show_dp_format(ofproto, &ds);
8560 struct shash ofproto_shash;
8561 const struct shash_node **sorted_ofprotos;
8564 shash_init(&ofproto_shash);
8565 sorted_ofprotos = get_ofprotos(&ofproto_shash);
8566 for (i = 0; i < shash_count(&ofproto_shash); i++) {
8567 const struct shash_node *node = sorted_ofprotos[i];
8568 show_dp_format(node->data, &ds);
8571 shash_destroy(&ofproto_shash);
8572 free(sorted_ofprotos);
8575 unixctl_command_reply(conn, ds_cstr(&ds));
8580 ofproto_unixctl_dpif_dump_flows(struct unixctl_conn *conn,
8581 int argc OVS_UNUSED, const char *argv[],
8582 void *aux OVS_UNUSED)
8584 struct ds ds = DS_EMPTY_INITIALIZER;
8585 const struct ofproto_dpif *ofproto;
8586 struct subfacet *subfacet;
8588 ofproto = ofproto_dpif_lookup(argv[1]);
8590 unixctl_command_reply_error(conn, "no such bridge");
8594 update_stats(ofproto->backer);
8596 HMAP_FOR_EACH (subfacet, hmap_node, &ofproto->subfacets) {
8597 odp_flow_key_format(subfacet->key, subfacet->key_len, &ds);
8599 ds_put_format(&ds, ", packets:%"PRIu64", bytes:%"PRIu64", used:",
8600 subfacet->dp_packet_count, subfacet->dp_byte_count);
8601 if (subfacet->used) {
8602 ds_put_format(&ds, "%.3fs",
8603 (time_msec() - subfacet->used) / 1000.0);
8605 ds_put_format(&ds, "never");
8607 if (subfacet->facet->tcp_flags) {
8608 ds_put_cstr(&ds, ", flags:");
8609 packet_format_tcp_flags(&ds, subfacet->facet->tcp_flags);
8612 ds_put_cstr(&ds, ", actions:");
8613 if (subfacet->slow) {
8614 uint64_t slow_path_stub[128 / 8];
8615 const struct nlattr *actions;
8618 compose_slow_path(ofproto, &subfacet->facet->flow, subfacet->slow,
8619 slow_path_stub, sizeof slow_path_stub,
8620 &actions, &actions_len);
8621 format_odp_actions(&ds, actions, actions_len);
8623 format_odp_actions(&ds, subfacet->actions, subfacet->actions_len);
8625 ds_put_char(&ds, '\n');
8628 unixctl_command_reply(conn, ds_cstr(&ds));
8633 ofproto_unixctl_dpif_del_flows(struct unixctl_conn *conn,
8634 int argc OVS_UNUSED, const char *argv[],
8635 void *aux OVS_UNUSED)
8637 struct ds ds = DS_EMPTY_INITIALIZER;
8638 struct ofproto_dpif *ofproto;
8640 ofproto = ofproto_dpif_lookup(argv[1]);
8642 unixctl_command_reply_error(conn, "no such bridge");
8646 flush(&ofproto->up);
8648 unixctl_command_reply(conn, ds_cstr(&ds));
8653 ofproto_dpif_unixctl_init(void)
8655 static bool registered;
8661 unixctl_command_register(
8663 "[dp_name]|bridge odp_flow|br_flow [-generate|packet]",
8664 1, 3, ofproto_unixctl_trace, NULL);
8665 unixctl_command_register("fdb/flush", "[bridge]", 0, 1,
8666 ofproto_unixctl_fdb_flush, NULL);
8667 unixctl_command_register("fdb/show", "bridge", 1, 1,
8668 ofproto_unixctl_fdb_show, NULL);
8669 unixctl_command_register("ofproto/clog", "", 0, 0,
8670 ofproto_dpif_clog, NULL);
8671 unixctl_command_register("ofproto/unclog", "", 0, 0,
8672 ofproto_dpif_unclog, NULL);
8673 unixctl_command_register("ofproto/self-check", "[bridge]", 0, 1,
8674 ofproto_dpif_self_check, NULL);
8675 unixctl_command_register("dpif/dump-dps", "", 0, 0,
8676 ofproto_unixctl_dpif_dump_dps, NULL);
8677 unixctl_command_register("dpif/show", "[bridge]", 0, INT_MAX,
8678 ofproto_unixctl_dpif_show, NULL);
8679 unixctl_command_register("dpif/dump-flows", "bridge", 1, 1,
8680 ofproto_unixctl_dpif_dump_flows, NULL);
8681 unixctl_command_register("dpif/del-flows", "bridge", 1, 1,
8682 ofproto_unixctl_dpif_del_flows, NULL);
8685 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
8687 * This is deprecated. It is only for compatibility with broken device drivers
8688 * in old versions of Linux that do not properly support VLANs when VLAN
8689 * devices are not used. When broken device drivers are no longer in
8690 * widespread use, we will delete these interfaces. */
8693 set_realdev(struct ofport *ofport_, uint16_t realdev_ofp_port, int vid)
8695 struct ofproto_dpif *ofproto = ofproto_dpif_cast(ofport_->ofproto);
8696 struct ofport_dpif *ofport = ofport_dpif_cast(ofport_);
8698 if (realdev_ofp_port == ofport->realdev_ofp_port
8699 && vid == ofport->vlandev_vid) {
8703 ofproto->backer->need_revalidate = REV_RECONFIGURE;
8705 if (ofport->realdev_ofp_port) {
8708 if (realdev_ofp_port && ofport->bundle) {
8709 /* vlandevs are enslaved to their realdevs, so they are not allowed to
8710 * themselves be part of a bundle. */
8711 bundle_set(ofport->up.ofproto, ofport->bundle, NULL);
8714 ofport->realdev_ofp_port = realdev_ofp_port;
8715 ofport->vlandev_vid = vid;
8717 if (realdev_ofp_port) {
8718 vsp_add(ofport, realdev_ofp_port, vid);
8725 hash_realdev_vid(uint16_t realdev_ofp_port, int vid)
8727 return hash_2words(realdev_ofp_port, vid);
8730 /* Returns the ODP port number of the Linux VLAN device that corresponds to
8731 * 'vlan_tci' on the network device with port number 'realdev_odp_port' in
8732 * 'ofproto'. For example, given 'realdev_odp_port' of eth0 and 'vlan_tci' 9,
8733 * it would return the port number of eth0.9.
8735 * Unless VLAN splinters are enabled for port 'realdev_odp_port', this
8736 * function just returns its 'realdev_odp_port' argument. */
8738 vsp_realdev_to_vlandev(const struct ofproto_dpif *ofproto,
8739 uint32_t realdev_odp_port, ovs_be16 vlan_tci)
8741 if (!hmap_is_empty(&ofproto->realdev_vid_map)) {
8742 uint16_t realdev_ofp_port;
8743 int vid = vlan_tci_to_vid(vlan_tci);
8744 const struct vlan_splinter *vsp;
8746 realdev_ofp_port = odp_port_to_ofp_port(ofproto, realdev_odp_port);
8747 HMAP_FOR_EACH_WITH_HASH (vsp, realdev_vid_node,
8748 hash_realdev_vid(realdev_ofp_port, vid),
8749 &ofproto->realdev_vid_map) {
8750 if (vsp->realdev_ofp_port == realdev_ofp_port
8751 && vsp->vid == vid) {
8752 return ofp_port_to_odp_port(ofproto, vsp->vlandev_ofp_port);
8756 return realdev_odp_port;
8759 static struct vlan_splinter *
8760 vlandev_find(const struct ofproto_dpif *ofproto, uint16_t vlandev_ofp_port)
8762 struct vlan_splinter *vsp;
8764 HMAP_FOR_EACH_WITH_HASH (vsp, vlandev_node, hash_int(vlandev_ofp_port, 0),
8765 &ofproto->vlandev_map) {
8766 if (vsp->vlandev_ofp_port == vlandev_ofp_port) {
8774 /* Returns the OpenFlow port number of the "real" device underlying the Linux
8775 * VLAN device with OpenFlow port number 'vlandev_ofp_port' and stores the
8776 * VLAN VID of the Linux VLAN device in '*vid'. For example, given
8777 * 'vlandev_ofp_port' of eth0.9, it would return the OpenFlow port number of
8778 * eth0 and store 9 in '*vid'.
8780 * Returns 0 and does not modify '*vid' if 'vlandev_ofp_port' is not a Linux
8781 * VLAN device. Unless VLAN splinters are enabled, this is what this function
8784 vsp_vlandev_to_realdev(const struct ofproto_dpif *ofproto,
8785 uint16_t vlandev_ofp_port, int *vid)
8787 if (!hmap_is_empty(&ofproto->vlandev_map)) {
8788 const struct vlan_splinter *vsp;
8790 vsp = vlandev_find(ofproto, vlandev_ofp_port);
8795 return vsp->realdev_ofp_port;
8801 /* Given 'flow', a flow representing a packet received on 'ofproto', checks
8802 * whether 'flow->in_port' represents a Linux VLAN device. If so, changes
8803 * 'flow->in_port' to the "real" device backing the VLAN device, sets
8804 * 'flow->vlan_tci' to the VLAN VID, and returns true. Otherwise (which is
8805 * always the case unless VLAN splinters are enabled), returns false without
8806 * making any changes. */
8808 vsp_adjust_flow(const struct ofproto_dpif *ofproto, struct flow *flow)
8813 realdev = vsp_vlandev_to_realdev(ofproto, flow->in_port, &vid);
8818 /* Cause the flow to be processed as if it came in on the real device with
8819 * the VLAN device's VLAN ID. */
8820 flow->in_port = realdev;
8821 flow->vlan_tci = htons((vid & VLAN_VID_MASK) | VLAN_CFI);
8826 vsp_remove(struct ofport_dpif *port)
8828 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
8829 struct vlan_splinter *vsp;
8831 vsp = vlandev_find(ofproto, port->up.ofp_port);
8833 hmap_remove(&ofproto->vlandev_map, &vsp->vlandev_node);
8834 hmap_remove(&ofproto->realdev_vid_map, &vsp->realdev_vid_node);
8837 port->realdev_ofp_port = 0;
8839 VLOG_ERR("missing vlan device record");
8844 vsp_add(struct ofport_dpif *port, uint16_t realdev_ofp_port, int vid)
8846 struct ofproto_dpif *ofproto = ofproto_dpif_cast(port->up.ofproto);
8848 if (!vsp_vlandev_to_realdev(ofproto, port->up.ofp_port, NULL)
8849 && (vsp_realdev_to_vlandev(ofproto, realdev_ofp_port, htons(vid))
8850 == realdev_ofp_port)) {
8851 struct vlan_splinter *vsp;
8853 vsp = xmalloc(sizeof *vsp);
8854 hmap_insert(&ofproto->vlandev_map, &vsp->vlandev_node,
8855 hash_int(port->up.ofp_port, 0));
8856 hmap_insert(&ofproto->realdev_vid_map, &vsp->realdev_vid_node,
8857 hash_realdev_vid(realdev_ofp_port, vid));
8858 vsp->realdev_ofp_port = realdev_ofp_port;
8859 vsp->vlandev_ofp_port = port->up.ofp_port;
8862 port->realdev_ofp_port = realdev_ofp_port;
8864 VLOG_ERR("duplicate vlan device record");
8869 ofp_port_to_odp_port(const struct ofproto_dpif *ofproto, uint16_t ofp_port)
8871 const struct ofport_dpif *ofport = get_ofp_port(ofproto, ofp_port);
8872 return ofport ? ofport->odp_port : OVSP_NONE;
8875 static struct ofport_dpif *
8876 odp_port_to_ofport(const struct dpif_backer *backer, uint32_t odp_port)
8878 struct ofport_dpif *port;
8880 HMAP_FOR_EACH_IN_BUCKET (port, odp_port_node,
8881 hash_int(odp_port, 0),
8882 &backer->odp_to_ofport_map) {
8883 if (port->odp_port == odp_port) {
8892 odp_port_to_ofp_port(const struct ofproto_dpif *ofproto, uint32_t odp_port)
8894 struct ofport_dpif *port;
8896 port = odp_port_to_ofport(ofproto->backer, odp_port);
8897 if (port && &ofproto->up == port->up.ofproto) {
8898 return port->up.ofp_port;
8903 static unsigned long long int
8904 avg_subfacet_life_span(const struct ofproto_dpif *ofproto)
8906 unsigned long long int dc;
8907 unsigned long long int avg;
8909 dc = ofproto->total_subfacet_del_count + ofproto->subfacet_del_count;
8910 avg = dc ? ofproto->total_subfacet_life_span / dc : 0;
8916 avg_subfacet_count(const struct ofproto_dpif *ofproto)
8920 if (ofproto->n_update_stats) {
8921 avg_c = (double)ofproto->total_subfacet_count
8922 / ofproto->n_update_stats;
8929 show_dp_rates(struct ds *ds, const char *heading,
8930 const struct avg_subfacet_rates *rates)
8932 ds_put_format(ds, "%s add rate: %5.3f/min, del rate: %5.3f/min\n",
8933 heading, rates->add_rate, rates->del_rate);
8937 update_max_subfacet_count(struct ofproto_dpif *ofproto)
8939 ofproto->max_n_subfacet = MAX(ofproto->max_n_subfacet,
8940 hmap_count(&ofproto->subfacets));
8943 /* Compute exponentially weighted moving average, adding 'new' as the newest,
8944 * most heavily weighted element. 'base' designates the rate of decay: after
8945 * 'base' further updates, 'new''s weight in the EWMA decays to about 1/e
8948 exp_mavg(double *avg, int base, double new)
8950 *avg = (*avg * (base - 1) + new) / base;
8954 update_moving_averages(struct ofproto_dpif *ofproto)
8956 const int min_ms = 60 * 1000; /* milliseconds in one minute. */
8958 /* Update hourly averages on the minute boundaries. */
8959 if (time_msec() - ofproto->last_minute >= min_ms) {
8960 exp_mavg(&ofproto->hourly.add_rate, 60, ofproto->subfacet_add_count);
8961 exp_mavg(&ofproto->hourly.del_rate, 60, ofproto->subfacet_del_count);
8963 /* Update daily averages on the hour boundaries. */
8964 if ((ofproto->last_minute - ofproto->created) / min_ms % 60 == 59) {
8965 exp_mavg(&ofproto->daily.add_rate, 24, ofproto->hourly.add_rate);
8966 exp_mavg(&ofproto->daily.del_rate, 24, ofproto->hourly.del_rate);
8969 ofproto->total_subfacet_add_count += ofproto->subfacet_add_count;
8970 ofproto->total_subfacet_del_count += ofproto->subfacet_del_count;
8971 ofproto->subfacet_add_count = 0;
8972 ofproto->subfacet_del_count = 0;
8973 ofproto->last_minute += min_ms;
8978 dpif_stats_update_hit_count(struct ofproto_dpif *ofproto, uint64_t delta)
8980 ofproto->n_hit += delta;
8983 const struct ofproto_class ofproto_dpif_class = {
9018 port_is_lacp_current,
9019 NULL, /* rule_choose_table */
9026 rule_modify_actions,
9040 get_stp_port_status,
9047 is_mirror_output_bundle,
9048 forward_bpdu_changed,
9049 set_mac_table_config,