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