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     uint8_t arp_sha[6];         /* ARP source hardware address. */
  58     uint8_t arp_tha[6];         /* ARP target hardware address. */
  59     uint32_t reserved;          /* Reserved for 64-bit packing. */
  60 };
  61
  62 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  63  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  64 #define FLOW_SIG_SIZE (52 + FLOW_N_REGS * 4)
  65 #define FLOW_PAD_SIZE 4
  66 BUILD_ASSERT_DECL(offsetof(struct flow, arp_tha) == FLOW_SIG_SIZE - 6);
  67 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->arp_tha) == 6);
  68 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
  69
  70 int flow_extract(struct ofpbuf *, uint64_t tun_id, uint16_t in_port,
  71                  struct flow *);
  72 void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
  73                         struct dpif_flow_stats *);
  74 char *flow_to_string(const struct flow *);
  75 void flow_format(struct ds *, const struct flow *);
  76 void flow_print(FILE *, const struct flow *);
  77 static inline int flow_compare(const struct flow *, const struct flow *);
  78 static inline bool flow_equal(const struct flow *, const struct flow *);
  79 static inline size_t flow_hash(const struct flow *, uint32_t basis);
  80
  81 static inline int
  82 flow_compare(const struct flow *a, const struct flow *b)
  83 {
  84     return memcmp(a, b, FLOW_SIG_SIZE);
  85 }
  86
  87 static inline bool
  88 flow_equal(const struct flow *a, const struct flow *b)
  89 {
  90     return !flow_compare(a, b);
  91 }
  92
  93 static inline size_t
  94 flow_hash(const struct flow *flow, uint32_t basis)
  95 {
  96     return hash_bytes(flow, FLOW_SIG_SIZE, basis);
  97 }
  98
  99 /* Open vSwitch flow wildcard bits.
 100  *
 101  * These are used only internally to Open vSwitch, in the 'wildcards' member of
 102  * struct flow_wildcards.  They never appear in the wire protocol in this
 103  * form. */
 104
 105 typedef unsigned int OVS_BITWISE flow_wildcards_t;
 106
 107 /* Same values and meanings as corresponding OFPFW_* bits. */
 108 #define FWW_IN_PORT     ((OVS_FORCE flow_wildcards_t) (1 << 0))
 109 #define FWW_DL_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 2))
 110 #define FWW_DL_DST      ((OVS_FORCE flow_wildcards_t) (1 << 3))
 111                                               /* excluding the multicast bit */
 112 #define FWW_DL_TYPE     ((OVS_FORCE flow_wildcards_t) (1 << 4))
 113 #define FWW_NW_PROTO    ((OVS_FORCE flow_wildcards_t) (1 << 5))
 114 #define FWW_TP_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 6))
 115 #define FWW_TP_DST      ((OVS_FORCE flow_wildcards_t) (1 << 7))
 116 /* Same meanings as corresponding OFPFW_* bits, but differ in value. */
 117 #define FWW_NW_TOS      ((OVS_FORCE flow_wildcards_t) (1 << 1))
 118 /* No corresponding OFPFW_* or OVSFW_* bits. */
 119 #define FWW_ETH_MCAST   ((OVS_FORCE flow_wildcards_t) (1 << 8))
 120                                                        /* multicast bit only */
 121 #define FWW_ARP_SHA     ((OVS_FORCE flow_wildcards_t) (1 << 9))
 122 #define FWW_ARP_THA     ((OVS_FORCE flow_wildcards_t) (1 << 10))
 123 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 11)) - 1))
 124
 125 /* Information on wildcards for a flow, as a supplement to "struct flow".
 126  *
 127  * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
 128  * the rest of the members. */
 129 struct flow_wildcards {
 130     ovs_be64 tun_id_mask;       /* 1-bit in each significant tun_id bit. */
 131     flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
 132     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
 133     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 134     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 135     ovs_be16 vlan_tci_mask;     /* 1-bit in each significant vlan_tci bit. */
 136     uint16_t zero;              /* Padding field set to zero. */
 137 };
 138
 139 void flow_wildcards_init_catchall(struct flow_wildcards *);
 140 void flow_wildcards_init_exact(struct flow_wildcards *);
 141
 142 bool flow_wildcards_is_exact(const struct flow_wildcards *);
 143
 144 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
 145 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
 146 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 147                                  int idx, uint32_t mask);
 148
 149 void flow_wildcards_combine(struct flow_wildcards *dst,
 150                             const struct flow_wildcards *src1,
 151                             const struct flow_wildcards *src2);
 152 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 153                               const struct flow_wildcards *);
 154
 155 uint32_t flow_wildcards_hash(const struct flow_wildcards *);
 156 bool flow_wildcards_equal(const struct flow_wildcards *,
 157                           const struct flow_wildcards *);
 158 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 159
 160 #endif /* flow.h */