lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #ifndef FLOW_H
  17 #define FLOW_H 1
  18
  19 #include <sys/types.h>
  20 #include <netinet/in.h>
  21 #include <stdbool.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include "openflow/nicira-ext.h"
  25 #include "openflow/openflow.h"
  26 #include "hash.h"
  27 #include "openvswitch/xflow.h"
  28 #include "packets.h"
  29 #include "util.h"
  30
  31 #ifdef  __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct ds;
  36 struct ofp_match;
  37 struct ofpbuf;
  38
  39 typedef struct flow flow_t;
  40 struct flow {
  41     uint32_t wildcards;         /* Wildcards. */
  42     uint32_t priority;          /* Priority. */
  43     uint32_t tun_id;            /* Encapsulating tunnel ID. */
  44     uint32_t nw_src;            /* IP source address. */
  45     uint32_t nw_dst;            /* IP destination address. */
  46     uint16_t in_port;           /* Input switch port. */
  47     uint16_t dl_vlan;           /* Input VLAN. */
  48     uint16_t dl_type;           /* Ethernet frame type. */
  49     uint16_t tp_src;            /* TCP/UDP source port. */
  50     uint16_t tp_dst;            /* TCP/UDP destination port. */
  51     uint8_t dl_src[ETH_ADDR_LEN]; /* Ethernet source address. */
  52     uint8_t dl_dst[ETH_ADDR_LEN]; /* Ethernet destination address. */
  53     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  54     uint8_t dl_vlan_pcp;        /* Input VLAN priority. */
  55     uint8_t nw_tos;             /* IP ToS (DSCP field, 6 bits). */
  56 };
  57
  58 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  59  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  60 #define FLOW_SIG_SIZE 45
  61 #define FLOW_PAD_SIZE 3
  62 BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1);
  63 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1);
  64 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
  65
  66 int flow_extract(struct ofpbuf *, uint32_t tun_id, uint16_t in_port, flow_t *);
  67 void flow_extract_stats(const flow_t *flow, struct ofpbuf *packet,
  68         struct xflow_flow_stats *stats);
  69 void flow_to_match(const flow_t *,
  70                    bool tun_id_from_cookie, struct ofp_match *);
  71 void flow_from_match(const struct ofp_match *, uint32_t priority,
  72                      bool tun_id_from_cookie, uint64_t cookie, flow_t *);
  73 char *flow_to_string(const flow_t *);
  74 void flow_format(struct ds *, const flow_t *);
  75 void flow_print(FILE *, const flow_t *);
  76 static inline int flow_compare_headers(const flow_t *, const flow_t *);
  77 static inline bool flow_equal_headers(const flow_t *, const flow_t *);
  78 static inline size_t flow_hash_headers(const flow_t *, uint32_t basis);
  79
  80 /* Compares members of 'a' and 'b' except for 'wildcards' and 'priority' and
  81  * returns a strcmp()-like return value. */
  82 static inline int
  83 flow_compare_headers(const flow_t *a, const flow_t *b)
  84 {
  85     /* Assert that 'wildcards' and 'priority' are leading 32-bit fields. */
  86     BUILD_ASSERT_DECL(offsetof(struct flow, wildcards) == 0);
  87     BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->wildcards) == 4);
  88     BUILD_ASSERT_DECL(offsetof(struct flow, priority) == 4);
  89     BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->priority) == 4);
  90
  91     return memcmp((char *) a + 8, (char *) b + 8, FLOW_SIG_SIZE - 8);
  92 }
  93
  94 /* Returns true if all members of 'a' and 'b' are equal except for 'wildcards'
  95  * and 'priority', false otherwise. */
  96 static inline bool
  97 flow_equal_headers(const flow_t *a, const flow_t *b)
  98 {
  99     return !flow_compare_headers(a, b);
 100 }
 101
 102 /* Returns a hash value for 'flow' that does not include 'wildcards' or
 103  * 'priority', folding 'basis' into the hash value. */
 104 static inline size_t
 105 flow_hash_headers(const flow_t *flow, uint32_t basis)
 106 {
 107     /* Assert that 'wildcards' and 'priority' are leading 32-bit fields. */
 108     BUILD_ASSERT_DECL(offsetof(struct flow, wildcards) == 0);
 109     BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->wildcards) == 4);
 110     BUILD_ASSERT_DECL(offsetof(struct flow, priority) == 4);
 111     BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->priority) == 4);
 112
 113     return hash_bytes((char *) flow + 8, FLOW_SIG_SIZE - 8, basis);
 114 }
 115
 116 /* Information on wildcards for a flow, as a supplement to flow_t. */
 117 struct flow_wildcards {
 118     uint32_t nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 119     uint32_t nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 120 };
 121
 122 /* Given the wildcard bit count in bits 'shift' through 'shift + 5' (inclusive)
 123  * of 'wildcards', returns a 32-bit bit mask with a 1 in each bit that must
 124  * match and a 0 in each bit that is wildcarded.
 125  *
 126  * The bits in 'wildcards' are in the format used in enum ofp_flow_wildcards: 0
 127  * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
 128  * ..., 32 and higher wildcard the entire field.  This is the *opposite* of the
 129  * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
 130  * wildcarded.
 131  *
 132  * 'wildcards' is in host byte order.  The return value is in network byte
 133  * order. */
 134 static inline uint32_t
 135 flow_nw_bits_to_mask(uint32_t wildcards, int shift)
 136 {
 137     wildcards = (wildcards >> shift) & 0x3f;
 138     return wildcards < 32 ? htonl(~((1u << wildcards) - 1)) : 0;
 139 }
 140
 141 static inline void
 142 flow_wildcards_init(struct flow_wildcards *wc, uint32_t wildcards)
 143 {
 144     wildcards &= OVSFW_ALL;
 145     wc->nw_src_mask = flow_nw_bits_to_mask(wildcards, OFPFW_NW_SRC_SHIFT);
 146     wc->nw_dst_mask = flow_nw_bits_to_mask(wildcards, OFPFW_NW_DST_SHIFT);
 147 }
 148
 149 #ifdef  __cplusplus
 150 }
 151 #endif
 152
 153 #endif /* flow.h */