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