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>
18 #include <linux/tcp.h>
19 #include <linux/udp.h>
20 #include <linux/icmp.h>
21 #include <linux/if_arp.h>
22 #include <linux/proc_fs.h>
23 #include <linux/seq_file.h>
25 #include <net/checksum.h>
27 #include <linux/netfilter_arp.h>
29 #include <linux/netfilter_ipv4/ip_tables.h>
30 #include <linux/netfilter_ipv4/ipt_CLUSTERIP.h>
31 #include <net/netfilter/nf_conntrack_compat.h>
33 #define CLUSTERIP_VERSION "0.8"
35 #define DEBUG_CLUSTERIP
37 #ifdef DEBUG_CLUSTERIP
43 #define ASSERT_READ_LOCK(x)
45 MODULE_LICENSE("GPL");
46 MODULE_AUTHOR("Harald Welte <laforge@netfilter.org>");
47 MODULE_DESCRIPTION("iptables target for CLUSTERIP");
49 struct clusterip_config {
50 struct list_head list; /* list of all configs */
51 atomic_t refcount; /* reference count */
52 atomic_t entries; /* number of entries/rules
55 u_int32_t clusterip; /* the IP address */
56 u_int8_t clustermac[ETH_ALEN]; /* the MAC address */
57 struct net_device *dev; /* device */
58 u_int16_t num_total_nodes; /* total number of nodes */
59 unsigned long local_nodes; /* node number array */
62 struct proc_dir_entry *pde; /* proc dir entry */
64 enum clusterip_hashmode hash_mode; /* which hashing mode */
65 u_int32_t hash_initval; /* hash initialization */
68 static LIST_HEAD(clusterip_configs);
70 /* clusterip_lock protects the clusterip_configs list */
71 static DEFINE_RWLOCK(clusterip_lock);
74 static struct file_operations clusterip_proc_fops;
75 static struct proc_dir_entry *clusterip_procdir;
79 clusterip_config_get(struct clusterip_config *c)
81 atomic_inc(&c->refcount);
85 clusterip_config_put(struct clusterip_config *c)
87 if (atomic_dec_and_test(&c->refcount))
91 /* increase the count of entries(rules) using/referencing this config */
93 clusterip_config_entry_get(struct clusterip_config *c)
95 atomic_inc(&c->entries);
98 /* decrease the count of entries using/referencing this config. If last
99 * entry(rule) is removed, remove the config from lists, but don't free it
100 * yet, since proc-files could still be holding references */
102 clusterip_config_entry_put(struct clusterip_config *c)
104 if (atomic_dec_and_test(&c->entries)) {
105 write_lock_bh(&clusterip_lock);
107 write_unlock_bh(&clusterip_lock);
109 dev_mc_delete(c->dev, c->clustermac, ETH_ALEN, 0);
112 /* In case anyone still accesses the file, the open/close
113 * functions are also incrementing the refcount on their own,
114 * so it's safe to remove the entry even if it's in use. */
115 #ifdef CONFIG_PROC_FS
116 remove_proc_entry(c->pde->name, c->pde->parent);
121 static struct clusterip_config *
122 __clusterip_config_find(u_int32_t clusterip)
124 struct list_head *pos;
126 ASSERT_READ_LOCK(&clusterip_lock);
127 list_for_each(pos, &clusterip_configs) {
128 struct clusterip_config *c = list_entry(pos,
129 struct clusterip_config, list);
130 if (c->clusterip == clusterip) {
138 static inline struct clusterip_config *
139 clusterip_config_find_get(u_int32_t clusterip, int entry)
141 struct clusterip_config *c;
143 read_lock_bh(&clusterip_lock);
144 c = __clusterip_config_find(clusterip);
146 read_unlock_bh(&clusterip_lock);
149 atomic_inc(&c->refcount);
151 atomic_inc(&c->entries);
152 read_unlock_bh(&clusterip_lock);
158 clusterip_config_init_nodelist(struct clusterip_config *c,
159 const struct ipt_clusterip_tgt_info *i)
163 for (n = 0; n < i->num_local_nodes; n++) {
164 set_bit(i->local_nodes[n] - 1, &c->local_nodes);
168 static struct clusterip_config *
169 clusterip_config_init(struct ipt_clusterip_tgt_info *i, u_int32_t ip,
170 struct net_device *dev)
172 struct clusterip_config *c;
175 c = kmalloc(sizeof(*c), GFP_ATOMIC);
179 memset(c, 0, sizeof(*c));
182 memcpy(&c->clustermac, &i->clustermac, ETH_ALEN);
183 c->num_total_nodes = i->num_total_nodes;
184 clusterip_config_init_nodelist(c, i);
185 c->hash_mode = i->hash_mode;
186 c->hash_initval = i->hash_initval;
187 atomic_set(&c->refcount, 1);
188 atomic_set(&c->entries, 1);
190 #ifdef CONFIG_PROC_FS
191 /* create proc dir entry */
192 sprintf(buffer, "%u.%u.%u.%u", NIPQUAD(ip));
193 c->pde = create_proc_entry(buffer, S_IWUSR|S_IRUSR, clusterip_procdir);
198 c->pde->proc_fops = &clusterip_proc_fops;
202 write_lock_bh(&clusterip_lock);
203 list_add(&c->list, &clusterip_configs);
204 write_unlock_bh(&clusterip_lock);
210 clusterip_add_node(struct clusterip_config *c, u_int16_t nodenum)
214 nodenum > c->num_total_nodes)
217 /* check if we already have this number in our bitfield */
218 if (test_and_set_bit(nodenum - 1, &c->local_nodes))
225 clusterip_del_node(struct clusterip_config *c, u_int16_t nodenum)
228 nodenum > c->num_total_nodes)
231 if (test_and_clear_bit(nodenum - 1, &c->local_nodes))
237 static inline u_int32_t
238 clusterip_hashfn(struct sk_buff *skb, struct clusterip_config *config)
240 struct iphdr *iph = skb->nh.iph;
241 unsigned long hashval;
242 u_int16_t sport, dport;
245 switch (iph->protocol) {
251 ports = (void *)iph+iph->ihl*4;
256 if (net_ratelimit()) {
257 printk(KERN_NOTICE "CLUSTERIP: unknown protocol `%u'\n",
263 switch (config->hash_mode) {
264 case CLUSTERIP_HASHMODE_SIP:
265 hashval = jhash_1word(ntohl(iph->saddr),
266 config->hash_initval);
268 case CLUSTERIP_HASHMODE_SIP_SPT:
269 hashval = jhash_2words(ntohl(iph->saddr), sport,
270 config->hash_initval);
272 case CLUSTERIP_HASHMODE_SIP_SPT_DPT:
273 hashval = jhash_3words(ntohl(iph->saddr), sport, dport,
274 config->hash_initval);
277 /* to make gcc happy */
279 /* This cannot happen, unless the check function wasn't called
280 * at rule load time */
281 printk("CLUSTERIP: unknown mode `%u'\n", config->hash_mode);
286 /* node numbers are 1..n, not 0..n */
287 return ((hashval % config->num_total_nodes)+1);
291 clusterip_responsible(struct clusterip_config *config, u_int32_t hash)
293 return test_bit(hash - 1, &config->local_nodes);
296 /***********************************************************************
298 ***********************************************************************/
301 target(struct sk_buff **pskb,
302 const struct net_device *in,
303 const struct net_device *out,
304 unsigned int hooknum,
305 const struct xt_target *target,
306 const void *targinfo,
309 const struct ipt_clusterip_tgt_info *cipinfo = targinfo;
310 enum ip_conntrack_info ctinfo;
311 u_int32_t *mark, hash;
313 /* don't need to clusterip_config_get() here, since refcount
314 * is only decremented by destroy() - and ip_tables guarantees
315 * that the ->target() function isn't called after ->destroy() */
317 mark = nf_ct_get_mark((*pskb), &ctinfo);
319 printk(KERN_ERR "CLUSTERIP: no conntrack!\n");
320 /* FIXME: need to drop invalid ones, since replies
321 * to outgoing connections of other nodes will be
322 * marked as INVALID */
326 /* special case: ICMP error handling. conntrack distinguishes between
327 * error messages (RELATED) and information requests (see below) */
328 if ((*pskb)->nh.iph->protocol == IPPROTO_ICMP
329 && (ctinfo == IP_CT_RELATED
330 || ctinfo == IP_CT_RELATED+IP_CT_IS_REPLY))
333 /* ip_conntrack_icmp guarantees us that we only have ICMP_ECHO,
334 * TIMESTAMP, INFO_REQUEST or ADDRESS type icmp packets from here
335 * on, which all have an ID field [relevant for hashing]. */
337 hash = clusterip_hashfn(*pskb, cipinfo->config);
344 case IP_CT_RELATED+IP_CT_IS_REPLY:
345 /* FIXME: we don't handle expectations at the
346 * moment. they can arrive on a different node than
347 * the master connection (e.g. FTP passive mode) */
348 case IP_CT_ESTABLISHED:
349 case IP_CT_ESTABLISHED+IP_CT_IS_REPLY:
355 #ifdef DEBUG_CLUSTERP
356 DUMP_TUPLE(&ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple);
358 DEBUGP("hash=%u ct_hash=%u ", hash, *mark);
359 if (!clusterip_responsible(cipinfo->config, hash)) {
360 DEBUGP("not responsible\n");
363 DEBUGP("responsible\n");
365 /* despite being received via linklayer multicast, this is
366 * actually a unicast IP packet. TCP doesn't like PACKET_MULTICAST */
367 (*pskb)->pkt_type = PACKET_HOST;
373 checkentry(const char *tablename,
375 const struct xt_target *target,
377 unsigned int targinfosize,
378 unsigned int hook_mask)
380 struct ipt_clusterip_tgt_info *cipinfo = targinfo;
381 const struct ipt_entry *e = e_void;
383 struct clusterip_config *config;
385 if (cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP &&
386 cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP_SPT &&
387 cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP_SPT_DPT) {
388 printk(KERN_WARNING "CLUSTERIP: unknown mode `%u'\n",
393 if (e->ip.dmsk.s_addr != 0xffffffff
394 || e->ip.dst.s_addr == 0) {
395 printk(KERN_ERR "CLUSTERIP: Please specify destination IP\n");
399 /* FIXME: further sanity checks */
401 config = clusterip_config_find_get(e->ip.dst.s_addr, 1);
403 if (cipinfo->config != NULL) {
404 /* Case A: This is an entry that gets reloaded, since
405 * it still has a cipinfo->config pointer. Simply
406 * increase the entry refcount and return */
407 if (cipinfo->config != config) {
408 printk(KERN_ERR "CLUSTERIP: Reloaded entry "
409 "has invalid config pointer!\n");
412 clusterip_config_entry_get(cipinfo->config);
414 /* Case B: This is a new rule referring to an existing
415 * clusterip config. */
416 cipinfo->config = config;
417 clusterip_config_entry_get(cipinfo->config);
420 /* Case C: This is a completely new clusterip config */
421 if (!(cipinfo->flags & CLUSTERIP_FLAG_NEW)) {
422 printk(KERN_WARNING "CLUSTERIP: no config found for %u.%u.%u.%u, need 'new'\n", NIPQUAD(e->ip.dst.s_addr));
425 struct net_device *dev;
427 if (e->ip.iniface[0] == '\0') {
428 printk(KERN_WARNING "CLUSTERIP: Please specify an interface name\n");
432 dev = dev_get_by_name(e->ip.iniface);
434 printk(KERN_WARNING "CLUSTERIP: no such interface %s\n", e->ip.iniface);
438 config = clusterip_config_init(cipinfo,
439 e->ip.dst.s_addr, dev);
441 printk(KERN_WARNING "CLUSTERIP: cannot allocate config\n");
445 dev_mc_add(config->dev,config->clustermac, ETH_ALEN, 0);
447 cipinfo->config = config;
453 /* drop reference count of cluster config when rule is deleted */
454 static void destroy(const struct xt_target *target, void *targinfo,
455 unsigned int targinfosize)
457 struct ipt_clusterip_tgt_info *cipinfo = targinfo;
459 /* if no more entries are referencing the config, remove it
460 * from the list and destroy the proc entry */
461 clusterip_config_entry_put(cipinfo->config);
463 clusterip_config_put(cipinfo->config);
466 static struct ipt_target clusterip_tgt = {
469 .targetsize = sizeof(struct ipt_clusterip_tgt_info),
470 .checkentry = checkentry,
476 /***********************************************************************
478 ***********************************************************************/
480 /* hardcoded for 48bit ethernet and 32bit ipv4 addresses */
482 u_int8_t src_hw[ETH_ALEN];
484 u_int8_t dst_hw[ETH_ALEN];
486 } __attribute__ ((packed));
488 #ifdef CLUSTERIP_DEBUG
489 static void arp_print(struct arp_payload *payload)
491 #define HBUFFERLEN 30
492 char hbuffer[HBUFFERLEN];
494 const char hexbuf[]= "0123456789abcdef";
496 for (k=0, j=0; k < HBUFFERLEN-3 && j < ETH_ALEN; j++) {
497 hbuffer[k++]=hexbuf[(payload->src_hw[j]>>4)&15];
498 hbuffer[k++]=hexbuf[payload->src_hw[j]&15];
503 printk("src %u.%u.%u.%u@%s, dst %u.%u.%u.%u\n",
504 NIPQUAD(payload->src_ip), hbuffer,
505 NIPQUAD(payload->dst_ip));
510 arp_mangle(unsigned int hook,
511 struct sk_buff **pskb,
512 const struct net_device *in,
513 const struct net_device *out,
514 int (*okfn)(struct sk_buff *))
516 struct arphdr *arp = (*pskb)->nh.arph;
517 struct arp_payload *payload;
518 struct clusterip_config *c;
520 /* we don't care about non-ethernet and non-ipv4 ARP */
521 if (arp->ar_hrd != htons(ARPHRD_ETHER)
522 || arp->ar_pro != htons(ETH_P_IP)
523 || arp->ar_pln != 4 || arp->ar_hln != ETH_ALEN)
526 /* we only want to mangle arp requests and replies */
527 if (arp->ar_op != htons(ARPOP_REPLY)
528 && arp->ar_op != htons(ARPOP_REQUEST))
531 payload = (void *)(arp+1);
533 /* if there is no clusterip configuration for the arp reply's
534 * source ip, we don't want to mangle it */
535 c = clusterip_config_find_get(payload->src_ip, 0);
539 /* normally the linux kernel always replies to arp queries of
540 * addresses on different interfacs. However, in the CLUSTERIP case
541 * this wouldn't work, since we didn't subscribe the mcast group on
542 * other interfaces */
544 DEBUGP("CLUSTERIP: not mangling arp reply on different "
545 "interface: cip'%s'-skb'%s'\n", c->dev->name, out->name);
546 clusterip_config_put(c);
550 /* mangle reply hardware address */
551 memcpy(payload->src_hw, c->clustermac, arp->ar_hln);
553 #ifdef CLUSTERIP_DEBUG
554 DEBUGP(KERN_DEBUG "CLUSTERIP mangled arp reply: ");
558 clusterip_config_put(c);
563 static struct nf_hook_ops cip_arp_ops = {
566 .hooknum = NF_ARP_OUT,
570 /***********************************************************************
572 ***********************************************************************/
574 #ifdef CONFIG_PROC_FS
576 struct clusterip_seq_position {
577 unsigned int pos; /* position */
578 unsigned int weight; /* number of bits set == size */
579 unsigned int bit; /* current bit */
580 unsigned long val; /* current value */
583 static void *clusterip_seq_start(struct seq_file *s, loff_t *pos)
585 struct proc_dir_entry *pde = s->private;
586 struct clusterip_config *c = pde->data;
588 u_int32_t local_nodes;
589 struct clusterip_seq_position *idx;
591 /* FIXME: possible race */
592 local_nodes = c->local_nodes;
593 weight = hweight32(local_nodes);
597 idx = kmalloc(sizeof(struct clusterip_seq_position), GFP_KERNEL);
599 return ERR_PTR(-ENOMEM);
602 idx->weight = weight;
603 idx->bit = ffs(local_nodes);
604 idx->val = local_nodes;
605 clear_bit(idx->bit - 1, &idx->val);
610 static void *clusterip_seq_next(struct seq_file *s, void *v, loff_t *pos)
612 struct clusterip_seq_position *idx = (struct clusterip_seq_position *)v;
615 if (*pos >= idx->weight) {
619 idx->bit = ffs(idx->val);
620 clear_bit(idx->bit - 1, &idx->val);
624 static void clusterip_seq_stop(struct seq_file *s, void *v)
629 static int clusterip_seq_show(struct seq_file *s, void *v)
631 struct clusterip_seq_position *idx = (struct clusterip_seq_position *)v;
636 seq_printf(s, "%u", idx->bit);
638 if (idx->pos == idx->weight - 1)
644 static struct seq_operations clusterip_seq_ops = {
645 .start = clusterip_seq_start,
646 .next = clusterip_seq_next,
647 .stop = clusterip_seq_stop,
648 .show = clusterip_seq_show,
651 static int clusterip_proc_open(struct inode *inode, struct file *file)
653 int ret = seq_open(file, &clusterip_seq_ops);
656 struct seq_file *sf = file->private_data;
657 struct proc_dir_entry *pde = PDE(inode);
658 struct clusterip_config *c = pde->data;
662 clusterip_config_get(c);
668 static int clusterip_proc_release(struct inode *inode, struct file *file)
670 struct proc_dir_entry *pde = PDE(inode);
671 struct clusterip_config *c = pde->data;
674 ret = seq_release(inode, file);
677 clusterip_config_put(c);
682 static ssize_t clusterip_proc_write(struct file *file, const char __user *input,
683 size_t size, loff_t *ofs)
685 #define PROC_WRITELEN 10
686 char buffer[PROC_WRITELEN+1];
687 struct proc_dir_entry *pde = PDE(file->f_dentry->d_inode);
688 struct clusterip_config *c = pde->data;
689 unsigned long nodenum;
691 if (copy_from_user(buffer, input, PROC_WRITELEN))
694 if (*buffer == '+') {
695 nodenum = simple_strtoul(buffer+1, NULL, 10);
696 if (clusterip_add_node(c, nodenum))
698 } else if (*buffer == '-') {
699 nodenum = simple_strtoul(buffer+1, NULL,10);
700 if (clusterip_del_node(c, nodenum))
708 static struct file_operations clusterip_proc_fops = {
709 .owner = THIS_MODULE,
710 .open = clusterip_proc_open,
712 .write = clusterip_proc_write,
714 .release = clusterip_proc_release,
717 #endif /* CONFIG_PROC_FS */
719 static int __init ipt_clusterip_init(void)
723 ret = ipt_register_target(&clusterip_tgt);
727 ret = nf_register_hook(&cip_arp_ops);
731 #ifdef CONFIG_PROC_FS
732 clusterip_procdir = proc_mkdir("ipt_CLUSTERIP", proc_net);
733 if (!clusterip_procdir) {
734 printk(KERN_ERR "CLUSTERIP: Unable to proc dir entry\n");
738 #endif /* CONFIG_PROC_FS */
740 printk(KERN_NOTICE "ClusterIP Version %s loaded successfully\n",
745 nf_unregister_hook(&cip_arp_ops);
747 ipt_unregister_target(&clusterip_tgt);
751 static void __exit ipt_clusterip_fini(void)
753 printk(KERN_NOTICE "ClusterIP Version %s unloading\n",
755 #ifdef CONFIG_PROC_FS
756 remove_proc_entry(clusterip_procdir->name, clusterip_procdir->parent);
758 nf_unregister_hook(&cip_arp_ops);
759 ipt_unregister_target(&clusterip_tgt);
762 module_init(ipt_clusterip_init);
763 module_exit(ipt_clusterip_fini);