f1c41eede9938ba964b5661ee0669c701d10a9a5
[linux-2.6.git] / include / net / ip_vs.h
1 /*
2  *      IP Virtual Server
3  *      data structure and functionality definitions
4  */
5
6 #ifndef _IP_VS_H
7 #define _IP_VS_H
8
9 #include <asm/types.h>          /* For __uXX types */
10 #include <linux/types.h>        /* For __beXX types in userland */
11
12 #define IP_VS_VERSION_CODE      0x010201
13 #define NVERSION(version)                       \
14         (version >> 16) & 0xFF,                 \
15         (version >> 8) & 0xFF,                  \
16         version & 0xFF
17
18 /*
19  *      Virtual Service Flags
20  */
21 #define IP_VS_SVC_F_PERSISTENT  0x0001          /* persistent port */
22 #define IP_VS_SVC_F_HASHED      0x0002          /* hashed entry */
23
24 /*
25  *      Destination Server Flags
26  */
27 #define IP_VS_DEST_F_AVAILABLE  0x0001          /* server is available */
28 #define IP_VS_DEST_F_OVERLOAD   0x0002          /* server is overloaded */
29
30 /*
31  *      IPVS sync daemon states
32  */
33 #define IP_VS_STATE_NONE        0x0000          /* daemon is stopped */
34 #define IP_VS_STATE_MASTER      0x0001          /* started as master */
35 #define IP_VS_STATE_BACKUP      0x0002          /* started as backup */
36
37 /*
38  *      IPVS socket options
39  */
40 #define IP_VS_BASE_CTL          (64+1024+64)            /* base */
41
42 #define IP_VS_SO_SET_NONE       IP_VS_BASE_CTL          /* just peek */
43 #define IP_VS_SO_SET_INSERT     (IP_VS_BASE_CTL+1)
44 #define IP_VS_SO_SET_ADD        (IP_VS_BASE_CTL+2)
45 #define IP_VS_SO_SET_EDIT       (IP_VS_BASE_CTL+3)
46 #define IP_VS_SO_SET_DEL        (IP_VS_BASE_CTL+4)
47 #define IP_VS_SO_SET_FLUSH      (IP_VS_BASE_CTL+5)
48 #define IP_VS_SO_SET_LIST       (IP_VS_BASE_CTL+6)
49 #define IP_VS_SO_SET_ADDDEST    (IP_VS_BASE_CTL+7)
50 #define IP_VS_SO_SET_DELDEST    (IP_VS_BASE_CTL+8)
51 #define IP_VS_SO_SET_EDITDEST   (IP_VS_BASE_CTL+9)
52 #define IP_VS_SO_SET_TIMEOUT    (IP_VS_BASE_CTL+10)
53 #define IP_VS_SO_SET_STARTDAEMON (IP_VS_BASE_CTL+11)
54 #define IP_VS_SO_SET_STOPDAEMON (IP_VS_BASE_CTL+12)
55 #define IP_VS_SO_SET_RESTORE    (IP_VS_BASE_CTL+13)
56 #define IP_VS_SO_SET_SAVE       (IP_VS_BASE_CTL+14)
57 #define IP_VS_SO_SET_ZERO       (IP_VS_BASE_CTL+15)
58 #define IP_VS_SO_SET_MAX        IP_VS_SO_SET_ZERO
59
60 #define IP_VS_SO_GET_VERSION    IP_VS_BASE_CTL
61 #define IP_VS_SO_GET_INFO       (IP_VS_BASE_CTL+1)
62 #define IP_VS_SO_GET_SERVICES   (IP_VS_BASE_CTL+2)
63 #define IP_VS_SO_GET_SERVICE    (IP_VS_BASE_CTL+3)
64 #define IP_VS_SO_GET_DESTS      (IP_VS_BASE_CTL+4)
65 #define IP_VS_SO_GET_DEST       (IP_VS_BASE_CTL+5)      /* not used now */
66 #define IP_VS_SO_GET_TIMEOUT    (IP_VS_BASE_CTL+6)
67 #define IP_VS_SO_GET_DAEMON     (IP_VS_BASE_CTL+7)
68 #define IP_VS_SO_GET_MAX        IP_VS_SO_GET_DAEMON
69
70
71 /*
72  *      IPVS Connection Flags
73  */
74 #define IP_VS_CONN_F_FWD_MASK   0x0007          /* mask for the fwd methods */
75 #define IP_VS_CONN_F_MASQ       0x0000          /* masquerading/NAT */
76 #define IP_VS_CONN_F_LOCALNODE  0x0001          /* local node */
77 #define IP_VS_CONN_F_TUNNEL     0x0002          /* tunneling */
78 #define IP_VS_CONN_F_DROUTE     0x0003          /* direct routing */
79 #define IP_VS_CONN_F_BYPASS     0x0004          /* cache bypass */
80 #define IP_VS_CONN_F_SYNC       0x0020          /* entry created by sync */
81 #define IP_VS_CONN_F_HASHED     0x0040          /* hashed entry */
82 #define IP_VS_CONN_F_NOOUTPUT   0x0080          /* no output packets */
83 #define IP_VS_CONN_F_INACTIVE   0x0100          /* not established */
84 #define IP_VS_CONN_F_OUT_SEQ    0x0200          /* must do output seq adjust */
85 #define IP_VS_CONN_F_IN_SEQ     0x0400          /* must do input seq adjust */
86 #define IP_VS_CONN_F_SEQ_MASK   0x0600          /* in/out sequence mask */
87 #define IP_VS_CONN_F_NO_CPORT   0x0800          /* no client port set yet */
88 #define IP_VS_CONN_F_TEMPLATE   0x1000          /* template, not connection */
89
90 /* Move it to better place one day, for now keep it unique */
91 #define NFC_IPVS_PROPERTY       0x10000
92
93 #define IP_VS_SCHEDNAME_MAXLEN  16
94 #define IP_VS_IFNAME_MAXLEN     16
95
96
97 /*
98  *      The struct ip_vs_service_user and struct ip_vs_dest_user are
99  *      used to set IPVS rules through setsockopt.
100  */
101 struct ip_vs_service_user {
102         /* virtual service addresses */
103         u_int16_t               protocol;
104         __be32                  addr;           /* virtual ip address */
105         __be16                  port;
106         u_int32_t               fwmark;         /* firwall mark of service */
107
108         /* virtual service options */
109         char                    sched_name[IP_VS_SCHEDNAME_MAXLEN];
110         unsigned                flags;          /* virtual service flags */
111         unsigned                timeout;        /* persistent timeout in sec */
112         __be32                  netmask;        /* persistent netmask */
113 };
114
115
116 struct ip_vs_dest_user {
117         /* destination server address */
118         __be32                  addr;
119         __be16                  port;
120
121         /* real server options */
122         unsigned                conn_flags;     /* connection flags */
123         int                     weight;         /* destination weight */
124
125         /* thresholds for active connections */
126         u_int32_t               u_threshold;    /* upper threshold */
127         u_int32_t               l_threshold;    /* lower threshold */
128 };
129
130
131 /*
132  *      IPVS statistics object (for user space)
133  */
134 struct ip_vs_stats_user
135 {
136         __u32                   conns;          /* connections scheduled */
137         __u32                   inpkts;         /* incoming packets */
138         __u32                   outpkts;        /* outgoing packets */
139         __u64                   inbytes;        /* incoming bytes */
140         __u64                   outbytes;       /* outgoing bytes */
141
142         __u32                   cps;            /* current connection rate */
143         __u32                   inpps;          /* current in packet rate */
144         __u32                   outpps;         /* current out packet rate */
145         __u32                   inbps;          /* current in byte rate */
146         __u32                   outbps;         /* current out byte rate */
147 };
148
149
150 /* The argument to IP_VS_SO_GET_INFO */
151 struct ip_vs_getinfo {
152         /* version number */
153         unsigned int            version;
154
155         /* size of connection hash table */
156         unsigned int            size;
157
158         /* number of virtual services */
159         unsigned int            num_services;
160 };
161
162
163 /* The argument to IP_VS_SO_GET_SERVICE */
164 struct ip_vs_service_entry {
165         /* which service: user fills in these */
166         u_int16_t               protocol;
167         __be32                  addr;           /* virtual address */
168         __be16                  port;
169         u_int32_t               fwmark;         /* firwall mark of service */
170
171         /* service options */
172         char                    sched_name[IP_VS_SCHEDNAME_MAXLEN];
173         unsigned                flags;          /* virtual service flags */
174         unsigned                timeout;        /* persistent timeout */
175         __be32                  netmask;        /* persistent netmask */
176
177         /* number of real servers */
178         unsigned int            num_dests;
179
180         /* statistics */
181         struct ip_vs_stats_user stats;
182 };
183
184
185 struct ip_vs_dest_entry {
186         __be32                  addr;           /* destination address */
187         __be16                  port;
188         unsigned                conn_flags;     /* connection flags */
189         int                     weight;         /* destination weight */
190
191         u_int32_t               u_threshold;    /* upper threshold */
192         u_int32_t               l_threshold;    /* lower threshold */
193
194         u_int32_t               activeconns;    /* active connections */
195         u_int32_t               inactconns;     /* inactive connections */
196         u_int32_t               persistconns;   /* persistent connections */
197
198         /* statistics */
199         struct ip_vs_stats_user stats;
200 };
201
202
203 /* The argument to IP_VS_SO_GET_DESTS */
204 struct ip_vs_get_dests {
205         /* which service: user fills in these */
206         u_int16_t               protocol;
207         __be32                  addr;           /* virtual address */
208         __be16                  port;
209         u_int32_t               fwmark;         /* firwall mark of service */
210
211         /* number of real servers */
212         unsigned int            num_dests;
213
214         /* the real servers */
215         struct ip_vs_dest_entry entrytable[0];
216 };
217
218
219 /* The argument to IP_VS_SO_GET_SERVICES */
220 struct ip_vs_get_services {
221         /* number of virtual services */
222         unsigned int            num_services;
223
224         /* service table */
225         struct ip_vs_service_entry entrytable[0];
226 };
227
228
229 /* The argument to IP_VS_SO_GET_TIMEOUT */
230 struct ip_vs_timeout_user {
231         int                     tcp_timeout;
232         int                     tcp_fin_timeout;
233         int                     udp_timeout;
234 };
235
236
237 /* The argument to IP_VS_SO_GET_DAEMON */
238 struct ip_vs_daemon_user {
239         /* sync daemon state (master/backup) */
240         int                     state;
241
242         /* multicast interface name */
243         char                    mcast_ifn[IP_VS_IFNAME_MAXLEN];
244
245         /* SyncID we belong to */
246         int                     syncid;
247 };
248
249
250 #ifdef __KERNEL__
251
252 #include <linux/list.h>                 /* for struct list_head */
253 #include <linux/spinlock.h>             /* for struct rwlock_t */
254 #include <asm/atomic.h>                 /* for struct atomic_t */
255 #include <linux/compiler.h>
256 #include <linux/timer.h>
257
258 #include <net/checksum.h>
259
260 #ifdef CONFIG_IP_VS_DEBUG
261 #include <linux/net.h>
262
263 extern int ip_vs_get_debug_level(void);
264 #define IP_VS_DBG(level, msg...)                        \
265     do {                                                \
266             if (level <= ip_vs_get_debug_level())       \
267                     printk(KERN_DEBUG "IPVS: " msg);    \
268     } while (0)
269 #define IP_VS_DBG_RL(msg...)                            \
270     do {                                                \
271             if (net_ratelimit())                        \
272                     printk(KERN_DEBUG "IPVS: " msg);    \
273     } while (0)
274 #define IP_VS_DBG_PKT(level, pp, skb, ofs, msg)         \
275     do {                                                \
276             if (level <= ip_vs_get_debug_level())       \
277                 pp->debug_packet(pp, skb, ofs, msg);    \
278     } while (0)
279 #define IP_VS_DBG_RL_PKT(level, pp, skb, ofs, msg)      \
280     do {                                                \
281             if (level <= ip_vs_get_debug_level() &&     \
282                 net_ratelimit())                        \
283                 pp->debug_packet(pp, skb, ofs, msg);    \
284     } while (0)
285 #else   /* NO DEBUGGING at ALL */
286 #define IP_VS_DBG(level, msg...)  do {} while (0)
287 #define IP_VS_DBG_RL(msg...)  do {} while (0)
288 #define IP_VS_DBG_PKT(level, pp, skb, ofs, msg)         do {} while (0)
289 #define IP_VS_DBG_RL_PKT(level, pp, skb, ofs, msg)      do {} while (0)
290 #endif
291
292 #define IP_VS_BUG() BUG()
293 #define IP_VS_ERR(msg...) printk(KERN_ERR "IPVS: " msg)
294 #define IP_VS_INFO(msg...) printk(KERN_INFO "IPVS: " msg)
295 #define IP_VS_WARNING(msg...) \
296         printk(KERN_WARNING "IPVS: " msg)
297 #define IP_VS_ERR_RL(msg...)                            \
298     do {                                                \
299             if (net_ratelimit())                        \
300                     printk(KERN_ERR "IPVS: " msg);      \
301     } while (0)
302
303 #ifdef CONFIG_IP_VS_DEBUG
304 #define EnterFunction(level)                                            \
305     do {                                                                \
306             if (level <= ip_vs_get_debug_level())                       \
307                     printk(KERN_DEBUG "Enter: %s, %s line %i\n",        \
308                            __FUNCTION__, __FILE__, __LINE__);           \
309     } while (0)
310 #define LeaveFunction(level)                                            \
311     do {                                                                \
312             if (level <= ip_vs_get_debug_level())                       \
313                         printk(KERN_DEBUG "Leave: %s, %s line %i\n",    \
314                                __FUNCTION__, __FILE__, __LINE__);       \
315     } while (0)
316 #else
317 #define EnterFunction(level)   do {} while (0)
318 #define LeaveFunction(level)   do {} while (0)
319 #endif
320
321 #define IP_VS_WAIT_WHILE(expr)  while (expr) { cpu_relax(); }
322
323
324 /*
325  *      The port number of FTP service (in network order).
326  */
327 #define FTPPORT  __constant_htons(21)
328 #define FTPDATA  __constant_htons(20)
329
330 /*
331  *      IPVS sysctl variables under the /proc/sys/net/ipv4/vs/
332  */
333 #define NET_IPV4_VS              21
334
335 enum {
336         NET_IPV4_VS_DEBUG_LEVEL=1,
337         NET_IPV4_VS_AMEMTHRESH=2,
338         NET_IPV4_VS_AMDROPRATE=3,
339         NET_IPV4_VS_TO_ES=7,
340         NET_IPV4_VS_TO_SS=8,
341         NET_IPV4_VS_TO_SR=9,
342         NET_IPV4_VS_TO_FW=10,
343         NET_IPV4_VS_TO_TW=11,
344         NET_IPV4_VS_TO_CL=12,
345         NET_IPV4_VS_TO_CW=13,
346         NET_IPV4_VS_TO_LA=14,
347         NET_IPV4_VS_TO_LI=15,
348         NET_IPV4_VS_TO_SA=16,
349         NET_IPV4_VS_TO_UDP=17,
350         NET_IPV4_VS_TO_ICMP=18,
351         NET_IPV4_VS_CACHE_BYPASS=22,
352         NET_IPV4_VS_EXPIRE_NODEST_CONN=23,
353         NET_IPV4_VS_NAT_ICMP_SEND=25,
354         NET_IPV4_VS_EXPIRE_QUIESCENT_TEMPLATE=26,
355         NET_IPV4_VS_LAST
356 };
357
358 /*
359  *      TCP State Values
360  */
361 enum {
362         IP_VS_TCP_S_NONE = 0,
363         IP_VS_TCP_S_ESTABLISHED,
364         IP_VS_TCP_S_SYN_SENT,
365         IP_VS_TCP_S_SYN_RECV,
366         IP_VS_TCP_S_FIN_WAIT,
367         IP_VS_TCP_S_TIME_WAIT,
368         IP_VS_TCP_S_CLOSE,
369         IP_VS_TCP_S_CLOSE_WAIT,
370         IP_VS_TCP_S_LAST_ACK,
371         IP_VS_TCP_S_LISTEN,
372         IP_VS_TCP_S_SYNACK,
373         IP_VS_TCP_S_LAST
374 };
375
376 /*
377  *      UDP State Values
378  */
379 enum {
380         IP_VS_UDP_S_NORMAL,
381         IP_VS_UDP_S_LAST,
382 };
383
384 /*
385  *      ICMP State Values
386  */
387 enum {
388         IP_VS_ICMP_S_NORMAL,
389         IP_VS_ICMP_S_LAST,
390 };
391
392 /*
393  *      Delta sequence info structure
394  *      Each ip_vs_conn has 2 (output AND input seq. changes).
395  *      Only used in the VS/NAT.
396  */
397 struct ip_vs_seq {
398         __u32                   init_seq;       /* Add delta from this seq */
399         __u32                   delta;          /* Delta in sequence numbers */
400         __u32                   previous_delta; /* Delta in sequence numbers
401                                                    before last resized pkt */
402 };
403
404
405 /*
406  *      IPVS statistics object
407  */
408 struct ip_vs_stats
409 {
410         __u32                   conns;          /* connections scheduled */
411         __u32                   inpkts;         /* incoming packets */
412         __u32                   outpkts;        /* outgoing packets */
413         __u64                   inbytes;        /* incoming bytes */
414         __u64                   outbytes;       /* outgoing bytes */
415
416         __u32                   cps;            /* current connection rate */
417         __u32                   inpps;          /* current in packet rate */
418         __u32                   outpps;         /* current out packet rate */
419         __u32                   inbps;          /* current in byte rate */
420         __u32                   outbps;         /* current out byte rate */
421
422         spinlock_t              lock;           /* spin lock */
423 };
424
425 struct dst_entry;
426 struct iphdr;
427 struct ip_vs_conn;
428 struct ip_vs_app;
429 struct sk_buff;
430
431 struct ip_vs_protocol {
432         struct ip_vs_protocol   *next;
433         char                    *name;
434         __u16                   protocol;
435         int                     dont_defrag;
436         atomic_t                appcnt;         /* counter of proto app incs */
437         int                     *timeout_table; /* protocol timeout table */
438
439         void (*init)(struct ip_vs_protocol *pp);
440
441         void (*exit)(struct ip_vs_protocol *pp);
442
443         int (*conn_schedule)(struct sk_buff *skb,
444                              struct ip_vs_protocol *pp,
445                              int *verdict, struct ip_vs_conn **cpp);
446
447         struct ip_vs_conn *
448         (*conn_in_get)(const struct sk_buff *skb,
449                        struct ip_vs_protocol *pp,
450                        const struct iphdr *iph,
451                        unsigned int proto_off,
452                        int inverse);
453
454         struct ip_vs_conn *
455         (*conn_out_get)(const struct sk_buff *skb,
456                         struct ip_vs_protocol *pp,
457                         const struct iphdr *iph,
458                         unsigned int proto_off,
459                         int inverse);
460
461         int (*snat_handler)(struct sk_buff *skb,
462                             struct ip_vs_protocol *pp, struct ip_vs_conn *cp);
463
464         int (*dnat_handler)(struct sk_buff *skb,
465                             struct ip_vs_protocol *pp, struct ip_vs_conn *cp);
466
467         int (*csum_check)(struct sk_buff *skb, struct ip_vs_protocol *pp);
468
469         const char *(*state_name)(int state);
470
471         int (*state_transition)(struct ip_vs_conn *cp, int direction,
472                                 const struct sk_buff *skb,
473                                 struct ip_vs_protocol *pp);
474
475         int (*register_app)(struct ip_vs_app *inc);
476
477         void (*unregister_app)(struct ip_vs_app *inc);
478
479         int (*app_conn_bind)(struct ip_vs_conn *cp);
480
481         void (*debug_packet)(struct ip_vs_protocol *pp,
482                              const struct sk_buff *skb,
483                              int offset,
484                              const char *msg);
485
486         void (*timeout_change)(struct ip_vs_protocol *pp, int flags);
487
488         int (*set_state_timeout)(struct ip_vs_protocol *pp, char *sname, int to);
489 };
490
491 extern struct ip_vs_protocol * ip_vs_proto_get(unsigned short proto);
492
493 /*
494  *      IP_VS structure allocated for each dynamically scheduled connection
495  */
496 struct ip_vs_conn {
497         struct list_head        c_list;         /* hashed list heads */
498
499         /* Protocol, addresses and port numbers */
500         __be32                   caddr;          /* client address */
501         __be32                   vaddr;          /* virtual address */
502         __be32                   daddr;          /* destination address */
503         __be16                   cport;
504         __be16                   vport;
505         __be16                   dport;
506         __u16                   protocol;       /* Which protocol (TCP/UDP) */
507
508         /* counter and timer */
509         atomic_t                refcnt;         /* reference count */
510         struct timer_list       timer;          /* Expiration timer */
511         volatile unsigned long  timeout;        /* timeout */
512
513         /* Flags and state transition */
514         spinlock_t              lock;           /* lock for state transition */
515         volatile __u16          flags;          /* status flags */
516         volatile __u16          state;          /* state info */
517         volatile __u16          old_state;      /* old state, to be used for
518                                                  * state transition triggerd
519                                                  * synchronization
520                                                  */
521
522         /* Control members */
523         struct ip_vs_conn       *control;       /* Master control connection */
524         atomic_t                n_control;      /* Number of controlled ones */
525         struct ip_vs_dest       *dest;          /* real server */
526         atomic_t                in_pkts;        /* incoming packet counter */
527
528         /* packet transmitter for different forwarding methods.  If it
529            mangles the packet, it must return NF_DROP or better NF_STOLEN,
530            otherwise this must be changed to a sk_buff **.
531          */
532         int (*packet_xmit)(struct sk_buff *skb, struct ip_vs_conn *cp,
533                            struct ip_vs_protocol *pp);
534
535         /* Note: we can group the following members into a structure,
536            in order to save more space, and the following members are
537            only used in VS/NAT anyway */
538         struct ip_vs_app        *app;           /* bound ip_vs_app object */
539         void                    *app_data;      /* Application private data */
540         struct ip_vs_seq        in_seq;         /* incoming seq. struct */
541         struct ip_vs_seq        out_seq;        /* outgoing seq. struct */
542 };
543
544
545 /*
546  *      The information about the virtual service offered to the net
547  *      and the forwarding entries
548  */
549 struct ip_vs_service {
550         struct list_head        s_list;   /* for normal service table */
551         struct list_head        f_list;   /* for fwmark-based service table */
552         atomic_t                refcnt;   /* reference counter */
553         atomic_t                usecnt;   /* use counter */
554
555         __u16                   protocol; /* which protocol (TCP/UDP) */
556         __be32                  addr;     /* IP address for virtual service */
557         __be16                  port;     /* port number for the service */
558         __u32                   fwmark;   /* firewall mark of the service */
559         unsigned                flags;    /* service status flags */
560         unsigned                timeout;  /* persistent timeout in ticks */
561         __be32                  netmask;  /* grouping granularity */
562
563         struct list_head        destinations;  /* real server d-linked list */
564         __u32                   num_dests;     /* number of servers */
565         struct ip_vs_stats      stats;         /* statistics for the service */
566         struct ip_vs_app        *inc;     /* bind conns to this app inc */
567
568         /* for scheduling */
569         struct ip_vs_scheduler  *scheduler;    /* bound scheduler object */
570         rwlock_t                sched_lock;    /* lock sched_data */
571         void                    *sched_data;   /* scheduler application data */
572 };
573
574
575 /*
576  *      The real server destination forwarding entry
577  *      with ip address, port number, and so on.
578  */
579 struct ip_vs_dest {
580         struct list_head        n_list;   /* for the dests in the service */
581         struct list_head        d_list;   /* for table with all the dests */
582
583         __be32                  addr;           /* IP address of the server */
584         __be16                  port;           /* port number of the server */
585         volatile unsigned       flags;          /* dest status flags */
586         atomic_t                conn_flags;     /* flags to copy to conn */
587         atomic_t                weight;         /* server weight */
588
589         atomic_t                refcnt;         /* reference counter */
590         struct ip_vs_stats      stats;          /* statistics */
591
592         /* connection counters and thresholds */
593         atomic_t                activeconns;    /* active connections */
594         atomic_t                inactconns;     /* inactive connections */
595         atomic_t                persistconns;   /* persistent connections */
596         __u32                   u_threshold;    /* upper threshold */
597         __u32                   l_threshold;    /* lower threshold */
598
599         /* for destination cache */
600         spinlock_t              dst_lock;       /* lock of dst_cache */
601         struct dst_entry        *dst_cache;     /* destination cache entry */
602         u32                     dst_rtos;       /* RT_TOS(tos) for dst */
603
604         /* for virtual service */
605         struct ip_vs_service    *svc;           /* service it belongs to */
606         __u16                   protocol;       /* which protocol (TCP/UDP) */
607         __be32                  vaddr;          /* virtual IP address */
608         __be16                  vport;          /* virtual port number */
609         __u32                   vfwmark;        /* firewall mark of service */
610 };
611
612
613 /*
614  *      The scheduler object
615  */
616 struct ip_vs_scheduler {
617         struct list_head        n_list;         /* d-linked list head */
618         char                    *name;          /* scheduler name */
619         atomic_t                refcnt;         /* reference counter */
620         struct module           *module;        /* THIS_MODULE/NULL */
621
622         /* scheduler initializing service */
623         int (*init_service)(struct ip_vs_service *svc);
624         /* scheduling service finish */
625         int (*done_service)(struct ip_vs_service *svc);
626         /* scheduler updating service */
627         int (*update_service)(struct ip_vs_service *svc);
628
629         /* selecting a server from the given service */
630         struct ip_vs_dest* (*schedule)(struct ip_vs_service *svc,
631                                        const struct sk_buff *skb);
632 };
633
634
635 /*
636  *      The application module object (a.k.a. app incarnation)
637  */
638 struct ip_vs_app
639 {
640         struct list_head        a_list;         /* member in app list */
641         int                     type;           /* IP_VS_APP_TYPE_xxx */
642         char                    *name;          /* application module name */
643         __u16                   protocol;
644         struct module           *module;        /* THIS_MODULE/NULL */
645         struct list_head        incs_list;      /* list of incarnations */
646
647         /* members for application incarnations */
648         struct list_head        p_list;         /* member in proto app list */
649         struct ip_vs_app        *app;           /* its real application */
650         __be16                  port;           /* port number in net order */
651         atomic_t                usecnt;         /* usage counter */
652
653         /* output hook: return false if can't linearize. diff set for TCP.  */
654         int (*pkt_out)(struct ip_vs_app *, struct ip_vs_conn *,
655                        struct sk_buff *, int *diff);
656
657         /* input hook: return false if can't linearize. diff set for TCP. */
658         int (*pkt_in)(struct ip_vs_app *, struct ip_vs_conn *,
659                       struct sk_buff *, int *diff);
660
661         /* ip_vs_app initializer */
662         int (*init_conn)(struct ip_vs_app *, struct ip_vs_conn *);
663
664         /* ip_vs_app finish */
665         int (*done_conn)(struct ip_vs_app *, struct ip_vs_conn *);
666
667
668         /* not used now */
669         int (*bind_conn)(struct ip_vs_app *, struct ip_vs_conn *,
670                          struct ip_vs_protocol *);
671
672         void (*unbind_conn)(struct ip_vs_app *, struct ip_vs_conn *);
673
674         int *                   timeout_table;
675         int *                   timeouts;
676         int                     timeouts_size;
677
678         int (*conn_schedule)(struct sk_buff *skb, struct ip_vs_app *app,
679                              int *verdict, struct ip_vs_conn **cpp);
680
681         struct ip_vs_conn *
682         (*conn_in_get)(const struct sk_buff *skb, struct ip_vs_app *app,
683                        const struct iphdr *iph, unsigned int proto_off,
684                        int inverse);
685
686         struct ip_vs_conn *
687         (*conn_out_get)(const struct sk_buff *skb, struct ip_vs_app *app,
688                         const struct iphdr *iph, unsigned int proto_off,
689                         int inverse);
690
691         int (*state_transition)(struct ip_vs_conn *cp, int direction,
692                                 const struct sk_buff *skb,
693                                 struct ip_vs_app *app);
694
695         void (*timeout_change)(struct ip_vs_app *app, int flags);
696 };
697
698
699 /*
700  *      IPVS core functions
701  *      (from ip_vs_core.c)
702  */
703 extern const char *ip_vs_proto_name(unsigned proto);
704 extern void ip_vs_init_hash_table(struct list_head *table, int rows);
705 #define IP_VS_INIT_HASH_TABLE(t) ip_vs_init_hash_table(t, sizeof(t)/sizeof(t[0]))
706
707 #define IP_VS_APP_TYPE_UNSPEC   0
708 #define IP_VS_APP_TYPE_FTP      1
709
710 /*
711  *     ip_vs_conn handling functions
712  *     (from ip_vs_conn.c)
713  */
714
715 /*
716  *     IPVS connection entry hash table
717  */
718 #ifndef CONFIG_IP_VS_TAB_BITS
719 #define CONFIG_IP_VS_TAB_BITS   12
720 #endif
721 /* make sure that IP_VS_CONN_TAB_BITS is located in [8, 20] */
722 #if CONFIG_IP_VS_TAB_BITS < 8
723 #define IP_VS_CONN_TAB_BITS     8
724 #endif
725 #if CONFIG_IP_VS_TAB_BITS > 20
726 #define IP_VS_CONN_TAB_BITS     20
727 #endif
728 #if 8 <= CONFIG_IP_VS_TAB_BITS && CONFIG_IP_VS_TAB_BITS <= 20
729 #define IP_VS_CONN_TAB_BITS     CONFIG_IP_VS_TAB_BITS
730 #endif
731 #define IP_VS_CONN_TAB_SIZE     (1 << IP_VS_CONN_TAB_BITS)
732 #define IP_VS_CONN_TAB_MASK     (IP_VS_CONN_TAB_SIZE - 1)
733
734 enum {
735         IP_VS_DIR_INPUT = 0,
736         IP_VS_DIR_OUTPUT,
737         IP_VS_DIR_INPUT_ONLY,
738         IP_VS_DIR_LAST,
739 };
740
741 extern struct ip_vs_conn *ip_vs_conn_in_get
742 (int protocol, __be32 s_addr, __be16 s_port, __be32 d_addr, __be16 d_port);
743 extern struct ip_vs_conn *ip_vs_ct_in_get
744 (int protocol, __be32 s_addr, __be16 s_port, __be32 d_addr, __be16 d_port);
745 extern struct ip_vs_conn *ip_vs_conn_out_get
746 (int protocol, __be32 s_addr, __be16 s_port, __be32 d_addr, __be16 d_port);
747
748 /* put back the conn without restarting its timer */
749 static inline void __ip_vs_conn_put(struct ip_vs_conn *cp)
750 {
751         atomic_dec(&cp->refcnt);
752 }
753 extern void ip_vs_conn_put(struct ip_vs_conn *cp);
754 extern void ip_vs_conn_fill_cport(struct ip_vs_conn *cp, __be16 cport);
755
756 extern struct ip_vs_conn *
757 ip_vs_conn_new(int proto, __be32 caddr, __be16 cport, __be32 vaddr, __be16 vport,
758                __be32 daddr, __be16 dport, unsigned flags,
759                struct ip_vs_dest *dest);
760 extern void ip_vs_conn_expire_now(struct ip_vs_conn *cp);
761
762 extern const char * ip_vs_state_name(__u16 proto, int state);
763
764 extern void ip_vs_tcp_conn_listen(struct ip_vs_conn *cp);
765 extern int ip_vs_check_template(struct ip_vs_conn *ct);
766 extern void ip_vs_secure_tcp_set(int on);
767 extern void ip_vs_random_dropentry(void);
768 extern int ip_vs_conn_init(void);
769 extern void ip_vs_conn_cleanup(void);
770
771 static inline void ip_vs_control_del(struct ip_vs_conn *cp)
772 {
773         struct ip_vs_conn *ctl_cp = cp->control;
774         if (!ctl_cp) {
775                 IP_VS_ERR("request control DEL for uncontrolled: "
776                           "%d.%d.%d.%d:%d to %d.%d.%d.%d:%d\n",
777                           NIPQUAD(cp->caddr),ntohs(cp->cport),
778                           NIPQUAD(cp->vaddr),ntohs(cp->vport));
779                 return;
780         }
781
782         IP_VS_DBG(7, "DELeting control for: "
783                   "cp.dst=%d.%d.%d.%d:%d ctl_cp.dst=%d.%d.%d.%d:%d\n",
784                   NIPQUAD(cp->caddr),ntohs(cp->cport),
785                   NIPQUAD(ctl_cp->caddr),ntohs(ctl_cp->cport));
786
787         cp->control = NULL;
788         if (atomic_read(&ctl_cp->n_control) == 0) {
789                 IP_VS_ERR("BUG control DEL with n=0 : "
790                           "%d.%d.%d.%d:%d to %d.%d.%d.%d:%d\n",
791                           NIPQUAD(cp->caddr),ntohs(cp->cport),
792                           NIPQUAD(cp->vaddr),ntohs(cp->vport));
793                 return;
794         }
795         atomic_dec(&ctl_cp->n_control);
796 }
797
798 static inline void
799 ip_vs_control_add(struct ip_vs_conn *cp, struct ip_vs_conn *ctl_cp)
800 {
801         if (cp->control) {
802                 IP_VS_ERR("request control ADD for already controlled: "
803                           "%d.%d.%d.%d:%d to %d.%d.%d.%d:%d\n",
804                           NIPQUAD(cp->caddr),ntohs(cp->cport),
805                           NIPQUAD(cp->vaddr),ntohs(cp->vport));
806                 ip_vs_control_del(cp);
807         }
808
809         IP_VS_DBG(7, "ADDing control for: "
810                   "cp.dst=%d.%d.%d.%d:%d ctl_cp.dst=%d.%d.%d.%d:%d\n",
811                   NIPQUAD(cp->caddr),ntohs(cp->cport),
812                   NIPQUAD(ctl_cp->caddr),ntohs(ctl_cp->cport));
813
814         cp->control = ctl_cp;
815         atomic_inc(&ctl_cp->n_control);
816 }
817
818
819 /*
820  *      IPVS application functions
821  *      (from ip_vs_app.c)
822  */
823 #define IP_VS_APP_MAX_PORTS  8
824 extern int register_ip_vs_app(struct ip_vs_app *app);
825 extern void unregister_ip_vs_app(struct ip_vs_app *app);
826 extern int ip_vs_bind_app(struct ip_vs_conn *cp, struct ip_vs_protocol *pp);
827 extern void ip_vs_unbind_app(struct ip_vs_conn *cp);
828 extern int
829 register_ip_vs_app_inc(struct ip_vs_app *app, __u16 proto, __u16 port);
830 extern int ip_vs_app_inc_get(struct ip_vs_app *inc);
831 extern void ip_vs_app_inc_put(struct ip_vs_app *inc);
832
833 extern int ip_vs_app_pkt_out(struct ip_vs_conn *, struct sk_buff *skb);
834 extern int ip_vs_app_pkt_in(struct ip_vs_conn *, struct sk_buff *skb);
835 extern int ip_vs_skb_replace(struct sk_buff *skb, gfp_t pri,
836                              char *o_buf, int o_len, char *n_buf, int n_len);
837 extern int ip_vs_app_init(void);
838 extern void ip_vs_app_cleanup(void);
839
840
841 /*
842  *      IPVS protocol functions (from ip_vs_proto.c)
843  */
844 extern int ip_vs_protocol_init(void);
845 extern void ip_vs_protocol_cleanup(void);
846 extern void ip_vs_protocol_timeout_change(int flags);
847 extern int *ip_vs_create_timeout_table(int *table, int size);
848 extern int
849 ip_vs_set_state_timeout(int *table, int num, char **names, char *name, int to);
850 extern void
851 ip_vs_tcpudp_debug_packet(struct ip_vs_protocol *pp, const struct sk_buff *skb,
852                           int offset, const char *msg);
853
854 extern struct ip_vs_protocol ip_vs_protocol_tcp;
855 extern struct ip_vs_protocol ip_vs_protocol_udp;
856 extern struct ip_vs_protocol ip_vs_protocol_icmp;
857 extern struct ip_vs_protocol ip_vs_protocol_esp;
858 extern struct ip_vs_protocol ip_vs_protocol_ah;
859
860
861 /*
862  *      Registering/unregistering scheduler functions
863  *      (from ip_vs_sched.c)
864  */
865 extern int register_ip_vs_scheduler(struct ip_vs_scheduler *scheduler);
866 extern int unregister_ip_vs_scheduler(struct ip_vs_scheduler *scheduler);
867 extern int ip_vs_bind_scheduler(struct ip_vs_service *svc,
868                                 struct ip_vs_scheduler *scheduler);
869 extern int ip_vs_unbind_scheduler(struct ip_vs_service *svc);
870 extern struct ip_vs_scheduler *ip_vs_scheduler_get(const char *sched_name);
871 extern void ip_vs_scheduler_put(struct ip_vs_scheduler *scheduler);
872 extern struct ip_vs_conn *
873 ip_vs_schedule(struct ip_vs_service *svc, const struct sk_buff *skb);
874 extern int ip_vs_leave(struct ip_vs_service *svc, struct sk_buff *skb,
875                         struct ip_vs_protocol *pp);
876
877
878 /*
879  *      IPVS control data and functions (from ip_vs_ctl.c)
880  */
881 extern int sysctl_ip_vs_cache_bypass;
882 extern int sysctl_ip_vs_expire_nodest_conn;
883 extern int sysctl_ip_vs_expire_quiescent_template;
884 extern int sysctl_ip_vs_sync_threshold[2];
885 extern int sysctl_ip_vs_nat_icmp_send;
886 extern struct ip_vs_stats ip_vs_stats;
887
888 extern struct ip_vs_service *
889 ip_vs_service_get(__u32 fwmark, __u16 protocol, __be32 vaddr, __be16 vport);
890
891 static inline void ip_vs_service_put(struct ip_vs_service *svc)
892 {
893         atomic_dec(&svc->usecnt);
894 }
895
896 extern struct ip_vs_dest *
897 ip_vs_lookup_real_service(__u16 protocol, __be32 daddr, __be16 dport);
898 extern int ip_vs_use_count_inc(void);
899 extern void ip_vs_use_count_dec(void);
900 extern int ip_vs_control_init(void);
901 extern void ip_vs_control_cleanup(void);
902 extern struct ip_vs_dest *
903 ip_vs_find_dest(__be32 daddr, __be16 dport,
904                  __be32 vaddr, __be16 vport, __u16 protocol);
905 extern struct ip_vs_dest *ip_vs_try_bind_dest(struct ip_vs_conn *cp);
906
907
908 /*
909  *      IPVS sync daemon data and function prototypes
910  *      (from ip_vs_sync.c)
911  */
912 extern volatile int ip_vs_sync_state;
913 extern volatile int ip_vs_master_syncid;
914 extern volatile int ip_vs_backup_syncid;
915 extern char ip_vs_master_mcast_ifn[IP_VS_IFNAME_MAXLEN];
916 extern char ip_vs_backup_mcast_ifn[IP_VS_IFNAME_MAXLEN];
917 extern int start_sync_thread(int state, char *mcast_ifn, __u8 syncid);
918 extern int stop_sync_thread(int state);
919 extern void ip_vs_sync_conn(struct ip_vs_conn *cp);
920
921
922 /*
923  *      IPVS rate estimator prototypes (from ip_vs_est.c)
924  */
925 extern int ip_vs_new_estimator(struct ip_vs_stats *stats);
926 extern void ip_vs_kill_estimator(struct ip_vs_stats *stats);
927 extern void ip_vs_zero_estimator(struct ip_vs_stats *stats);
928
929 /*
930  *      Various IPVS packet transmitters (from ip_vs_xmit.c)
931  */
932 extern int ip_vs_null_xmit
933 (struct sk_buff *skb, struct ip_vs_conn *cp, struct ip_vs_protocol *pp);
934 extern int ip_vs_bypass_xmit
935 (struct sk_buff *skb, struct ip_vs_conn *cp, struct ip_vs_protocol *pp);
936 extern int ip_vs_nat_xmit
937 (struct sk_buff *skb, struct ip_vs_conn *cp, struct ip_vs_protocol *pp);
938 extern int ip_vs_tunnel_xmit
939 (struct sk_buff *skb, struct ip_vs_conn *cp, struct ip_vs_protocol *pp);
940 extern int ip_vs_dr_xmit
941 (struct sk_buff *skb, struct ip_vs_conn *cp, struct ip_vs_protocol *pp);
942 extern int ip_vs_icmp_xmit
943 (struct sk_buff *skb, struct ip_vs_conn *cp, struct ip_vs_protocol *pp, int offset);
944 extern void ip_vs_dst_reset(struct ip_vs_dest *dest);
945
946
947 /*
948  *      This is a simple mechanism to ignore packets when
949  *      we are loaded. Just set ip_vs_drop_rate to 'n' and
950  *      we start to drop 1/rate of the packets
951  */
952 extern int ip_vs_drop_rate;
953 extern int ip_vs_drop_counter;
954
955 static __inline__ int ip_vs_todrop(void)
956 {
957         if (!ip_vs_drop_rate) return 0;
958         if (--ip_vs_drop_counter > 0) return 0;
959         ip_vs_drop_counter = ip_vs_drop_rate;
960         return 1;
961 }
962
963 /*
964  *      ip_vs_fwd_tag returns the forwarding tag of the connection
965  */
966 #define IP_VS_FWD_METHOD(cp)  (cp->flags & IP_VS_CONN_F_FWD_MASK)
967
968 static inline char ip_vs_fwd_tag(struct ip_vs_conn *cp)
969 {
970         char fwd;
971
972         switch (IP_VS_FWD_METHOD(cp)) {
973         case IP_VS_CONN_F_MASQ:
974                 fwd = 'M'; break;
975         case IP_VS_CONN_F_LOCALNODE:
976                 fwd = 'L'; break;
977         case IP_VS_CONN_F_TUNNEL:
978                 fwd = 'T'; break;
979         case IP_VS_CONN_F_DROUTE:
980                 fwd = 'R'; break;
981         case IP_VS_CONN_F_BYPASS:
982                 fwd = 'B'; break;
983         default:
984                 fwd = '?'; break;
985         }
986         return fwd;
987 }
988
989 extern void ip_vs_nat_icmp(struct sk_buff *skb, struct ip_vs_protocol *pp,
990                 struct ip_vs_conn *cp, int dir);
991
992 extern __sum16 ip_vs_checksum_complete(struct sk_buff *skb, int offset);
993
994 static inline __wsum ip_vs_check_diff4(__be32 old, __be32 new, __wsum oldsum)
995 {
996         __be32 diff[2] = { ~old, new };
997
998         return csum_partial((char *) diff, sizeof(diff), oldsum);
999 }
1000
1001 static inline __wsum ip_vs_check_diff2(__be16 old, __be16 new, __wsum oldsum)
1002 {
1003         __be16 diff[2] = { ~old, new };
1004
1005         return csum_partial((char *) diff, sizeof(diff), oldsum);
1006 }
1007
1008 #endif /* __KERNEL__ */
1009
1010 #endif  /* _IP_VS_H */