datapath/flow.h

   1 /*
   2  * Copyright (c) 2007-2013 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 };
  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 struct sw_flow_key {
  71         struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
  72         struct {
  73                 u32     priority;       /* Packet QoS priority. */
  74                 u32     skb_mark;       /* SKB mark. */
  75                 u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  76         } phy;
  77         struct {
  78                 u8     src[ETH_ALEN];   /* Ethernet source address. */
  79                 u8     dst[ETH_ALEN];   /* Ethernet destination address. */
  80                 __be16 tci;             /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  81                 __be16 type;            /* Ethernet frame type. */
  82         } eth;
  83         struct {
  84                 u8     proto;           /* IP protocol or lower 8 bits of ARP opcode. */
  85                 u8     tos;             /* IP ToS. */
  86                 u8     ttl;             /* IP TTL/hop limit. */
  87                 u8     frag;            /* One of OVS_FRAG_TYPE_*. */
  88         } ip;
  89         union {
  90                 struct {
  91                         struct {
  92                                 __be32 src;     /* IP source address. */
  93                                 __be32 dst;     /* IP destination address. */
  94                         } addr;
  95                         union {
  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                                 struct {
 102                                         u8 sha[ETH_ALEN];       /* ARP source hardware address. */
 103                                         u8 tha[ETH_ALEN];       /* ARP target hardware address. */
 104                                 } arp;
 105                         };
 106                 } ipv4;
 107                 struct {
 108                         struct {
 109                                 struct in6_addr src;    /* IPv6 source address. */
 110                                 struct in6_addr dst;    /* IPv6 destination address. */
 111                         } addr;
 112                         __be32 label;                   /* IPv6 flow label. */
 113                         struct {
 114                                 __be16 src;             /* TCP/UDP/SCTP source port. */
 115                                 __be16 dst;             /* TCP/UDP/SCTP destination port. */
 116                                 __be16 flags;           /* TCP flags. */
 117                         } tp;
 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 list_head list;
 136         struct sw_flow_key_range range;
 137         struct sw_flow_key key;
 138 };
 139
 140 struct sw_flow_match {
 141         struct sw_flow_key *key;
 142         struct sw_flow_key_range range;
 143         struct sw_flow_mask *mask;
 144 };
 145
 146 struct sw_flow_actions {
 147         struct rcu_head rcu;
 148         u32 actions_len;
 149         struct nlattr actions[];
 150 };
 151
 152 struct flow_stats {
 153         u64 packet_count;               /* Number of packets matched. */
 154         u64 byte_count;                 /* Number of bytes matched. */
 155         unsigned long used;             /* Last used time (in jiffies). */
 156         spinlock_t lock;                /* Lock for atomic stats update. */
 157         __be16 tcp_flags;               /* Union of seen TCP flags. */
 158 };
 159
 160 struct sw_flow_stats {
 161         bool is_percpu;
 162         union {
 163                 struct flow_stats *stat;
 164                 struct flow_stats __percpu *cpu_stats;
 165         };
 166 };
 167
 168 struct sw_flow {
 169         struct rcu_head rcu;
 170         struct hlist_node hash_node[2];
 171         u32 hash;
 172
 173         struct sw_flow_key key;
 174         struct sw_flow_key unmasked_key;
 175         struct sw_flow_mask *mask;
 176         struct sw_flow_actions __rcu *sf_acts;
 177         struct sw_flow_stats stats;
 178 };
 179
 180 struct arp_eth_header {
 181         __be16      ar_hrd;     /* format of hardware address   */
 182         __be16      ar_pro;     /* format of protocol address   */
 183         unsigned char   ar_hln; /* length of hardware address   */
 184         unsigned char   ar_pln; /* length of protocol address   */
 185         __be16      ar_op;      /* ARP opcode (command)     */
 186
 187         /* Ethernet+IPv4 specific members. */
 188         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 189         unsigned char       ar_sip[4];          /* sender IP address        */
 190         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 191         unsigned char       ar_tip[4];          /* target IP address        */
 192 } __packed;
 193
 194 void ovs_flow_stats_update(struct sw_flow *flow, struct sk_buff *skb);
 195 void ovs_flow_stats_get(struct sw_flow *flow, struct ovs_flow_stats *stats,
 196                         unsigned long *used, __be16 *tcp_flags);
 197 void ovs_flow_stats_clear(struct sw_flow *flow);
 198 u64 ovs_flow_used_time(unsigned long flow_jiffies);
 199
 200 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);
 201
 202 #endif /* flow.h */