ipvs: extend connection flags to 32 bits
[linux-2.6.git] / include / linux / 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 <linux/types.h>        /* For __beXX types in userland */
10
11 #define IP_VS_VERSION_CODE      0x010201
12 #define NVERSION(version)                       \
13         (version >> 16) & 0xFF,                 \
14         (version >> 8) & 0xFF,                  \
15         version & 0xFF
16
17 /*
18  *      Virtual Service Flags
19  */
20 #define IP_VS_SVC_F_PERSISTENT  0x0001          /* persistent port */
21 #define IP_VS_SVC_F_HASHED      0x0002          /* hashed entry */
22 #define IP_VS_SVC_F_ONEPACKET   0x0004          /* one-packet scheduling */
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  *      Only flags 0..15 are sent to backup server
74  */
75 #define IP_VS_CONN_F_FWD_MASK   0x0007          /* mask for the fwd methods */
76 #define IP_VS_CONN_F_MASQ       0x0000          /* masquerading/NAT */
77 #define IP_VS_CONN_F_LOCALNODE  0x0001          /* local node */
78 #define IP_VS_CONN_F_TUNNEL     0x0002          /* tunneling */
79 #define IP_VS_CONN_F_DROUTE     0x0003          /* direct routing */
80 #define IP_VS_CONN_F_BYPASS     0x0004          /* cache bypass */
81 #define IP_VS_CONN_F_SYNC       0x0020          /* entry created by sync */
82 #define IP_VS_CONN_F_HASHED     0x0040          /* hashed entry */
83 #define IP_VS_CONN_F_NOOUTPUT   0x0080          /* no output packets */
84 #define IP_VS_CONN_F_INACTIVE   0x0100          /* not established */
85 #define IP_VS_CONN_F_OUT_SEQ    0x0200          /* must do output seq adjust */
86 #define IP_VS_CONN_F_IN_SEQ     0x0400          /* must do input seq adjust */
87 #define IP_VS_CONN_F_SEQ_MASK   0x0600          /* in/out sequence mask */
88 #define IP_VS_CONN_F_NO_CPORT   0x0800          /* no client port set yet */
89 #define IP_VS_CONN_F_TEMPLATE   0x1000          /* template, not connection */
90 #define IP_VS_CONN_F_ONE_PACKET 0x2000          /* forward only one packet */
91
92 /* Flags that are not sent to backup server start from bit 16 */
93
94 /* Connection flags from destination that can be changed by user space */
95 #define IP_VS_CONN_F_DEST_MASK (IP_VS_CONN_F_FWD_MASK | \
96                                 IP_VS_CONN_F_ONE_PACKET | \
97                                 0)
98
99 #define IP_VS_SCHEDNAME_MAXLEN  16
100 #define IP_VS_IFNAME_MAXLEN     16
101
102
103 /*
104  *      The struct ip_vs_service_user and struct ip_vs_dest_user are
105  *      used to set IPVS rules through setsockopt.
106  */
107 struct ip_vs_service_user {
108         /* virtual service addresses */
109         __u16           protocol;
110         __be32                  addr;           /* virtual ip address */
111         __be16                  port;
112         __u32           fwmark;         /* firwall mark of service */
113
114         /* virtual service options */
115         char                    sched_name[IP_VS_SCHEDNAME_MAXLEN];
116         unsigned                flags;          /* virtual service flags */
117         unsigned                timeout;        /* persistent timeout in sec */
118         __be32                  netmask;        /* persistent netmask */
119 };
120
121
122 struct ip_vs_dest_user {
123         /* destination server address */
124         __be32                  addr;
125         __be16                  port;
126
127         /* real server options */
128         unsigned                conn_flags;     /* connection flags */
129         int                     weight;         /* destination weight */
130
131         /* thresholds for active connections */
132         __u32           u_threshold;    /* upper threshold */
133         __u32           l_threshold;    /* lower threshold */
134 };
135
136
137 /*
138  *      IPVS statistics object (for user space)
139  */
140 struct ip_vs_stats_user {
141         __u32                   conns;          /* connections scheduled */
142         __u32                   inpkts;         /* incoming packets */
143         __u32                   outpkts;        /* outgoing packets */
144         __u64                   inbytes;        /* incoming bytes */
145         __u64                   outbytes;       /* outgoing bytes */
146
147         __u32                   cps;            /* current connection rate */
148         __u32                   inpps;          /* current in packet rate */
149         __u32                   outpps;         /* current out packet rate */
150         __u32                   inbps;          /* current in byte rate */
151         __u32                   outbps;         /* current out byte rate */
152 };
153
154
155 /* The argument to IP_VS_SO_GET_INFO */
156 struct ip_vs_getinfo {
157         /* version number */
158         unsigned int            version;
159
160         /* size of connection hash table */
161         unsigned int            size;
162
163         /* number of virtual services */
164         unsigned int            num_services;
165 };
166
167
168 /* The argument to IP_VS_SO_GET_SERVICE */
169 struct ip_vs_service_entry {
170         /* which service: user fills in these */
171         __u16           protocol;
172         __be32                  addr;           /* virtual address */
173         __be16                  port;
174         __u32           fwmark;         /* firwall mark of service */
175
176         /* service options */
177         char                    sched_name[IP_VS_SCHEDNAME_MAXLEN];
178         unsigned                flags;          /* virtual service flags */
179         unsigned                timeout;        /* persistent timeout */
180         __be32                  netmask;        /* persistent netmask */
181
182         /* number of real servers */
183         unsigned int            num_dests;
184
185         /* statistics */
186         struct ip_vs_stats_user stats;
187 };
188
189
190 struct ip_vs_dest_entry {
191         __be32                  addr;           /* destination address */
192         __be16                  port;
193         unsigned                conn_flags;     /* connection flags */
194         int                     weight;         /* destination weight */
195
196         __u32           u_threshold;    /* upper threshold */
197         __u32           l_threshold;    /* lower threshold */
198
199         __u32           activeconns;    /* active connections */
200         __u32           inactconns;     /* inactive connections */
201         __u32           persistconns;   /* persistent connections */
202
203         /* statistics */
204         struct ip_vs_stats_user stats;
205 };
206
207
208 /* The argument to IP_VS_SO_GET_DESTS */
209 struct ip_vs_get_dests {
210         /* which service: user fills in these */
211         __u16           protocol;
212         __be32                  addr;           /* virtual address */
213         __be16                  port;
214         __u32           fwmark;         /* firwall mark of service */
215
216         /* number of real servers */
217         unsigned int            num_dests;
218
219         /* the real servers */
220         struct ip_vs_dest_entry entrytable[0];
221 };
222
223
224 /* The argument to IP_VS_SO_GET_SERVICES */
225 struct ip_vs_get_services {
226         /* number of virtual services */
227         unsigned int            num_services;
228
229         /* service table */
230         struct ip_vs_service_entry entrytable[0];
231 };
232
233
234 /* The argument to IP_VS_SO_GET_TIMEOUT */
235 struct ip_vs_timeout_user {
236         int                     tcp_timeout;
237         int                     tcp_fin_timeout;
238         int                     udp_timeout;
239 };
240
241
242 /* The argument to IP_VS_SO_GET_DAEMON */
243 struct ip_vs_daemon_user {
244         /* sync daemon state (master/backup) */
245         int                     state;
246
247         /* multicast interface name */
248         char                    mcast_ifn[IP_VS_IFNAME_MAXLEN];
249
250         /* SyncID we belong to */
251         int                     syncid;
252 };
253
254 /*
255  *
256  * IPVS Generic Netlink interface definitions
257  *
258  */
259
260 /* Generic Netlink family info */
261
262 #define IPVS_GENL_NAME          "IPVS"
263 #define IPVS_GENL_VERSION       0x1
264
265 struct ip_vs_flags {
266         __be32 flags;
267         __be32 mask;
268 };
269
270 /* Generic Netlink command attributes */
271 enum {
272         IPVS_CMD_UNSPEC = 0,
273
274         IPVS_CMD_NEW_SERVICE,           /* add service */
275         IPVS_CMD_SET_SERVICE,           /* modify service */
276         IPVS_CMD_DEL_SERVICE,           /* delete service */
277         IPVS_CMD_GET_SERVICE,           /* get service info */
278
279         IPVS_CMD_NEW_DEST,              /* add destination */
280         IPVS_CMD_SET_DEST,              /* modify destination */
281         IPVS_CMD_DEL_DEST,              /* delete destination */
282         IPVS_CMD_GET_DEST,              /* get destination info */
283
284         IPVS_CMD_NEW_DAEMON,            /* start sync daemon */
285         IPVS_CMD_DEL_DAEMON,            /* stop sync daemon */
286         IPVS_CMD_GET_DAEMON,            /* get sync daemon status */
287
288         IPVS_CMD_SET_CONFIG,            /* set config settings */
289         IPVS_CMD_GET_CONFIG,            /* get config settings */
290
291         IPVS_CMD_SET_INFO,              /* only used in GET_INFO reply */
292         IPVS_CMD_GET_INFO,              /* get general IPVS info */
293
294         IPVS_CMD_ZERO,                  /* zero all counters and stats */
295         IPVS_CMD_FLUSH,                 /* flush services and dests */
296
297         __IPVS_CMD_MAX,
298 };
299
300 #define IPVS_CMD_MAX (__IPVS_CMD_MAX - 1)
301
302 /* Attributes used in the first level of commands */
303 enum {
304         IPVS_CMD_ATTR_UNSPEC = 0,
305         IPVS_CMD_ATTR_SERVICE,          /* nested service attribute */
306         IPVS_CMD_ATTR_DEST,             /* nested destination attribute */
307         IPVS_CMD_ATTR_DAEMON,           /* nested sync daemon attribute */
308         IPVS_CMD_ATTR_TIMEOUT_TCP,      /* TCP connection timeout */
309         IPVS_CMD_ATTR_TIMEOUT_TCP_FIN,  /* TCP FIN wait timeout */
310         IPVS_CMD_ATTR_TIMEOUT_UDP,      /* UDP timeout */
311         __IPVS_CMD_ATTR_MAX,
312 };
313
314 #define IPVS_CMD_ATTR_MAX (__IPVS_SVC_ATTR_MAX - 1)
315
316 /*
317  * Attributes used to describe a service
318  *
319  * Used inside nested attribute IPVS_CMD_ATTR_SERVICE
320  */
321 enum {
322         IPVS_SVC_ATTR_UNSPEC = 0,
323         IPVS_SVC_ATTR_AF,               /* address family */
324         IPVS_SVC_ATTR_PROTOCOL,         /* virtual service protocol */
325         IPVS_SVC_ATTR_ADDR,             /* virtual service address */
326         IPVS_SVC_ATTR_PORT,             /* virtual service port */
327         IPVS_SVC_ATTR_FWMARK,           /* firewall mark of service */
328
329         IPVS_SVC_ATTR_SCHED_NAME,       /* name of scheduler */
330         IPVS_SVC_ATTR_FLAGS,            /* virtual service flags */
331         IPVS_SVC_ATTR_TIMEOUT,          /* persistent timeout */
332         IPVS_SVC_ATTR_NETMASK,          /* persistent netmask */
333
334         IPVS_SVC_ATTR_STATS,            /* nested attribute for service stats */
335         __IPVS_SVC_ATTR_MAX,
336 };
337
338 #define IPVS_SVC_ATTR_MAX (__IPVS_SVC_ATTR_MAX - 1)
339
340 /*
341  * Attributes used to describe a destination (real server)
342  *
343  * Used inside nested attribute IPVS_CMD_ATTR_DEST
344  */
345 enum {
346         IPVS_DEST_ATTR_UNSPEC = 0,
347         IPVS_DEST_ATTR_ADDR,            /* real server address */
348         IPVS_DEST_ATTR_PORT,            /* real server port */
349
350         IPVS_DEST_ATTR_FWD_METHOD,      /* forwarding method */
351         IPVS_DEST_ATTR_WEIGHT,          /* destination weight */
352
353         IPVS_DEST_ATTR_U_THRESH,        /* upper threshold */
354         IPVS_DEST_ATTR_L_THRESH,        /* lower threshold */
355
356         IPVS_DEST_ATTR_ACTIVE_CONNS,    /* active connections */
357         IPVS_DEST_ATTR_INACT_CONNS,     /* inactive connections */
358         IPVS_DEST_ATTR_PERSIST_CONNS,   /* persistent connections */
359
360         IPVS_DEST_ATTR_STATS,           /* nested attribute for dest stats */
361         __IPVS_DEST_ATTR_MAX,
362 };
363
364 #define IPVS_DEST_ATTR_MAX (__IPVS_DEST_ATTR_MAX - 1)
365
366 /*
367  * Attributes describing a sync daemon
368  *
369  * Used inside nested attribute IPVS_CMD_ATTR_DAEMON
370  */
371 enum {
372         IPVS_DAEMON_ATTR_UNSPEC = 0,
373         IPVS_DAEMON_ATTR_STATE,         /* sync daemon state (master/backup) */
374         IPVS_DAEMON_ATTR_MCAST_IFN,     /* multicast interface name */
375         IPVS_DAEMON_ATTR_SYNC_ID,       /* SyncID we belong to */
376         __IPVS_DAEMON_ATTR_MAX,
377 };
378
379 #define IPVS_DAEMON_ATTR_MAX (__IPVS_DAEMON_ATTR_MAX - 1)
380
381 /*
382  * Attributes used to describe service or destination entry statistics
383  *
384  * Used inside nested attributes IPVS_SVC_ATTR_STATS and IPVS_DEST_ATTR_STATS
385  */
386 enum {
387         IPVS_STATS_ATTR_UNSPEC = 0,
388         IPVS_STATS_ATTR_CONNS,          /* connections scheduled */
389         IPVS_STATS_ATTR_INPKTS,         /* incoming packets */
390         IPVS_STATS_ATTR_OUTPKTS,        /* outgoing packets */
391         IPVS_STATS_ATTR_INBYTES,        /* incoming bytes */
392         IPVS_STATS_ATTR_OUTBYTES,       /* outgoing bytes */
393
394         IPVS_STATS_ATTR_CPS,            /* current connection rate */
395         IPVS_STATS_ATTR_INPPS,          /* current in packet rate */
396         IPVS_STATS_ATTR_OUTPPS,         /* current out packet rate */
397         IPVS_STATS_ATTR_INBPS,          /* current in byte rate */
398         IPVS_STATS_ATTR_OUTBPS,         /* current out byte rate */
399         __IPVS_STATS_ATTR_MAX,
400 };
401
402 #define IPVS_STATS_ATTR_MAX (__IPVS_STATS_ATTR_MAX - 1)
403
404 /* Attributes used in response to IPVS_CMD_GET_INFO command */
405 enum {
406         IPVS_INFO_ATTR_UNSPEC = 0,
407         IPVS_INFO_ATTR_VERSION,         /* IPVS version number */
408         IPVS_INFO_ATTR_CONN_TAB_SIZE,   /* size of connection hash table */
409         __IPVS_INFO_ATTR_MAX,
410 };
411
412 #define IPVS_INFO_ATTR_MAX (__IPVS_INFO_ATTR_MAX - 1)
413
414 #endif  /* _IP_VS_H */