/*
- * Copyright (c) 2009 Nicira Networks.
+ * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#define ODP_UTIL_H 1
#include <stdbool.h>
+#include <stddef.h>
#include <stdint.h>
+#include <string.h>
+#include <linux/openvswitch.h>
+#include "hash.h"
#include "openflow/openflow.h"
-#include "openvswitch/datapath-protocol.h"
+#include "util.h"
struct ds;
+struct flow;
+struct nlattr;
+struct ofpbuf;
+struct shash;
-/* The kernel datapaths limits actions to those that fit in a single page of
- * memory, so there is no point in allocating more than that. */
-enum { MAX_ODP_ACTIONS = 4096 / sizeof(union odp_action) };
-
-struct odp_actions {
- size_t n_actions;
- union odp_action actions[MAX_ODP_ACTIONS];
-};
-
-static inline void
-odp_actions_init(struct odp_actions *actions)
-{
- actions->n_actions = 0;
-}
-
-union odp_action *odp_actions_add(struct odp_actions *actions, uint16_t type);
-
-static inline bool
-odp_actions_overflow(const struct odp_actions *actions)
-{
- return actions->n_actions > MAX_ODP_ACTIONS;
-}
+#define OVSP_NONE ((uint16_t) -1)
static inline uint16_t
ofp_port_to_odp_port(uint16_t ofp_port)
{
switch (ofp_port) {
case OFPP_LOCAL:
- return ODPP_LOCAL;
+ return OVSP_LOCAL;
case OFPP_NONE:
- return ODPP_NONE;
+ return OVSP_NONE;
default:
return ofp_port;
}
odp_port_to_ofp_port(uint16_t odp_port)
{
switch (odp_port) {
- case ODPP_LOCAL:
+ case OVSP_LOCAL:
return OFPP_LOCAL;
- case ODPP_NONE:
+ case OVSP_NONE:
return OFPP_NONE;
default:
return odp_port;
}
}
-void format_odp_action(struct ds *, const union odp_action *);
-void format_odp_actions(struct ds *, const union odp_action *actions,
- size_t n_actions);
-void format_odp_flow_stats(struct ds *, const struct odp_flow_stats *);
-void format_odp_flow(struct ds *, const struct odp_flow *);
+void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
+ size_t actions_len);
+int odp_actions_from_string(const char *, const struct shash *port_names,
+ struct ofpbuf *odp_actions);
+
+/* Upper bound on the length of a nlattr-formatted flow key. The longest
+ * nlattr-formatted flow key would be:
+ *
+ * struct pad nl hdr total
+ * ------ --- ------ -----
+ * OVS_KEY_ATTR_PRIORITY 4 -- 4 8
+ * OVS_KEY_ATTR_TUN_ID 8 -- 4 12
+ * OVS_KEY_ATTR_IN_PORT 4 -- 4 8
+ * OVS_KEY_ATTR_ETHERNET 12 -- 4 16
+ * OVS_KEY_ATTR_8021Q 4 -- 4 8
+ * OVS_KEY_ATTR_ETHERTYPE 2 2 4 8
+ * OVS_KEY_ATTR_IPV6 40 -- 4 44
+ * OVS_KEY_ATTR_ICMPV6 2 2 4 8
+ * OVS_KEY_ATTR_ND 28 -- 4 32
+ * -------------------------------------------------
+ * total 144
+ */
+#define ODPUTIL_FLOW_KEY_BYTES 144
+
+/* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
+ * key. An array of "struct nlattr" might not, in theory, be sufficiently
+ * aligned because it only contains 16-bit types. */
+struct odputil_keybuf {
+ uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
+};
+
+void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
+int odp_flow_key_from_string(const char *s, const struct shash *port_names,
+ struct ofpbuf *);
+
+void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *);
+
+uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
+
+/* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
+ * attributes) matches OVS userspace expectations.
+ *
+ * These values are arranged so that greater values are "more important" than
+ * lesser ones. In particular, a single flow key can fit the descriptions for
+ * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH. Such a key is treated as
+ * ODP_FIT_TOO_LITTLE. */
+enum odp_key_fitness {
+ ODP_FIT_PERFECT, /* The key had exactly the fields we expect. */
+ ODP_FIT_TOO_MUCH, /* The key had fields we don't understand. */
+ ODP_FIT_TOO_LITTLE, /* The key lacked fields we expected to see. */
+ ODP_FIT_ERROR, /* The key was invalid. */
+};
+enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
+ struct flow *);
+const char *odp_key_fitness_to_string(enum odp_key_fitness);
+
+enum user_action_cookie_type {
+ USER_ACTION_COOKIE_UNSPEC,
+ USER_ACTION_COOKIE_SFLOW, /* Packet for sFlow sampling. */
+};
+
+/* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
+ * Since is it passed to kernel as u64, its size has to be 8 bytes. */
+struct user_action_cookie {
+ uint8_t type; /* enum user_action_cookie_type. */
+ uint8_t n_output; /* No of output ports. used by sflow. */
+ ovs_be16 vlan_tci; /* Used by sFlow */
+ uint32_t data; /* Data is len for OFPP_CONTROLLER action.
+ For sFlow it is port_ifindex. */
+};
+
+BUILD_ASSERT_DECL(sizeof(struct user_action_cookie) == 8);
+
+size_t odp_put_userspace_action(uint32_t pid,
+ const struct user_action_cookie *,
+ struct ofpbuf *odp_actions);
+void commit_odp_actions(const struct flow *, struct flow *base,
+ struct ofpbuf *odp_actions);
#endif /* odp-util.h */