datapath/flow.h

   1 /*
   2  * Copyright (c) 2007-2011 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
  37 struct sw_flow_actions {
  38         struct rcu_head rcu;
  39         u32 actions_len;
  40         struct nlattr actions[];
  41 };
  42
  43 struct sw_flow_key {
  44         struct {
  45                 u32     priority;       /* Packet QoS priority. */
  46                 u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  47         } phy;
  48         struct {
  49                 struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
  50         } tun;
  51         struct {
  52                 u8     src[ETH_ALEN];   /* Ethernet source address. */
  53                 u8     dst[ETH_ALEN];   /* Ethernet destination address. */
  54                 __be16 tci;             /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  55                 __be16 type;            /* Ethernet frame type. */
  56         } eth;
  57         struct {
  58                 u8     proto;           /* IP protocol or lower 8 bits of ARP opcode. */
  59                 u8     tos;             /* IP ToS. */
  60                 u8     ttl;             /* IP TTL/hop limit. */
  61                 u8     frag;            /* One of OVS_FRAG_TYPE_*. */
  62         } ip;
  63         union {
  64                 struct {
  65                         struct {
  66                                 __be32 src;     /* IP source address. */
  67                                 __be32 dst;     /* IP destination address. */
  68                         } addr;
  69                         union {
  70                                 struct {
  71                                         __be16 src;             /* TCP/UDP source port. */
  72                                         __be16 dst;             /* TCP/UDP destination port. */
  73                                 } tp;
  74                                 struct {
  75                                         u8 sha[ETH_ALEN];       /* ARP source hardware address. */
  76                                         u8 tha[ETH_ALEN];       /* ARP target hardware address. */
  77                                 } arp;
  78                         };
  79                 } ipv4;
  80                 struct {
  81                         struct {
  82                                 struct in6_addr src;    /* IPv6 source address. */
  83                                 struct in6_addr dst;    /* IPv6 destination address. */
  84                         } addr;
  85                         __be32 label;                   /* IPv6 flow label. */
  86                         struct {
  87                                 __be16 src;             /* TCP/UDP source port. */
  88                                 __be16 dst;             /* TCP/UDP destination port. */
  89                         } tp;
  90                         struct {
  91                                 struct in6_addr target; /* ND target address. */
  92                                 u8 sll[ETH_ALEN];       /* ND source link layer address. */
  93                                 u8 tll[ETH_ALEN];       /* ND target link layer address. */
  94                         } nd;
  95                 } ipv6;
  96         };
  97 };
  98
  99 struct sw_flow {
 100         struct rcu_head rcu;
 101         struct hlist_node hash_node[2];
 102         u32 hash;
 103
 104         struct sw_flow_key key;
 105         struct sw_flow_actions __rcu *sf_acts;
 106
 107         atomic_t refcnt;
 108         bool dead;
 109
 110         spinlock_t lock;        /* Lock for values below. */
 111         unsigned long used;     /* Last used time (in jiffies). */
 112         u64 packet_count;       /* Number of packets matched. */
 113         u64 byte_count;         /* Number of bytes matched. */
 114         u8 tcp_flags;           /* Union of seen TCP flags. */
 115 };
 116
 117 struct arp_eth_header {
 118         __be16      ar_hrd;     /* format of hardware address   */
 119         __be16      ar_pro;     /* format of protocol address   */
 120         unsigned char   ar_hln; /* length of hardware address   */
 121         unsigned char   ar_pln; /* length of protocol address   */
 122         __be16      ar_op;      /* ARP opcode (command)     */
 123
 124         /* Ethernet+IPv4 specific members. */
 125         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 126         unsigned char       ar_sip[4];          /* sender IP address        */
 127         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 128         unsigned char       ar_tip[4];          /* target IP address        */
 129 } __packed;
 130
 131 int ovs_flow_init(void);
 132 void ovs_flow_exit(void);
 133
 134 struct sw_flow *ovs_flow_alloc(void);
 135 void ovs_flow_deferred_free(struct sw_flow *);
 136
 137 struct sw_flow_actions *ovs_flow_actions_alloc(const struct nlattr *);
 138 void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
 139
 140 void ovs_flow_hold(struct sw_flow *);
 141 void ovs_flow_put(struct sw_flow *);
 142
 143 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *,
 144                      int *key_lenp);
 145 void ovs_flow_used(struct sw_flow *, struct sk_buff *);
 146 u64 ovs_flow_used_time(unsigned long flow_jiffies);
 147
 148 /* Upper bound on the length of a nlattr-formatted flow key.  The longest
 149  * nlattr-formatted flow key would be:
 150  *
 151  *                         struct  pad  nl hdr  total
 152  *                         ------  ---  ------  -----
 153  *  OVS_KEY_ATTR_PRIORITY      4    --     4      8
 154  *  OVS_KEY_ATTR_TUN_ID        8    --     4     12
 155  *  OVS_KEY_ATTR_IPV4_TUNNEL  24    --     4     28
 156  *  OVS_KEY_ATTR_IN_PORT       4    --     4      8
 157  *  OVS_KEY_ATTR_ETHERNET     12    --     4     16
 158  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8  (outer VLAN ethertype)
 159  *  OVS_KEY_ATTR_8021Q         4    --     4      8
 160  *  OVS_KEY_ATTR_ENCAP         0    --     4      4  (VLAN encapsulation)
 161  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8  (inner VLAN ethertype)
 162  *  OVS_KEY_ATTR_IPV6         40    --     4     44
 163  *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
 164  *  OVS_KEY_ATTR_ND           28    --     4     32
 165  *  -------------------------------------------------
 166  *  total                                       184
 167  */
 168 #define FLOW_BUFSIZE 184
 169
 170 int ovs_flow_to_nlattrs(const struct sw_flow_key *, struct sk_buff *);
 171 int ovs_flow_from_nlattrs(struct sw_flow_key *swkey, int *key_lenp,
 172                       const struct nlattr *);
 173 int ovs_flow_metadata_from_nlattrs(u32 *priority, u16 *in_port,
 174                                    struct ovs_key_ipv4_tunnel *tun_key,
 175                                    const struct nlattr *);
 176
 177 #define MAX_ACTIONS_BUFSIZE     (16 * 1024)
 178 #define TBL_MIN_BUCKETS         1024
 179
 180 struct flow_table {
 181         struct flex_array *buckets;
 182         unsigned int count, n_buckets;
 183         struct rcu_head rcu;
 184         int node_ver;
 185         u32 hash_seed;
 186         bool keep_flows;
 187 };
 188
 189 static inline int ovs_flow_tbl_count(struct flow_table *table)
 190 {
 191         return table->count;
 192 }
 193
 194 static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
 195 {
 196         return (table->count > table->n_buckets);
 197 }
 198
 199 struct sw_flow *ovs_flow_tbl_lookup(struct flow_table *table,
 200                                     struct sw_flow_key *key, int len);
 201 void ovs_flow_tbl_destroy(struct flow_table *table);
 202 void ovs_flow_tbl_deferred_destroy(struct flow_table *table);
 203 struct flow_table *ovs_flow_tbl_alloc(int new_size);
 204 struct flow_table *ovs_flow_tbl_expand(struct flow_table *table);
 205 struct flow_table *ovs_flow_tbl_rehash(struct flow_table *table);
 206 void ovs_flow_tbl_insert(struct flow_table *table, struct sw_flow *flow);
 207 void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow);
 208 u32 ovs_flow_hash(const struct sw_flow_key *key, int key_len);
 209
 210 struct sw_flow *ovs_flow_tbl_next(struct flow_table *table, u32 *bucket, u32 *idx);
 211 extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
 212
 213 #endif /* flow.h */