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