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