include/net/netfilter/nf_conntrack.h

   1 /*
   2  * Connection state tracking for netfilter.  This is separated from,
   3  * but required by, the (future) NAT layer; it can also be used by an iptables
   4  * extension.
   5  *
   6  * 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
   7  *      - generalize L3 protocol dependent part.
   8  *
   9  * Derived from include/linux/netfiter_ipv4/ip_conntrack.h
  10  */
  11
  12 #ifndef _NF_CONNTRACK_H
  13 #define _NF_CONNTRACK_H
  14
  15 #include <linux/netfilter/nf_conntrack_common.h>
  16
  17 #ifdef __KERNEL__
  18 #include <linux/bitops.h>
  19 #include <linux/compiler.h>
  20 #include <asm/atomic.h>
  21
  22 #include <linux/netfilter/nf_conntrack_tcp.h>
  23 #include <linux/netfilter/nf_conntrack_sctp.h>
  24 #include <linux/netfilter/nf_conntrack_proto_gre.h>
  25 #include <net/netfilter/ipv4/nf_conntrack_icmp.h>
  26 #include <net/netfilter/ipv6/nf_conntrack_icmpv6.h>
  27
  28 #include <net/netfilter/nf_conntrack_tuple.h>
  29
  30 /* per conntrack: protocol private data */
  31 union nf_conntrack_proto {
  32         /* insert conntrack proto private data here */
  33         struct ip_ct_sctp sctp;
  34         struct ip_ct_tcp tcp;
  35         struct ip_ct_icmp icmp;
  36         struct nf_ct_icmpv6 icmpv6;
  37         struct nf_ct_gre gre;
  38 };
  39
  40 union nf_conntrack_expect_proto {
  41         /* insert expect proto private data here */
  42 };
  43
  44 /* Add protocol helper include file here */
  45 #include <linux/netfilter/nf_conntrack_ftp.h>
  46 #include <linux/netfilter/nf_conntrack_pptp.h>
  47 #include <linux/netfilter/nf_conntrack_h323.h>
  48 #include <linux/netfilter/nf_conntrack_sane.h>
  49 #include <linux/netfilter/nf_conntrack_sip.h>
  50
  51 /* per conntrack: application helper private data */
  52 union nf_conntrack_help {
  53         /* insert conntrack helper private data (master) here */
  54         struct nf_ct_ftp_master ct_ftp_info;
  55         struct nf_ct_pptp_master ct_pptp_info;
  56         struct nf_ct_h323_master ct_h323_info;
  57         struct nf_ct_sane_master ct_sane_info;
  58         struct nf_ct_sip_master ct_sip_info;
  59 };
  60
  61 #include <linux/types.h>
  62 #include <linux/skbuff.h>
  63 #include <linux/timer.h>
  64
  65 #ifdef CONFIG_NETFILTER_DEBUG
  66 #define NF_CT_ASSERT(x)                                                 \
  67 do {                                                                    \
  68         if (!(x))                                                       \
  69                 /* Wooah!  I'm tripping my conntrack in a frenzy of     \
  70                    netplay... */                                        \
  71                 printk("NF_CT_ASSERT: %s:%i(%s)\n",                     \
  72                        __FILE__, __LINE__, __FUNCTION__);               \
  73 } while(0)
  74 #else
  75 #define NF_CT_ASSERT(x)
  76 #endif
  77
  78 struct nf_conntrack_helper;
  79
  80 /* Must be kept in sync with the classes defined by helpers */
  81 #define NF_CT_MAX_EXPECT_CLASSES        3
  82
  83 /* nf_conn feature for connections that have a helper */
  84 struct nf_conn_help {
  85         /* Helper. if any */
  86         struct nf_conntrack_helper *helper;
  87
  88         union nf_conntrack_help help;
  89
  90         struct hlist_head expectations;
  91
  92         /* Current number of expected connections */
  93         u8 expecting[NF_CT_MAX_EXPECT_CLASSES];
  94 };
  95
  96
  97 #include <net/netfilter/ipv4/nf_conntrack_ipv4.h>
  98 #include <net/netfilter/ipv6/nf_conntrack_ipv6.h>
  99
 100 struct nf_conn
 101 {
 102         /* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
 103            plus 1 for any connection(s) we are `master' for */
 104         struct nf_conntrack ct_general;
 105
 106         /* XXX should I move this to the tail ? - Y.K */
 107         /* These are my tuples; original and reply */
 108         struct nf_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];
 109
 110         /* Have we seen traffic both ways yet? (bitset) */
 111         unsigned long status;
 112
 113         /* If we were expected by an expectation, this will be it */
 114         struct nf_conn *master;
 115
 116         /* Timer function; drops refcnt when it goes off. */
 117         struct timer_list timeout;
 118
 119 #ifdef CONFIG_NF_CT_ACCT
 120         /* Accounting Information (same cache line as other written members) */
 121         struct ip_conntrack_counter counters[IP_CT_DIR_MAX];
 122 #endif
 123
 124 #if defined(CONFIG_NF_CONNTRACK_MARK)
 125         u_int32_t mark;
 126 #endif
 127
 128 #ifdef CONFIG_NF_CONNTRACK_SECMARK
 129         u_int32_t secmark;
 130 #endif
 131
 132         /* Storage reserved for other modules: */
 133         union nf_conntrack_proto proto;
 134
 135         /* Extensions */
 136         struct nf_ct_ext *ext;
 137
 138         struct rcu_head rcu;
 139 };
 140
 141 static inline struct nf_conn *
 142 nf_ct_tuplehash_to_ctrack(const struct nf_conntrack_tuple_hash *hash)
 143 {
 144         return container_of(hash, struct nf_conn,
 145                             tuplehash[hash->tuple.dst.dir]);
 146 }
 147
 148 /* get master conntrack via master expectation */
 149 #define master_ct(conntr) (conntr->master)
 150
 151 /* Alter reply tuple (maybe alter helper). */
 152 extern void
 153 nf_conntrack_alter_reply(struct nf_conn *ct,
 154                          const struct nf_conntrack_tuple *newreply);
 155
 156 /* Is this tuple taken? (ignoring any belonging to the given
 157    conntrack). */
 158 extern int
 159 nf_conntrack_tuple_taken(const struct nf_conntrack_tuple *tuple,
 160                          const struct nf_conn *ignored_conntrack);
 161
 162 /* Return conntrack_info and tuple hash for given skb. */
 163 static inline struct nf_conn *
 164 nf_ct_get(const struct sk_buff *skb, enum ip_conntrack_info *ctinfo)
 165 {
 166         *ctinfo = skb->nfctinfo;
 167         return (struct nf_conn *)skb->nfct;
 168 }
 169
 170 /* decrement reference count on a conntrack */
 171 static inline void nf_ct_put(struct nf_conn *ct)
 172 {
 173         NF_CT_ASSERT(ct);
 174         nf_conntrack_put(&ct->ct_general);
 175 }
 176
 177 /* Protocol module loading */
 178 extern int nf_ct_l3proto_try_module_get(unsigned short l3proto);
 179 extern void nf_ct_l3proto_module_put(unsigned short l3proto);
 180
 181 extern struct hlist_head *nf_ct_alloc_hashtable(unsigned int *sizep, int *vmalloced);
 182 extern void nf_ct_free_hashtable(struct hlist_head *hash, int vmalloced,
 183                                  unsigned int size);
 184
 185 extern struct nf_conntrack_tuple_hash *
 186 __nf_conntrack_find(const struct nf_conntrack_tuple *tuple);
 187
 188 extern void nf_conntrack_hash_insert(struct nf_conn *ct);
 189
 190 extern void nf_conntrack_flush(void);
 191
 192 extern int nf_ct_get_tuplepr(const struct sk_buff *skb,
 193                              unsigned int nhoff,
 194                              u_int16_t l3num,
 195                              struct nf_conntrack_tuple *tuple);
 196 extern int nf_ct_invert_tuplepr(struct nf_conntrack_tuple *inverse,
 197                                 const struct nf_conntrack_tuple *orig);
 198
 199 extern void __nf_ct_refresh_acct(struct nf_conn *ct,
 200                                  enum ip_conntrack_info ctinfo,
 201                                  const struct sk_buff *skb,
 202                                  unsigned long extra_jiffies,
 203                                  int do_acct);
 204
 205 /* Refresh conntrack for this many jiffies and do accounting */
 206 static inline void nf_ct_refresh_acct(struct nf_conn *ct,
 207                                       enum ip_conntrack_info ctinfo,
 208                                       const struct sk_buff *skb,
 209                                       unsigned long extra_jiffies)
 210 {
 211         __nf_ct_refresh_acct(ct, ctinfo, skb, extra_jiffies, 1);
 212 }
 213
 214 /* Refresh conntrack for this many jiffies */
 215 static inline void nf_ct_refresh(struct nf_conn *ct,
 216                                  const struct sk_buff *skb,
 217                                  unsigned long extra_jiffies)
 218 {
 219         __nf_ct_refresh_acct(ct, 0, skb, extra_jiffies, 0);
 220 }
 221
 222 /* These are for NAT.  Icky. */
 223 /* Update TCP window tracking data when NAT mangles the packet */
 224 extern void nf_conntrack_tcp_update(const struct sk_buff *skb,
 225                                     unsigned int dataoff,
 226                                     struct nf_conn *ct,
 227                                     int dir);
 228
 229 /* Fake conntrack entry for untracked connections */
 230 extern struct nf_conn nf_conntrack_untracked;
 231
 232 /* Iterate over all conntracks: if iter returns true, it's deleted. */
 233 extern void
 234 nf_ct_iterate_cleanup(int (*iter)(struct nf_conn *i, void *data), void *data);
 235 extern void nf_conntrack_free(struct nf_conn *ct);
 236 extern struct nf_conn *
 237 nf_conntrack_alloc(const struct nf_conntrack_tuple *orig,
 238                    const struct nf_conntrack_tuple *repl);
 239
 240 /* It's confirmed if it is, or has been in the hash table. */
 241 static inline int nf_ct_is_confirmed(struct nf_conn *ct)
 242 {
 243         return test_bit(IPS_CONFIRMED_BIT, &ct->status);
 244 }
 245
 246 static inline int nf_ct_is_dying(struct nf_conn *ct)
 247 {
 248         return test_bit(IPS_DYING_BIT, &ct->status);
 249 }
 250
 251 static inline int nf_ct_is_untracked(const struct sk_buff *skb)
 252 {
 253         return (skb->nfct == &nf_conntrack_untracked.ct_general);
 254 }
 255
 256 extern int nf_conntrack_set_hashsize(const char *val, struct kernel_param *kp);
 257 extern unsigned int nf_conntrack_htable_size;
 258 extern int nf_conntrack_checksum;
 259 extern atomic_t nf_conntrack_count;
 260 extern int nf_conntrack_max;
 261
 262 DECLARE_PER_CPU(struct ip_conntrack_stat, nf_conntrack_stat);
 263 #define NF_CT_STAT_INC(count) (__get_cpu_var(nf_conntrack_stat).count++)
 264 #define NF_CT_STAT_INC_ATOMIC(count)                    \
 265 do {                                                    \
 266         local_bh_disable();                             \
 267         __get_cpu_var(nf_conntrack_stat).count++;       \
 268         local_bh_enable();                              \
 269 } while (0)
 270
 271 #endif /* __KERNEL__ */
 272 #endif /* _NF_CONNTRACK_H */