include/linux/netfilter_ipv4/ip_conntrack.h

   1 #ifndef _IP_CONNTRACK_H
   2 #define _IP_CONNTRACK_H
   3
   4 #include <linux/netfilter/nf_conntrack_common.h>
   5
   6 #ifdef __KERNEL__
   7 #include <linux/config.h>
   8 #include <linux/netfilter_ipv4/ip_conntrack_tuple.h>
   9 #include <linux/bitops.h>
  10 #include <linux/compiler.h>
  11 #include <asm/atomic.h>
  12
  13 #include <linux/netfilter_ipv4/ip_conntrack_tcp.h>
  14 #include <linux/netfilter_ipv4/ip_conntrack_icmp.h>
  15 #include <linux/netfilter_ipv4/ip_conntrack_proto_gre.h>
  16 #include <linux/netfilter_ipv4/ip_conntrack_sctp.h>
  17
  18 /* per conntrack: protocol private data */
  19 union ip_conntrack_proto {
  20         /* insert conntrack proto private data here */
  21         struct ip_ct_gre gre;
  22         struct ip_ct_sctp sctp;
  23         struct ip_ct_tcp tcp;
  24         struct ip_ct_icmp icmp;
  25 };
  26
  27 union ip_conntrack_expect_proto {
  28         /* insert expect proto private data here */
  29 };
  30
  31 /* Add protocol helper include file here */
  32 #include <linux/netfilter_ipv4/ip_conntrack_h323.h>
  33 #include <linux/netfilter_ipv4/ip_conntrack_pptp.h>
  34 #include <linux/netfilter_ipv4/ip_conntrack_amanda.h>
  35 #include <linux/netfilter_ipv4/ip_conntrack_ftp.h>
  36 #include <linux/netfilter_ipv4/ip_conntrack_irc.h>
  37
  38 /* per conntrack: application helper private data */
  39 union ip_conntrack_help {
  40         /* insert conntrack helper private data (master) here */
  41         struct ip_ct_h323_master ct_h323_info;
  42         struct ip_ct_pptp_master ct_pptp_info;
  43         struct ip_ct_ftp_master ct_ftp_info;
  44         struct ip_ct_irc_master ct_irc_info;
  45 };
  46
  47 #ifdef CONFIG_IP_NF_NAT_NEEDED
  48 #include <linux/netfilter_ipv4/ip_nat.h>
  49 #include <linux/netfilter_ipv4/ip_nat_pptp.h>
  50
  51 /* per conntrack: nat application helper private data */
  52 union ip_conntrack_nat_help {
  53         /* insert nat helper private data here */
  54         struct ip_nat_pptp nat_pptp_info;
  55 };
  56 #endif
  57
  58 #include <linux/types.h>
  59 #include <linux/skbuff.h>
  60
  61 #ifdef CONFIG_NETFILTER_DEBUG
  62 #define IP_NF_ASSERT(x)                                                 \
  63 do {                                                                    \
  64         if (!(x))                                                       \
  65                 /* Wooah!  I'm tripping my conntrack in a frenzy of     \
  66                    netplay... */                                        \
  67                 printk("NF_IP_ASSERT: %s:%i(%s)\n",                     \
  68                        __FILE__, __LINE__, __FUNCTION__);               \
  69 } while(0)
  70 #else
  71 #define IP_NF_ASSERT(x)
  72 #endif
  73
  74 struct ip_conntrack_helper;
  75
  76 struct ip_conntrack
  77 {
  78         /* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
  79            plus 1 for any connection(s) we are `master' for */
  80         struct nf_conntrack ct_general;
  81
  82         /* Have we seen traffic both ways yet? (bitset) */
  83         unsigned long status;
  84
  85         /* Timer function; drops refcnt when it goes off. */
  86         struct timer_list timeout;
  87
  88 #ifdef CONFIG_IP_NF_CT_ACCT
  89         /* Accounting Information (same cache line as other written members) */
  90         struct ip_conntrack_counter counters[IP_CT_DIR_MAX];
  91 #endif
  92         /* If we were expected by an expectation, this will be it */
  93         struct ip_conntrack *master;
  94
  95         /* Current number of expected connections */
  96         unsigned int expecting;
  97
  98         /* Unique ID that identifies this conntrack*/
  99         unsigned int id;
 100
 101         /* Helper, if any. */
 102         struct ip_conntrack_helper *helper;
 103
 104         /* Storage reserved for other modules: */
 105         union ip_conntrack_proto proto;
 106
 107         union ip_conntrack_help help;
 108
 109 #ifdef CONFIG_IP_NF_NAT_NEEDED
 110         struct {
 111                 struct ip_nat_info info;
 112                 union ip_conntrack_nat_help help;
 113 #if defined(CONFIG_IP_NF_TARGET_MASQUERADE) || \
 114         defined(CONFIG_IP_NF_TARGET_MASQUERADE_MODULE)
 115                 int masq_index;
 116 #endif
 117         } nat;
 118 #endif /* CONFIG_IP_NF_NAT_NEEDED */
 119
 120 #if defined(CONFIG_IP_NF_CONNTRACK_MARK)
 121         u_int32_t mark;
 122 #endif
 123
 124         /* Traversed often, so hopefully in different cacheline to top */
 125         /* These are my tuples; original and reply */
 126         struct ip_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];
 127 };
 128
 129 struct ip_conntrack_expect
 130 {
 131         /* Internal linked list (global expectation list) */
 132         struct list_head list;
 133
 134         /* We expect this tuple, with the following mask */
 135         struct ip_conntrack_tuple tuple, mask;
 136
 137         /* Function to call after setup and insertion */
 138         void (*expectfn)(struct ip_conntrack *new,
 139                          struct ip_conntrack_expect *this);
 140
 141         /* The conntrack of the master connection */
 142         struct ip_conntrack *master;
 143
 144         /* Timer function; deletes the expectation. */
 145         struct timer_list timeout;
 146
 147         /* Usage count. */
 148         atomic_t use;
 149
 150         /* Unique ID */
 151         unsigned int id;
 152
 153         /* Flags */
 154         unsigned int flags;
 155
 156 #ifdef CONFIG_IP_NF_NAT_NEEDED
 157         u_int32_t saved_ip;
 158         /* This is the original per-proto part, used to map the
 159          * expected connection the way the recipient expects. */
 160         union ip_conntrack_manip_proto saved_proto;
 161         /* Direction relative to the master connection. */
 162         enum ip_conntrack_dir dir;
 163 #endif
 164 };
 165
 166 #define IP_CT_EXPECT_PERMANENT  0x1
 167
 168 static inline struct ip_conntrack *
 169 tuplehash_to_ctrack(const struct ip_conntrack_tuple_hash *hash)
 170 {
 171         return container_of(hash, struct ip_conntrack,
 172                             tuplehash[hash->tuple.dst.dir]);
 173 }
 174
 175 /* get master conntrack via master expectation */
 176 #define master_ct(conntr) (conntr->master)
 177
 178 /* Alter reply tuple (maybe alter helper). */
 179 extern void
 180 ip_conntrack_alter_reply(struct ip_conntrack *conntrack,
 181                          const struct ip_conntrack_tuple *newreply);
 182
 183 /* Is this tuple taken? (ignoring any belonging to the given
 184    conntrack). */
 185 extern int
 186 ip_conntrack_tuple_taken(const struct ip_conntrack_tuple *tuple,
 187                          const struct ip_conntrack *ignored_conntrack);
 188
 189 /* Return conntrack_info and tuple hash for given skb. */
 190 static inline struct ip_conntrack *
 191 ip_conntrack_get(const struct sk_buff *skb, enum ip_conntrack_info *ctinfo)
 192 {
 193         *ctinfo = skb->nfctinfo;
 194         return (struct ip_conntrack *)skb->nfct;
 195 }
 196
 197 /* decrement reference count on a conntrack */
 198 static inline void
 199 ip_conntrack_put(struct ip_conntrack *ct)
 200 {
 201         IP_NF_ASSERT(ct);
 202         nf_conntrack_put(&ct->ct_general);
 203 }
 204
 205 extern int invert_tuplepr(struct ip_conntrack_tuple *inverse,
 206                           const struct ip_conntrack_tuple *orig);
 207
 208 extern void __ip_ct_refresh_acct(struct ip_conntrack *ct,
 209                                  enum ip_conntrack_info ctinfo,
 210                                  const struct sk_buff *skb,
 211                                  unsigned long extra_jiffies,
 212                                  int do_acct);
 213
 214 /* Refresh conntrack for this many jiffies and do accounting */
 215 static inline void ip_ct_refresh_acct(struct ip_conntrack *ct,
 216                                       enum ip_conntrack_info ctinfo,
 217                                       const struct sk_buff *skb,
 218                                       unsigned long extra_jiffies)
 219 {
 220         __ip_ct_refresh_acct(ct, ctinfo, skb, extra_jiffies, 1);
 221 }
 222
 223 /* Refresh conntrack for this many jiffies */
 224 static inline void ip_ct_refresh(struct ip_conntrack *ct,
 225                                  const struct sk_buff *skb,
 226                                  unsigned long extra_jiffies)
 227 {
 228         __ip_ct_refresh_acct(ct, 0, skb, extra_jiffies, 0);
 229 }
 230
 231 /* These are for NAT.  Icky. */
 232 /* Update TCP window tracking data when NAT mangles the packet */
 233 extern void ip_conntrack_tcp_update(struct sk_buff *skb,
 234                                     struct ip_conntrack *conntrack,
 235                                     enum ip_conntrack_dir dir);
 236
 237 /* Call me when a conntrack is destroyed. */
 238 extern void (*ip_conntrack_destroyed)(struct ip_conntrack *conntrack);
 239
 240 /* Fake conntrack entry for untracked connections */
 241 extern struct ip_conntrack ip_conntrack_untracked;
 242
 243 /* Returns new sk_buff, or NULL */
 244 struct sk_buff *
 245 ip_ct_gather_frags(struct sk_buff *skb, u_int32_t user);
 246
 247 /* Iterate over all conntracks: if iter returns true, it's deleted. */
 248 extern void
 249 ip_ct_iterate_cleanup(int (*iter)(struct ip_conntrack *i, void *data),
 250                       void *data);
 251
 252 extern struct ip_conntrack_helper *
 253 __ip_conntrack_helper_find_byname(const char *);
 254 extern struct ip_conntrack_helper *
 255 ip_conntrack_helper_find_get(const struct ip_conntrack_tuple *tuple);
 256 extern void ip_conntrack_helper_put(struct ip_conntrack_helper *helper);
 257
 258 extern struct ip_conntrack_protocol *
 259 __ip_conntrack_proto_find(u_int8_t protocol);
 260 extern struct ip_conntrack_protocol *
 261 ip_conntrack_proto_find_get(u_int8_t protocol);
 262 extern void ip_conntrack_proto_put(struct ip_conntrack_protocol *proto);
 263
 264 extern void ip_ct_remove_expectations(struct ip_conntrack *ct);
 265
 266 extern struct ip_conntrack *ip_conntrack_alloc(struct ip_conntrack_tuple *,
 267                                                struct ip_conntrack_tuple *);
 268
 269 extern void ip_conntrack_free(struct ip_conntrack *ct);
 270
 271 extern void ip_conntrack_hash_insert(struct ip_conntrack *ct);
 272
 273 extern struct ip_conntrack_expect *
 274 __ip_conntrack_expect_find(const struct ip_conntrack_tuple *tuple);
 275
 276 extern struct ip_conntrack_expect *
 277 ip_conntrack_expect_find(const struct ip_conntrack_tuple *tuple);
 278
 279 extern struct ip_conntrack_tuple_hash *
 280 __ip_conntrack_find(const struct ip_conntrack_tuple *tuple,
 281                     const struct ip_conntrack *ignored_conntrack);
 282
 283 extern void ip_conntrack_flush(void);
 284
 285 /* It's confirmed if it is, or has been in the hash table. */
 286 static inline int is_confirmed(struct ip_conntrack *ct)
 287 {
 288         return test_bit(IPS_CONFIRMED_BIT, &ct->status);
 289 }
 290
 291 static inline int is_dying(struct ip_conntrack *ct)
 292 {
 293         return test_bit(IPS_DYING_BIT, &ct->status);
 294 }
 295
 296 extern unsigned int ip_conntrack_htable_size;
 297 extern int ip_conntrack_checksum;
 298
 299 #define CONNTRACK_STAT_INC(count) (__get_cpu_var(ip_conntrack_stat).count++)
 300
 301 #ifdef CONFIG_IP_NF_CONNTRACK_EVENTS
 302 #include <linux/notifier.h>
 303 #include <linux/interrupt.h>
 304
 305 struct ip_conntrack_ecache {
 306         struct ip_conntrack *ct;
 307         unsigned int events;
 308 };
 309 DECLARE_PER_CPU(struct ip_conntrack_ecache, ip_conntrack_ecache);
 310
 311 #define CONNTRACK_ECACHE(x)     (__get_cpu_var(ip_conntrack_ecache).x)
 312
 313 extern struct atomic_notifier_head ip_conntrack_chain;
 314 extern struct atomic_notifier_head ip_conntrack_expect_chain;
 315
 316 static inline int ip_conntrack_register_notifier(struct notifier_block *nb)
 317 {
 318         return atomic_notifier_chain_register(&ip_conntrack_chain, nb);
 319 }
 320
 321 static inline int ip_conntrack_unregister_notifier(struct notifier_block *nb)
 322 {
 323         return atomic_notifier_chain_unregister(&ip_conntrack_chain, nb);
 324 }
 325
 326 static inline int
 327 ip_conntrack_expect_register_notifier(struct notifier_block *nb)
 328 {
 329         return atomic_notifier_chain_register(&ip_conntrack_expect_chain, nb);
 330 }
 331
 332 static inline int
 333 ip_conntrack_expect_unregister_notifier(struct notifier_block *nb)
 334 {
 335         return atomic_notifier_chain_unregister(&ip_conntrack_expect_chain,
 336                         nb);
 337 }
 338
 339 extern void ip_ct_deliver_cached_events(const struct ip_conntrack *ct);
 340 extern void __ip_ct_event_cache_init(struct ip_conntrack *ct);
 341
 342 static inline void
 343 ip_conntrack_event_cache(enum ip_conntrack_events event,
 344                          const struct sk_buff *skb)
 345 {
 346         struct ip_conntrack *ct = (struct ip_conntrack *)skb->nfct;
 347         struct ip_conntrack_ecache *ecache;
 348
 349         local_bh_disable();
 350         ecache = &__get_cpu_var(ip_conntrack_ecache);
 351         if (ct != ecache->ct)
 352                 __ip_ct_event_cache_init(ct);
 353         ecache->events |= event;
 354         local_bh_enable();
 355 }
 356
 357 static inline void ip_conntrack_event(enum ip_conntrack_events event,
 358                                       struct ip_conntrack *ct)
 359 {
 360         if (is_confirmed(ct) && !is_dying(ct))
 361                 atomic_notifier_call_chain(&ip_conntrack_chain, event, ct);
 362 }
 363
 364 static inline void
 365 ip_conntrack_expect_event(enum ip_conntrack_expect_events event,
 366                           struct ip_conntrack_expect *exp)
 367 {
 368         atomic_notifier_call_chain(&ip_conntrack_expect_chain, event, exp);
 369 }
 370 #else /* CONFIG_IP_NF_CONNTRACK_EVENTS */
 371 static inline void ip_conntrack_event_cache(enum ip_conntrack_events event,
 372                                             const struct sk_buff *skb) {}
 373 static inline void ip_conntrack_event(enum ip_conntrack_events event,
 374                                       struct ip_conntrack *ct) {}
 375 static inline void ip_ct_deliver_cached_events(const struct ip_conntrack *ct) {}
 376 static inline void
 377 ip_conntrack_expect_event(enum ip_conntrack_expect_events event,
 378                           struct ip_conntrack_expect *exp) {}
 379 #endif /* CONFIG_IP_NF_CONNTRACK_EVENTS */
 380
 381 #ifdef CONFIG_IP_NF_NAT_NEEDED
 382 static inline int ip_nat_initialized(struct ip_conntrack *conntrack,
 383                                      enum ip_nat_manip_type manip)
 384 {
 385         if (manip == IP_NAT_MANIP_SRC)
 386                 return test_bit(IPS_SRC_NAT_DONE_BIT, &conntrack->status);
 387         return test_bit(IPS_DST_NAT_DONE_BIT, &conntrack->status);
 388 }
 389 #endif /* CONFIG_IP_NF_NAT_NEEDED */
 390
 391 #endif /* __KERNEL__ */
 392 #endif /* _IP_CONNTRACK_H */