datapath/flow.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   3  * Distributed under the terms of the GNU GPL version 2.
   4  *
   5  * Significant portions of this file may be copied from parts of the Linux
   6  * kernel, by Linus Torvalds and others.
   7  */
   8
   9 #ifndef FLOW_H
  10 #define FLOW_H 1
  11
  12 #include <linux/kernel.h>
  13 #include <linux/netlink.h>
  14 #include <linux/openvswitch.h>
  15 #include <linux/spinlock.h>
  16 #include <linux/types.h>
  17 #include <linux/rcupdate.h>
  18 #include <linux/if_ether.h>
  19 #include <linux/in6.h>
  20 #include <linux/jiffies.h>
  21 #include <linux/time.h>
  22 #include <linux/flex_array.h>
  23 #include <net/inet_ecn.h>
  24
  25 struct sk_buff;
  26
  27 struct sw_flow_actions {
  28         struct rcu_head rcu;
  29         u32 actions_len;
  30         struct nlattr actions[];
  31 };
  32
  33 /* Mask for the OVS_FRAG_TYPE_* value in the low 2 bits of ip.tos_frag in
  34  * struct sw_flow_key. */
  35 #define OVS_FRAG_TYPE_MASK INET_ECN_MASK
  36
  37 struct sw_flow_key {
  38         struct {
  39                 __be64 tun_id;          /* Encapsulating tunnel ID. */
  40                 u16    in_port;         /* Input switch port (or USHRT_MAX). */
  41                 u8     src[ETH_ALEN];   /* Ethernet source address. */
  42                 u8     dst[ETH_ALEN];   /* Ethernet destination address. */
  43                 __be16 tci;             /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  44                 __be16 type;            /* Ethernet frame type. */
  45         } eth;
  46         struct {
  47                 u8     proto;           /* IP protocol or lower 8 bits of ARP opcode. */
  48                 u8     tos_frag;        /* IP ToS DSCP in high 6 bits,
  49                                          * OVS_FRAG_TYPE_* in low 2 bits. */
  50         } ip;
  51         union {
  52                 struct {
  53                         struct {
  54                                 __be32 src;     /* IP source address. */
  55                                 __be32 dst;     /* IP destination address. */
  56                         } addr;
  57                         union {
  58                                 struct {
  59                                         __be16 src;             /* TCP/UDP source port. */
  60                                         __be16 dst;             /* TCP/UDP destination port. */
  61                                 } tp;
  62                                 struct {
  63                                         u8 sha[ETH_ALEN];       /* ARP source hardware address. */
  64                                         u8 tha[ETH_ALEN];       /* ARP target hardware address. */
  65                                 } arp;
  66                         };
  67                 } ipv4;
  68                 struct {
  69                         struct {
  70                                 struct in6_addr src;    /* IPv6 source address. */
  71                                 struct in6_addr dst;    /* IPv6 destination address. */
  72                         } addr;
  73                         struct {
  74                                 __be16 src;             /* TCP/UDP source port. */
  75                                 __be16 dst;             /* TCP/UDP destination port. */
  76                         } tp;
  77                         struct {
  78                                 struct in6_addr target; /* ND target address. */
  79                                 u8 sll[ETH_ALEN];       /* ND source link layer address. */
  80                                 u8 tll[ETH_ALEN];       /* ND target link layer address. */
  81                         } nd;
  82                 } ipv6;
  83         };
  84 };
  85
  86 struct sw_flow {
  87         struct rcu_head rcu;
  88         struct hlist_node  hash_node;
  89         u32 hash;
  90
  91         struct sw_flow_key key;
  92         struct sw_flow_actions __rcu *sf_acts;
  93
  94         atomic_t refcnt;
  95         bool dead;
  96
  97         spinlock_t lock;        /* Lock for values below. */
  98         unsigned long used;     /* Last used time (in jiffies). */
  99         u64 packet_count;       /* Number of packets matched. */
 100         u64 byte_count;         /* Number of bytes matched. */
 101         u8 tcp_flags;           /* Union of seen TCP flags. */
 102 };
 103
 104 struct arp_eth_header
 105 {
 106         __be16      ar_hrd;     /* format of hardware address   */
 107         __be16      ar_pro;     /* format of protocol address   */
 108         unsigned char   ar_hln; /* length of hardware address   */
 109         unsigned char   ar_pln; /* length of protocol address   */
 110         __be16      ar_op;      /* ARP opcode (command)     */
 111
 112         /* Ethernet+IPv4 specific members. */
 113         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
 114         unsigned char       ar_sip[4];          /* sender IP address        */
 115         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
 116         unsigned char       ar_tip[4];          /* target IP address        */
 117 } __packed;
 118
 119 int flow_init(void);
 120 void flow_exit(void);
 121
 122 struct sw_flow *flow_alloc(void);
 123 void flow_deferred_free(struct sw_flow *);
 124
 125 struct sw_flow_actions *flow_actions_alloc(const struct nlattr *);
 126 void flow_deferred_free_acts(struct sw_flow_actions *);
 127
 128 void flow_hold(struct sw_flow *);
 129 void flow_put(struct sw_flow *);
 130
 131 int flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *,
 132                  int *key_lenp);
 133 void flow_used(struct sw_flow *, struct sk_buff *);
 134 u64 flow_used_time(unsigned long flow_jiffies);
 135
 136 /* Upper bound on the length of a nlattr-formatted flow key.  The longest
 137  * nlattr-formatted flow key would be:
 138  *
 139  *                         struct  pad  nl hdr  total
 140  *                         ------  ---  ------  -----
 141  *  OVS_KEY_ATTR_TUN_ID        8    --     4     12
 142  *  OVS_KEY_ATTR_IN_PORT       4    --     4      8
 143  *  OVS_KEY_ATTR_ETHERNET     12    --     4     16
 144  *  OVS_KEY_ATTR_8021Q         4    --     4      8
 145  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8
 146  *  OVS_KEY_ATTR_IPV6         34     2     4     40
 147  *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
 148  *  OVS_KEY_ATTR_ND           28    --     4     32
 149  *  -------------------------------------------------
 150  *  total                                       132
 151  */
 152 #define FLOW_BUFSIZE 132
 153
 154 int flow_to_nlattrs(const struct sw_flow_key *, struct sk_buff *);
 155 int flow_from_nlattrs(struct sw_flow_key *swkey, int *key_lenp,
 156                       const struct nlattr *);
 157 int flow_metadata_from_nlattrs(u16 *in_port, __be64 *tun_id,
 158                                const struct nlattr *);
 159
 160 #define TBL_MIN_BUCKETS         1024
 161
 162 struct flow_table {
 163         struct flex_array *buckets;
 164         unsigned int count, n_buckets;
 165         struct rcu_head rcu;
 166 };
 167
 168 static inline int flow_tbl_count(struct flow_table *table)
 169 {
 170         return table->count;
 171 }
 172
 173 static inline int flow_tbl_need_to_expand(struct flow_table *table)
 174 {
 175         return (table->count > table->n_buckets);
 176 }
 177
 178 struct sw_flow *flow_tbl_lookup(struct flow_table *table,
 179                                 struct sw_flow_key *key,    int len);
 180 void flow_tbl_destroy(struct flow_table *table);
 181 void flow_tbl_deferred_destroy(struct flow_table *table);
 182 struct flow_table *flow_tbl_alloc(int new_size);
 183 struct flow_table *flow_tbl_expand(struct flow_table *table);
 184 void flow_tbl_insert(struct flow_table *table, struct sw_flow *flow);
 185 void flow_tbl_remove(struct flow_table *table, struct sw_flow *flow);
 186 u32 flow_hash(const struct sw_flow_key *key, int key_len);
 187
 188 struct sw_flow *flow_tbl_next(struct flow_table *table, u32 *bucket, u32 *idx);
 189 extern const u32 ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
 190
 191 #endif /* flow.h */