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