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 struct vlan_head {
  54         __be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
  55         __be16 tci;  /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  56 };
  57
  58 #define OVS_SW_FLOW_KEY_METADATA_SIZE                   \
  59         (offsetof(struct sw_flow_key, recirc_id) +      \
  60         FIELD_SIZEOF(struct sw_flow_key, recirc_id))
  61
  62 struct sw_flow_key {
  63         u8 tun_opts[IP_TUNNEL_OPTS_MAX];
  64         u8 tun_opts_len;
  65         struct ip_tunnel_key tun_key;   /* Encapsulating tunnel key. */
  66         struct {
  67                 u32     priority;       /* Packet QoS priority. */
  68                 u32     skb_mark;       /* SKB mark. */
  69                 u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  70         } __packed phy; /* Safe when right after 'tun_key'. */
  71         u8 tun_proto;                   /* Protocol of encapsulating tunnel. */
  72         u32 ovs_flow_hash;              /* Datapath computed hash value.  */
  73         u32 recirc_id;                  /* Recirculation ID.  */
  74         struct {
  75                 u8     src[ETH_ALEN];   /* Ethernet source address. */
  76                 u8     dst[ETH_ALEN];   /* Ethernet destination address. */
  77                 struct vlan_head vlan;
  78                 struct vlan_head cvlan;
  79                 __be16 type;            /* Ethernet frame type. */
  80         } eth;
  81         union {
  82                 struct {
  83                         __be32 top_lse; /* top label stack entry */
  84                 } mpls;
  85                 struct {
  86                         u8     proto;   /* IP protocol or lower 8 bits of ARP opcode. */
  87                         u8     tos;         /* IP ToS. */
  88                         u8     ttl;         /* IP TTL/hop limit. */
  89                         u8     frag;    /* One of OVS_FRAG_TYPE_*. */
  90                 } ip;
  91         };
  92         struct {
  93                 __be16 src;             /* TCP/UDP/SCTP source port. */
  94                 __be16 dst;             /* TCP/UDP/SCTP destination port. */
  95                 __be16 flags;           /* TCP flags. */
  96         } tp;
  97         union {
  98                 struct {
  99                         struct {
 100                                 __be32 src;     /* IP source address. */
 101                                 __be32 dst;     /* IP destination address. */
 102                         } addr;
 103                         struct {
 104                                 u8 sha[ETH_ALEN];       /* ARP source hardware address. */
 105                                 u8 tha[ETH_ALEN];       /* ARP target hardware address. */
 106                         } arp;
 107                 } ipv4;
 108                 struct {
 109                         struct {
 110                                 struct in6_addr src;    /* IPv6 source address. */
 111                                 struct in6_addr dst;    /* IPv6 destination address. */
 112                         } addr;
 113                         __be32 label;                   /* IPv6 flow label. */
 114                         struct {
 115                                 struct in6_addr target; /* ND target address. */
 116                                 u8 sll[ETH_ALEN];       /* ND source link layer address. */
 117                                 u8 tll[ETH_ALEN];       /* ND target link layer address. */
 118                         } nd;
 119                 } ipv6;
 120         };
 121         struct {
 122                 /* Connection tracking fields. */
 123                 u16 zone;
 124                 u32 mark;
 125                 u8 state;
 126                 struct ovs_key_ct_labels labels;
 127         } ct;
 128
 129 } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
 130
 131 struct sw_flow_key_range {
 132         unsigned short int start;
 133         unsigned short int end;
 134 };
 135
 136 struct sw_flow_mask {
 137         int ref_count;
 138         struct rcu_head rcu;
 139         struct list_head list;
 140         struct sw_flow_key_range range;
 141         struct sw_flow_key key;
 142 };
 143
 144 struct sw_flow_match {
 145         struct sw_flow_key *key;
 146         struct sw_flow_key_range range;
 147         struct sw_flow_mask *mask;
 148 };
 149
 150 #define MAX_UFID_LENGTH 16 /* 128 bits */
 151
 152 struct sw_flow_id {
 153         u32 ufid_len;
 154         union {
 155                 u32 ufid[MAX_UFID_LENGTH / 4];
 156                 struct sw_flow_key *unmasked_key;
 157         };
 158 };
 159
 160 struct sw_flow_actions {
 161         struct rcu_head rcu;
 162         size_t orig_len;        /* From flow_cmd_new netlink actions size */
 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 {
 178                 struct hlist_node node[2];
 179                 u32 hash;
 180         } flow_table, ufid_table;
 181         int stats_last_writer;          /* CPU id of the last writer on
 182                                          * 'stats[0]'.
 183                                          */
 184         struct sw_flow_key key;
 185         struct sw_flow_id id;
 186         struct sw_flow_mask *mask;
 187         struct sw_flow_actions __rcu *sf_acts;
 188         struct flow_stats __rcu *stats[]; /* One for each CPU.  First one
 189                                            * is allocated at flow creation time,
 190                                            * the rest are allocated on demand
 191                                            * while holding the 'stats[0].lock'.
 192                                            */
 193 };
 194
 195 struct arp_eth_header {
 196         __be16      ar_hrd;     /* format of hardware address   */
 197         __be16      ar_pro;     /* format of protocol address   */
 198         unsigned char   ar_hln; /* length of hardware address   */
 199         unsigned char   ar_pln; /* length of protocol address   */
 200         __be16      ar_op;      /* ARP opcode (command)     */
 201
 202         /* Ethernet+IPv4 specific members. */
 203         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 204         unsigned char       ar_sip[4];          /* sender IP address        */
 205         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 206         unsigned char       ar_tip[4];          /* target IP address        */
 207 } __packed;
 208
 209 static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
 210 {
 211         return sfid->ufid_len;
 212 }
 213
 214 static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
 215 {
 216         return !ovs_identifier_is_ufid(sfid);
 217 }
 218
 219 void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
 220                            const struct sk_buff *);
 221 void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
 222                         unsigned long *used, __be16 *tcp_flags);
 223 void ovs_flow_stats_clear(struct sw_flow *);
 224 u64 ovs_flow_used_time(unsigned long flow_jiffies);
 225
 226 int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
 227 int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
 228                          struct sk_buff *skb,
 229                          struct sw_flow_key *key);
 230 /* Extract key from packet coming from userspace. */
 231 int ovs_flow_key_extract_userspace(struct net *net, const struct nlattr *attr,
 232                                    struct sk_buff *skb,
 233                                    struct sw_flow_key *key, bool log);
 234
 235 #endif /* flow.h */