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