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 #include <net/ip_tunnels.h>
  36 #include <net/dst_metadata.h>
  37
  38 struct sk_buff;
  39
  40 /* Store options at the end of the array if they are less than the
  41  * maximum size. This allows us to get the benefits of variable length
  42  * matching for small options.
  43  */
  44 #define TUN_METADATA_OFFSET(opt_len) \
  45         (FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
  46 #define TUN_METADATA_OPTS(flow_key, opt_len) \
  47         ((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
  48
  49 struct ovs_tunnel_info {
  50         struct metadata_dst     *tun_dst;
  51 };
  52
  53 #define OVS_SW_FLOW_KEY_METADATA_SIZE                   \
  54         (offsetof(struct sw_flow_key, recirc_id) +      \
  55         FIELD_SIZEOF(struct sw_flow_key, recirc_id))
  56
  57 struct sw_flow_key {
  58         u8 tun_opts[IP_TUNNEL_OPTS_MAX];
  59         u8 tun_opts_len;
  60         struct ip_tunnel_key tun_key;   /* Encapsulating tunnel key. */
  61         struct {
  62                 u32     priority;       /* Packet QoS priority. */
  63                 u32     skb_mark;       /* SKB mark. */
  64                 u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  65         } __packed phy; /* Safe when right after 'tun_key'. */
  66         u8 tun_proto;                   /* Protocol of encapsulating tunnel. */
  67         u32 ovs_flow_hash;              /* Datapath computed hash value.  */
  68         u32 recirc_id;                  /* Recirculation ID.  */
  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         union {
  76                 struct {
  77                         __be32 top_lse; /* top label stack entry */
  78                 } mpls;
  79                 struct {
  80                         u8     proto;   /* IP protocol or lower 8 bits of ARP opcode. */
  81                         u8     tos;         /* IP ToS. */
  82                         u8     ttl;         /* IP TTL/hop limit. */
  83                         u8     frag;    /* One of OVS_FRAG_TYPE_*. */
  84                 } ip;
  85         };
  86         struct {
  87                 __be16 src;             /* TCP/UDP/SCTP source port. */
  88                 __be16 dst;             /* TCP/UDP/SCTP destination port. */
  89                 __be16 flags;           /* TCP flags. */
  90         } tp;
  91         union {
  92                 struct {
  93                         struct {
  94                                 __be32 src;     /* IP source address. */
  95                                 __be32 dst;     /* IP destination address. */
  96                         } addr;
  97                         struct {
  98                                 u8 sha[ETH_ALEN];       /* ARP source hardware address. */
  99                                 u8 tha[ETH_ALEN];       /* ARP target hardware address. */
 100                         } arp;
 101                 } ipv4;
 102                 struct {
 103                         struct {
 104                                 struct in6_addr src;    /* IPv6 source address. */
 105                                 struct in6_addr dst;    /* IPv6 destination address. */
 106                         } addr;
 107                         __be32 label;                   /* IPv6 flow label. */
 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         struct {
 116                 /* Connection tracking fields. */
 117                 u16 zone;
 118                 u32 mark;
 119                 u8 state;
 120                 struct ovs_key_ct_labels labels;
 121         } ct;
 122
 123 } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
 124
 125 struct sw_flow_key_range {
 126         unsigned short int start;
 127         unsigned short int end;
 128 };
 129
 130 struct sw_flow_mask {
 131         int ref_count;
 132         struct rcu_head rcu;
 133         struct list_head list;
 134         struct sw_flow_key_range range;
 135         struct sw_flow_key key;
 136 };
 137
 138 struct sw_flow_match {
 139         struct sw_flow_key *key;
 140         struct sw_flow_key_range range;
 141         struct sw_flow_mask *mask;
 142 };
 143
 144 #define MAX_UFID_LENGTH 16 /* 128 bits */
 145
 146 struct sw_flow_id {
 147         u32 ufid_len;
 148         union {
 149                 u32 ufid[MAX_UFID_LENGTH / 4];
 150                 struct sw_flow_key *unmasked_key;
 151         };
 152 };
 153
 154 struct sw_flow_actions {
 155         struct rcu_head rcu;
 156         size_t orig_len;        /* From flow_cmd_new netlink actions size */
 157         u32 actions_len;
 158         struct nlattr actions[];
 159 };
 160
 161 struct flow_stats {
 162         u64 packet_count;               /* Number of packets matched. */
 163         u64 byte_count;                 /* Number of bytes matched. */
 164         unsigned long used;             /* Last used time (in jiffies). */
 165         spinlock_t lock;                /* Lock for atomic stats update. */
 166         __be16 tcp_flags;               /* Union of seen TCP flags. */
 167 };
 168
 169 struct sw_flow {
 170         struct rcu_head rcu;
 171         struct {
 172                 struct hlist_node node[2];
 173                 u32 hash;
 174         } flow_table, ufid_table;
 175         int stats_last_writer;          /* NUMA-node id of the last writer on
 176                                          * 'stats[0]'.
 177                                          */
 178         struct sw_flow_key key;
 179         struct sw_flow_id id;
 180         struct sw_flow_mask *mask;
 181         struct sw_flow_actions __rcu *sf_acts;
 182         struct flow_stats __rcu *stats[]; /* One for each NUMA node.  First one
 183                                            * is allocated at flow creation time,
 184                                            * the rest are allocated on demand
 185                                            * while holding the 'stats[0].lock'.
 186                                            */
 187 };
 188
 189 struct arp_eth_header {
 190         __be16      ar_hrd;     /* format of hardware address   */
 191         __be16      ar_pro;     /* format of protocol address   */
 192         unsigned char   ar_hln; /* length of hardware address   */
 193         unsigned char   ar_pln; /* length of protocol address   */
 194         __be16      ar_op;      /* ARP opcode (command)     */
 195
 196         /* Ethernet+IPv4 specific members. */
 197         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 198         unsigned char       ar_sip[4];          /* sender IP address        */
 199         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 200         unsigned char       ar_tip[4];          /* target IP address        */
 201 } __packed;
 202
 203 static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
 204 {
 205         return sfid->ufid_len;
 206 }
 207
 208 static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
 209 {
 210         return !ovs_identifier_is_ufid(sfid);
 211 }
 212
 213 void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
 214                            const struct sk_buff *);
 215 void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
 216                         unsigned long *used, __be16 *tcp_flags);
 217 void ovs_flow_stats_clear(struct sw_flow *);
 218 u64 ovs_flow_used_time(unsigned long flow_jiffies);
 219
 220 int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
 221 int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
 222                          struct sk_buff *skb,
 223                          struct sw_flow_key *key);
 224 /* Extract key from packet coming from userspace. */
 225 int ovs_flow_key_extract_userspace(struct net *net, const struct nlattr *attr,
 226                                    struct sk_buff *skb,
 227                                    struct sw_flow_key *key, bool log);
 228
 229 #endif /* flow.h */