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 #define FLOW_N_REGS 3
  36 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  37
  38 struct flow {
  39     uint32_t regs[FLOW_N_REGS]; /* Registers. */
  40     ovs_be32 tun_id;            /* Encapsulating tunnel ID. */
  41     ovs_be32 nw_src;            /* IP source address. */
  42     ovs_be32 nw_dst;            /* IP destination address. */
  43     uint16_t in_port;           /* Input switch port. */
  44     ovs_be16 dl_vlan;           /* Input VLAN. */
  45     ovs_be16 dl_type;           /* Ethernet frame type. */
  46     ovs_be16 tp_src;            /* TCP/UDP source port. */
  47     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
  48     uint8_t dl_src[6];          /* Ethernet source address. */
  49     uint8_t dl_dst[6];          /* Ethernet destination address. */
  50     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  51     uint8_t dl_vlan_pcp;        /* Input VLAN priority. */
  52     uint8_t nw_tos;             /* IP ToS (DSCP field, 6 bits). */
  53 };
  54
  55 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  56  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  57 #define FLOW_SIG_SIZE (37 + FLOW_N_REGS * 4)
  58 #define FLOW_PAD_SIZE 3
  59 BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1);
  60 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1);
  61 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
  62
  63 int flow_extract(struct ofpbuf *, ovs_be32 tun_id, uint16_t in_port,
  64                  struct flow *);
  65 void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
  66         struct odp_flow_stats *stats);
  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 /* Open vSwitch flow wildcard bits.
  93  *
  94  * These are used only internally to Open vSwitch, in the 'wildcards' member of
  95  * struct flow_wildcards.  They never appear in the wire protocol in this
  96  * form. */
  97
  98 typedef unsigned int OVS_BITWISE flow_wildcards_t;
  99
 100 /* Same values and meanings as corresponding OFPFW_* bits. */
 101 #define FWW_IN_PORT     ((OVS_FORCE flow_wildcards_t) (1 << 0))
 102 #define FWW_DL_VLAN     ((OVS_FORCE flow_wildcards_t) (1 << 1))
 103 #define FWW_DL_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 2))
 104 #define FWW_DL_DST      ((OVS_FORCE flow_wildcards_t) (1 << 3))
 105                                               /* excluding the multicast bit */
 106 #define FWW_DL_TYPE     ((OVS_FORCE flow_wildcards_t) (1 << 4))
 107 #define FWW_NW_PROTO    ((OVS_FORCE flow_wildcards_t) (1 << 5))
 108 #define FWW_TP_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 6))
 109 #define FWW_TP_DST      ((OVS_FORCE flow_wildcards_t) (1 << 7))
 110 /* Same meanings as corresponding OFPFW_* bits, but differ in value. */
 111 #define FWW_DL_VLAN_PCP ((OVS_FORCE flow_wildcards_t) (1 << 8))
 112 #define FWW_NW_TOS      ((OVS_FORCE flow_wildcards_t) (1 << 9))
 113 /* No OFPFW_* bits, but they do have corresponding OVSFW_* bits. */
 114 #define FWW_TUN_ID      ((OVS_FORCE flow_wildcards_t) (1 << 10))
 115 /* No corresponding OFPFW_* or OVSFW_* bits. */
 116 #define FWW_ETH_MCAST   ((OVS_FORCE flow_wildcards_t) (1 << 11))
 117                                                        /* multicast bit only */
 118 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 12)) - 1))
 119
 120 /* Information on wildcards for a flow, as a supplement to "struct flow".
 121  *
 122  * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
 123  * the rest of the members. */
 124 struct flow_wildcards {
 125     flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
 126     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
 127     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 128     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 129 };
 130
 131 void flow_wildcards_init_catchall(struct flow_wildcards *);
 132 void flow_wildcards_init_exact(struct flow_wildcards *);
 133
 134 bool flow_wildcards_is_exact(const struct flow_wildcards *);
 135
 136 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
 137 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
 138 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 139                                  int idx, uint32_t mask);
 140
 141 void flow_wildcards_combine(struct flow_wildcards *dst,
 142                             const struct flow_wildcards *src1,
 143                             const struct flow_wildcards *src2);
 144 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 145                               const struct flow_wildcards *);
 146
 147 uint32_t flow_wildcards_hash(const struct flow_wildcards *);
 148 bool flow_wildcards_equal(const struct flow_wildcards *,
 149                           const struct flow_wildcards *);
 150
 151 #endif /* flow.h */