Global replace of Nicira Networks.
[sliver-openvswitch.git] / lib / meta-flow.h
index 6aa4a1f..662778c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011 Nicira Networks.
+ * Copyright (c) 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.
 #ifndef META_FLOW_H
 #define META_FLOW_H 1
 
+#include <sys/types.h>
+#include <netinet/in.h>
 #include <netinet/ip6.h>
 #include "flow.h"
+#include "ofp-errors.h"
 #include "packets.h"
 
 struct cls_rule;
@@ -44,6 +47,18 @@ enum mf_field_id {
     MFF_REG3,                   /* be32 */
 #endif
 #if FLOW_N_REGS > 4
+    MFF_REG4,                   /* be32 */
+#endif
+#if FLOW_N_REGS > 5
+    MFF_REG5,                   /* be32 */
+#endif
+#if FLOW_N_REGS > 6
+    MFF_REG6,                   /* be32 */
+#endif
+#if FLOW_N_REGS > 7
+    MFF_REG7,                   /* be32 */
+#endif
+#if FLOW_N_REGS > 8
 #error
 #endif
 
@@ -62,9 +77,13 @@ enum mf_field_id {
 
     MFF_IPV6_SRC,               /* ipv6 */
     MFF_IPV6_DST,               /* ipv6 */
+    MFF_IPV6_LABEL,             /* be32 */
 
     MFF_IP_PROTO,               /* u8 (used for IPv4 or IPv6) */
-    MFF_IP_TOS,                 /* 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 */
     MFF_ARP_SPA,                /* be32 */
@@ -79,8 +98,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 */
@@ -107,8 +129,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,
@@ -139,7 +161,8 @@ enum mf_string {
     MFS_ETHERNET,
     MFS_IPV4,
     MFS_IPV6,
-    MFS_OFP_PORT                /* An OpenFlow port number or name. */
+    MFS_OFP_PORT,               /* An OpenFlow port number or name. */
+    MFS_FRAG                    /* no, yes, first, later, not_later */
 };
 
 struct mf_field {
@@ -150,9 +173,13 @@ struct mf_field {
 
     /* Size.
      *
-     * Most fields have n_bytes * 8 == n_bits.  There are only two exceptions
-     * currently: "dl_vlan" is 2 bytes but only 12 bits, and "dl_vlan_pcp" is
-     * 1 byte but only 3 bits. */
+     * Most fields have n_bytes * 8 == n_bits.  There are a few exceptions:
+     *
+     *     - "dl_vlan" is 2 bytes but only 12 bits.
+     *     - "dl_vlan_pcp" is 1 byte but only 3 bits.
+     *     - "is_frag" is 1 byte but only 2 bits.
+     *     - "ipv6_label" is 4 bytes but only 20 bits.
+     */
     unsigned int n_bytes;       /* Width of the field in bytes. */
     unsigned int n_bits;        /* Number of significant bits in field. */
 
@@ -161,7 +188,23 @@ 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. */
+
+    /* OXM properties */
+    uint32_t oxm_header;        /* Field id in the OXM basic class,
+                                * an OXM_* constant.
+                                * Ignored if oxm_name is NULL */
+    const char *oxm_name;      /* The OXM_* constant's name,
+                                * NULL if the field is not present
+                                * in the OXM basic class */
+
 };
 
 /* The representation of a field's value. */
@@ -173,10 +216,33 @@ union mf_value {
     uint8_t mac[ETH_ADDR_LEN];
     struct in6_addr ipv6;
 };
+BUILD_ASSERT_DECL(sizeof(union mf_value) == 16);
+
+/* Part of a field. */
+struct mf_subfield {
+    const struct mf_field *field;
+    unsigned int ofs;           /* Bit offset. */
+    unsigned int n_bits;        /* Number of bits. */
+};
+
+/* Data for some part of an mf_field.
+ *
+ * The data is stored "right-justified".  For example, if "union mf_subvalue
+ * value" contains NXM_OF_VLAN_TCI[0..11], then one could access the
+ * corresponding data in value.be16[7] as the bits in the mask htons(0xfff). */
+union mf_subvalue {
+    uint8_t u8[16];
+    ovs_be16 be16[8];
+    ovs_be32 be32[4];
+    ovs_be64 be64[2];
+};
+BUILD_ASSERT_DECL(sizeof(union mf_value) == sizeof (union mf_subvalue));
 
 /* 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 *);
@@ -196,19 +262,39 @@ 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_write_subfield(const struct mf_subfield *, const union mf_subvalue *,
+                       struct cls_rule *);
+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 *);
+
+void mf_read_subfield(const struct mf_subfield *, const struct flow *,
+                      union mf_subvalue *);
+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);