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