linux/net/openvswitch/flow.h
<<
>>
Prefs
   1/*
   2 * Copyright (c) 2007-2011 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/kernel.h>
  23#include <linux/netlink.h>
  24#include <linux/openvswitch.h>
  25#include <linux/spinlock.h>
  26#include <linux/types.h>
  27#include <linux/rcupdate.h>
  28#include <linux/if_ether.h>
  29#include <linux/in6.h>
  30#include <linux/jiffies.h>
  31#include <linux/time.h>
  32#include <linux/flex_array.h>
  33#include <net/inet_ecn.h>
  34
  35struct sk_buff;
  36
  37struct sw_flow_actions {
  38        struct rcu_head rcu;
  39        u32 actions_len;
  40        struct nlattr actions[];
  41};
  42
  43/* Used to memset ovs_key_ipv4_tunnel padding. */
  44#define OVS_TUNNEL_KEY_SIZE                                     \
  45        (offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) +       \
  46        FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
  47
  48struct ovs_key_ipv4_tunnel {
  49        __be64 tun_id;
  50        __be32 ipv4_src;
  51        __be32 ipv4_dst;
  52        __be16 tun_flags;
  53        u8   ipv4_tos;
  54        u8   ipv4_ttl;
  55};
  56
  57static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
  58                                         const struct iphdr *iph, __be64 tun_id,
  59                                         __be16 tun_flags)
  60{
  61        tun_key->tun_id = tun_id;
  62        tun_key->ipv4_src = iph->saddr;
  63        tun_key->ipv4_dst = iph->daddr;
  64        tun_key->ipv4_tos = iph->tos;
  65        tun_key->ipv4_ttl = iph->ttl;
  66        tun_key->tun_flags = tun_flags;
  67
  68        /* clear struct padding. */
  69        memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
  70               sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
  71}
  72
  73struct sw_flow_key {
  74        struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
  75        struct {
  76                u32     priority;       /* Packet QoS priority. */
  77                u32     skb_mark;       /* SKB mark. */
  78                u16     in_port;        /* Input switch port (or DP_MAX_PORTS). */
  79        } phy;
  80        struct {
  81                u8     src[ETH_ALEN];   /* Ethernet source address. */
  82                u8     dst[ETH_ALEN];   /* Ethernet destination address. */
  83                __be16 tci;             /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  84                __be16 type;            /* Ethernet frame type. */
  85        } eth;
  86        struct {
  87                u8     proto;           /* IP protocol or lower 8 bits of ARP opcode. */
  88                u8     tos;             /* IP ToS. */
  89                u8     ttl;             /* IP TTL/hop limit. */
  90                u8     frag;            /* One of OVS_FRAG_TYPE_*. */
  91        } ip;
  92        union {
  93                struct {
  94                        struct {
  95                                __be32 src;     /* IP source address. */
  96                                __be32 dst;     /* IP destination address. */
  97                        } addr;
  98                        union {
  99                                struct {
 100                                        __be16 src;             /* TCP/UDP source port. */
 101                                        __be16 dst;             /* TCP/UDP destination port. */
 102                                } tp;
 103                                struct {
 104                                        u8 sha[ETH_ALEN];       /* ARP source hardware address. */
 105                                        u8 tha[ETH_ALEN];       /* ARP target hardware address. */
 106                                } arp;
 107                        };
 108                } ipv4;
 109                struct {
 110                        struct {
 111                                struct in6_addr src;    /* IPv6 source address. */
 112                                struct in6_addr dst;    /* IPv6 destination address. */
 113                        } addr;
 114                        __be32 label;                   /* IPv6 flow label. */
 115                        struct {
 116                                __be16 src;             /* TCP/UDP source port. */
 117                                __be16 dst;             /* TCP/UDP destination port. */
 118                        } tp;
 119                        struct {
 120                                struct in6_addr target; /* ND target address. */
 121                                u8 sll[ETH_ALEN];       /* ND source link layer address. */
 122                                u8 tll[ETH_ALEN];       /* ND target link layer address. */
 123                        } nd;
 124                } ipv6;
 125        };
 126};
 127
 128struct sw_flow {
 129        struct rcu_head rcu;
 130        struct hlist_node hash_node[2];
 131        u32 hash;
 132
 133        struct sw_flow_key key;
 134        struct sw_flow_actions __rcu *sf_acts;
 135
 136        spinlock_t lock;        /* Lock for values below. */
 137        unsigned long used;     /* Last used time (in jiffies). */
 138        u64 packet_count;       /* Number of packets matched. */
 139        u64 byte_count;         /* Number of bytes matched. */
 140        u8 tcp_flags;           /* Union of seen TCP flags. */
 141};
 142
 143struct arp_eth_header {
 144        __be16      ar_hrd;     /* format of hardware address   */
 145        __be16      ar_pro;     /* format of protocol address   */
 146        unsigned char   ar_hln; /* length of hardware address   */
 147        unsigned char   ar_pln; /* length of protocol address   */
 148        __be16      ar_op;      /* ARP opcode (command)     */
 149
 150        /* Ethernet+IPv4 specific members. */
 151        unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 152        unsigned char       ar_sip[4];          /* sender IP address        */
 153        unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 154        unsigned char       ar_tip[4];          /* target IP address        */
 155} __packed;
 156
 157int ovs_flow_init(void);
 158void ovs_flow_exit(void);
 159
 160struct sw_flow *ovs_flow_alloc(void);
 161void ovs_flow_deferred_free(struct sw_flow *);
 162void ovs_flow_free(struct sw_flow *flow);
 163
 164struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
 165void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
 166
 167int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *,
 168                     int *key_lenp);
 169void ovs_flow_used(struct sw_flow *, struct sk_buff *);
 170u64 ovs_flow_used_time(unsigned long flow_jiffies);
 171
 172int ovs_flow_to_nlattrs(const struct sw_flow_key *, struct sk_buff *);
 173int ovs_flow_from_nlattrs(struct sw_flow_key *swkey, int *key_lenp,
 174                      const struct nlattr *);
 175int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow, int key_len,
 176                                  const struct nlattr *attr);
 177
 178#define MAX_ACTIONS_BUFSIZE    (32 * 1024)
 179#define TBL_MIN_BUCKETS         1024
 180
 181struct flow_table {
 182        struct flex_array *buckets;
 183        unsigned int count, n_buckets;
 184        struct rcu_head rcu;
 185        int node_ver;
 186        u32 hash_seed;
 187        bool keep_flows;
 188};
 189
 190static inline int ovs_flow_tbl_count(struct flow_table *table)
 191{
 192        return table->count;
 193}
 194
 195static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
 196{
 197        return (table->count > table->n_buckets);
 198}
 199
 200struct sw_flow *ovs_flow_tbl_lookup(struct flow_table *table,
 201                                    struct sw_flow_key *key, int len);
 202void ovs_flow_tbl_destroy(struct flow_table *table);
 203void ovs_flow_tbl_deferred_destroy(struct flow_table *table);
 204struct flow_table *ovs_flow_tbl_alloc(int new_size);
 205struct flow_table *ovs_flow_tbl_expand(struct flow_table *table);
 206struct flow_table *ovs_flow_tbl_rehash(struct flow_table *table);
 207void ovs_flow_tbl_insert(struct flow_table *table, struct sw_flow *flow,
 208                         struct sw_flow_key *key, int key_len);
 209void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow);
 210
 211struct sw_flow *ovs_flow_tbl_next(struct flow_table *table, u32 *bucket, u32 *idx);
 212extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
 213int ovs_ipv4_tun_from_nlattr(const struct nlattr *attr,
 214                         struct ovs_key_ipv4_tunnel *tun_key);
 215int ovs_ipv4_tun_to_nlattr(struct sk_buff *skb,
 216                        const struct ovs_key_ipv4_tunnel *tun_key);
 217
 218#endif /* flow.h */
 219