lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 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 dpif_flow_stats;
  31 struct ds;
  32 struct flow_wildcards;
  33 struct ofp_match;
  34 struct ofpbuf;
  35
  36 #define FLOW_N_REGS 4
  37 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  38
  39 /* Used for struct flow's dl_type member for frames that have no Ethernet
  40  * type, that is, pure 802.2 frames. */
  41 #define FLOW_DL_TYPE_NONE 0x5ff
  42
  43 struct flow {
  44     ovs_be64 tun_id;            /* Encapsulating tunnel ID. */
  45     uint32_t regs[FLOW_N_REGS]; /* Registers. */
  46     ovs_be32 nw_src;            /* IP source address. */
  47     ovs_be32 nw_dst;            /* IP destination address. */
  48     uint16_t in_port;           /* Input switch port. */
  49     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
  50     ovs_be16 dl_type;           /* Ethernet frame type. */
  51     ovs_be16 tp_src;            /* TCP/UDP source port. */
  52     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
  53     uint8_t dl_src[6];          /* Ethernet source address. */
  54     uint8_t dl_dst[6];          /* Ethernet destination address. */
  55     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  56     uint8_t nw_tos;             /* IP ToS (DSCP field, 6 bits). */
  57 };
  58
  59 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  60  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  61 #define FLOW_SIG_SIZE (40 + FLOW_N_REGS * 4)
  62 #define FLOW_PAD_SIZE 0
  63 BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1);
  64 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1);
  65 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
  66
  67 int flow_extract(struct ofpbuf *, uint64_t tun_id, uint16_t in_port,
  68                  struct flow *);
  69 void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
  70                         struct dpif_flow_stats *);
  71 char *flow_to_string(const struct flow *);
  72 void flow_format(struct ds *, const struct flow *);
  73 void flow_print(FILE *, const struct flow *);
  74 static inline int flow_compare(const struct flow *, const struct flow *);
  75 static inline bool flow_equal(const struct flow *, const struct flow *);
  76 static inline size_t flow_hash(const struct flow *, uint32_t basis);
  77
  78 static inline int
  79 flow_compare(const struct flow *a, const struct flow *b)
  80 {
  81     return memcmp(a, b, FLOW_SIG_SIZE);
  82 }
  83
  84 static inline bool
  85 flow_equal(const struct flow *a, const struct flow *b)
  86 {
  87     return !flow_compare(a, b);
  88 }
  89
  90 static inline size_t
  91 flow_hash(const struct flow *flow, uint32_t basis)
  92 {
  93     return hash_bytes(flow, FLOW_SIG_SIZE, basis);
  94 }
  95
  96 /* Open vSwitch flow wildcard bits.
  97  *
  98  * These are used only internally to Open vSwitch, in the 'wildcards' member of
  99  * struct flow_wildcards.  They never appear in the wire protocol in this
 100  * form. */
 101
 102 typedef unsigned int OVS_BITWISE flow_wildcards_t;
 103
 104 /* Same values and meanings as corresponding OFPFW_* bits. */
 105 #define FWW_IN_PORT     ((OVS_FORCE flow_wildcards_t) (1 << 0))
 106 #define FWW_DL_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 2))
 107 #define FWW_DL_DST      ((OVS_FORCE flow_wildcards_t) (1 << 3))
 108                                               /* excluding the multicast bit */
 109 #define FWW_DL_TYPE     ((OVS_FORCE flow_wildcards_t) (1 << 4))
 110 #define FWW_NW_PROTO    ((OVS_FORCE flow_wildcards_t) (1 << 5))
 111 #define FWW_TP_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 6))
 112 #define FWW_TP_DST      ((OVS_FORCE flow_wildcards_t) (1 << 7))
 113 /* Same meanings as corresponding OFPFW_* bits, but differ in value. */
 114 #define FWW_NW_TOS      ((OVS_FORCE flow_wildcards_t) (1 << 1))
 115 /* No corresponding OFPFW_* or OVSFW_* bits. */
 116 #define FWW_ETH_MCAST   ((OVS_FORCE flow_wildcards_t) (1 << 8))
 117                                                        /* multicast bit only */
 118 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 9)) - 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     ovs_be64 tun_id_mask;       /* 1-bit in each significant tun_id bit. */
 126     flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
 127     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
 128     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 129     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 130     ovs_be16 vlan_tci_mask;     /* 1-bit in each significant vlan_tci bit. */
 131     uint16_t zero;              /* Padding field set to zero. */
 132 };
 133
 134 void flow_wildcards_init_catchall(struct flow_wildcards *);
 135 void flow_wildcards_init_exact(struct flow_wildcards *);
 136
 137 bool flow_wildcards_is_exact(const struct flow_wildcards *);
 138
 139 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
 140 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
 141 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 142                                  int idx, uint32_t mask);
 143
 144 void flow_wildcards_combine(struct flow_wildcards *dst,
 145                             const struct flow_wildcards *src1,
 146                             const struct flow_wildcards *src2);
 147 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 148                               const struct flow_wildcards *);
 149
 150 uint32_t flow_wildcards_hash(const struct flow_wildcards *);
 151 bool flow_wildcards_equal(const struct flow_wildcards *,
 152                           const struct flow_wildcards *);
 153 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 154
 155 #endif /* flow.h */