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>
24 #include <linux/netfilter_arp.h>
25 #include <linux/netfilter/x_tables.h>
26 #include <linux/netfilter_ipv4/ip_tables.h>
27 #include <linux/netfilter_ipv4/ipt_CLUSTERIP.h>
28 #include <net/netfilter/nf_conntrack.h>
29 #include <net/checksum.h>
31 #define CLUSTERIP_VERSION "0.8"
33 #define DEBUG_CLUSTERIP
35 #ifdef DEBUG_CLUSTERIP
41 MODULE_LICENSE("GPL");
42 MODULE_AUTHOR("Harald Welte <laforge@netfilter.org>");
43 MODULE_DESCRIPTION("iptables target for CLUSTERIP");
45 struct clusterip_config {
46 struct list_head list; /* list of all configs */
47 atomic_t refcount; /* reference count */
48 atomic_t entries; /* number of entries/rules
51 __be32 clusterip; /* the IP address */
52 u_int8_t clustermac[ETH_ALEN]; /* the MAC address */
53 struct net_device *dev; /* device */
54 u_int16_t num_total_nodes; /* total number of nodes */
55 unsigned long local_nodes; /* node number array */
58 struct proc_dir_entry *pde; /* proc dir entry */
60 enum clusterip_hashmode hash_mode; /* which hashing mode */
61 u_int32_t hash_initval; /* hash initialization */
64 static LIST_HEAD(clusterip_configs);
66 /* clusterip_lock protects the clusterip_configs list */
67 static DEFINE_RWLOCK(clusterip_lock);
70 static const struct file_operations clusterip_proc_fops;
71 static struct proc_dir_entry *clusterip_procdir;
75 clusterip_config_get(struct clusterip_config *c)
77 atomic_inc(&c->refcount);
81 clusterip_config_put(struct clusterip_config *c)
83 if (atomic_dec_and_test(&c->refcount))
87 /* increase the count of entries(rules) using/referencing this config */
89 clusterip_config_entry_get(struct clusterip_config *c)
91 atomic_inc(&c->entries);
94 /* decrease the count of entries using/referencing this config. If last
95 * entry(rule) is removed, remove the config from lists, but don't free it
96 * yet, since proc-files could still be holding references */
98 clusterip_config_entry_put(struct clusterip_config *c)
100 if (atomic_dec_and_test(&c->entries)) {
101 write_lock_bh(&clusterip_lock);
103 write_unlock_bh(&clusterip_lock);
105 dev_mc_delete(c->dev, c->clustermac, ETH_ALEN, 0);
108 /* In case anyone still accesses the file, the open/close
109 * functions are also incrementing the refcount on their own,
110 * so it's safe to remove the entry even if it's in use. */
111 #ifdef CONFIG_PROC_FS
112 remove_proc_entry(c->pde->name, c->pde->parent);
117 static struct clusterip_config *
118 __clusterip_config_find(__be32 clusterip)
120 struct list_head *pos;
122 list_for_each(pos, &clusterip_configs) {
123 struct clusterip_config *c = list_entry(pos,
124 struct clusterip_config, list);
125 if (c->clusterip == clusterip)
132 static inline struct clusterip_config *
133 clusterip_config_find_get(__be32 clusterip, int entry)
135 struct clusterip_config *c;
137 read_lock_bh(&clusterip_lock);
138 c = __clusterip_config_find(clusterip);
140 read_unlock_bh(&clusterip_lock);
143 atomic_inc(&c->refcount);
145 atomic_inc(&c->entries);
146 read_unlock_bh(&clusterip_lock);
152 clusterip_config_init_nodelist(struct clusterip_config *c,
153 const struct ipt_clusterip_tgt_info *i)
157 for (n = 0; n < i->num_local_nodes; n++)
158 set_bit(i->local_nodes[n] - 1, &c->local_nodes);
161 static struct clusterip_config *
162 clusterip_config_init(struct ipt_clusterip_tgt_info *i, __be32 ip,
163 struct net_device *dev)
165 struct clusterip_config *c;
167 c = kzalloc(sizeof(*c), GFP_ATOMIC);
173 memcpy(&c->clustermac, &i->clustermac, ETH_ALEN);
174 c->num_total_nodes = i->num_total_nodes;
175 clusterip_config_init_nodelist(c, i);
176 c->hash_mode = i->hash_mode;
177 c->hash_initval = i->hash_initval;
178 atomic_set(&c->refcount, 1);
179 atomic_set(&c->entries, 1);
181 #ifdef CONFIG_PROC_FS
185 /* create proc dir entry */
186 sprintf(buffer, "%u.%u.%u.%u", NIPQUAD(ip));
187 c->pde = create_proc_entry(buffer, S_IWUSR|S_IRUSR,
194 c->pde->proc_fops = &clusterip_proc_fops;
198 write_lock_bh(&clusterip_lock);
199 list_add(&c->list, &clusterip_configs);
200 write_unlock_bh(&clusterip_lock);
205 #ifdef CONFIG_PROC_FS
207 clusterip_add_node(struct clusterip_config *c, u_int16_t nodenum)
211 nodenum > c->num_total_nodes)
214 /* check if we already have this number in our bitfield */
215 if (test_and_set_bit(nodenum - 1, &c->local_nodes))
222 clusterip_del_node(struct clusterip_config *c, u_int16_t nodenum)
225 nodenum > c->num_total_nodes)
228 if (test_and_clear_bit(nodenum - 1, &c->local_nodes))
235 static inline u_int32_t
236 clusterip_hashfn(const struct sk_buff *skb,
237 const struct clusterip_config *config)
239 const struct iphdr *iph = ip_hdr(skb);
240 unsigned long hashval;
241 u_int16_t sport, dport;
242 const u_int16_t *ports;
244 switch (iph->protocol) {
247 case IPPROTO_UDPLITE:
251 ports = (const void *)iph+iph->ihl*4;
257 printk(KERN_NOTICE "CLUSTERIP: unknown protocol `%u'\n",
262 switch (config->hash_mode) {
263 case CLUSTERIP_HASHMODE_SIP:
264 hashval = jhash_1word(ntohl(iph->saddr),
265 config->hash_initval);
267 case CLUSTERIP_HASHMODE_SIP_SPT:
268 hashval = jhash_2words(ntohl(iph->saddr), sport,
269 config->hash_initval);
271 case CLUSTERIP_HASHMODE_SIP_SPT_DPT:
272 hashval = jhash_3words(ntohl(iph->saddr), sport, dport,
273 config->hash_initval);
276 /* to make gcc happy */
278 /* This cannot happen, unless the check function wasn't called
279 * at rule load time */
280 printk("CLUSTERIP: unknown mode `%u'\n", config->hash_mode);
285 /* node numbers are 1..n, not 0..n */
286 return (hashval % config->num_total_nodes) + 1;
290 clusterip_responsible(const struct clusterip_config *config, u_int32_t hash)
292 return test_bit(hash - 1, &config->local_nodes);
295 /***********************************************************************
297 ***********************************************************************/
300 target(struct sk_buff **pskb,
301 const struct net_device *in,
302 const struct net_device *out,
303 unsigned int hooknum,
304 const struct xt_target *target,
305 const void *targinfo)
307 const struct ipt_clusterip_tgt_info *cipinfo = targinfo;
309 enum ip_conntrack_info ctinfo;
312 /* don't need to clusterip_config_get() here, since refcount
313 * is only decremented by destroy() - and ip_tables guarantees
314 * that the ->target() function isn't called after ->destroy() */
316 ct = nf_ct_get(*pskb, &ctinfo);
318 printk(KERN_ERR "CLUSTERIP: no conntrack!\n");
319 /* FIXME: need to drop invalid ones, since replies
320 * to outgoing connections of other nodes will be
321 * marked as INVALID */
325 /* special case: ICMP error handling. conntrack distinguishes between
326 * error messages (RELATED) and information requests (see below) */
327 if (ip_hdr(*pskb)->protocol == IPPROTO_ICMP
328 && (ctinfo == IP_CT_RELATED
329 || ctinfo == IP_CT_RELATED+IP_CT_IS_REPLY))
332 /* ip_conntrack_icmp guarantees us that we only have ICMP_ECHO,
333 * TIMESTAMP, INFO_REQUEST or ADDRESS type icmp packets from here
334 * on, which all have an ID field [relevant for hashing]. */
336 hash = clusterip_hashfn(*pskb, cipinfo->config);
343 case IP_CT_RELATED+IP_CT_IS_REPLY:
344 /* FIXME: we don't handle expectations at the
345 * moment. they can arrive on a different node than
346 * the master connection (e.g. FTP passive mode) */
347 case IP_CT_ESTABLISHED:
348 case IP_CT_ESTABLISHED+IP_CT_IS_REPLY:
354 #ifdef DEBUG_CLUSTERP
355 DUMP_TUPLE(&ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple);
357 DEBUGP("hash=%u ct_hash=%u ", hash, ct->mark);
358 if (!clusterip_responsible(cipinfo->config, hash)) {
359 DEBUGP("not responsible\n");
362 DEBUGP("responsible\n");
364 /* despite being received via linklayer multicast, this is
365 * actually a unicast IP packet. TCP doesn't like PACKET_MULTICAST */
366 (*pskb)->pkt_type = PACKET_HOST;
372 checkentry(const char *tablename,
374 const struct xt_target *target,
376 unsigned int hook_mask)
378 struct ipt_clusterip_tgt_info *cipinfo = targinfo;
379 const struct ipt_entry *e = e_void;
381 struct clusterip_config *config;
383 if (cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP &&
384 cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP_SPT &&
385 cipinfo->hash_mode != CLUSTERIP_HASHMODE_SIP_SPT_DPT) {
386 printk(KERN_WARNING "CLUSTERIP: unknown mode `%u'\n",
391 if (e->ip.dmsk.s_addr != htonl(0xffffffff)
392 || e->ip.dst.s_addr == 0) {
393 printk(KERN_ERR "CLUSTERIP: Please specify destination IP\n");
397 /* FIXME: further sanity checks */
399 config = clusterip_config_find_get(e->ip.dst.s_addr, 1);
401 if (!(cipinfo->flags & CLUSTERIP_FLAG_NEW)) {
402 printk(KERN_WARNING "CLUSTERIP: no config found for %u.%u.%u.%u, need 'new'\n", NIPQUAD(e->ip.dst.s_addr));
405 struct net_device *dev;
407 if (e->ip.iniface[0] == '\0') {
408 printk(KERN_WARNING "CLUSTERIP: Please specify an interface name\n");
412 dev = dev_get_by_name(e->ip.iniface);
414 printk(KERN_WARNING "CLUSTERIP: no such interface %s\n", e->ip.iniface);
418 config = clusterip_config_init(cipinfo,
419 e->ip.dst.s_addr, dev);
421 printk(KERN_WARNING "CLUSTERIP: cannot allocate config\n");
425 dev_mc_add(config->dev,config->clustermac, ETH_ALEN, 0);
428 cipinfo->config = config;
430 if (nf_ct_l3proto_try_module_get(target->family) < 0) {
431 printk(KERN_WARNING "can't load conntrack support for "
432 "proto=%d\n", target->family);
439 /* drop reference count of cluster config when rule is deleted */
440 static void destroy(const struct xt_target *target, void *targinfo)
442 struct ipt_clusterip_tgt_info *cipinfo = targinfo;
444 /* if no more entries are referencing the config, remove it
445 * from the list and destroy the proc entry */
446 clusterip_config_entry_put(cipinfo->config);
448 clusterip_config_put(cipinfo->config);
450 nf_ct_l3proto_module_put(target->family);
454 struct compat_ipt_clusterip_tgt_info
457 u_int8_t clustermac[6];
458 u_int16_t num_total_nodes;
459 u_int16_t num_local_nodes;
460 u_int16_t local_nodes[CLUSTERIP_MAX_NODES];
462 u_int32_t hash_initval;
463 compat_uptr_t config;
465 #endif /* CONFIG_COMPAT */
467 static struct xt_target clusterip_tgt __read_mostly = {
471 .checkentry = checkentry,
473 .targetsize = sizeof(struct ipt_clusterip_tgt_info),
475 .compatsize = sizeof(struct compat_ipt_clusterip_tgt_info),
476 #endif /* CONFIG_COMPAT */
481 /***********************************************************************
483 ***********************************************************************/
485 /* hardcoded for 48bit ethernet and 32bit ipv4 addresses */
487 u_int8_t src_hw[ETH_ALEN];
489 u_int8_t dst_hw[ETH_ALEN];
491 } __attribute__ ((packed));
493 #ifdef CLUSTERIP_DEBUG
494 static void arp_print(struct arp_payload *payload)
496 #define HBUFFERLEN 30
497 char hbuffer[HBUFFERLEN];
499 const char hexbuf[]= "0123456789abcdef";
501 for (k=0, j=0; k < HBUFFERLEN-3 && j < ETH_ALEN; j++) {
502 hbuffer[k++]=hexbuf[(payload->src_hw[j]>>4)&15];
503 hbuffer[k++]=hexbuf[payload->src_hw[j]&15];
508 printk("src %u.%u.%u.%u@%s, dst %u.%u.%u.%u\n",
509 NIPQUAD(payload->src_ip), hbuffer,
510 NIPQUAD(payload->dst_ip));
515 arp_mangle(unsigned int hook,
516 struct sk_buff **pskb,
517 const struct net_device *in,
518 const struct net_device *out,
519 int (*okfn)(struct sk_buff *))
521 struct arphdr *arp = arp_hdr(*pskb);
522 struct arp_payload *payload;
523 struct clusterip_config *c;
525 /* we don't care about non-ethernet and non-ipv4 ARP */
526 if (arp->ar_hrd != htons(ARPHRD_ETHER)
527 || arp->ar_pro != htons(ETH_P_IP)
528 || arp->ar_pln != 4 || arp->ar_hln != ETH_ALEN)
531 /* we only want to mangle arp requests and replies */
532 if (arp->ar_op != htons(ARPOP_REPLY)
533 && arp->ar_op != htons(ARPOP_REQUEST))
536 payload = (void *)(arp+1);
538 /* if there is no clusterip configuration for the arp reply's
539 * source ip, we don't want to mangle it */
540 c = clusterip_config_find_get(payload->src_ip, 0);
544 /* normally the linux kernel always replies to arp queries of
545 * addresses on different interfacs. However, in the CLUSTERIP case
546 * this wouldn't work, since we didn't subscribe the mcast group on
547 * other interfaces */
549 DEBUGP("CLUSTERIP: not mangling arp reply on different "
550 "interface: cip'%s'-skb'%s'\n", c->dev->name, out->name);
551 clusterip_config_put(c);
555 /* mangle reply hardware address */
556 memcpy(payload->src_hw, c->clustermac, arp->ar_hln);
558 #ifdef CLUSTERIP_DEBUG
559 DEBUGP(KERN_DEBUG "CLUSTERIP mangled arp reply: ");
563 clusterip_config_put(c);
568 static struct nf_hook_ops cip_arp_ops = {
571 .hooknum = NF_ARP_OUT,
575 /***********************************************************************
577 ***********************************************************************/
579 #ifdef CONFIG_PROC_FS
581 struct clusterip_seq_position {
582 unsigned int pos; /* position */
583 unsigned int weight; /* number of bits set == size */
584 unsigned int bit; /* current bit */
585 unsigned long val; /* current value */
588 static void *clusterip_seq_start(struct seq_file *s, loff_t *pos)
590 struct proc_dir_entry *pde = s->private;
591 struct clusterip_config *c = pde->data;
593 u_int32_t local_nodes;
594 struct clusterip_seq_position *idx;
596 /* FIXME: possible race */
597 local_nodes = c->local_nodes;
598 weight = hweight32(local_nodes);
602 idx = kmalloc(sizeof(struct clusterip_seq_position), GFP_KERNEL);
604 return ERR_PTR(-ENOMEM);
607 idx->weight = weight;
608 idx->bit = ffs(local_nodes);
609 idx->val = local_nodes;
610 clear_bit(idx->bit - 1, &idx->val);
615 static void *clusterip_seq_next(struct seq_file *s, void *v, loff_t *pos)
617 struct clusterip_seq_position *idx = (struct clusterip_seq_position *)v;
620 if (*pos >= idx->weight) {
624 idx->bit = ffs(idx->val);
625 clear_bit(idx->bit - 1, &idx->val);
629 static void clusterip_seq_stop(struct seq_file *s, void *v)
634 static int clusterip_seq_show(struct seq_file *s, void *v)
636 struct clusterip_seq_position *idx = (struct clusterip_seq_position *)v;
641 seq_printf(s, "%u", idx->bit);
643 if (idx->pos == idx->weight - 1)
649 static struct seq_operations clusterip_seq_ops = {
650 .start = clusterip_seq_start,
651 .next = clusterip_seq_next,
652 .stop = clusterip_seq_stop,
653 .show = clusterip_seq_show,
656 static int clusterip_proc_open(struct inode *inode, struct file *file)
658 int ret = seq_open(file, &clusterip_seq_ops);
661 struct seq_file *sf = file->private_data;
662 struct proc_dir_entry *pde = PDE(inode);
663 struct clusterip_config *c = pde->data;
667 clusterip_config_get(c);
673 static int clusterip_proc_release(struct inode *inode, struct file *file)
675 struct proc_dir_entry *pde = PDE(inode);
676 struct clusterip_config *c = pde->data;
679 ret = seq_release(inode, file);
682 clusterip_config_put(c);
687 static ssize_t clusterip_proc_write(struct file *file, const char __user *input,
688 size_t size, loff_t *ofs)
690 #define PROC_WRITELEN 10
691 char buffer[PROC_WRITELEN+1];
692 struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
693 struct clusterip_config *c = pde->data;
694 unsigned long nodenum;
696 if (copy_from_user(buffer, input, PROC_WRITELEN))
699 if (*buffer == '+') {
700 nodenum = simple_strtoul(buffer+1, NULL, 10);
701 if (clusterip_add_node(c, nodenum))
703 } else if (*buffer == '-') {
704 nodenum = simple_strtoul(buffer+1, NULL,10);
705 if (clusterip_del_node(c, nodenum))
713 static const struct file_operations clusterip_proc_fops = {
714 .owner = THIS_MODULE,
715 .open = clusterip_proc_open,
717 .write = clusterip_proc_write,
719 .release = clusterip_proc_release,
722 #endif /* CONFIG_PROC_FS */
724 static int __init ipt_clusterip_init(void)
728 ret = xt_register_target(&clusterip_tgt);
732 ret = nf_register_hook(&cip_arp_ops);
736 #ifdef CONFIG_PROC_FS
737 clusterip_procdir = proc_mkdir("ipt_CLUSTERIP", proc_net);
738 if (!clusterip_procdir) {
739 printk(KERN_ERR "CLUSTERIP: Unable to proc dir entry\n");
743 #endif /* CONFIG_PROC_FS */
745 printk(KERN_NOTICE "ClusterIP Version %s loaded successfully\n",
749 #ifdef CONFIG_PROC_FS
751 nf_unregister_hook(&cip_arp_ops);
752 #endif /* CONFIG_PROC_FS */
754 xt_unregister_target(&clusterip_tgt);
758 static void __exit ipt_clusterip_fini(void)
760 printk(KERN_NOTICE "ClusterIP Version %s unloading\n",
762 #ifdef CONFIG_PROC_FS
763 remove_proc_entry(clusterip_procdir->name, clusterip_procdir->parent);
765 nf_unregister_hook(&cip_arp_ops);
766 xt_unregister_target(&clusterip_tgt);
769 module_init(ipt_clusterip_init);
770 module_exit(ipt_clusterip_fini);