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