-/* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
+/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <stdint.h>
#include "hmapx.h"
-#include "ofproto/ofproto-provider.h"
+#include "odp-util.h"
+#include "ofp-util.h"
+#include "ovs-thread.h"
+#include "ofproto-provider.h"
#include "timer.h"
#include "util.h"
+#include "ovs-thread.h"
union user_action_cookie;
+struct dpif_flow_stats;
+struct ofproto;
struct ofproto_dpif;
+struct ofproto_packet_in;
struct ofport_dpif;
+struct dpif_backer;
+struct OVS_LOCKABLE rule_dpif;
+struct OVS_LOCKABLE group_dpif;
-struct rule_dpif {
- struct rule up;
-
- /* These statistics:
- *
- * - Do include packets and bytes from facets that have been deleted or
- * whose own statistics have been folded into the rule.
- *
- * - Do include packets and bytes sent "by hand" that were accounted to
- * the rule without any facet being involved (this is a rare corner
- * case in rule_execute()).
- *
- * - Do not include packet or bytes that can be obtained from any facet's
- * packet_count or byte_count member or that can be obtained from the
- * datapath by, e.g., dpif_flow_get() for any subfacet.
- */
- uint64_t packet_count; /* Number of packets received. */
- uint64_t byte_count; /* Number of bytes received. */
+enum rule_dpif_lookup_verdict {
+ RULE_DPIF_LOOKUP_VERDICT_MATCH, /* A match occurred. */
+ RULE_DPIF_LOOKUP_VERDICT_CONTROLLER, /* A miss occurred and the packet
+ * should be passed to
+ * the controller. */
+ RULE_DPIF_LOOKUP_VERDICT_DROP, /* A miss occurred and the packet
+ * should be dropped. */
+ RULE_DPIF_LOOKUP_VERDICT_DEFAULT, /* A miss occurred and the packet
+ * should handled by the default
+ * miss behaviour.
+ * For pre-OF1.3 it should be
+ * forwarded to the controller.
+ * For OF1.3+ it should be
+ * dropped. */
};
-static inline struct rule_dpif *rule_dpif_cast(const struct rule *rule)
-{
- return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
-}
+/* For lock annotation below only. */
+extern struct ovs_rwlock xlate_rwlock;
-struct rule_dpif *rule_dpif_lookup_in_table(struct ofproto_dpif *,
- const struct flow *,
- struct flow_wildcards *,
- uint8_t table_id);
+/* Ofproto-dpif -- DPIF based ofproto implementation.
+ *
+ * Ofproto-dpif provides an ofproto implementation for those platforms which
+ * implement the netdev and dpif interface defined in netdev.h and dpif.h. The
+ * most important of which is the Linux Kernel Module (dpif-linux), but
+ * alternatives are supported such as a userspace only implementation
+ * (dpif-netdev), and a dummy implementation used for unit testing.
+ *
+ * Ofproto-dpif is divided into three major chunks.
+ *
+ * - ofproto-dpif.c
+ * The main ofproto-dpif module is responsible for implementing the
+ * provider interface, installing and removing datapath flows, maintaining
+ * packet statistics, running protocols (BFD, LACP, STP, etc), and
+ * configuring relevant submodules.
+ *
+ * - ofproto-dpif-upcall.c
+ * Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
+ * processing miss upcalls, and handing more complex ones up to the main
+ * ofproto-dpif module. Miss upcall processing boils down to figuring out
+ * what each packet's actions are, executing them (i.e. asking the kernel to
+ * forward it), and handing it up to ofproto-dpif to decided whether or not
+ * to install a kernel flow.
+ *
+ * - ofproto-dpif-xlate.c
+ * Ofproto-dpif-xlate is responsible for translating translating OpenFlow
+ * actions into datapath actions. */
+
+size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
+bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif *);
+
+uint8_t rule_dpif_lookup(struct ofproto_dpif *, struct flow *,
+ struct flow_wildcards *, struct rule_dpif **rule,
+ bool take_ref);
+
+enum rule_dpif_lookup_verdict rule_dpif_lookup_from_table(struct ofproto_dpif *,
+ const struct flow *,
+ struct flow_wildcards *,
+ bool force_controller_on_miss,
+ uint8_t *table_id,
+ struct rule_dpif **rule,
+ bool take_ref);
+
+void rule_dpif_ref(struct rule_dpif *);
+void rule_dpif_unref(struct rule_dpif *);
+
+void rule_dpif_credit_stats(struct rule_dpif *rule ,
+ const struct dpif_flow_stats *);
+
+bool rule_dpif_is_fail_open(const struct rule_dpif *);
+bool rule_dpif_is_table_miss(const struct rule_dpif *);
+bool rule_dpif_is_internal(const struct rule_dpif *);
+uint8_t rule_dpif_get_table(const struct rule_dpif *);
+
+const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
+
+ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
+
+void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
+ uint16_t hard_timeout);
+
+void choose_miss_rule(enum ofputil_port_config,
+ struct rule_dpif *miss_rule,
+ struct rule_dpif *no_packet_in_rule,
+ struct rule_dpif **rule, bool take_ref);
+
+bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
+ struct group_dpif **group);
-struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
- const struct flow *);
+void group_dpif_release(struct group_dpif *group);
-void rule_credit_stats(struct rule_dpif *, const struct dpif_flow_stats *);
+void group_dpif_get_buckets(const struct group_dpif *group,
+ const struct list **buckets);
+enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
ofp_port_t realdev_ofp_port,
ovs_be16 vlan_tci);
+bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
+int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
+ struct rule_dpif *, const struct ofpact *,
+ size_t ofpacts_len, struct ofpbuf *)
+ OVS_EXCLUDED(xlate_rwlock);
void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
- struct ofputil_packet_in *pin);
+ struct ofproto_packet_in *);
+bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
+int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
+struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
+
+struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
+
+/*
+ * Recirculation
+ * =============
+ *
+ * Recirculation is a technique to allow a frame to re-enter the packet
+ * processing path for one or multiple times to achieve more flexible packet
+ * processing in the data path. MPLS handling and selecting bond slave port
+ * of a bond ports.
+ *
+ * Data path and user space interface
+ * -----------------------------------
+ *
+ * Two new fields, recirc_id and dp_hash, are added to the current flow data
+ * structure. They are both of type uint32_t. In addition, a new action,
+ * RECIRC, are added.
+ *
+ * The value recirc_id is used to distinguish a packet from multiple
+ * iterations of recirculation. A packet initially received is considered of
+ * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
+ * the data path.
+ *
+ * On the other hand, dp_hash can only be computed by the data path, opaque to
+ * the user space. In fact, user space may not able to recompute the hash
+ * value. The dp_hash value should be wildcarded when for a newly received
+ * packet. RECIRC action specifies whether the hash is computed. If computed,
+ * how many fields to be included in the hash computation. The computed hash
+ * value is stored into the dp_hash field prior to recirculation.
+ *
+ * The RECIRC action computes and set the dp_hash field, set the recirc_id
+ * field and then reprocess the packet as if it was received on the same input
+ * port. RECIRC action works like a function call; actions listed behind the
+ * RECIRC action will be executed after its execution. RECIRC action can be
+ * nested, data path implementation limits the number of recirculation executed
+ * to prevent unreasonable nesting depth or infinite loop.
+ *
+ * Both flow fields and the RECIRC action are exposed as open flow fields via
+ * Nicira extensions.
+ *
+ * Post recirculation flow
+ * ------------------------
+ *
+ * At the open flow level, post recirculation rules are always hidden from the
+ * controller. They are installed in table 254 which is set up as a hidden
+ * table during boot time. Those rules are managed by the local user space
+ * program only.
+ *
+ * To speed up the classifier look up process, recirc_id is always reflected
+ * into the metadata field, since recirc_id is required to be exactly matched.
+ *
+ * Classifier look up always starts with table 254. A post recirculation flow
+ * lookup should find its hidden rule within this table. On the other hand, A
+ * newly received packet should miss all post recirculation rules because its
+ * recirc_id is zero, then hit a pre-installed lower priority rule to redirect
+ * classifier to look up starting from table 0:
+ *
+ * * , actions=resubmit(,0)
+ *
+ * Post recirculation data path flows are managed like other data path flows.
+ * They are created on demand. Miss handling, stats collection and revalidation
+ * work the same way as regular flows.
+ */
+
+uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif *ofproto);
+void ofproto_dpif_free_recirc_id(struct ofproto_dpif *ofproto, uint32_t recirc_id);
+int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
+ struct match *, int priority,
+ const struct ofpbuf *ofpacts,
+ struct rule **rulep);
+int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
+ int priority);
#endif /* ofproto-dpif.h */
git://git.onelab.eu / sliver-openvswitch.git / blobdiff