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