pintos-os.org Git - openvswitch/blob - 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/datapath-protocol.h"
  28 #include "util.h"
  29
  30 struct ds;
  31 struct flow_wildcards;
  32 struct ofp_match;
  33 struct ofpbuf;
  34
  35 struct flow {
  36     ovs_be32 tun_id;            /* Encapsulating tunnel ID. */
  37     ovs_be32 nw_src;            /* IP source address. */
  38     ovs_be32 nw_dst;            /* IP destination address. */
  39     uint16_t in_port;           /* Input switch port. */
  40     ovs_be16 dl_vlan;           /* Input VLAN. */
  41     ovs_be16 dl_type;           /* Ethernet frame type. */
  42     ovs_be16 tp_src;            /* TCP/UDP source port. */
  43     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
  44     uint8_t dl_src[6];          /* Ethernet source address. */
  45     uint8_t dl_dst[6];          /* Ethernet destination address. */
  46     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  47     uint8_t dl_vlan_pcp;        /* Input VLAN priority. */
  48     uint8_t nw_tos;             /* IP ToS (DSCP field, 6 bits). */
  49 };
  50
  51 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  52  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  53 #define FLOW_SIG_SIZE 37
  54 #define FLOW_PAD_SIZE 3
  55 BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1);
  56 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1);
  57 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
  58
  59 int flow_extract(struct ofpbuf *, ovs_be32 tun_id, uint16_t in_port,
  60                  struct flow *);
  61 void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
  62         struct odp_flow_stats *stats);
  63 void flow_to_match(const struct flow *, uint32_t wildcards, int flow_format,
  64                    struct ofp_match *);
  65 void flow_from_match(const struct ofp_match *, int flow_format,
  66                      ovs_be64 cookie, struct flow *, struct flow_wildcards *);
  67 char *flow_to_string(const struct flow *);
  68 void flow_format(struct ds *, const struct flow *);
  69 void flow_print(FILE *, const struct flow *);
  70 static inline int flow_compare(const struct flow *, const struct flow *);
  71 static inline bool flow_equal(const struct flow *, const struct flow *);
  72 static inline size_t flow_hash(const struct flow *, uint32_t basis);
  73
  74 static inline int
  75 flow_compare(const struct flow *a, const struct flow *b)
  76 {
  77     return memcmp(a, b, FLOW_SIG_SIZE);
  78 }
  79
  80 static inline bool
  81 flow_equal(const struct flow *a, const struct flow *b)
  82 {
  83     return !flow_compare(a, b);
  84 }
  85
  86 static inline size_t
  87 flow_hash(const struct flow *flow, uint32_t basis)
  88 {
  89     return hash_bytes(flow, FLOW_SIG_SIZE, basis);
  90 }
  91
  92 /* Information on wildcards for a flow, as a supplement to "struct flow".
  93  *
  94  * The flow_wildcards_*() functions below both depend on and maintain the
  95  * following important invariants:
  96  *
  97  * 1. 'wildcards' is nonzero if and only if at least one bit or field is
  98  *    wildcarded.
  99  *
 100  * 2. Bits in 'wildcards' not included in OVSFW_ALL are set to 0.  (This is a
 101  *    corollary to invariant #1.)
 102  *
 103  * 3. The fields in 'wildcards' masked by OFPFW_NW_SRC_MASK and
 104  *    OFPFW_NW_DST_MASK have values between 0 and 32, inclusive.
 105  *
 106  * 4. The fields masked by OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK correspond
 107  *    correctly to the masks in 'nw_src_mask' and 'nw_dst_mask', respectively.
 108  */
 109 struct flow_wildcards {
 110     uint32_t wildcards;         /* enum ofp_flow_wildcards. */
 111     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 112     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 113 };
 114
 115 ovs_be32 flow_nw_bits_to_mask(uint32_t wildcards, int shift);
 116 void flow_wildcards_init(struct flow_wildcards *, uint32_t wildcards);
 117 void flow_wildcards_init_exact(struct flow_wildcards *);
 118
 119 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
 120 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
 121
 122 void flow_wildcards_combine(struct flow_wildcards *dst,
 123                             const struct flow_wildcards *src1,
 124                             const struct flow_wildcards *src2);
 125 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 126                               const struct flow_wildcards *);
 127
 128 uint32_t flow_wildcards_hash(const struct flow_wildcards *);
 129 bool flow_wildcards_equal(const struct flow_wildcards *,
 130                           const struct flow_wildcards *);
 131
 132 #endif /* flow.h */