| /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ |
| /* |
| * IP Virtual Server |
| * data structure and functionality definitions |
| */ |
| |
| #ifndef _IP_VS_H |
| #define _IP_VS_H |
| |
| #include <linux/types.h> /* For __beXX types in userland */ |
| |
| #define IP_VS_VERSION_CODE 0x010201 |
| #define NVERSION(version) \ |
| (version >> 16) & 0xFF, \ |
| (version >> 8) & 0xFF, \ |
| version & 0xFF |
| |
| /* |
| * Virtual Service Flags |
| */ |
| #define IP_VS_SVC_F_PERSISTENT 0x0001 /* persistent port */ |
| #define IP_VS_SVC_F_HASHED 0x0002 /* hashed entry */ |
| #define IP_VS_SVC_F_ONEPACKET 0x0004 /* one-packet scheduling */ |
| #define IP_VS_SVC_F_SCHED1 0x0008 /* scheduler flag 1 */ |
| #define IP_VS_SVC_F_SCHED2 0x0010 /* scheduler flag 2 */ |
| #define IP_VS_SVC_F_SCHED3 0x0020 /* scheduler flag 3 */ |
| |
| #define IP_VS_SVC_F_SCHED_SH_FALLBACK IP_VS_SVC_F_SCHED1 /* SH fallback */ |
| #define IP_VS_SVC_F_SCHED_SH_PORT IP_VS_SVC_F_SCHED2 /* SH use port */ |
| |
| /* |
| * Destination Server Flags |
| */ |
| #define IP_VS_DEST_F_AVAILABLE 0x0001 /* server is available */ |
| #define IP_VS_DEST_F_OVERLOAD 0x0002 /* server is overloaded */ |
| |
| /* |
| * IPVS sync daemon states |
| */ |
| #define IP_VS_STATE_NONE 0x0000 /* daemon is stopped */ |
| #define IP_VS_STATE_MASTER 0x0001 /* started as master */ |
| #define IP_VS_STATE_BACKUP 0x0002 /* started as backup */ |
| |
| /* |
| * IPVS socket options |
| */ |
| #define IP_VS_BASE_CTL (64+1024+64) /* base */ |
| |
| #define IP_VS_SO_SET_NONE IP_VS_BASE_CTL /* just peek */ |
| #define IP_VS_SO_SET_INSERT (IP_VS_BASE_CTL+1) |
| #define IP_VS_SO_SET_ADD (IP_VS_BASE_CTL+2) |
| #define IP_VS_SO_SET_EDIT (IP_VS_BASE_CTL+3) |
| #define IP_VS_SO_SET_DEL (IP_VS_BASE_CTL+4) |
| #define IP_VS_SO_SET_FLUSH (IP_VS_BASE_CTL+5) |
| #define IP_VS_SO_SET_LIST (IP_VS_BASE_CTL+6) |
| #define IP_VS_SO_SET_ADDDEST (IP_VS_BASE_CTL+7) |
| #define IP_VS_SO_SET_DELDEST (IP_VS_BASE_CTL+8) |
| #define IP_VS_SO_SET_EDITDEST (IP_VS_BASE_CTL+9) |
| #define IP_VS_SO_SET_TIMEOUT (IP_VS_BASE_CTL+10) |
| #define IP_VS_SO_SET_STARTDAEMON (IP_VS_BASE_CTL+11) |
| #define IP_VS_SO_SET_STOPDAEMON (IP_VS_BASE_CTL+12) |
| #define IP_VS_SO_SET_RESTORE (IP_VS_BASE_CTL+13) |
| #define IP_VS_SO_SET_SAVE (IP_VS_BASE_CTL+14) |
| #define IP_VS_SO_SET_ZERO (IP_VS_BASE_CTL+15) |
| #define IP_VS_SO_SET_MAX IP_VS_SO_SET_ZERO |
| |
| #define IP_VS_SO_GET_VERSION IP_VS_BASE_CTL |
| #define IP_VS_SO_GET_INFO (IP_VS_BASE_CTL+1) |
| #define IP_VS_SO_GET_SERVICES (IP_VS_BASE_CTL+2) |
| #define IP_VS_SO_GET_SERVICE (IP_VS_BASE_CTL+3) |
| #define IP_VS_SO_GET_DESTS (IP_VS_BASE_CTL+4) |
| #define IP_VS_SO_GET_DEST (IP_VS_BASE_CTL+5) /* not used now */ |
| #define IP_VS_SO_GET_TIMEOUT (IP_VS_BASE_CTL+6) |
| #define IP_VS_SO_GET_DAEMON (IP_VS_BASE_CTL+7) |
| #define IP_VS_SO_GET_MAX IP_VS_SO_GET_DAEMON |
| |
| |
| /* |
| * IPVS Connection Flags |
| * Only flags 0..15 are sent to backup server |
| */ |
| #define IP_VS_CONN_F_FWD_MASK 0x0007 /* mask for the fwd methods */ |
| #define IP_VS_CONN_F_MASQ 0x0000 /* masquerading/NAT */ |
| #define IP_VS_CONN_F_LOCALNODE 0x0001 /* local node */ |
| #define IP_VS_CONN_F_TUNNEL 0x0002 /* tunneling */ |
| #define IP_VS_CONN_F_DROUTE 0x0003 /* direct routing */ |
| #define IP_VS_CONN_F_BYPASS 0x0004 /* cache bypass */ |
| #define IP_VS_CONN_F_SYNC 0x0020 /* entry created by sync */ |
| #define IP_VS_CONN_F_HASHED 0x0040 /* hashed entry */ |
| #define IP_VS_CONN_F_NOOUTPUT 0x0080 /* no output packets */ |
| #define IP_VS_CONN_F_INACTIVE 0x0100 /* not established */ |
| #define IP_VS_CONN_F_OUT_SEQ 0x0200 /* must do output seq adjust */ |
| #define IP_VS_CONN_F_IN_SEQ 0x0400 /* must do input seq adjust */ |
| #define IP_VS_CONN_F_SEQ_MASK 0x0600 /* in/out sequence mask */ |
| #define IP_VS_CONN_F_NO_CPORT 0x0800 /* no client port set yet */ |
| #define IP_VS_CONN_F_TEMPLATE 0x1000 /* template, not connection */ |
| #define IP_VS_CONN_F_ONE_PACKET 0x2000 /* forward only one packet */ |
| |
| /* Initial bits allowed in backup server */ |
| #define IP_VS_CONN_F_BACKUP_MASK (IP_VS_CONN_F_FWD_MASK | \ |
| IP_VS_CONN_F_NOOUTPUT | \ |
| IP_VS_CONN_F_INACTIVE | \ |
| IP_VS_CONN_F_SEQ_MASK | \ |
| IP_VS_CONN_F_NO_CPORT | \ |
| IP_VS_CONN_F_TEMPLATE \ |
| ) |
| |
| /* Bits allowed to update in backup server */ |
| #define IP_VS_CONN_F_BACKUP_UPD_MASK (IP_VS_CONN_F_INACTIVE | \ |
| IP_VS_CONN_F_SEQ_MASK) |
| |
| /* Flags that are not sent to backup server start from bit 16 */ |
| #define IP_VS_CONN_F_NFCT (1 << 16) /* use netfilter conntrack */ |
| |
| /* Connection flags from destination that can be changed by user space */ |
| #define IP_VS_CONN_F_DEST_MASK (IP_VS_CONN_F_FWD_MASK | \ |
| IP_VS_CONN_F_ONE_PACKET | \ |
| IP_VS_CONN_F_NFCT | \ |
| 0) |
| |
| #define IP_VS_SCHEDNAME_MAXLEN 16 |
| #define IP_VS_PENAME_MAXLEN 16 |
| #define IP_VS_IFNAME_MAXLEN 16 |
| |
| #define IP_VS_PEDATA_MAXLEN 255 |
| |
| /* Tunnel types */ |
| enum { |
| IP_VS_CONN_F_TUNNEL_TYPE_IPIP = 0, /* IPIP */ |
| IP_VS_CONN_F_TUNNEL_TYPE_GUE, /* GUE */ |
| IP_VS_CONN_F_TUNNEL_TYPE_GRE, /* GRE */ |
| IP_VS_CONN_F_TUNNEL_TYPE_MAX, |
| }; |
| |
| /* Tunnel encapsulation flags */ |
| #define IP_VS_TUNNEL_ENCAP_FLAG_NOCSUM (0) |
| #define IP_VS_TUNNEL_ENCAP_FLAG_CSUM (1 << 0) |
| #define IP_VS_TUNNEL_ENCAP_FLAG_REMCSUM (1 << 1) |
| |
| /* |
| * The struct ip_vs_service_user and struct ip_vs_dest_user are |
| * used to set IPVS rules through setsockopt. |
| */ |
| struct ip_vs_service_user { |
| /* virtual service addresses */ |
| __u16 protocol; |
| __be32 addr; /* virtual ip address */ |
| __be16 port; |
| __u32 fwmark; /* firwall mark of service */ |
| |
| /* virtual service options */ |
| char sched_name[IP_VS_SCHEDNAME_MAXLEN]; |
| unsigned int flags; /* virtual service flags */ |
| unsigned int timeout; /* persistent timeout in sec */ |
| __be32 netmask; /* persistent netmask */ |
| }; |
| |
| |
| struct ip_vs_dest_user { |
| /* destination server address */ |
| __be32 addr; |
| __be16 port; |
| |
| /* real server options */ |
| unsigned int conn_flags; /* connection flags */ |
| int weight; /* destination weight */ |
| |
| /* thresholds for active connections */ |
| __u32 u_threshold; /* upper threshold */ |
| __u32 l_threshold; /* lower threshold */ |
| }; |
| |
| |
| /* |
| * IPVS statistics object (for user space) |
| */ |
| struct ip_vs_stats_user { |
| __u32 conns; /* connections scheduled */ |
| __u32 inpkts; /* incoming packets */ |
| __u32 outpkts; /* outgoing packets */ |
| __u64 inbytes; /* incoming bytes */ |
| __u64 outbytes; /* outgoing bytes */ |
| |
| __u32 cps; /* current connection rate */ |
| __u32 inpps; /* current in packet rate */ |
| __u32 outpps; /* current out packet rate */ |
| __u32 inbps; /* current in byte rate */ |
| __u32 outbps; /* current out byte rate */ |
| }; |
| |
| |
| /* The argument to IP_VS_SO_GET_INFO */ |
| struct ip_vs_getinfo { |
| /* version number */ |
| unsigned int version; |
| |
| /* size of connection hash table */ |
| unsigned int size; |
| |
| /* number of virtual services */ |
| unsigned int num_services; |
| }; |
| |
| |
| /* The argument to IP_VS_SO_GET_SERVICE */ |
| struct ip_vs_service_entry { |
| /* which service: user fills in these */ |
| __u16 protocol; |
| __be32 addr; /* virtual address */ |
| __be16 port; |
| __u32 fwmark; /* firwall mark of service */ |
| |
| /* service options */ |
| char sched_name[IP_VS_SCHEDNAME_MAXLEN]; |
| unsigned int flags; /* virtual service flags */ |
| unsigned int timeout; /* persistent timeout */ |
| __be32 netmask; /* persistent netmask */ |
| |
| /* number of real servers */ |
| unsigned int num_dests; |
| |
| /* statistics */ |
| struct ip_vs_stats_user stats; |
| }; |
| |
| |
| struct ip_vs_dest_entry { |
| __be32 addr; /* destination address */ |
| __be16 port; |
| unsigned int conn_flags; /* connection flags */ |
| int weight; /* destination weight */ |
| |
| __u32 u_threshold; /* upper threshold */ |
| __u32 l_threshold; /* lower threshold */ |
| |
| __u32 activeconns; /* active connections */ |
| __u32 inactconns; /* inactive connections */ |
| __u32 persistconns; /* persistent connections */ |
| |
| /* statistics */ |
| struct ip_vs_stats_user stats; |
| }; |
| |
| |
| /* The argument to IP_VS_SO_GET_DESTS */ |
| struct ip_vs_get_dests { |
| /* which service: user fills in these */ |
| __u16 protocol; |
| __be32 addr; /* virtual address */ |
| __be16 port; |
| __u32 fwmark; /* firwall mark of service */ |
| |
| /* number of real servers */ |
| unsigned int num_dests; |
| |
| /* the real servers */ |
| struct ip_vs_dest_entry entrytable[]; |
| }; |
| |
| |
| /* The argument to IP_VS_SO_GET_SERVICES */ |
| struct ip_vs_get_services { |
| /* number of virtual services */ |
| unsigned int num_services; |
| |
| /* service table */ |
| struct ip_vs_service_entry entrytable[]; |
| }; |
| |
| |
| /* The argument to IP_VS_SO_GET_TIMEOUT */ |
| struct ip_vs_timeout_user { |
| int tcp_timeout; |
| int tcp_fin_timeout; |
| int udp_timeout; |
| }; |
| |
| |
| /* The argument to IP_VS_SO_GET_DAEMON */ |
| struct ip_vs_daemon_user { |
| /* sync daemon state (master/backup) */ |
| int state; |
| |
| /* multicast interface name */ |
| char mcast_ifn[IP_VS_IFNAME_MAXLEN]; |
| |
| /* SyncID we belong to */ |
| int syncid; |
| }; |
| |
| /* |
| * |
| * IPVS Generic Netlink interface definitions |
| * |
| */ |
| |
| /* Generic Netlink family info */ |
| |
| #define IPVS_GENL_NAME "IPVS" |
| #define IPVS_GENL_VERSION 0x1 |
| |
| struct ip_vs_flags { |
| __u32 flags; |
| __u32 mask; |
| }; |
| |
| /* Generic Netlink command attributes */ |
| enum { |
| IPVS_CMD_UNSPEC = 0, |
| |
| IPVS_CMD_NEW_SERVICE, /* add service */ |
| IPVS_CMD_SET_SERVICE, /* modify service */ |
| IPVS_CMD_DEL_SERVICE, /* delete service */ |
| IPVS_CMD_GET_SERVICE, /* get service info */ |
| |
| IPVS_CMD_NEW_DEST, /* add destination */ |
| IPVS_CMD_SET_DEST, /* modify destination */ |
| IPVS_CMD_DEL_DEST, /* delete destination */ |
| IPVS_CMD_GET_DEST, /* get destination info */ |
| |
| IPVS_CMD_NEW_DAEMON, /* start sync daemon */ |
| IPVS_CMD_DEL_DAEMON, /* stop sync daemon */ |
| IPVS_CMD_GET_DAEMON, /* get sync daemon status */ |
| |
| IPVS_CMD_SET_CONFIG, /* set config settings */ |
| IPVS_CMD_GET_CONFIG, /* get config settings */ |
| |
| IPVS_CMD_SET_INFO, /* only used in GET_INFO reply */ |
| IPVS_CMD_GET_INFO, /* get general IPVS info */ |
| |
| IPVS_CMD_ZERO, /* zero all counters and stats */ |
| IPVS_CMD_FLUSH, /* flush services and dests */ |
| |
| __IPVS_CMD_MAX, |
| }; |
| |
| #define IPVS_CMD_MAX (__IPVS_CMD_MAX - 1) |
| |
| /* Attributes used in the first level of commands */ |
| enum { |
| IPVS_CMD_ATTR_UNSPEC = 0, |
| IPVS_CMD_ATTR_SERVICE, /* nested service attribute */ |
| IPVS_CMD_ATTR_DEST, /* nested destination attribute */ |
| IPVS_CMD_ATTR_DAEMON, /* nested sync daemon attribute */ |
| IPVS_CMD_ATTR_TIMEOUT_TCP, /* TCP connection timeout */ |
| IPVS_CMD_ATTR_TIMEOUT_TCP_FIN, /* TCP FIN wait timeout */ |
| IPVS_CMD_ATTR_TIMEOUT_UDP, /* UDP timeout */ |
| __IPVS_CMD_ATTR_MAX, |
| }; |
| |
| #define IPVS_CMD_ATTR_MAX (__IPVS_CMD_ATTR_MAX - 1) |
| |
| /* |
| * Attributes used to describe a service |
| * |
| * Used inside nested attribute IPVS_CMD_ATTR_SERVICE |
| */ |
| enum { |
| IPVS_SVC_ATTR_UNSPEC = 0, |
| IPVS_SVC_ATTR_AF, /* address family */ |
| IPVS_SVC_ATTR_PROTOCOL, /* virtual service protocol */ |
| IPVS_SVC_ATTR_ADDR, /* virtual service address */ |
| IPVS_SVC_ATTR_PORT, /* virtual service port */ |
| IPVS_SVC_ATTR_FWMARK, /* firewall mark of service */ |
| |
| IPVS_SVC_ATTR_SCHED_NAME, /* name of scheduler */ |
| IPVS_SVC_ATTR_FLAGS, /* virtual service flags */ |
| IPVS_SVC_ATTR_TIMEOUT, /* persistent timeout */ |
| IPVS_SVC_ATTR_NETMASK, /* persistent netmask */ |
| |
| IPVS_SVC_ATTR_STATS, /* nested attribute for service stats */ |
| |
| IPVS_SVC_ATTR_PE_NAME, /* name of ct retriever */ |
| |
| IPVS_SVC_ATTR_STATS64, /* nested attribute for service stats */ |
| |
| __IPVS_SVC_ATTR_MAX, |
| }; |
| |
| #define IPVS_SVC_ATTR_MAX (__IPVS_SVC_ATTR_MAX - 1) |
| |
| /* |
| * Attributes used to describe a destination (real server) |
| * |
| * Used inside nested attribute IPVS_CMD_ATTR_DEST |
| */ |
| enum { |
| IPVS_DEST_ATTR_UNSPEC = 0, |
| IPVS_DEST_ATTR_ADDR, /* real server address */ |
| IPVS_DEST_ATTR_PORT, /* real server port */ |
| |
| IPVS_DEST_ATTR_FWD_METHOD, /* forwarding method */ |
| IPVS_DEST_ATTR_WEIGHT, /* destination weight */ |
| |
| IPVS_DEST_ATTR_U_THRESH, /* upper threshold */ |
| IPVS_DEST_ATTR_L_THRESH, /* lower threshold */ |
| |
| IPVS_DEST_ATTR_ACTIVE_CONNS, /* active connections */ |
| IPVS_DEST_ATTR_INACT_CONNS, /* inactive connections */ |
| IPVS_DEST_ATTR_PERSIST_CONNS, /* persistent connections */ |
| |
| IPVS_DEST_ATTR_STATS, /* nested attribute for dest stats */ |
| |
| IPVS_DEST_ATTR_ADDR_FAMILY, /* Address family of address */ |
| |
| IPVS_DEST_ATTR_STATS64, /* nested attribute for dest stats */ |
| |
| IPVS_DEST_ATTR_TUN_TYPE, /* tunnel type */ |
| |
| IPVS_DEST_ATTR_TUN_PORT, /* tunnel port */ |
| |
| IPVS_DEST_ATTR_TUN_FLAGS, /* tunnel flags */ |
| |
| __IPVS_DEST_ATTR_MAX, |
| }; |
| |
| #define IPVS_DEST_ATTR_MAX (__IPVS_DEST_ATTR_MAX - 1) |
| |
| /* |
| * Attributes describing a sync daemon |
| * |
| * Used inside nested attribute IPVS_CMD_ATTR_DAEMON |
| */ |
| enum { |
| IPVS_DAEMON_ATTR_UNSPEC = 0, |
| IPVS_DAEMON_ATTR_STATE, /* sync daemon state (master/backup) */ |
| IPVS_DAEMON_ATTR_MCAST_IFN, /* multicast interface name */ |
| IPVS_DAEMON_ATTR_SYNC_ID, /* SyncID we belong to */ |
| IPVS_DAEMON_ATTR_SYNC_MAXLEN, /* UDP Payload Size */ |
| IPVS_DAEMON_ATTR_MCAST_GROUP, /* IPv4 Multicast Address */ |
| IPVS_DAEMON_ATTR_MCAST_GROUP6, /* IPv6 Multicast Address */ |
| IPVS_DAEMON_ATTR_MCAST_PORT, /* Multicast Port (base) */ |
| IPVS_DAEMON_ATTR_MCAST_TTL, /* Multicast TTL */ |
| __IPVS_DAEMON_ATTR_MAX, |
| }; |
| |
| #define IPVS_DAEMON_ATTR_MAX (__IPVS_DAEMON_ATTR_MAX - 1) |
| |
| /* |
| * Attributes used to describe service or destination entry statistics |
| * |
| * Used inside nested attributes IPVS_SVC_ATTR_STATS, IPVS_DEST_ATTR_STATS, |
| * IPVS_SVC_ATTR_STATS64 and IPVS_DEST_ATTR_STATS64. |
| */ |
| enum { |
| IPVS_STATS_ATTR_UNSPEC = 0, |
| IPVS_STATS_ATTR_CONNS, /* connections scheduled */ |
| IPVS_STATS_ATTR_INPKTS, /* incoming packets */ |
| IPVS_STATS_ATTR_OUTPKTS, /* outgoing packets */ |
| IPVS_STATS_ATTR_INBYTES, /* incoming bytes */ |
| IPVS_STATS_ATTR_OUTBYTES, /* outgoing bytes */ |
| |
| IPVS_STATS_ATTR_CPS, /* current connection rate */ |
| IPVS_STATS_ATTR_INPPS, /* current in packet rate */ |
| IPVS_STATS_ATTR_OUTPPS, /* current out packet rate */ |
| IPVS_STATS_ATTR_INBPS, /* current in byte rate */ |
| IPVS_STATS_ATTR_OUTBPS, /* current out byte rate */ |
| IPVS_STATS_ATTR_PAD, |
| __IPVS_STATS_ATTR_MAX, |
| }; |
| |
| #define IPVS_STATS_ATTR_MAX (__IPVS_STATS_ATTR_MAX - 1) |
| |
| /* Attributes used in response to IPVS_CMD_GET_INFO command */ |
| enum { |
| IPVS_INFO_ATTR_UNSPEC = 0, |
| IPVS_INFO_ATTR_VERSION, /* IPVS version number */ |
| IPVS_INFO_ATTR_CONN_TAB_SIZE, /* size of connection hash table */ |
| __IPVS_INFO_ATTR_MAX, |
| }; |
| |
| #define IPVS_INFO_ATTR_MAX (__IPVS_INFO_ATTR_MAX - 1) |
| |
| #endif /* _IP_VS_H */ |