2 * IPVS: Source Hashing scheduling module
4 * Authors: Wensong Zhang <wensong@gnuchina.org>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
16 * The sh algorithm is to select server by the hash key of source IP
17 * address. The pseudo code is as follows:
19 * n <- servernode[src_ip];
21 * (n is overloaded) or (n.weight <= 0) then
26 * Notes that servernode is a 256-bucket hash table that maps the hash
27 * index derived from packet source IP address to the current server
28 * array. If the sh scheduler is used in cache cluster, it is good to
29 * combine it with cache_bypass feature. When the statically assigned
30 * server is dead or overloaded, the load balancer can bypass the cache
31 * server and send requests to the original server directly.
36 #include <linux/module.h>
37 #include <linux/kernel.h>
38 #include <linux/skbuff.h>
40 #include <net/ip_vs.h>
46 struct ip_vs_sh_bucket {
47 struct ip_vs_dest *dest; /* real server (cache) */
51 * for IPVS SH entry hash table
53 #ifndef CONFIG_IP_VS_SH_TAB_BITS
54 #define CONFIG_IP_VS_SH_TAB_BITS 8
56 #define IP_VS_SH_TAB_BITS CONFIG_IP_VS_SH_TAB_BITS
57 #define IP_VS_SH_TAB_SIZE (1 << IP_VS_SH_TAB_BITS)
58 #define IP_VS_SH_TAB_MASK (IP_VS_SH_TAB_SIZE - 1)
62 * Returns hash value for IPVS SH entry
64 static inline unsigned ip_vs_sh_hashkey(__be32 addr)
66 return (ntohl(addr)*2654435761UL) & IP_VS_SH_TAB_MASK;
71 * Get ip_vs_dest associated with supplied parameters.
73 static inline struct ip_vs_dest *
74 ip_vs_sh_get(struct ip_vs_sh_bucket *tbl, __be32 addr)
76 return (tbl[ip_vs_sh_hashkey(addr)]).dest;
81 * Assign all the hash buckets of the specified table with the service.
84 ip_vs_sh_assign(struct ip_vs_sh_bucket *tbl, struct ip_vs_service *svc)
87 struct ip_vs_sh_bucket *b;
89 struct ip_vs_dest *dest;
92 p = &svc->destinations;
93 for (i=0; i<IP_VS_SH_TAB_SIZE; i++) {
97 if (p == &svc->destinations)
100 dest = list_entry(p, struct ip_vs_dest, n_list);
101 atomic_inc(&dest->refcnt);
113 * Flush all the hash buckets of the specified table.
115 static void ip_vs_sh_flush(struct ip_vs_sh_bucket *tbl)
118 struct ip_vs_sh_bucket *b;
121 for (i=0; i<IP_VS_SH_TAB_SIZE; i++) {
123 atomic_dec(&b->dest->refcnt);
131 static int ip_vs_sh_init_svc(struct ip_vs_service *svc)
133 struct ip_vs_sh_bucket *tbl;
135 /* allocate the SH table for this service */
136 tbl = kmalloc(sizeof(struct ip_vs_sh_bucket)*IP_VS_SH_TAB_SIZE,
139 IP_VS_ERR("ip_vs_sh_init_svc(): no memory\n");
142 svc->sched_data = tbl;
143 IP_VS_DBG(6, "SH hash table (memory=%Zdbytes) allocated for "
145 sizeof(struct ip_vs_sh_bucket)*IP_VS_SH_TAB_SIZE);
147 /* assign the hash buckets with the updated service */
148 ip_vs_sh_assign(tbl, svc);
154 static int ip_vs_sh_done_svc(struct ip_vs_service *svc)
156 struct ip_vs_sh_bucket *tbl = svc->sched_data;
158 /* got to clean up hash buckets here */
161 /* release the table itself */
162 kfree(svc->sched_data);
163 IP_VS_DBG(6, "SH hash table (memory=%Zdbytes) released\n",
164 sizeof(struct ip_vs_sh_bucket)*IP_VS_SH_TAB_SIZE);
170 static int ip_vs_sh_update_svc(struct ip_vs_service *svc)
172 struct ip_vs_sh_bucket *tbl = svc->sched_data;
174 /* got to clean up hash buckets here */
177 /* assign the hash buckets with the updated service */
178 ip_vs_sh_assign(tbl, svc);
185 * If the dest flags is set with IP_VS_DEST_F_OVERLOAD,
186 * consider that the server is overloaded here.
188 static inline int is_overloaded(struct ip_vs_dest *dest)
190 return dest->flags & IP_VS_DEST_F_OVERLOAD;
195 * Source Hashing scheduling
197 static struct ip_vs_dest *
198 ip_vs_sh_schedule(struct ip_vs_service *svc, const struct sk_buff *skb)
200 struct ip_vs_dest *dest;
201 struct ip_vs_sh_bucket *tbl;
202 struct iphdr *iph = ip_hdr(skb);
204 IP_VS_DBG(6, "ip_vs_sh_schedule(): Scheduling...\n");
206 tbl = (struct ip_vs_sh_bucket *)svc->sched_data;
207 dest = ip_vs_sh_get(tbl, iph->saddr);
209 || !(dest->flags & IP_VS_DEST_F_AVAILABLE)
210 || atomic_read(&dest->weight) <= 0
211 || is_overloaded(dest)) {
215 IP_VS_DBG(6, "SH: source IP address %u.%u.%u.%u "
216 "--> server %u.%u.%u.%u:%d\n",
226 * IPVS SH Scheduler structure
228 static struct ip_vs_scheduler ip_vs_sh_scheduler =
231 .refcnt = ATOMIC_INIT(0),
232 .module = THIS_MODULE,
233 .init_service = ip_vs_sh_init_svc,
234 .done_service = ip_vs_sh_done_svc,
235 .update_service = ip_vs_sh_update_svc,
236 .schedule = ip_vs_sh_schedule,
240 static int __init ip_vs_sh_init(void)
242 INIT_LIST_HEAD(&ip_vs_sh_scheduler.n_list);
243 return register_ip_vs_scheduler(&ip_vs_sh_scheduler);
247 static void __exit ip_vs_sh_cleanup(void)
249 unregister_ip_vs_scheduler(&ip_vs_sh_scheduler);
253 module_init(ip_vs_sh_init);
254 module_exit(ip_vs_sh_cleanup);
255 MODULE_LICENSE("GPL");