net/openvswitch/flow.h

   1 /*
   2  * Copyright (c) 2007-2014 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/cache.h>
  23 #include <linux/kernel.h>
  24 #include <linux/netlink.h>
  25 #include <linux/openvswitch.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/types.h>
  28 #include <linux/rcupdate.h>
  29 #include <linux/if_ether.h>
  30 #include <linux/in6.h>
  31 #include <linux/jiffies.h>
  32 #include <linux/time.h>
  33 #include <linux/flex_array.h>
  34 #include <net/inet_ecn.h>
  35
  36 struct sk_buff;
  37
  38 /* Used to memset ovs_key_ipv4_tunnel padding. */
  39 #define OVS_TUNNEL_KEY_SIZE                                     \
  40         (offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) +       \
  41         FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
  42
  43 struct ovs_key_ipv4_tunnel {
  44         __be64 tun_id;
  45         __be32 ipv4_src;
  46         __be32 ipv4_dst;
  47         __be16 tun_flags;
  48         u8   ipv4_tos;
  49         u8   ipv4_ttl;
  50 } __packed __aligned(4); /* Minimize padding. */
  51
  52 struct ovs_tunnel_info {
  53         struct ovs_key_ipv4_tunnel tunnel;
  54         struct geneve_opt *options;
  55         u8 options_len;
  56 };
  57
  58 /* Store options at the end of the array if they are less than the
  59  * maximum size. This allows us to get the benefits of variable length
  60  * matching for small options.
  61  */
  62 #define GENEVE_OPTS(flow_key, opt_len)  \
  63         ((struct geneve_opt *)((flow_key)->tun_opts + \
  64                                FIELD_SIZEOF(struct sw_flow_key, tun_opts) - \
  65                                opt_len))
  66
  67 static inline void ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
  68                                           const struct iphdr *iph,
  69                                           __be64 tun_id, __be16 tun_flags,
  70                                           struct geneve_opt *opts,
  71                                           u8 opts_len)
  72 {
  73         tun_info->tunnel.tun_id = tun_id;
  74         tun_info->tunnel.ipv4_src = iph->saddr;
  75         tun_info->tunnel.ipv4_dst = iph->daddr;
  76         tun_info->tunnel.ipv4_tos = iph->tos;
  77         tun_info->tunnel.ipv4_ttl = iph->ttl;
  78         tun_info->tunnel.tun_flags = tun_flags;
  79
  80         /* clear struct padding. */
  81         memset((unsigned char *)&tun_info->tunnel + OVS_TUNNEL_KEY_SIZE, 0,
  82                sizeof(tun_info->tunnel) - OVS_TUNNEL_KEY_SIZE);
  83
  84         tun_info->options = opts;
  85         tun_info->options_len = opts_len;
  86 }
  87
  88 struct sw_flow_key {
  89         u8 tun_opts[255];
  90         u8 tun_opts_len;
  91         struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
  92         struct {
  93                 u32     priority;       /* Packet QoS priority. */
  94                 u32     skb_mark;       /* SKB mark. */
  95                 u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  96         } __packed phy; /* Safe when right after 'tun_key'. */
  97         u32 ovs_flow_hash;              /* Datapath computed hash value.  */
  98         u32 recirc_id;                  /* Recirculation ID.  */
  99         struct {
 100                 u8     src[ETH_ALEN];   /* Ethernet source address. */
 101                 u8     dst[ETH_ALEN];   /* Ethernet destination address. */
 102                 __be16 tci;             /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
 103                 __be16 type;            /* Ethernet frame type. */
 104         } eth;
 105         struct {
 106                 u8     proto;           /* IP protocol or lower 8 bits of ARP opcode. */
 107                 u8     tos;             /* IP ToS. */
 108                 u8     ttl;             /* IP TTL/hop limit. */
 109                 u8     frag;            /* One of OVS_FRAG_TYPE_*. */
 110         } ip;
 111         struct {
 112                 __be16 src;             /* TCP/UDP/SCTP source port. */
 113                 __be16 dst;             /* TCP/UDP/SCTP destination port. */
 114                 __be16 flags;           /* TCP flags. */
 115         } tp;
 116         union {
 117                 struct {
 118                         struct {
 119                                 __be32 src;     /* IP source address. */
 120                                 __be32 dst;     /* IP destination address. */
 121                         } addr;
 122                         struct {
 123                                 u8 sha[ETH_ALEN];       /* ARP source hardware address. */
 124                                 u8 tha[ETH_ALEN];       /* ARP target hardware address. */
 125                         } arp;
 126                 } ipv4;
 127                 struct {
 128                         struct {
 129                                 struct in6_addr src;    /* IPv6 source address. */
 130                                 struct in6_addr dst;    /* IPv6 destination address. */
 131                         } addr;
 132                         __be32 label;                   /* IPv6 flow label. */
 133                         struct {
 134                                 struct in6_addr target; /* ND target address. */
 135                                 u8 sll[ETH_ALEN];       /* ND source link layer address. */
 136                                 u8 tll[ETH_ALEN];       /* ND target link layer address. */
 137                         } nd;
 138                 } ipv6;
 139         };
 140 } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
 141
 142 struct sw_flow_key_range {
 143         unsigned short int start;
 144         unsigned short int end;
 145 };
 146
 147 struct sw_flow_mask {
 148         int ref_count;
 149         struct rcu_head rcu;
 150         struct list_head list;
 151         struct sw_flow_key_range range;
 152         struct sw_flow_key key;
 153 };
 154
 155 struct sw_flow_match {
 156         struct sw_flow_key *key;
 157         struct sw_flow_key_range range;
 158         struct sw_flow_mask *mask;
 159 };
 160
 161 struct sw_flow_actions {
 162         struct rcu_head rcu;
 163         u32 actions_len;
 164         struct nlattr actions[];
 165 };
 166
 167 struct flow_stats {
 168         u64 packet_count;               /* Number of packets matched. */
 169         u64 byte_count;                 /* Number of bytes matched. */
 170         unsigned long used;             /* Last used time (in jiffies). */
 171         spinlock_t lock;                /* Lock for atomic stats update. */
 172         __be16 tcp_flags;               /* Union of seen TCP flags. */
 173 };
 174
 175 struct sw_flow {
 176         struct rcu_head rcu;
 177         struct hlist_node hash_node[2];
 178         u32 hash;
 179         int stats_last_writer;          /* NUMA-node id of the last writer on
 180                                          * 'stats[0]'.
 181                                          */
 182         struct sw_flow_key key;
 183         struct sw_flow_key unmasked_key;
 184         struct sw_flow_mask *mask;
 185         struct sw_flow_actions __rcu *sf_acts;
 186         struct flow_stats __rcu *stats[]; /* One for each NUMA node.  First one
 187                                            * is allocated at flow creation time,
 188                                            * the rest are allocated on demand
 189                                            * while holding the 'stats[0].lock'.
 190                                            */
 191 };
 192
 193 struct arp_eth_header {
 194         __be16      ar_hrd;     /* format of hardware address   */
 195         __be16      ar_pro;     /* format of protocol address   */
 196         unsigned char   ar_hln; /* length of hardware address   */
 197         unsigned char   ar_pln; /* length of protocol address   */
 198         __be16      ar_op;      /* ARP opcode (command)     */
 199
 200         /* Ethernet+IPv4 specific members. */
 201         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 202         unsigned char       ar_sip[4];          /* sender IP address        */
 203         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 204         unsigned char       ar_tip[4];          /* target IP address        */
 205 } __packed;
 206
 207 void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
 208                            struct sk_buff *);
 209 void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
 210                         unsigned long *used, __be16 *tcp_flags);
 211 void ovs_flow_stats_clear(struct sw_flow *);
 212 u64 ovs_flow_used_time(unsigned long flow_jiffies);
 213
 214 int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
 215 int ovs_flow_key_extract(struct ovs_tunnel_info *tun_info, struct sk_buff *skb,
 216                          struct sw_flow_key *key);
 217 /* Extract key from packet coming from userspace. */
 218 int ovs_flow_key_extract_userspace(const struct nlattr *attr,
 219                                    struct sk_buff *skb,
 220                                    struct sw_flow_key *key);
 221
 222 #endif /* flow.h */