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