include/net/flow_dissector.h

   1 #ifndef _NET_FLOW_DISSECTOR_H
   2 #define _NET_FLOW_DISSECTOR_H
   3
   4 #include <linux/types.h>
   5 #include <linux/skbuff.h>
   6 #include <linux/in6.h>
   7 #include <uapi/linux/if_ether.h>
   8
   9 /**
  10  * struct flow_dissector_key_control:
  11  * @thoff: Transport header offset
  12  */
  13 struct flow_dissector_key_control {
  14         u16     thoff;
  15         u16     addr_type;
  16 };
  17
  18 /**
  19  * struct flow_dissector_key_basic:
  20  * @thoff: Transport header offset
  21  * @n_proto: Network header protocol (eg. IPv4/IPv6)
  22  * @ip_proto: Transport header protocol (eg. TCP/UDP)
  23  */
  24 struct flow_dissector_key_basic {
  25         __be16  n_proto;
  26         u8      ip_proto;
  27         u8      padding;
  28 };
  29
  30 struct flow_dissector_key_tags {
  31         u32     vlan_id:12,
  32                 flow_label:20;
  33 };
  34
  35 /**
  36  * struct flow_dissector_key_ipv4_addrs:
  37  * @src: source ip address
  38  * @dst: destination ip address
  39  */
  40 struct flow_dissector_key_ipv4_addrs {
  41         /* (src,dst) must be grouped, in the same way than in IP header */
  42         __be32 src;
  43         __be32 dst;
  44 };
  45
  46 /**
  47  * struct flow_dissector_key_ipv6_addrs:
  48  * @src: source ip address
  49  * @dst: destination ip address
  50  */
  51 struct flow_dissector_key_ipv6_addrs {
  52         /* (src,dst) must be grouped, in the same way than in IP header */
  53         struct in6_addr src;
  54         struct in6_addr dst;
  55 };
  56
  57 /**
  58  * struct flow_dissector_key_tipc_addrs:
  59  * @srcnode: source node address
  60  */
  61 struct flow_dissector_key_tipc_addrs {
  62         __be32 srcnode;
  63 };
  64
  65 /**
  66  * struct flow_dissector_key_addrs:
  67  * @v4addrs: IPv4 addresses
  68  * @v6addrs: IPv6 addresses
  69  */
  70 struct flow_dissector_key_addrs {
  71         union {
  72                 struct flow_dissector_key_ipv4_addrs v4addrs;
  73                 struct flow_dissector_key_ipv6_addrs v6addrs;
  74                 struct flow_dissector_key_tipc_addrs tipcaddrs;
  75         };
  76 };
  77
  78 /**
  79  * flow_dissector_key_tp_ports:
  80  *      @ports: port numbers of Transport header
  81  *              src: source port number
  82  *              dst: destination port number
  83  */
  84 struct flow_dissector_key_ports {
  85         union {
  86                 __be32 ports;
  87                 struct {
  88                         __be16 src;
  89                         __be16 dst;
  90                 };
  91         };
  92 };
  93
  94
  95 /**
  96  * struct flow_dissector_key_eth_addrs:
  97  * @src: source Ethernet address
  98  * @dst: destination Ethernet address
  99  */
 100 struct flow_dissector_key_eth_addrs {
 101         /* (dst,src) must be grouped, in the same way than in ETH header */
 102         unsigned char dst[ETH_ALEN];
 103         unsigned char src[ETH_ALEN];
 104 };
 105
 106 enum flow_dissector_key_id {
 107         FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
 108         FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
 109         FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
 110         FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
 111         FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
 112         FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
 113         FLOW_DISSECTOR_KEY_TIPC_ADDRS, /* struct flow_dissector_key_tipc_addrs */
 114         FLOW_DISSECTOR_KEY_VLANID, /* struct flow_dissector_key_flow_tags */
 115         FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_flow_tags */
 116
 117         FLOW_DISSECTOR_KEY_MAX,
 118 };
 119
 120 struct flow_dissector_key {
 121         enum flow_dissector_key_id key_id;
 122         size_t offset; /* offset of struct flow_dissector_key_*
 123                           in target the struct */
 124 };
 125
 126 struct flow_dissector {
 127         unsigned int used_keys; /* each bit repesents presence of one key id */
 128         unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
 129 };
 130
 131 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
 132                              const struct flow_dissector_key *key,
 133                              unsigned int key_count);
 134
 135 bool __skb_flow_dissect(const struct sk_buff *skb,
 136                         struct flow_dissector *flow_dissector,
 137                         void *target_container,
 138                         void *data, __be16 proto, int nhoff, int hlen);
 139
 140 static inline bool skb_flow_dissect(const struct sk_buff *skb,
 141                                     struct flow_dissector *flow_dissector,
 142                                     void *target_container)
 143 {
 144         return __skb_flow_dissect(skb, flow_dissector, target_container,
 145                                   NULL, 0, 0, 0);
 146 }
 147
 148 struct flow_keys {
 149         struct flow_dissector_key_control control;
 150 #define FLOW_KEYS_HASH_START_FIELD basic
 151         struct flow_dissector_key_basic basic;
 152         struct flow_dissector_key_tags tags;
 153         struct flow_dissector_key_ports ports;
 154         struct flow_dissector_key_addrs addrs;
 155 };
 156
 157 #define FLOW_KEYS_HASH_OFFSET           \
 158         offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
 159
 160 __be32 flow_get_u32_src(const struct flow_keys *flow);
 161 __be32 flow_get_u32_dst(const struct flow_keys *flow);
 162
 163 extern struct flow_dissector flow_keys_dissector;
 164 extern struct flow_dissector flow_keys_buf_dissector;
 165
 166 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
 167                                               struct flow_keys *flow)
 168 {
 169         memset(flow, 0, sizeof(*flow));
 170         return __skb_flow_dissect(skb, &flow_keys_dissector, flow,
 171                                   NULL, 0, 0, 0);
 172 }
 173
 174 static inline bool skb_flow_dissect_flow_keys_buf(struct flow_keys *flow,
 175                                                   void *data, __be16 proto,
 176                                                   int nhoff, int hlen)
 177 {
 178         memset(flow, 0, sizeof(*flow));
 179         return __skb_flow_dissect(NULL, &flow_keys_buf_dissector, flow,
 180                                   data, proto, nhoff, hlen);
 181 }
 182
 183 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
 184                             void *data, int hlen_proto);
 185
 186 static inline __be32 skb_flow_get_ports(const struct sk_buff *skb,
 187                                         int thoff, u8 ip_proto)
 188 {
 189         return __skb_flow_get_ports(skb, thoff, ip_proto, NULL, 0);
 190 }
 191
 192 u32 flow_hash_from_keys(struct flow_keys *keys);
 193 void __skb_get_hash(struct sk_buff *skb);
 194 u32 skb_get_poff(const struct sk_buff *skb);
 195 u32 __skb_get_poff(const struct sk_buff *skb, void *data,
 196                    const struct flow_keys *keys, int hlen);
 197
 198 /* struct flow_keys_digest:
 199  *
 200  * This structure is used to hold a digest of the full flow keys. This is a
 201  * larger "hash" of a flow to allow definitively matching specific flows where
 202  * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
 203  * that it can by used in CB of skb (see sch_choke for an example).
 204  */
 205 #define FLOW_KEYS_DIGEST_LEN    16
 206 struct flow_keys_digest {
 207         u8      data[FLOW_KEYS_DIGEST_LEN];
 208 };
 209
 210 void make_flow_keys_digest(struct flow_keys_digest *digest,
 211                            const struct flow_keys *flow);
 212
 213 #endif