net/openvswitch/flow.h

   1 /*
   2  * Copyright (c) 2007-2013 Nicira, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301, USA
  17  */
  18
  19 #ifndef FLOW_H
  20 #define FLOW_H 1
  21
  22 #include <linux/kernel.h>
  23 #include <linux/netlink.h>
  24 #include <linux/openvswitch.h>
  25 #include <linux/spinlock.h>
  26 #include <linux/types.h>
  27 #include <linux/rcupdate.h>
  28 #include <linux/if_ether.h>
  29 #include <linux/in6.h>
  30 #include <linux/jiffies.h>
  31 #include <linux/time.h>
  32 #include <linux/flex_array.h>
  33 #include <net/inet_ecn.h>
  34
  35 struct sk_buff;
  36 struct sw_flow_mask;
  37 struct flow_table;
  38
  39 struct sw_flow_actions {
  40         struct rcu_head rcu;
  41         u32 actions_len;
  42         struct nlattr actions[];
  43 };
  44
  45 /* Used to memset ovs_key_ipv4_tunnel padding. */
  46 #define OVS_TUNNEL_KEY_SIZE                                     \
  47         (offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) +       \
  48         FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
  49
  50 struct ovs_key_ipv4_tunnel {
  51         __be64 tun_id;
  52         __be32 ipv4_src;
  53         __be32 ipv4_dst;
  54         __be16 tun_flags;
  55         u8   ipv4_tos;
  56         u8   ipv4_ttl;
  57 };
  58
  59 static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
  60                                          const struct iphdr *iph, __be64 tun_id,
  61                                          __be16 tun_flags)
  62 {
  63         tun_key->tun_id = tun_id;
  64         tun_key->ipv4_src = iph->saddr;
  65         tun_key->ipv4_dst = iph->daddr;
  66         tun_key->ipv4_tos = iph->tos;
  67         tun_key->ipv4_ttl = iph->ttl;
  68         tun_key->tun_flags = tun_flags;
  69
  70         /* clear struct padding. */
  71         memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
  72                sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
  73 }
  74
  75 struct sw_flow_key {
  76         struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
  77         struct {
  78                 u32     priority;       /* Packet QoS priority. */
  79                 u32     skb_mark;       /* SKB mark. */
  80                 u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  81         } phy;
  82         struct {
  83                 u8     src[ETH_ALEN];   /* Ethernet source address. */
  84                 u8     dst[ETH_ALEN];   /* Ethernet destination address. */
  85                 __be16 tci;             /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  86                 __be16 type;            /* Ethernet frame type. */
  87         } eth;
  88         struct {
  89                 u8     proto;           /* IP protocol or lower 8 bits of ARP opcode. */
  90                 u8     tos;             /* IP ToS. */
  91                 u8     ttl;             /* IP TTL/hop limit. */
  92                 u8     frag;            /* One of OVS_FRAG_TYPE_*. */
  93         } ip;
  94         union {
  95                 struct {
  96                         struct {
  97                                 __be32 src;     /* IP source address. */
  98                                 __be32 dst;     /* IP destination address. */
  99                         } addr;
 100                         union {
 101                                 struct {
 102                                         __be16 src;             /* TCP/UDP/SCTP source port. */
 103                                         __be16 dst;             /* TCP/UDP/SCTP destination port. */
 104                                 } tp;
 105                                 struct {
 106                                         u8 sha[ETH_ALEN];       /* ARP source hardware address. */
 107                                         u8 tha[ETH_ALEN];       /* ARP target hardware address. */
 108                                 } arp;
 109                         };
 110                 } ipv4;
 111                 struct {
 112                         struct {
 113                                 struct in6_addr src;    /* IPv6 source address. */
 114                                 struct in6_addr dst;    /* IPv6 destination address. */
 115                         } addr;
 116                         __be32 label;                   /* IPv6 flow label. */
 117                         struct {
 118                                 __be16 src;             /* TCP/UDP/SCTP source port. */
 119                                 __be16 dst;             /* TCP/UDP/SCTP destination port. */
 120                         } tp;
 121                         struct {
 122                                 struct in6_addr target; /* ND target address. */
 123                                 u8 sll[ETH_ALEN];       /* ND source link layer address. */
 124                                 u8 tll[ETH_ALEN];       /* ND target link layer address. */
 125                         } nd;
 126                 } ipv6;
 127         };
 128 } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
 129
 130 struct sw_flow {
 131         struct rcu_head rcu;
 132         struct hlist_node hash_node[2];
 133         u32 hash;
 134
 135         struct sw_flow_key key;
 136         struct sw_flow_key unmasked_key;
 137         struct sw_flow_mask *mask;
 138         struct sw_flow_actions __rcu *sf_acts;
 139
 140         spinlock_t lock;        /* Lock for values below. */
 141         unsigned long used;     /* Last used time (in jiffies). */
 142         u64 packet_count;       /* Number of packets matched. */
 143         u64 byte_count;         /* Number of bytes matched. */
 144         u8 tcp_flags;           /* Union of seen TCP flags. */
 145 };
 146
 147 struct sw_flow_key_range {
 148         size_t start;
 149         size_t end;
 150 };
 151
 152 struct sw_flow_match {
 153         struct sw_flow_key *key;
 154         struct sw_flow_key_range range;
 155         struct sw_flow_mask *mask;
 156 };
 157
 158 void ovs_match_init(struct sw_flow_match *match,
 159                 struct sw_flow_key *key, struct sw_flow_mask *mask);
 160
 161 struct arp_eth_header {
 162         __be16      ar_hrd;     /* format of hardware address   */
 163         __be16      ar_pro;     /* format of protocol address   */
 164         unsigned char   ar_hln; /* length of hardware address   */
 165         unsigned char   ar_pln; /* length of protocol address   */
 166         __be16      ar_op;      /* ARP opcode (command)     */
 167
 168         /* Ethernet+IPv4 specific members. */
 169         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 170         unsigned char       ar_sip[4];          /* sender IP address        */
 171         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 172         unsigned char       ar_tip[4];          /* target IP address        */
 173 } __packed;
 174
 175 int ovs_flow_init(void);
 176 void ovs_flow_exit(void);
 177
 178 struct sw_flow *ovs_flow_alloc(void);
 179 void ovs_flow_deferred_free(struct sw_flow *);
 180 void ovs_flow_free(struct sw_flow *, bool deferred);
 181
 182 struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
 183 void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
 184
 185 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);
 186 void ovs_flow_used(struct sw_flow *, struct sk_buff *);
 187 u64 ovs_flow_used_time(unsigned long flow_jiffies);
 188 int ovs_flow_to_nlattrs(const struct sw_flow_key *,
 189                 const struct sw_flow_key *, struct sk_buff *);
 190 int ovs_match_from_nlattrs(struct sw_flow_match *match,
 191                       const struct nlattr *,
 192                       const struct nlattr *);
 193 int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow,
 194                 const struct nlattr *attr);
 195
 196 #define MAX_ACTIONS_BUFSIZE    (32 * 1024)
 197 #define TBL_MIN_BUCKETS         1024
 198
 199 struct flow_table {
 200         struct flex_array *buckets;
 201         unsigned int count, n_buckets;
 202         struct rcu_head rcu;
 203         struct list_head *mask_list;
 204         int node_ver;
 205         u32 hash_seed;
 206         bool keep_flows;
 207 };
 208
 209 static inline int ovs_flow_tbl_count(struct flow_table *table)
 210 {
 211         return table->count;
 212 }
 213
 214 static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
 215 {
 216         return (table->count > table->n_buckets);
 217 }
 218
 219 struct sw_flow *ovs_flow_lookup(struct flow_table *,
 220                                 const struct sw_flow_key *);
 221 struct sw_flow *ovs_flow_lookup_unmasked_key(struct flow_table *table,
 222                                     struct sw_flow_match *match);
 223
 224 void ovs_flow_tbl_destroy(struct flow_table *table, bool deferred);
 225 struct flow_table *ovs_flow_tbl_alloc(int new_size);
 226 struct flow_table *ovs_flow_tbl_expand(struct flow_table *table);
 227 struct flow_table *ovs_flow_tbl_rehash(struct flow_table *table);
 228
 229 void ovs_flow_insert(struct flow_table *table, struct sw_flow *flow);
 230 void ovs_flow_remove(struct flow_table *table, struct sw_flow *flow);
 231
 232 struct sw_flow *ovs_flow_dump_next(struct flow_table *table, u32 *bucket, u32 *idx);
 233 extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
 234 int ovs_ipv4_tun_from_nlattr(const struct nlattr *attr,
 235                              struct sw_flow_match *match, bool is_mask);
 236 int ovs_ipv4_tun_to_nlattr(struct sk_buff *skb,
 237                            const struct ovs_key_ipv4_tunnel *tun_key,
 238                            const struct ovs_key_ipv4_tunnel *output);
 239
 240 bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
 241                 const struct sw_flow_key *key, int key_end);
 242
 243 struct sw_flow_mask {
 244         int ref_count;
 245         struct rcu_head rcu;
 246         struct list_head list;
 247         struct sw_flow_key_range range;
 248         struct sw_flow_key key;
 249 };
 250
 251 struct sw_flow_mask *ovs_sw_flow_mask_alloc(void);
 252 void ovs_sw_flow_mask_add_ref(struct sw_flow_mask *);
 253 void ovs_sw_flow_mask_del_ref(struct sw_flow_mask *, bool deferred);
 254 void ovs_sw_flow_mask_insert(struct flow_table *, struct sw_flow_mask *);
 255 struct sw_flow_mask *ovs_sw_flow_mask_find(const struct flow_table *,
 256                 const struct sw_flow_mask *);
 257 void ovs_flow_key_mask(struct sw_flow_key *dst, const struct sw_flow_key *src,
 258                        const struct sw_flow_mask *mask);
 259 #endif /* flow.h */