include/net/flow.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  *
   4  *      Generic internet FLOW.
   5  *
   6  */
   7
   8 #ifndef _NET_FLOW_H
   9 #define _NET_FLOW_H
  10
  11 #include <linux/socket.h>
  12 #include <linux/in6.h>
  13 #include <linux/atomic.h>
  14 #include <net/flow_dissector.h>
  15 #include <linux/uidgid.h>
  16
  17 /*
  18  * ifindex generation is per-net namespace, and loopback is
  19  * always the 1st device in ns (see net_dev_init), thus any
  20  * loopback device should get ifindex 1
  21  */
  22
  23 #define LOOPBACK_IFINDEX        1
  24
  25 struct flowi_tunnel {
  26         __be64                  tun_id;
  27 };
  28
  29 struct flowi_common {
  30         int     flowic_oif;
  31         int     flowic_iif;
  32         __u32   flowic_mark;
  33         __u8    flowic_tos;
  34         __u8    flowic_scope;
  35         __u8    flowic_proto;
  36         __u8    flowic_flags;
  37 #define FLOWI_FLAG_ANYSRC               0x01
  38 #define FLOWI_FLAG_KNOWN_NH             0x02
  39 #define FLOWI_FLAG_SKIP_NH_OIF          0x04
  40         __u32   flowic_secid;
  41         struct flowi_tunnel flowic_tun_key;
  42         kuid_t  flowic_uid;
  43 };
  44
  45 union flowi_uli {
  46         struct {
  47                 __be16  dport;
  48                 __be16  sport;
  49         } ports;
  50
  51         struct {
  52                 __u8    type;
  53                 __u8    code;
  54         } icmpt;
  55
  56         struct {
  57                 __le16  dport;
  58                 __le16  sport;
  59         } dnports;
  60
  61         __be32          spi;
  62         __be32          gre_key;
  63
  64         struct {
  65                 __u8    type;
  66         } mht;
  67 };
  68
  69 struct flowi4 {
  70         struct flowi_common     __fl_common;
  71 #define flowi4_oif              __fl_common.flowic_oif
  72 #define flowi4_iif              __fl_common.flowic_iif
  73 #define flowi4_mark             __fl_common.flowic_mark
  74 #define flowi4_tos              __fl_common.flowic_tos
  75 #define flowi4_scope            __fl_common.flowic_scope
  76 #define flowi4_proto            __fl_common.flowic_proto
  77 #define flowi4_flags            __fl_common.flowic_flags
  78 #define flowi4_secid            __fl_common.flowic_secid
  79 #define flowi4_tun_key          __fl_common.flowic_tun_key
  80 #define flowi4_uid              __fl_common.flowic_uid
  81
  82         /* (saddr,daddr) must be grouped, same order as in IP header */
  83         __be32                  saddr;
  84         __be32                  daddr;
  85
  86         union flowi_uli         uli;
  87 #define fl4_sport               uli.ports.sport
  88 #define fl4_dport               uli.ports.dport
  89 #define fl4_icmp_type           uli.icmpt.type
  90 #define fl4_icmp_code           uli.icmpt.code
  91 #define fl4_ipsec_spi           uli.spi
  92 #define fl4_mh_type             uli.mht.type
  93 #define fl4_gre_key             uli.gre_key
  94 } __attribute__((__aligned__(BITS_PER_LONG/8)));
  95
  96 static inline void flowi4_init_output(struct flowi4 *fl4, int oif,
  97                                       __u32 mark, __u8 tos, __u8 scope,
  98                                       __u8 proto, __u8 flags,
  99                                       __be32 daddr, __be32 saddr,
 100                                       __be16 dport, __be16 sport,
 101                                       kuid_t uid)
 102 {
 103         fl4->flowi4_oif = oif;
 104         fl4->flowi4_iif = LOOPBACK_IFINDEX;
 105         fl4->flowi4_mark = mark;
 106         fl4->flowi4_tos = tos;
 107         fl4->flowi4_scope = scope;
 108         fl4->flowi4_proto = proto;
 109         fl4->flowi4_flags = flags;
 110         fl4->flowi4_secid = 0;
 111         fl4->flowi4_tun_key.tun_id = 0;
 112         fl4->flowi4_uid = uid;
 113         fl4->daddr = daddr;
 114         fl4->saddr = saddr;
 115         fl4->fl4_dport = dport;
 116         fl4->fl4_sport = sport;
 117 }
 118
 119 /* Reset some input parameters after previous lookup */
 120 static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
 121                                         __be32 daddr, __be32 saddr)
 122 {
 123         fl4->flowi4_oif = oif;
 124         fl4->flowi4_tos = tos;
 125         fl4->daddr = daddr;
 126         fl4->saddr = saddr;
 127 }
 128
 129
 130 struct flowi6 {
 131         struct flowi_common     __fl_common;
 132 #define flowi6_oif              __fl_common.flowic_oif
 133 #define flowi6_iif              __fl_common.flowic_iif
 134 #define flowi6_mark             __fl_common.flowic_mark
 135 #define flowi6_scope            __fl_common.flowic_scope
 136 #define flowi6_proto            __fl_common.flowic_proto
 137 #define flowi6_flags            __fl_common.flowic_flags
 138 #define flowi6_secid            __fl_common.flowic_secid
 139 #define flowi6_tun_key          __fl_common.flowic_tun_key
 140 #define flowi6_uid              __fl_common.flowic_uid
 141         struct in6_addr         daddr;
 142         struct in6_addr         saddr;
 143         /* Note: flowi6_tos is encoded in flowlabel, too. */
 144         __be32                  flowlabel;
 145         union flowi_uli         uli;
 146 #define fl6_sport               uli.ports.sport
 147 #define fl6_dport               uli.ports.dport
 148 #define fl6_icmp_type           uli.icmpt.type
 149 #define fl6_icmp_code           uli.icmpt.code
 150 #define fl6_ipsec_spi           uli.spi
 151 #define fl6_mh_type             uli.mht.type
 152 #define fl6_gre_key             uli.gre_key
 153         __u32                   mp_hash;
 154 } __attribute__((__aligned__(BITS_PER_LONG/8)));
 155
 156 struct flowidn {
 157         struct flowi_common     __fl_common;
 158 #define flowidn_oif             __fl_common.flowic_oif
 159 #define flowidn_iif             __fl_common.flowic_iif
 160 #define flowidn_mark            __fl_common.flowic_mark
 161 #define flowidn_scope           __fl_common.flowic_scope
 162 #define flowidn_proto           __fl_common.flowic_proto
 163 #define flowidn_flags           __fl_common.flowic_flags
 164         __le16                  daddr;
 165         __le16                  saddr;
 166         union flowi_uli         uli;
 167 #define fld_sport               uli.ports.sport
 168 #define fld_dport               uli.ports.dport
 169 } __attribute__((__aligned__(BITS_PER_LONG/8)));
 170
 171 struct flowi {
 172         union {
 173                 struct flowi_common     __fl_common;
 174                 struct flowi4           ip4;
 175                 struct flowi6           ip6;
 176                 struct flowidn          dn;
 177         } u;
 178 #define flowi_oif       u.__fl_common.flowic_oif
 179 #define flowi_iif       u.__fl_common.flowic_iif
 180 #define flowi_mark      u.__fl_common.flowic_mark
 181 #define flowi_tos       u.__fl_common.flowic_tos
 182 #define flowi_scope     u.__fl_common.flowic_scope
 183 #define flowi_proto     u.__fl_common.flowic_proto
 184 #define flowi_flags     u.__fl_common.flowic_flags
 185 #define flowi_secid     u.__fl_common.flowic_secid
 186 #define flowi_tun_key   u.__fl_common.flowic_tun_key
 187 #define flowi_uid       u.__fl_common.flowic_uid
 188 } __attribute__((__aligned__(BITS_PER_LONG/8)));
 189
 190 static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
 191 {
 192         return container_of(fl4, struct flowi, u.ip4);
 193 }
 194
 195 static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
 196 {
 197         return container_of(fl6, struct flowi, u.ip6);
 198 }
 199
 200 static inline struct flowi *flowidn_to_flowi(struct flowidn *fldn)
 201 {
 202         return container_of(fldn, struct flowi, u.dn);
 203 }
 204
 205 typedef unsigned long flow_compare_t;
 206
 207 static inline unsigned int flow_key_size(u16 family)
 208 {
 209         switch (family) {
 210         case AF_INET:
 211                 BUILD_BUG_ON(sizeof(struct flowi4) % sizeof(flow_compare_t));
 212                 return sizeof(struct flowi4) / sizeof(flow_compare_t);
 213         case AF_INET6:
 214                 BUILD_BUG_ON(sizeof(struct flowi6) % sizeof(flow_compare_t));
 215                 return sizeof(struct flowi6) / sizeof(flow_compare_t);
 216         case AF_DECnet:
 217                 BUILD_BUG_ON(sizeof(struct flowidn) % sizeof(flow_compare_t));
 218                 return sizeof(struct flowidn) / sizeof(flow_compare_t);
 219         }
 220         return 0;
 221 }
 222
 223 __u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys);
 224
 225 static inline __u32 get_hash_from_flowi6(const struct flowi6 *fl6)
 226 {
 227         struct flow_keys keys;
 228
 229         return __get_hash_from_flowi6(fl6, &keys);
 230 }
 231
 232 __u32 __get_hash_from_flowi4(const struct flowi4 *fl4, struct flow_keys *keys);
 233
 234 static inline __u32 get_hash_from_flowi4(const struct flowi4 *fl4)
 235 {
 236         struct flow_keys keys;
 237
 238         return __get_hash_from_flowi4(fl4, &keys);
 239 }
 240
 241 #endif