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     padding;
  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 /**
  31  * struct flow_dissector_key_addrs:
  32  * @src: source ip address in case of IPv4
  33  *       For IPv6 it contains 32bit hash of src address
  34  * @dst: destination ip address in case of IPv4
  35  *       For IPv6 it contains 32bit hash of dst address
  36  */
  37 struct flow_dissector_key_addrs {
  38         /* (src,dst) must be grouped, in the same way than in IP header */
  39         __be32 src;
  40         __be32 dst;
  41 };
  42
  43 /**
  44  * flow_dissector_key_tp_ports:
  45  *      @ports: port numbers of Transport header
  46  *              src: source port number
  47  *              dst: destination port number
  48  */
  49 struct flow_dissector_key_ports {
  50         union {
  51                 __be32 ports;
  52                 struct {
  53                         __be16 src;
  54                         __be16 dst;
  55                 };
  56         };
  57 };
  58
  59 /**
  60  * struct flow_dissector_key_ipv6_addrs:
  61  * @src: source ip address
  62  * @dst: destination ip address
  63  */
  64 struct flow_dissector_key_ipv6_addrs {
  65         /* (src,dst) must be grouped, in the same way than in IP header */
  66         struct in6_addr src;
  67         struct in6_addr dst;
  68 };
  69
  70 /**
  71  * struct flow_dissector_key_eth_addrs:
  72  * @src: source Ethernet address
  73  * @dst: destination Ethernet address
  74  */
  75 struct flow_dissector_key_eth_addrs {
  76         /* (dst,src) must be grouped, in the same way than in ETH header */
  77         unsigned char dst[ETH_ALEN];
  78         unsigned char src[ETH_ALEN];
  79 };
  80
  81 enum flow_dissector_key_id {
  82         FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
  83         FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
  84         FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_addrs */
  85         FLOW_DISSECTOR_KEY_IPV6_HASH_ADDRS, /* struct flow_dissector_key_addrs */
  86         FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
  87         FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
  88         FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
  89
  90         FLOW_DISSECTOR_KEY_MAX,
  91 };
  92
  93 struct flow_dissector_key {
  94         enum flow_dissector_key_id key_id;
  95         size_t offset; /* offset of struct flow_dissector_key_*
  96                           in target the struct */
  97 };
  98
  99 struct flow_dissector {
 100         unsigned int used_keys; /* each bit repesents presence of one key id */
 101         unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
 102 };
 103
 104 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
 105                              const struct flow_dissector_key *key,
 106                              unsigned int key_count);
 107
 108 bool __skb_flow_dissect(const struct sk_buff *skb,
 109                         struct flow_dissector *flow_dissector,
 110                         void *target_container,
 111                         void *data, __be16 proto, int nhoff, int hlen);
 112
 113 static inline bool skb_flow_dissect(const struct sk_buff *skb,
 114                                     struct flow_dissector *flow_dissector,
 115                                     void *target_container)
 116 {
 117         return __skb_flow_dissect(skb, flow_dissector, target_container,
 118                                   NULL, 0, 0, 0);
 119 }
 120
 121 struct flow_keys {
 122         struct flow_dissector_key_control control;
 123 #define FLOW_KEYS_HASH_START_FIELD basic
 124         struct flow_dissector_key_basic basic;
 125         struct flow_dissector_key_ports ports;
 126         struct flow_dissector_key_addrs addrs;
 127 };
 128
 129 #define FLOW_KEYS_HASH_OFFSET           \
 130         offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
 131
 132 extern struct flow_dissector flow_keys_dissector;
 133 extern struct flow_dissector flow_keys_buf_dissector;
 134
 135 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
 136                                               struct flow_keys *flow)
 137 {
 138         memset(flow, 0, sizeof(*flow));
 139         return __skb_flow_dissect(skb, &flow_keys_dissector, flow,
 140                                   NULL, 0, 0, 0);
 141 }
 142
 143 static inline bool skb_flow_dissect_flow_keys_buf(struct flow_keys *flow,
 144                                                   void *data, __be16 proto,
 145                                                   int nhoff, int hlen)
 146 {
 147         memset(flow, 0, sizeof(*flow));
 148         return __skb_flow_dissect(NULL, &flow_keys_buf_dissector, flow,
 149                                   data, proto, nhoff, hlen);
 150 }
 151
 152 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
 153                             void *data, int hlen_proto);
 154
 155 static inline __be32 skb_flow_get_ports(const struct sk_buff *skb,
 156                                         int thoff, u8 ip_proto)
 157 {
 158         return __skb_flow_get_ports(skb, thoff, ip_proto, NULL, 0);
 159 }
 160
 161 u32 flow_hash_from_keys(struct flow_keys *keys);
 162 void __skb_get_hash(struct sk_buff *skb);
 163 u32 skb_get_poff(const struct sk_buff *skb);
 164 u32 __skb_get_poff(const struct sk_buff *skb, void *data,
 165                    const struct flow_keys *keys, int hlen);
 166
 167 /* struct flow_keys_digest:
 168  *
 169  * This structure is used to hold a digest of the full flow keys. This is a
 170  * larger "hash" of a flow to allow definitively matching specific flows where
 171  * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
 172  * that it can by used in CB of skb (see sch_choke for an example).
 173  */
 174 #define FLOW_KEYS_DIGEST_LEN    16
 175 struct flow_keys_digest {
 176         u8      data[FLOW_KEYS_DIGEST_LEN];
 177 };
 178
 179 void make_flow_keys_digest(struct flow_keys_digest *digest,
 180                            const struct flow_keys *flow);
 181
 182 #endif