meta-flow: New "subfield" data structure.

[sliver-openvswitch.git] / lib / meta-flow.h

diff --git a/lib/meta-flow.h b/lib/meta-flow.h
index eddc549..4917834 100644 (file)
--- a/lib/meta-flow.h
+++ b/lib/meta-flow.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011 Nicira Networks.
+ * Copyright (c) 2011, 2012 Nicira Networks.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
 #include <netinet/in.h>
 #include <netinet/ip6.h>
 #include "flow.h"
+#include "ofp-errors.h"
 #include "packets.h"
 
 struct cls_rule;
@@ -72,6 +73,7 @@ enum mf_field_id {
     MFF_IP_PROTO,               /* u8 (used for IPv4 or IPv6) */
     MFF_IP_DSCP,                /* u8 (used for IPv4 or IPv6) */
     MFF_IP_ECN,                 /* u8 (used for IPv4 or IPv6) */
+    MFF_IP_TTL,                 /* u8 (used for IPv4 or IPv6) */
     MFF_IP_FRAG,                /* u8 (used for IPv4 or IPv6) */
 
     MFF_ARP_OP,                 /* be16 */
@@ -87,8 +89,11 @@ enum mf_field_id {
     MFF_UDP_SRC,                /* be16 (used for IPv4 or IPv6) */
     MFF_UDP_DST,                /* be16 (used for IPv4 or IPv6) */
 
-    MFF_ICMP_TYPE,              /* u8 (used for IPv4 or IPv6) */
-    MFF_ICMP_CODE,              /* u8 (used for IPv4 or IPv6) */
+    MFF_ICMPV4_TYPE,            /* u8 */
+    MFF_ICMPV4_CODE,            /* u8 */
+
+    MFF_ICMPV6_TYPE,            /* u8 */
+    MFF_ICMPV6_CODE,            /* u8 */
 
     /* ICMPv6 Neighbor Discovery. */
     MFF_ND_TARGET,              /* ipv6 */
@@ -115,8 +120,8 @@ enum mf_prereqs {
     /* L2+L3 requirements. */
     MFP_TCP,                    /* On IPv4 or IPv6. */
     MFP_UDP,                    /* On IPv4 or IPv6. */
+    MFP_ICMPV4,
     MFP_ICMPV6,
-    MFP_ICMP_ANY,
 
     /* L2+L3+L4 requirements. */
     MFP_ND,
@@ -174,7 +179,14 @@ struct mf_field {
     flow_wildcards_t fww_bit;   /* Either 0 or exactly one FWW_* bit. */
     enum mf_string string;
     enum mf_prereqs prereqs;
+    bool writable;              /* May be written by actions? */
+
+    /* NXM properties.
+     *
+     * A few "mf_field"s don't correspond to NXM fields.  Those have 0 and
+     * NULL for the following members, respectively. */
     uint32_t nxm_header;        /* An NXM_* constant (a few fields have 0). */
+    const char *nxm_name;       /* The "NXM_*" constant's name. */
 };
 
 /* The representation of a field's value. */
@@ -187,9 +199,18 @@ union mf_value {
     struct in6_addr ipv6;
 };
 
+/* Part of a field. */
+struct mf_subfield {
+    const struct mf_field *field;
+    unsigned int ofs;           /* Bit offset. */
+    unsigned int n_bits;        /* Number of bits. */
+};
+
 /* Finding mf_fields. */
 const struct mf_field *mf_from_id(enum mf_field_id);
 const struct mf_field *mf_from_name(const char *name);
+const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
+const struct mf_field *mf_from_nxm_name(const char *nxm_name);
 
 /* Inspecting wildcarded bits. */
 bool mf_is_all_wild(const struct mf_field *, const struct flow_wildcards *);
@@ -209,19 +230,33 @@ void mf_get_value(const struct mf_field *, const struct flow *,
                   union mf_value *value);
 void mf_set_value(const struct mf_field *, const union mf_value *value,
                   struct cls_rule *);
+void mf_set_flow_value(const struct mf_field *, const union mf_value *value,
+                       struct flow *);
 
 void mf_get(const struct mf_field *, const struct cls_rule *,
             union mf_value *value, union mf_value *mask);
 void mf_set(const struct mf_field *,
             const union mf_value *value, const union mf_value *mask,
             struct cls_rule *);
-void mf_set_subfield(const struct mf_field *, uint64_t value, unsigned int ofs,
-                     unsigned int n_bits, struct cls_rule *);
 
 void mf_set_wild(const struct mf_field *, struct cls_rule *);
 
 void mf_random_value(const struct mf_field *, union mf_value *value);
 
+/* Subfields. */
+void mf_set_subfield(const struct mf_subfield *, uint64_t value,
+                     struct cls_rule *);
+void mf_set_subfield_value(const struct mf_subfield *, uint64_t value,
+                           struct flow *);
+uint64_t mf_get_subfield(const struct mf_subfield *, const struct flow *);
+
+void mf_format_subfield(const struct mf_subfield *, struct ds *);
+char *mf_parse_subfield__(struct mf_subfield *sf, const char **s);
+const char *mf_parse_subfield(struct mf_subfield *, const char *);
+
+enum ofperr mf_check_src(const struct mf_subfield *, const struct flow *);
+enum ofperr mf_check_dst(const struct mf_subfield *, const struct flow *);
+
 /* Parsing and formatting. */
 char *mf_parse(const struct mf_field *, const char *,
                union mf_value *value, union mf_value *mask);