include/net/netfilter/nf_flow_table.h

   1 #ifndef _NF_FLOW_TABLE_H
   2 #define _NF_FLOW_TABLE_H
   3
   4 #include <linux/in.h>
   5 #include <linux/in6.h>
   6 #include <linux/netdevice.h>
   7 #include <linux/rhashtable-types.h>
   8 #include <linux/rcupdate.h>
   9 #include <linux/netfilter.h>
  10 #include <linux/netfilter/nf_conntrack_tuple_common.h>
  11 #include <net/flow_offload.h>
  12 #include <net/dst.h>
  13
  14 struct nf_flowtable;
  15 struct nf_flow_rule;
  16 struct flow_offload;
  17 enum flow_offload_tuple_dir;
  18
  19 struct nf_flow_key {
  20         struct flow_dissector_key_meta                  meta;
  21         struct flow_dissector_key_control               control;
  22         struct flow_dissector_key_control               enc_control;
  23         struct flow_dissector_key_basic                 basic;
  24         union {
  25                 struct flow_dissector_key_ipv4_addrs    ipv4;
  26                 struct flow_dissector_key_ipv6_addrs    ipv6;
  27         };
  28         struct flow_dissector_key_keyid                 enc_key_id;
  29         union {
  30                 struct flow_dissector_key_ipv4_addrs    enc_ipv4;
  31                 struct flow_dissector_key_ipv6_addrs    enc_ipv6;
  32         };
  33         struct flow_dissector_key_tcp                   tcp;
  34         struct flow_dissector_key_ports                 tp;
  35 } __aligned(BITS_PER_LONG / 8); /* Ensure that we can do comparisons as longs. */
  36
  37 struct nf_flow_match {
  38         struct flow_dissector   dissector;
  39         struct nf_flow_key      key;
  40         struct nf_flow_key      mask;
  41 };
  42
  43 struct nf_flow_rule {
  44         struct nf_flow_match    match;
  45         struct flow_rule        *rule;
  46 };
  47
  48 struct nf_flowtable_type {
  49         struct list_head                list;
  50         int                             family;
  51         int                             (*init)(struct nf_flowtable *ft);
  52         int                             (*setup)(struct nf_flowtable *ft,
  53                                                  struct net_device *dev,
  54                                                  enum flow_block_command cmd);
  55         int                             (*action)(struct net *net,
  56                                                   const struct flow_offload *flow,
  57                                                   enum flow_offload_tuple_dir dir,
  58                                                   struct nf_flow_rule *flow_rule);
  59         void                            (*free)(struct nf_flowtable *ft);
  60         nf_hookfn                       *hook;
  61         struct module                   *owner;
  62 };
  63
  64 enum nf_flowtable_flags {
  65         NF_FLOWTABLE_HW_OFFLOAD         = 0x1,  /* NFT_FLOWTABLE_HW_OFFLOAD */
  66         NF_FLOWTABLE_COUNTER            = 0x2,  /* NFT_FLOWTABLE_COUNTER */
  67 };
  68
  69 struct nf_flowtable {
  70         struct list_head                list;
  71         struct rhashtable               rhashtable;
  72         int                             priority;
  73         const struct nf_flowtable_type  *type;
  74         struct delayed_work             gc_work;
  75         unsigned int                    flags;
  76         struct flow_block               flow_block;
  77         struct rw_semaphore             flow_block_lock; /* Guards flow_block */
  78         possible_net_t                  net;
  79 };
  80
  81 static inline bool nf_flowtable_hw_offload(struct nf_flowtable *flowtable)
  82 {
  83         return flowtable->flags & NF_FLOWTABLE_HW_OFFLOAD;
  84 }
  85
  86 enum flow_offload_tuple_dir {
  87         FLOW_OFFLOAD_DIR_ORIGINAL = IP_CT_DIR_ORIGINAL,
  88         FLOW_OFFLOAD_DIR_REPLY = IP_CT_DIR_REPLY,
  89         FLOW_OFFLOAD_DIR_MAX = IP_CT_DIR_MAX
  90 };
  91
  92 struct flow_offload_tuple {
  93         union {
  94                 struct in_addr          src_v4;
  95                 struct in6_addr         src_v6;
  96         };
  97         union {
  98                 struct in_addr          dst_v4;
  99                 struct in6_addr         dst_v6;
 100         };
 101         struct {
 102                 __be16                  src_port;
 103                 __be16                  dst_port;
 104         };
 105
 106         int                             iifidx;
 107
 108         u8                              l3proto;
 109         u8                              l4proto;
 110         u8                              dir;
 111
 112         u16                             mtu;
 113
 114         struct dst_entry                *dst_cache;
 115 };
 116
 117 struct flow_offload_tuple_rhash {
 118         struct rhash_head               node;
 119         struct flow_offload_tuple       tuple;
 120 };
 121
 122 enum nf_flow_flags {
 123         NF_FLOW_SNAT,
 124         NF_FLOW_DNAT,
 125         NF_FLOW_TEARDOWN,
 126         NF_FLOW_HW,
 127         NF_FLOW_HW_DYING,
 128         NF_FLOW_HW_DEAD,
 129         NF_FLOW_HW_REFRESH,
 130         NF_FLOW_HW_PENDING,
 131 };
 132
 133 enum flow_offload_type {
 134         NF_FLOW_OFFLOAD_UNSPEC  = 0,
 135         NF_FLOW_OFFLOAD_ROUTE,
 136 };
 137
 138 struct flow_offload {
 139         struct flow_offload_tuple_rhash         tuplehash[FLOW_OFFLOAD_DIR_MAX];
 140         struct nf_conn                          *ct;
 141         unsigned long                           flags;
 142         u16                                     type;
 143         u32                                     timeout;
 144         struct rcu_head                         rcu_head;
 145 };
 146
 147 #define NF_FLOW_TIMEOUT (30 * HZ)
 148 #define nf_flowtable_time_stamp (u32)jiffies
 149
 150 static inline __s32 nf_flow_timeout_delta(unsigned int timeout)
 151 {
 152         return (__s32)(timeout - nf_flowtable_time_stamp);
 153 }
 154
 155 struct nf_flow_route {
 156         struct {
 157                 struct dst_entry        *dst;
 158         } tuple[FLOW_OFFLOAD_DIR_MAX];
 159 };
 160
 161 struct flow_offload *flow_offload_alloc(struct nf_conn *ct);
 162 void flow_offload_free(struct flow_offload *flow);
 163
 164 static inline int
 165 nf_flow_table_offload_add_cb(struct nf_flowtable *flow_table,
 166                              flow_setup_cb_t *cb, void *cb_priv)
 167 {
 168         struct flow_block *block = &flow_table->flow_block;
 169         struct flow_block_cb *block_cb;
 170         int err = 0;
 171
 172         down_write(&flow_table->flow_block_lock);
 173         block_cb = flow_block_cb_lookup(block, cb, cb_priv);
 174         if (block_cb) {
 175                 err = -EEXIST;
 176                 goto unlock;
 177         }
 178
 179         block_cb = flow_block_cb_alloc(cb, cb_priv, cb_priv, NULL);
 180         if (IS_ERR(block_cb)) {
 181                 err = PTR_ERR(block_cb);
 182                 goto unlock;
 183         }
 184
 185         list_add_tail(&block_cb->list, &block->cb_list);
 186
 187 unlock:
 188         up_write(&flow_table->flow_block_lock);
 189         return err;
 190 }
 191
 192 static inline void
 193 nf_flow_table_offload_del_cb(struct nf_flowtable *flow_table,
 194                              flow_setup_cb_t *cb, void *cb_priv)
 195 {
 196         struct flow_block *block = &flow_table->flow_block;
 197         struct flow_block_cb *block_cb;
 198
 199         down_write(&flow_table->flow_block_lock);
 200         block_cb = flow_block_cb_lookup(block, cb, cb_priv);
 201         if (block_cb) {
 202                 list_del(&block_cb->list);
 203                 flow_block_cb_free(block_cb);
 204         } else {
 205                 WARN_ON(true);
 206         }
 207         up_write(&flow_table->flow_block_lock);
 208 }
 209
 210 int flow_offload_route_init(struct flow_offload *flow,
 211                             const struct nf_flow_route *route);
 212
 213 int flow_offload_add(struct nf_flowtable *flow_table, struct flow_offload *flow);
 214 void flow_offload_refresh(struct nf_flowtable *flow_table,
 215                           struct flow_offload *flow);
 216
 217 struct flow_offload_tuple_rhash *flow_offload_lookup(struct nf_flowtable *flow_table,
 218                                                      struct flow_offload_tuple *tuple);
 219 void nf_flow_table_gc_cleanup(struct nf_flowtable *flowtable,
 220                               struct net_device *dev);
 221 void nf_flow_table_cleanup(struct net_device *dev);
 222
 223 int nf_flow_table_init(struct nf_flowtable *flow_table);
 224 void nf_flow_table_free(struct nf_flowtable *flow_table);
 225
 226 void flow_offload_teardown(struct flow_offload *flow);
 227
 228 int nf_flow_snat_port(const struct flow_offload *flow,
 229                       struct sk_buff *skb, unsigned int thoff,
 230                       u8 protocol, enum flow_offload_tuple_dir dir);
 231 int nf_flow_dnat_port(const struct flow_offload *flow,
 232                       struct sk_buff *skb, unsigned int thoff,
 233                       u8 protocol, enum flow_offload_tuple_dir dir);
 234
 235 struct flow_ports {
 236         __be16 source, dest;
 237 };
 238
 239 unsigned int nf_flow_offload_ip_hook(void *priv, struct sk_buff *skb,
 240                                      const struct nf_hook_state *state);
 241 unsigned int nf_flow_offload_ipv6_hook(void *priv, struct sk_buff *skb,
 242                                        const struct nf_hook_state *state);
 243
 244 #define MODULE_ALIAS_NF_FLOWTABLE(family)       \
 245         MODULE_ALIAS("nf-flowtable-" __stringify(family))
 246
 247 void nf_flow_offload_add(struct nf_flowtable *flowtable,
 248                          struct flow_offload *flow);
 249 void nf_flow_offload_del(struct nf_flowtable *flowtable,
 250                          struct flow_offload *flow);
 251 void nf_flow_offload_stats(struct nf_flowtable *flowtable,
 252                            struct flow_offload *flow);
 253
 254 void nf_flow_table_offload_flush(struct nf_flowtable *flowtable);
 255 int nf_flow_table_offload_setup(struct nf_flowtable *flowtable,
 256                                 struct net_device *dev,
 257                                 enum flow_block_command cmd);
 258 int nf_flow_rule_route_ipv4(struct net *net, const struct flow_offload *flow,
 259                             enum flow_offload_tuple_dir dir,
 260                             struct nf_flow_rule *flow_rule);
 261 int nf_flow_rule_route_ipv6(struct net *net, const struct flow_offload *flow,
 262                             enum flow_offload_tuple_dir dir,
 263                             struct nf_flow_rule *flow_rule);
 264
 265 int nf_flow_table_offload_init(void);
 266 void nf_flow_table_offload_exit(void);
 267
 268 #endif /* _NF_FLOW_TABLE_H */