netfilter: xtables: move extension arguments into compound structure (4/6)
[linux-2.6/verdex.git] / net / ipv4 / netfilter / ipt_CLUSTERIP.c
blob67e8aa8f34f29c0f1037611c53850d2d5d4b6428
1 /* Cluster IP hashmark target
2 * (C) 2003-2004 by Harald Welte <laforge@netfilter.org>
3 * based on ideas of Fabio Olive Leite <olive@unixforge.org>
5 * Development of this code funded by SuSE Linux AG, http://www.suse.com/
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/module.h>
13 #include <linux/proc_fs.h>
14 #include <linux/jhash.h>
15 #include <linux/bitops.h>
16 #include <linux/skbuff.h>
17 #include <linux/ip.h>
18 #include <linux/tcp.h>
19 #include <linux/udp.h>
20 #include <linux/icmp.h>
21 #include <linux/if_arp.h>
22 #include <linux/seq_file.h>
23 #include <linux/netfilter_arp.h>
24 #include <linux/netfilter/x_tables.h>
25 #include <linux/netfilter_ipv4/ip_tables.h>
26 #include <linux/netfilter_ipv4/ipt_CLUSTERIP.h>
27 #include <net/netfilter/nf_conntrack.h>
28 #include <net/net_namespace.h>
29 #include <net/checksum.h>
31 #define CLUSTERIP_VERSION "0.8"
33 MODULE_LICENSE("GPL");
34 MODULE_AUTHOR("Harald Welte <laforge@netfilter.org>");
35 MODULE_DESCRIPTION("Xtables: CLUSTERIP target");
37 struct clusterip_config {
38 struct list_head list; /* list of all configs */
39 atomic_t refcount; /* reference count */
40 atomic_t entries; /* number of entries/rules
41 * referencing us */
43 __be32 clusterip; /* the IP address */
44 u_int8_t clustermac[ETH_ALEN]; /* the MAC address */
45 struct net_device *dev; /* device */
46 u_int16_t num_total_nodes; /* total number of nodes */
47 unsigned long local_nodes; /* node number array */
49 #ifdef CONFIG_PROC_FS
50 struct proc_dir_entry *pde; /* proc dir entry */
51 #endif
52 enum clusterip_hashmode hash_mode; /* which hashing mode */
53 u_int32_t hash_initval; /* hash initialization */
56 static LIST_HEAD(clusterip_configs);
58 /* clusterip_lock protects the clusterip_configs list */
59 static DEFINE_RWLOCK(clusterip_lock);
61 #ifdef CONFIG_PROC_FS
62 static const struct file_operations clusterip_proc_fops;
63 static struct proc_dir_entry *clusterip_procdir;
64 #endif
66 static inline void
67 clusterip_config_get(struct clusterip_config *c)
69 atomic_inc(&c->refcount);
72 static inline void
73 clusterip_config_put(struct clusterip_config *c)
75 if (atomic_dec_and_test(&c->refcount))
76 kfree(c);
79 /* decrease the count of entries using/referencing this config. If last
80 * entry(rule) is removed, remove the config from lists, but don't free it
81 * yet, since proc-files could still be holding references */
82 static inline void
83 clusterip_config_entry_put(struct clusterip_config *c)
85 write_lock_bh(&clusterip_lock);
86 if (atomic_dec_and_test(&c->entries)) {
87 list_del(&c->list);
88 write_unlock_bh(&clusterip_lock);
90 dev_mc_delete(c->dev, c->clustermac, ETH_ALEN, 0);
91 dev_put(c->dev);
93 /* In case anyone still accesses the file, the open/close
94 * functions are also incrementing the refcount on their own,
95 * so it's safe to remove the entry even if it's in use. */
96 #ifdef CONFIG_PROC_FS
97 remove_proc_entry(c->pde->name, c->pde->parent);
98 #endif
99 return;
101 write_unlock_bh(&clusterip_lock);
104 static struct clusterip_config *
105 __clusterip_config_find(__be32 clusterip)
107 struct clusterip_config *c;
109 list_for_each_entry(c, &clusterip_configs, list) {
110 if (c->clusterip == clusterip)
111 return c;
114 return NULL;
117 static inline struct clusterip_config *
118 clusterip_config_find_get(__be32 clusterip, int entry)
120 struct clusterip_config *c;
122 read_lock_bh(&clusterip_lock);
123 c = __clusterip_config_find(clusterip);
124 if (!c) {
125 read_unlock_bh(&clusterip_lock);
126 return NULL;
128 atomic_inc(&c->refcount);
129 if (entry)
130 atomic_inc(&c->entries);
131 read_unlock_bh(&clusterip_lock);
133 return c;
136 static void
137 clusterip_config_init_nodelist(struct clusterip_config *c,
138 const struct ipt_clusterip_tgt_info *i)
140 int n;
142 for (n = 0; n < i->num_local_nodes; n++)
143 set_bit(i->local_nodes[n] - 1, &c->local_nodes);
146 static struct clusterip_config *
147 clusterip_config_init(const struct ipt_clusterip_tgt_info *i, __be32 ip,
148 struct net_device *dev)
150 struct clusterip_config *c;
152 c = kzalloc(sizeof(*c), GFP_ATOMIC);
153 if (!c)
154 return NULL;
156 c->dev = dev;
157 c->clusterip = ip;
158 memcpy(&c->clustermac, &i->clustermac, ETH_ALEN);
159 c->num_total_nodes = i->num_total_nodes;
160 clusterip_config_init_nodelist(c, i);
161 c->hash_mode = i->hash_mode;
162 c->hash_initval = i->hash_initval;
163 atomic_set(&c->refcount, 1);
164 atomic_set(&c->entries, 1);
166 #ifdef CONFIG_PROC_FS
168 char buffer[16];
170 /* create proc dir entry */
171 sprintf(buffer, "%u.%u.%u.%u", NIPQUAD(ip));
172 c->pde = proc_create_data(buffer, S_IWUSR|S_IRUSR,
173 clusterip_procdir,
174 &clusterip_proc_fops, c);
175 if (!c->pde) {
176 kfree(c);
177 return NULL;
180 #endif
182 write_lock_bh(&clusterip_lock);
183 list_add(&c->list, &clusterip_configs);
184 write_unlock_bh(&clusterip_lock);
186 return c;
189 #ifdef CONFIG_PROC_FS
190 static int
191 clusterip_add_node(struct clusterip_config *c, u_int16_t nodenum)
194 if (nodenum == 0 ||
195 nodenum > c->num_total_nodes)
196 return 1;
198 /* check if we already have this number in our bitfield */
199 if (test_and_set_bit(nodenum - 1, &c->local_nodes))
200 return 1;
202 return 0;
205 static bool
206 clusterip_del_node(struct clusterip_config *c, u_int16_t nodenum)
208 if (nodenum == 0 ||
209 nodenum > c->num_total_nodes)
210 return true;
212 if (test_and_clear_bit(nodenum - 1, &c->local_nodes))
213 return false;
215 return true;
217 #endif
219 static inline u_int32_t
220 clusterip_hashfn(const struct sk_buff *skb,
221 const struct clusterip_config *config)
223 const struct iphdr *iph = ip_hdr(skb);
224 unsigned long hashval;
225 u_int16_t sport, dport;
226 const u_int16_t *ports;
228 switch (iph->protocol) {
229 case IPPROTO_TCP:
230 case IPPROTO_UDP:
231 case IPPROTO_UDPLITE:
232 case IPPROTO_SCTP:
233 case IPPROTO_DCCP:
234 case IPPROTO_ICMP:
235 ports = (const void *)iph+iph->ihl*4;
236 sport = ports[0];
237 dport = ports[1];
238 break;
239 default:
240 if (net_ratelimit())
241 printk(KERN_NOTICE "CLUSTERIP: unknown protocol `%u'\n",
242 iph->protocol);
243 sport = dport = 0;
246 switch (config->hash_mode) {
247 case CLUSTERIP_HASHMODE_SIP:
248 hashval = jhash_1word(ntohl(iph->saddr),
249 config->hash_initval);
250 break;
251 case CLUSTERIP_HASHMODE_SIP_SPT:
252 hashval = jhash_2words(ntohl(iph->saddr), sport,
253 config->hash_initval);
254 break;
255 case CLUSTERIP_HASHMODE_SIP_SPT_DPT:
256 hashval = jhash_3words(ntohl(iph->saddr), sport, dport,
257 config->hash_initval);
258 break;
259 default:
260 /* to make gcc happy */
261 hashval = 0;
262 /* This cannot happen, unless the check function wasn't called
263 * at rule load time */
264 printk("CLUSTERIP: unknown mode `%u'\n", config->hash_mode);
265 BUG();
266 break;
269 /* node numbers are 1..n, not 0..n */
270 return (((u64)hashval * config->num_total_nodes) >> 32) + 1;
273 static inline int
274 clusterip_responsible(const struct clusterip_config *config, u_int32_t hash)
276 return test_bit(hash - 1, &config->local_nodes);
279 /***********************************************************************
280 * IPTABLES TARGET
281 ***********************************************************************/
283 static unsigned int
284 clusterip_tg(struct sk_buff *skb, const struct xt_target_param *par)
286 const struct ipt_clusterip_tgt_info *cipinfo = par->targinfo;
287 struct nf_conn *ct;
288 enum ip_conntrack_info ctinfo;
289 u_int32_t hash;
291 /* don't need to clusterip_config_get() here, since refcount
292 * is only decremented by destroy() - and ip_tables guarantees
293 * that the ->target() function isn't called after ->destroy() */
295 ct = nf_ct_get(skb, &ctinfo);
296 if (ct == NULL) {
297 printk(KERN_ERR "CLUSTERIP: no conntrack!\n");
298 /* FIXME: need to drop invalid ones, since replies
299 * to outgoing connections of other nodes will be
300 * marked as INVALID */
301 return NF_DROP;
304 /* special case: ICMP error handling. conntrack distinguishes between
305 * error messages (RELATED) and information requests (see below) */
306 if (ip_hdr(skb)->protocol == IPPROTO_ICMP
307 && (ctinfo == IP_CT_RELATED
308 || ctinfo == IP_CT_RELATED+IP_CT_IS_REPLY))
309 return XT_CONTINUE;
311 /* ip_conntrack_icmp guarantees us that we only have ICMP_ECHO,
312 * TIMESTAMP, INFO_REQUEST or ADDRESS type icmp packets from here
313 * on, which all have an ID field [relevant for hashing]. */
315 hash = clusterip_hashfn(skb, cipinfo->config);
317 switch (ctinfo) {
318 case IP_CT_NEW:
319 ct->mark = hash;
320 break;
321 case IP_CT_RELATED:
322 case IP_CT_RELATED+IP_CT_IS_REPLY:
323 /* FIXME: we don't handle expectations at the
324 * moment. they can arrive on a different node than
325 * the master connection (e.g. FTP passive mode) */
326 case IP_CT_ESTABLISHED:
327 case IP_CT_ESTABLISHED+IP_CT_IS_REPLY:
328 break;
329 default:
330 break;
333 #ifdef DEBUG
334 nf_ct_dump_tuple_ip(&ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple);
335 #endif
336 pr_debug("hash=%u ct_hash=%u ", hash, ct->mark);
337 if (!clusterip_responsible(cipinfo->config, hash)) {
338 pr_debug("not responsible\n");
339 return NF_DROP;
341 pr_debug("responsible\n");
343 /* despite being received via linklayer multicast, this is
344 * actually a unicast IP packet. TCP doesn't like PACKET_MULTICAST */
345 skb->pkt_type = PACKET_HOST;
347 return XT_CONTINUE;
350 static bool
351 clusterip_tg_check(const char *tablename, const void *e_void,
352 const struct xt_target *target, void *targinfo,
353 unsigned int hook_mask)
355 struct ipt_clusterip_tgt_info *cipinfo = targinfo;
356 const struct ipt_entry *e = e_void;
358 struct clusterip_config *config;
360 if (cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP &&
361 cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP_SPT &&
362 cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP_SPT_DPT) {
363 printk(KERN_WARNING "CLUSTERIP: unknown mode `%u'\n",
364 cipinfo->hash_mode);
365 return false;
368 if (e->ip.dmsk.s_addr != htonl(0xffffffff)
369 || e->ip.dst.s_addr == 0) {
370 printk(KERN_ERR "CLUSTERIP: Please specify destination IP\n");
371 return false;
374 /* FIXME: further sanity checks */
376 config = clusterip_config_find_get(e->ip.dst.s_addr, 1);
377 if (!config) {
378 if (!(cipinfo->flags & CLUSTERIP_FLAG_NEW)) {
379 printk(KERN_WARNING "CLUSTERIP: no config found for %u.%u.%u.%u, need 'new'\n", NIPQUAD(e->ip.dst.s_addr));
380 return false;
381 } else {
382 struct net_device *dev;
384 if (e->ip.iniface[0] == '\0') {
385 printk(KERN_WARNING "CLUSTERIP: Please specify an interface name\n");
386 return false;
389 dev = dev_get_by_name(&init_net, e->ip.iniface);
390 if (!dev) {
391 printk(KERN_WARNING "CLUSTERIP: no such interface %s\n", e->ip.iniface);
392 return false;
395 config = clusterip_config_init(cipinfo,
396 e->ip.dst.s_addr, dev);
397 if (!config) {
398 printk(KERN_WARNING "CLUSTERIP: cannot allocate config\n");
399 dev_put(dev);
400 return false;
402 dev_mc_add(config->dev,config->clustermac, ETH_ALEN, 0);
405 cipinfo->config = config;
407 if (nf_ct_l3proto_try_module_get(target->family) < 0) {
408 printk(KERN_WARNING "can't load conntrack support for "
409 "proto=%u\n", target->family);
410 return false;
413 return true;
416 /* drop reference count of cluster config when rule is deleted */
417 static void clusterip_tg_destroy(const struct xt_target *target, void *targinfo)
419 const struct ipt_clusterip_tgt_info *cipinfo = targinfo;
421 /* if no more entries are referencing the config, remove it
422 * from the list and destroy the proc entry */
423 clusterip_config_entry_put(cipinfo->config);
425 clusterip_config_put(cipinfo->config);
427 nf_ct_l3proto_module_put(target->family);
430 #ifdef CONFIG_COMPAT
431 struct compat_ipt_clusterip_tgt_info
433 u_int32_t flags;
434 u_int8_t clustermac[6];
435 u_int16_t num_total_nodes;
436 u_int16_t num_local_nodes;
437 u_int16_t local_nodes[CLUSTERIP_MAX_NODES];
438 u_int32_t hash_mode;
439 u_int32_t hash_initval;
440 compat_uptr_t config;
442 #endif /* CONFIG_COMPAT */
444 static struct xt_target clusterip_tg_reg __read_mostly = {
445 .name = "CLUSTERIP",
446 .family = NFPROTO_IPV4,
447 .target = clusterip_tg,
448 .checkentry = clusterip_tg_check,
449 .destroy = clusterip_tg_destroy,
450 .targetsize = sizeof(struct ipt_clusterip_tgt_info),
451 #ifdef CONFIG_COMPAT
452 .compatsize = sizeof(struct compat_ipt_clusterip_tgt_info),
453 #endif /* CONFIG_COMPAT */
454 .me = THIS_MODULE
458 /***********************************************************************
459 * ARP MANGLING CODE
460 ***********************************************************************/
462 /* hardcoded for 48bit ethernet and 32bit ipv4 addresses */
463 struct arp_payload {
464 u_int8_t src_hw[ETH_ALEN];
465 __be32 src_ip;
466 u_int8_t dst_hw[ETH_ALEN];
467 __be32 dst_ip;
468 } __attribute__ ((packed));
470 #ifdef DEBUG
471 static void arp_print(struct arp_payload *payload)
473 #define HBUFFERLEN 30
474 char hbuffer[HBUFFERLEN];
475 int j,k;
477 for (k=0, j=0; k < HBUFFERLEN-3 && j < ETH_ALEN; j++) {
478 hbuffer[k++] = hex_asc_hi(payload->src_hw[j]);
479 hbuffer[k++] = hex_asc_lo(payload->src_hw[j]);
480 hbuffer[k++]=':';
482 hbuffer[--k]='\0';
484 printk("src %u.%u.%u.%u@%s, dst %u.%u.%u.%u\n",
485 NIPQUAD(payload->src_ip), hbuffer,
486 NIPQUAD(payload->dst_ip));
488 #endif
490 static unsigned int
491 arp_mangle(unsigned int hook,
492 struct sk_buff *skb,
493 const struct net_device *in,
494 const struct net_device *out,
495 int (*okfn)(struct sk_buff *))
497 struct arphdr *arp = arp_hdr(skb);
498 struct arp_payload *payload;
499 struct clusterip_config *c;
501 /* we don't care about non-ethernet and non-ipv4 ARP */
502 if (arp->ar_hrd != htons(ARPHRD_ETHER)
503 || arp->ar_pro != htons(ETH_P_IP)
504 || arp->ar_pln != 4 || arp->ar_hln != ETH_ALEN)
505 return NF_ACCEPT;
507 /* we only want to mangle arp requests and replies */
508 if (arp->ar_op != htons(ARPOP_REPLY)
509 && arp->ar_op != htons(ARPOP_REQUEST))
510 return NF_ACCEPT;
512 payload = (void *)(arp+1);
514 /* if there is no clusterip configuration for the arp reply's
515 * source ip, we don't want to mangle it */
516 c = clusterip_config_find_get(payload->src_ip, 0);
517 if (!c)
518 return NF_ACCEPT;
520 /* normally the linux kernel always replies to arp queries of
521 * addresses on different interfacs. However, in the CLUSTERIP case
522 * this wouldn't work, since we didn't subscribe the mcast group on
523 * other interfaces */
524 if (c->dev != out) {
525 pr_debug("CLUSTERIP: not mangling arp reply on different "
526 "interface: cip'%s'-skb'%s'\n",
527 c->dev->name, out->name);
528 clusterip_config_put(c);
529 return NF_ACCEPT;
532 /* mangle reply hardware address */
533 memcpy(payload->src_hw, c->clustermac, arp->ar_hln);
535 #ifdef DEBUG
536 pr_debug(KERN_DEBUG "CLUSTERIP mangled arp reply: ");
537 arp_print(payload);
538 #endif
540 clusterip_config_put(c);
542 return NF_ACCEPT;
545 static struct nf_hook_ops cip_arp_ops __read_mostly = {
546 .hook = arp_mangle,
547 .pf = NFPROTO_ARP,
548 .hooknum = NF_ARP_OUT,
549 .priority = -1
552 /***********************************************************************
553 * PROC DIR HANDLING
554 ***********************************************************************/
556 #ifdef CONFIG_PROC_FS
558 struct clusterip_seq_position {
559 unsigned int pos; /* position */
560 unsigned int weight; /* number of bits set == size */
561 unsigned int bit; /* current bit */
562 unsigned long val; /* current value */
565 static void *clusterip_seq_start(struct seq_file *s, loff_t *pos)
567 const struct proc_dir_entry *pde = s->private;
568 struct clusterip_config *c = pde->data;
569 unsigned int weight;
570 u_int32_t local_nodes;
571 struct clusterip_seq_position *idx;
573 /* FIXME: possible race */
574 local_nodes = c->local_nodes;
575 weight = hweight32(local_nodes);
576 if (*pos >= weight)
577 return NULL;
579 idx = kmalloc(sizeof(struct clusterip_seq_position), GFP_KERNEL);
580 if (!idx)
581 return ERR_PTR(-ENOMEM);
583 idx->pos = *pos;
584 idx->weight = weight;
585 idx->bit = ffs(local_nodes);
586 idx->val = local_nodes;
587 clear_bit(idx->bit - 1, &idx->val);
589 return idx;
592 static void *clusterip_seq_next(struct seq_file *s, void *v, loff_t *pos)
594 struct clusterip_seq_position *idx = v;
596 *pos = ++idx->pos;
597 if (*pos >= idx->weight) {
598 kfree(v);
599 return NULL;
601 idx->bit = ffs(idx->val);
602 clear_bit(idx->bit - 1, &idx->val);
603 return idx;
606 static void clusterip_seq_stop(struct seq_file *s, void *v)
608 kfree(v);
611 static int clusterip_seq_show(struct seq_file *s, void *v)
613 struct clusterip_seq_position *idx = v;
615 if (idx->pos != 0)
616 seq_putc(s, ',');
618 seq_printf(s, "%u", idx->bit);
620 if (idx->pos == idx->weight - 1)
621 seq_putc(s, '\n');
623 return 0;
626 static const struct seq_operations clusterip_seq_ops = {
627 .start = clusterip_seq_start,
628 .next = clusterip_seq_next,
629 .stop = clusterip_seq_stop,
630 .show = clusterip_seq_show,
633 static int clusterip_proc_open(struct inode *inode, struct file *file)
635 int ret = seq_open(file, &clusterip_seq_ops);
637 if (!ret) {
638 struct seq_file *sf = file->private_data;
639 struct proc_dir_entry *pde = PDE(inode);
640 struct clusterip_config *c = pde->data;
642 sf->private = pde;
644 clusterip_config_get(c);
647 return ret;
650 static int clusterip_proc_release(struct inode *inode, struct file *file)
652 struct proc_dir_entry *pde = PDE(inode);
653 struct clusterip_config *c = pde->data;
654 int ret;
656 ret = seq_release(inode, file);
658 if (!ret)
659 clusterip_config_put(c);
661 return ret;
664 static ssize_t clusterip_proc_write(struct file *file, const char __user *input,
665 size_t size, loff_t *ofs)
667 #define PROC_WRITELEN 10
668 char buffer[PROC_WRITELEN+1];
669 const struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
670 struct clusterip_config *c = pde->data;
671 unsigned long nodenum;
673 if (copy_from_user(buffer, input, PROC_WRITELEN))
674 return -EFAULT;
676 if (*buffer == '+') {
677 nodenum = simple_strtoul(buffer+1, NULL, 10);
678 if (clusterip_add_node(c, nodenum))
679 return -ENOMEM;
680 } else if (*buffer == '-') {
681 nodenum = simple_strtoul(buffer+1, NULL,10);
682 if (clusterip_del_node(c, nodenum))
683 return -ENOENT;
684 } else
685 return -EIO;
687 return size;
690 static const struct file_operations clusterip_proc_fops = {
691 .owner = THIS_MODULE,
692 .open = clusterip_proc_open,
693 .read = seq_read,
694 .write = clusterip_proc_write,
695 .llseek = seq_lseek,
696 .release = clusterip_proc_release,
699 #endif /* CONFIG_PROC_FS */
701 static int __init clusterip_tg_init(void)
703 int ret;
705 ret = xt_register_target(&clusterip_tg_reg);
706 if (ret < 0)
707 return ret;
709 ret = nf_register_hook(&cip_arp_ops);
710 if (ret < 0)
711 goto cleanup_target;
713 #ifdef CONFIG_PROC_FS
714 clusterip_procdir = proc_mkdir("ipt_CLUSTERIP", init_net.proc_net);
715 if (!clusterip_procdir) {
716 printk(KERN_ERR "CLUSTERIP: Unable to proc dir entry\n");
717 ret = -ENOMEM;
718 goto cleanup_hook;
720 #endif /* CONFIG_PROC_FS */
722 printk(KERN_NOTICE "ClusterIP Version %s loaded successfully\n",
723 CLUSTERIP_VERSION);
724 return 0;
726 #ifdef CONFIG_PROC_FS
727 cleanup_hook:
728 nf_unregister_hook(&cip_arp_ops);
729 #endif /* CONFIG_PROC_FS */
730 cleanup_target:
731 xt_unregister_target(&clusterip_tg_reg);
732 return ret;
735 static void __exit clusterip_tg_exit(void)
737 printk(KERN_NOTICE "ClusterIP Version %s unloading\n",
738 CLUSTERIP_VERSION);
739 #ifdef CONFIG_PROC_FS
740 remove_proc_entry(clusterip_procdir->name, clusterip_procdir->parent);
741 #endif
742 nf_unregister_hook(&cip_arp_ops);
743 xt_unregister_target(&clusterip_tg_reg);
746 module_init(clusterip_tg_init);
747 module_exit(clusterip_tg_exit);