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