ofp-util: New function for parsing key-value pairs.
[sliver-openvswitch.git] / lib / odp-util.h
index d991b19..4379729 100644 (file)
@@ -30,16 +30,16 @@ struct ds;
 struct flow;
 struct ofpbuf;
 
-#define ODPP_NONE ((uint16_t) -1)
+#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;
     }
@@ -49,9 +49,9 @@ static inline uint16_t
 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;
@@ -63,17 +63,38 @@ void format_odp_action(struct ds *, const struct nlattr *);
 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
                         size_t actions_len);
 
-/* By my calculations currently the longest valid nlattr-formatted flow key is
- * 132 bytes long.
+/* Upper bound on the length of a nlattr-formatted flow key.  The longest
+ * nlattr-formatted flow key would be:
  *
- * We allocate temporary on-stack buffers for flow keys as arrays of uint32_t
- * to ensure proper 32-bit alignment for Netlink attributes.  (An array of
- * "struct nlattr" might not, in theory, be sufficiently aligned because it
- * only contains 16-bit types.) */
+ *                         struct  pad  nl hdr  total
+ *                         ------  ---  ------  -----
+ *  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         34     2     4     40
+ *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
+ *  OVS_KEY_ATTR_ND           28    --     4     32
+ *  -------------------------------------------------
+ *  total                                       132
+ */
 #define ODPUTIL_FLOW_KEY_BYTES 132
-#define ODPUTIL_FLOW_KEY_U32S DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)
+
+/* This is an imperfect sanity-check that ODPUTIL_FLOW_KEY_BYTES doesn't
+ * need to be updated, but will at least raise awareness when new OVS
+ * datapath key types are added. */
+BUILD_ASSERT_DECL(__OVS_KEY_ATTR_MAX == 14);
+
+/* 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, struct ofpbuf *);
 
 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *);
 int odp_flow_key_to_flow(const struct nlattr *, size_t, struct flow *);