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 <net/netfilter/ipv4/nf_conntrack_icmp.h>
  25 #include <net/netfilter/ipv6/nf_conntrack_icmpv6.h>
  26
  27 #include <net/netfilter/nf_conntrack_tuple.h>
  28
  29 /* per conntrack: protocol private data */
  30 union nf_conntrack_proto {
  31         /* insert conntrack proto private data here */
  32         struct ip_ct_sctp sctp;
  33         struct ip_ct_tcp tcp;
  34         struct ip_ct_icmp icmp;
  35         struct nf_ct_icmpv6 icmpv6;
  36 };
  37
  38 union nf_conntrack_expect_proto {
  39         /* insert expect proto private data here */
  40 };
  41
  42 /* Add protocol helper include file here */
  43 #include <linux/netfilter/nf_conntrack_ftp.h>
  44
  45 /* per conntrack: application helper private data */
  46 union nf_conntrack_help {
  47         /* insert conntrack helper private data (master) here */
  48         struct ip_ct_ftp_master ct_ftp_info;
  49 };
  50
  51 #include <linux/types.h>
  52 #include <linux/skbuff.h>
  53
  54 #ifdef CONFIG_NETFILTER_DEBUG
  55 #define NF_CT_ASSERT(x)                                                 \
  56 do {                                                                    \
  57         if (!(x))                                                       \
  58                 /* Wooah!  I'm tripping my conntrack in a frenzy of     \
  59                    netplay... */                                        \
  60                 printk("NF_CT_ASSERT: %s:%i(%s)\n",                     \
  61                        __FILE__, __LINE__, __FUNCTION__);               \
  62 } while(0)
  63 #else
  64 #define NF_CT_ASSERT(x)
  65 #endif
  66
  67 struct nf_conntrack_helper;
  68
  69 /* nf_conn feature for connections that have a helper */
  70 struct nf_conn_help {
  71         /* Helper. if any */
  72         struct nf_conntrack_helper *helper;
  73
  74         union nf_conntrack_help help;
  75
  76         /* Current number of expected connections */
  77         unsigned int expecting;
  78 };
  79
  80
  81 #include <net/netfilter/ipv4/nf_conntrack_ipv4.h>
  82 struct nf_conn
  83 {
  84         /* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
  85            plus 1 for any connection(s) we are `master' for */
  86         struct nf_conntrack ct_general;
  87
  88         /* XXX should I move this to the tail ? - Y.K */
  89         /* These are my tuples; original and reply */
  90         struct nf_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];
  91
  92         /* Have we seen traffic both ways yet? (bitset) */
  93         unsigned long status;
  94
  95         /* If we were expected by an expectation, this will be it */
  96         struct nf_conn *master;
  97
  98         /* Timer function; drops refcnt when it goes off. */
  99         struct timer_list timeout;
 100
 101 #ifdef CONFIG_NF_CT_ACCT
 102         /* Accounting Information (same cache line as other written members) */
 103         struct ip_conntrack_counter counters[IP_CT_DIR_MAX];
 104 #endif
 105
 106         /* Unique ID that identifies this conntrack*/
 107         unsigned int id;
 108
 109         /* features - nat, helper, ... used by allocating system */
 110         u_int32_t features;
 111
 112 #if defined(CONFIG_NF_CONNTRACK_MARK)
 113         u_int32_t mark;
 114 #endif
 115
 116 #ifdef CONFIG_NF_CONNTRACK_SECMARK
 117         u_int32_t secmark;
 118 #endif
 119
 120         /* Storage reserved for other modules: */
 121         union nf_conntrack_proto proto;
 122
 123         /* features dynamically at the end: helper, nat (both optional) */
 124         char data[0];
 125 };
 126
 127 struct nf_conntrack_expect
 128 {
 129         /* Internal linked list (global expectation list) */
 130         struct list_head list;
 131
 132         /* We expect this tuple, with the following mask */
 133         struct nf_conntrack_tuple tuple, mask;
 134
 135         /* Function to call after setup and insertion */
 136         void (*expectfn)(struct nf_conn *new,
 137                          struct nf_conntrack_expect *this);
 138
 139         /* The conntrack of the master connection */
 140         struct nf_conn *master;
 141
 142         /* Timer function; deletes the expectation. */
 143         struct timer_list timeout;
 144
 145         /* Usage count. */
 146         atomic_t use;
 147
 148         /* Unique ID */
 149         unsigned int id;
 150
 151         /* Flags */
 152         unsigned int flags;
 153
 154 #ifdef CONFIG_NF_NAT_NEEDED
 155         /* This is the original per-proto part, used to map the
 156          * expected connection the way the recipient expects. */
 157         union nf_conntrack_manip_proto saved_proto;
 158         /* Direction relative to the master connection. */
 159         enum ip_conntrack_dir dir;
 160 #endif
 161 };
 162
 163 #define NF_CT_EXPECT_PERMANENT 0x1
 164
 165 static inline struct nf_conn *
 166 nf_ct_tuplehash_to_ctrack(const struct nf_conntrack_tuple_hash *hash)
 167 {
 168         return container_of(hash, struct nf_conn,
 169                             tuplehash[hash->tuple.dst.dir]);
 170 }
 171
 172 /* get master conntrack via master expectation */
 173 #define master_ct(conntr) (conntr->master)
 174
 175 /* Alter reply tuple (maybe alter helper). */
 176 extern void
 177 nf_conntrack_alter_reply(struct nf_conn *conntrack,
 178                          const struct nf_conntrack_tuple *newreply);
 179
 180 /* Is this tuple taken? (ignoring any belonging to the given
 181    conntrack). */
 182 extern int
 183 nf_conntrack_tuple_taken(const struct nf_conntrack_tuple *tuple,
 184                          const struct nf_conn *ignored_conntrack);
 185
 186 /* Return conntrack_info and tuple hash for given skb. */
 187 static inline struct nf_conn *
 188 nf_ct_get(const struct sk_buff *skb, enum ip_conntrack_info *ctinfo)
 189 {
 190         *ctinfo = skb->nfctinfo;
 191         return (struct nf_conn *)skb->nfct;
 192 }
 193
 194 /* decrement reference count on a conntrack */
 195 static inline void nf_ct_put(struct nf_conn *ct)
 196 {
 197         NF_CT_ASSERT(ct);
 198         nf_conntrack_put(&ct->ct_general);
 199 }
 200
 201 /* Protocol module loading */
 202 extern int nf_ct_l3proto_try_module_get(unsigned short l3proto);
 203 extern void nf_ct_l3proto_module_put(unsigned short l3proto);
 204
 205 extern struct nf_conntrack_tuple_hash *
 206 __nf_conntrack_find(const struct nf_conntrack_tuple *tuple,
 207                     const struct nf_conn *ignored_conntrack);
 208
 209 extern void nf_conntrack_hash_insert(struct nf_conn *ct);
 210
 211 extern struct nf_conntrack_expect *
 212 __nf_conntrack_expect_find(const struct nf_conntrack_tuple *tuple);
 213
 214 extern struct nf_conntrack_expect *
 215 nf_conntrack_expect_find(const struct nf_conntrack_tuple *tuple);
 216
 217 extern void nf_ct_unlink_expect(struct nf_conntrack_expect *exp);
 218
 219 extern void nf_ct_remove_expectations(struct nf_conn *ct);
 220
 221 extern void nf_conntrack_flush(void);
 222
 223 extern struct nf_conntrack_helper *
 224 nf_ct_helper_find_get( const struct nf_conntrack_tuple *tuple);
 225 extern void nf_ct_helper_put(struct nf_conntrack_helper *helper);
 226
 227 extern struct nf_conntrack_helper *
 228 __nf_conntrack_helper_find_byname(const char *name);
 229
 230 extern int nf_ct_invert_tuplepr(struct nf_conntrack_tuple *inverse,
 231                                 const struct nf_conntrack_tuple *orig);
 232
 233 extern void __nf_ct_refresh_acct(struct nf_conn *ct,
 234                                  enum ip_conntrack_info ctinfo,
 235                                  const struct sk_buff *skb,
 236                                  unsigned long extra_jiffies,
 237                                  int do_acct);
 238
 239 /* Refresh conntrack for this many jiffies and do accounting */
 240 static inline void nf_ct_refresh_acct(struct nf_conn *ct,
 241                                       enum ip_conntrack_info ctinfo,
 242                                       const struct sk_buff *skb,
 243                                       unsigned long extra_jiffies)
 244 {
 245         __nf_ct_refresh_acct(ct, ctinfo, skb, extra_jiffies, 1);
 246 }
 247
 248 /* Refresh conntrack for this many jiffies */
 249 static inline void nf_ct_refresh(struct nf_conn *ct,
 250                                  const struct sk_buff *skb,
 251                                  unsigned long extra_jiffies)
 252 {
 253         __nf_ct_refresh_acct(ct, 0, skb, extra_jiffies, 0);
 254 }
 255
 256 /* These are for NAT.  Icky. */
 257 /* Update TCP window tracking data when NAT mangles the packet */
 258 extern void nf_conntrack_tcp_update(struct sk_buff *skb,
 259                                     unsigned int dataoff,
 260                                     struct nf_conn *conntrack,
 261                                     int dir);
 262
 263 /* Call me when a conntrack is destroyed. */
 264 extern void (*nf_conntrack_destroyed)(struct nf_conn *conntrack);
 265
 266 /* Fake conntrack entry for untracked connections */
 267 extern struct nf_conn nf_conntrack_untracked;
 268
 269 extern int nf_ct_no_defrag;
 270
 271 /* Iterate over all conntracks: if iter returns true, it's deleted. */
 272 extern void
 273 nf_ct_iterate_cleanup(int (*iter)(struct nf_conn *i, void *data), void *data);
 274 extern void nf_conntrack_free(struct nf_conn *ct);
 275 extern struct nf_conn *
 276 nf_conntrack_alloc(const struct nf_conntrack_tuple *orig,
 277                    const struct nf_conntrack_tuple *repl);
 278
 279 /* It's confirmed if it is, or has been in the hash table. */
 280 static inline int nf_ct_is_confirmed(struct nf_conn *ct)
 281 {
 282         return test_bit(IPS_CONFIRMED_BIT, &ct->status);
 283 }
 284
 285 static inline int nf_ct_is_dying(struct nf_conn *ct)
 286 {
 287         return test_bit(IPS_DYING_BIT, &ct->status);
 288 }
 289
 290 extern unsigned int nf_conntrack_htable_size;
 291 extern int nf_conntrack_checksum;
 292
 293 #define NF_CT_STAT_INC(count) (__get_cpu_var(nf_conntrack_stat).count++)
 294
 295 #ifdef CONFIG_NF_CONNTRACK_EVENTS
 296 #include <linux/notifier.h>
 297 #include <linux/interrupt.h>
 298
 299 struct nf_conntrack_ecache {
 300         struct nf_conn *ct;
 301         unsigned int events;
 302 };
 303 DECLARE_PER_CPU(struct nf_conntrack_ecache, nf_conntrack_ecache);
 304
 305 #define CONNTRACK_ECACHE(x)     (__get_cpu_var(nf_conntrack_ecache).x)
 306
 307 extern struct atomic_notifier_head nf_conntrack_chain;
 308 extern struct atomic_notifier_head nf_conntrack_expect_chain;
 309
 310 static inline int nf_conntrack_register_notifier(struct notifier_block *nb)
 311 {
 312         return atomic_notifier_chain_register(&nf_conntrack_chain, nb);
 313 }
 314
 315 static inline int nf_conntrack_unregister_notifier(struct notifier_block *nb)
 316 {
 317         return atomic_notifier_chain_unregister(&nf_conntrack_chain, nb);
 318 }
 319
 320 static inline int
 321 nf_conntrack_expect_register_notifier(struct notifier_block *nb)
 322 {
 323         return atomic_notifier_chain_register(&nf_conntrack_expect_chain, nb);
 324 }
 325
 326 static inline int
 327 nf_conntrack_expect_unregister_notifier(struct notifier_block *nb)
 328 {
 329         return atomic_notifier_chain_unregister(&nf_conntrack_expect_chain,
 330                         nb);
 331 }
 332
 333 extern void nf_ct_deliver_cached_events(const struct nf_conn *ct);
 334 extern void __nf_ct_event_cache_init(struct nf_conn *ct);
 335
 336 static inline void
 337 nf_conntrack_event_cache(enum ip_conntrack_events event,
 338                          const struct sk_buff *skb)
 339 {
 340         struct nf_conn *ct = (struct nf_conn *)skb->nfct;
 341         struct nf_conntrack_ecache *ecache;
 342
 343         local_bh_disable();
 344         ecache = &__get_cpu_var(nf_conntrack_ecache);
 345         if (ct != ecache->ct)
 346                 __nf_ct_event_cache_init(ct);
 347         ecache->events |= event;
 348         local_bh_enable();
 349 }
 350
 351 static inline void nf_conntrack_event(enum ip_conntrack_events event,
 352                                       struct nf_conn *ct)
 353 {
 354         if (nf_ct_is_confirmed(ct) && !nf_ct_is_dying(ct))
 355                 atomic_notifier_call_chain(&nf_conntrack_chain, event, ct);
 356 }
 357
 358 static inline void
 359 nf_conntrack_expect_event(enum ip_conntrack_expect_events event,
 360                           struct nf_conntrack_expect *exp)
 361 {
 362         atomic_notifier_call_chain(&nf_conntrack_expect_chain, event, exp);
 363 }
 364 #else /* CONFIG_NF_CONNTRACK_EVENTS */
 365 static inline void nf_conntrack_event_cache(enum ip_conntrack_events event,
 366                                             const struct sk_buff *skb) {}
 367 static inline void nf_conntrack_event(enum ip_conntrack_events event,
 368                                       struct nf_conn *ct) {}
 369 static inline void nf_ct_deliver_cached_events(const struct nf_conn *ct) {}
 370 static inline void
 371 nf_conntrack_expect_event(enum ip_conntrack_expect_events event,
 372                           struct nf_conntrack_expect *exp) {}
 373 #endif /* CONFIG_NF_CONNTRACK_EVENTS */
 374
 375 /* no helper, no nat */
 376 #define NF_CT_F_BASIC   0
 377 /* for helper */
 378 #define NF_CT_F_HELP    1
 379 /* for nat. */
 380 #define NF_CT_F_NAT     2
 381 #define NF_CT_F_NUM     4
 382
 383 extern int
 384 nf_conntrack_register_cache(u_int32_t features, const char *name, size_t size);
 385 extern void
 386 nf_conntrack_unregister_cache(u_int32_t features);
 387
 388 /* valid combinations:
 389  * basic: nf_conn, nf_conn .. nf_conn_help
 390  * nat: nf_conn .. nf_conn_nat, nf_conn .. nf_conn_nat, nf_conn help
 391  */
 392 static inline struct nf_conn_help *nfct_help(const struct nf_conn *ct)
 393 {
 394         unsigned int offset = sizeof(struct nf_conn);
 395
 396         if (!(ct->features & NF_CT_F_HELP))
 397                 return NULL;
 398
 399         return (struct nf_conn_help *) ((void *)ct + offset);
 400 }
 401
 402 #endif /* __KERNEL__ */
 403 #endif /* _NF_CONNTRACK_H */