mirror of
https://github.com/haproxy/haproxy.git
synced 2026-02-03 20:39:41 -05:00
Now that we support keep-alive, it's important to report a separate counter for requests. Right now it just appears in the CSV output.
344 lines
18 KiB
C
344 lines
18 KiB
C
/*
|
|
* include/types/proxy.h
|
|
* This file defines everything related to proxies.
|
|
*
|
|
* Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _TYPES_PROXY_H
|
|
#define _TYPES_PROXY_H
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/socket.h>
|
|
#include <netinet/in.h>
|
|
#include <arpa/inet.h>
|
|
|
|
#include <common/appsession.h>
|
|
#include <common/config.h>
|
|
#include <common/mini-clist.h>
|
|
#include <common/regex.h>
|
|
#include <common/sessionhash.h>
|
|
#include <common/tools.h>
|
|
#include <eb32tree.h>
|
|
|
|
#include <types/acl.h>
|
|
#include <types/pattern.h>
|
|
#include <types/backend.h>
|
|
#include <types/buffers.h>
|
|
#include <types/counters.h>
|
|
#include <types/freq_ctr.h>
|
|
#include <types/httperr.h>
|
|
#include <types/log.h>
|
|
#include <types/protocols.h>
|
|
#include <types/session.h>
|
|
#include <types/server.h>
|
|
#include <types/stick_table.h>
|
|
|
|
/* values for proxy->state */
|
|
#define PR_STNEW 0
|
|
#define PR_STIDLE 1
|
|
#define PR_STRUN 2
|
|
#define PR_STSTOPPED 3
|
|
#define PR_STPAUSED 4
|
|
#define PR_STERROR 5
|
|
|
|
/* values for proxy->mode */
|
|
#define PR_MODE_TCP 0
|
|
#define PR_MODE_HTTP 1
|
|
#define PR_MODE_HEALTH 2
|
|
|
|
/* flag values for proxy->cap. This is a bitmask of capabilities supported by the proxy */
|
|
#define PR_CAP_NONE 0x0000
|
|
#define PR_CAP_FE 0x0001
|
|
#define PR_CAP_BE 0x0002
|
|
#define PR_CAP_RS 0x0004
|
|
#define PR_CAP_LISTEN (PR_CAP_FE|PR_CAP_BE|PR_CAP_RS)
|
|
|
|
/* bits for proxy->options */
|
|
#define PR_O_REDISP 0x00000001 /* allow reconnection to dispatch in case of errors */
|
|
#define PR_O_TRANSP 0x00000002 /* transparent mode : use original DEST as dispatch */
|
|
#define PR_O_COOK_RW 0x00000004 /* rewrite all direct cookies with the right serverid */
|
|
#define PR_O_COOK_IND 0x00000008 /* keep only indirect cookies */
|
|
#define PR_O_COOK_INS 0x00000010 /* insert cookies when not accessing a server directly */
|
|
#define PR_O_COOK_PFX 0x00000020 /* rewrite all cookies by prefixing the right serverid */
|
|
#define PR_O_COOK_ANY (PR_O_COOK_RW | PR_O_COOK_IND | PR_O_COOK_INS | PR_O_COOK_PFX)
|
|
#define PR_O_SMTP_CHK 0x00000040 /* use SMTP EHLO check for server health - pvandijk@vision6.com.au */
|
|
#define PR_O_KEEPALIVE 0x00000080 /* follow keep-alive sessions */
|
|
#define PR_O_FWDFOR 0x00000100 /* insert x-forwarded-for with client address */
|
|
#define PR_O_BIND_SRC 0x00000200 /* bind to a specific source address when connect()ing */
|
|
#define PR_O_NULLNOLOG 0x00000400 /* a connect without request will not be logged */
|
|
#define PR_O_COOK_NOC 0x00000800 /* add a 'Cache-control' header with the cookie */
|
|
#define PR_O_COOK_POST 0x00001000 /* don't insert cookies for requests other than a POST */
|
|
#define PR_O_HTTP_CHK 0x00002000 /* use HTTP 'OPTIONS' method to check server health */
|
|
#define PR_O_PERSIST 0x00004000 /* server persistence stays effective even when server is down */
|
|
#define PR_O_LOGASAP 0x00008000 /* log as soon as possible, without waiting for the session to complete */
|
|
#define PR_O_HTTP_CLOSE 0x00010000 /* force 'connection: close' in both directions */
|
|
#define PR_O_CHK_CACHE 0x00020000 /* require examination of cacheability of the 'set-cookie' field */
|
|
#define PR_O_TCP_CLI_KA 0x00040000 /* enable TCP keep-alive on client-side sessions */
|
|
#define PR_O_TCP_SRV_KA 0x00080000 /* enable TCP keep-alive on server-side sessions */
|
|
#define PR_O_USE_ALL_BK 0x00100000 /* load-balance between backup servers */
|
|
#define PR_O_FORCE_CLO 0x00200000 /* enforce the connection close immediately after server response */
|
|
#define PR_O_TCP_NOLING 0x00400000 /* disable lingering on client and server connections */
|
|
#define PR_O_ABRT_CLOSE 0x00800000 /* immediately abort request when client closes */
|
|
#define PR_O_SSL3_CHK 0x01000000 /* use SSLv3 CLIENT_HELLO packets for server health */
|
|
|
|
/* TPXY: exclusive values */
|
|
#define PR_O_TPXY_ADDR 0x02000000 /* bind to this non-local address when connect()ing */
|
|
#define PR_O_TPXY_CIP 0x04000000 /* bind to the client's IP address when connect()ing */
|
|
#define PR_O_TPXY_CLI 0x06000000 /* bind to the client's IP+port when connect()ing */
|
|
#define PR_O_TPXY_MASK 0x06000000 /* bind to a non-local address when connect()ing */
|
|
|
|
#define PR_O_SERVER_CLO 0x08000000 /* option http-server-close */
|
|
#define PR_O_CONTSTATS 0x10000000 /* continous counters */
|
|
#define PR_O_HTTP_PROXY 0x20000000 /* Enable session to use HTTP proxy operations */
|
|
#define PR_O_DISABLE404 0x40000000 /* Disable a server on a 404 response to a health-check */
|
|
#define PR_O_ORGTO 0x80000000 /* insert x-original-to with destination address */
|
|
|
|
/* bits for proxy->options2 */
|
|
#define PR_O2_SPLIC_REQ 0x00000001 /* transfer requests using linux kernel's splice() */
|
|
#define PR_O2_SPLIC_RTR 0x00000002 /* transfer responses using linux kernel's splice() */
|
|
#define PR_O2_SPLIC_AUT 0x00000004 /* automatically use linux kernel's splice() */
|
|
#define PR_O2_SPLIC_ANY (PR_O2_SPLIC_REQ|PR_O2_SPLIC_RTR|PR_O2_SPLIC_AUT)
|
|
#define PR_O2_REQBUG_OK 0x00000008 /* let buggy requests pass through */
|
|
#define PR_O2_RSPBUG_OK 0x00000010 /* let buggy responses pass through */
|
|
#define PR_O2_NOLOGNORM 0x00000020 /* don't log normal traffic, only errors and retries */
|
|
#define PR_O2_LOGERRORS 0x00000040 /* log errors and retries at level LOG_ERR */
|
|
#define PR_O2_SMARTACC 0x00000080 /* don't immediately ACK request after accept */
|
|
#define PR_O2_SMARTCON 0x00000100 /* don't immediately send empty ACK after connect */
|
|
#define PR_O2_RDPC_PRST 0x00000200 /* Actvate rdp cookie analyser */
|
|
#define PR_O2_CLFLOG 0x00000400 /* log into clf format */
|
|
#define PR_O2_LOGHCHKS 0x00000800 /* log health checks */
|
|
#define PR_O2_INDEPSTR 0x00001000 /* independant streams, don't update rex on write */
|
|
#define PR_O2_SOCKSTAT 0x00002000 /* collect & provide separate statistics for sockets */
|
|
|
|
/* appsession */
|
|
#define PR_O2_AS_REQL 0x00004000 /* learn the session id from the request */
|
|
#define PR_O2_AS_PFX 0x00008000 /* match on the cookie prefix */
|
|
|
|
/* Encoding of appsession cookie matching modes : 2 possible values => 1 bit */
|
|
#define PR_O2_AS_M_PP 0x00000000 /* path-parameters mode (the default mode) */
|
|
#define PR_O2_AS_M_QS 0x00010000 /* query-string mode */
|
|
#define PR_O2_AS_M_ANY 0x00010000 /* mask covering all PR_O2_AS_M_* values */
|
|
|
|
#define PR_O2_MYSQL_CHK 0x00020000 /* use MYSQL check for server health */
|
|
#define PR_O2_USE_PXHDR 0x00040000 /* use Proxy-Connection for proxy requests */
|
|
#define PR_O2_CHK_SNDST 0x00080000 /* send the state of each server along with HTTP health checks */
|
|
/* end of proxy->options2 */
|
|
|
|
/* bits for sticking rules */
|
|
#define STK_IS_MATCH 0x00000001 /* match on request fetch */
|
|
#define STK_IS_STORE 0x00000002 /* store on request fetch */
|
|
#define STK_ON_RSP 0x00000004 /* store on response fetch */
|
|
|
|
struct error_snapshot {
|
|
struct timeval when; /* date of this event, (tv_sec == 0) means "never" */
|
|
unsigned int len; /* original length of the last invalid request/response */
|
|
unsigned int pos; /* position of the first invalid character */
|
|
unsigned int sid; /* ID of the faulty session */
|
|
struct server *srv; /* server associated with the error (or NULL) */
|
|
struct proxy *oe; /* other end = frontend or backend involved */
|
|
struct sockaddr_storage src; /* client's address */
|
|
char buf[BUFSIZE]; /* copy of the beginning of the message */
|
|
};
|
|
|
|
struct proxy {
|
|
struct listener *listen; /* the listen addresses and sockets */
|
|
struct in_addr mon_net, mon_mask; /* don't forward connections from this net (network order) FIXME: should support IPv6 */
|
|
int state; /* proxy state */
|
|
int options; /* PR_O_REDISP, PR_O_TRANSP, ... */
|
|
int options2; /* PR_O2_* */
|
|
unsigned int fe_req_ana, be_req_ana; /* bitmap of common request protocol analysers for the frontend and backend */
|
|
unsigned int fe_rsp_ana, be_rsp_ana; /* bitmap of common response protocol analysers for the frontend and backend */
|
|
int mode; /* mode = PR_MODE_TCP, PR_MODE_HTTP or PR_MODE_HEALTH */
|
|
struct sockaddr_in dispatch_addr; /* the default address to connect to */
|
|
union {
|
|
struct proxy *be; /* default backend, or NULL if none set */
|
|
char *name; /* default backend name during config parse */
|
|
} defbe;
|
|
struct list acl; /* ACL declared on this proxy */
|
|
struct list req_acl; /* request ACL: allow/deny/http-auth */
|
|
struct list block_cond; /* early blocking conditions (chained) */
|
|
struct list redirect_rules; /* content redirecting rules (chained) */
|
|
struct list switching_rules; /* content switching rules (chained) */
|
|
struct list force_persist_rules; /* 'force-persist' rules (chained) */
|
|
struct list sticking_rules; /* content sticking rules (chained) */
|
|
struct list storersp_rules; /* content store response rules (chained) */
|
|
struct { /* TCP request processing */
|
|
unsigned int inspect_delay; /* inspection delay */
|
|
struct list inspect_rules; /* inspection rules */
|
|
} tcp_req;
|
|
int acl_requires; /* Elements required to satisfy all ACLs (ACL_USE_*) */
|
|
struct server *srv, defsrv; /* known servers; default server configuration */
|
|
int srv_act, srv_bck; /* # of servers eligible for LB (UP|!checked) AND (enabled+weight!=0) */
|
|
struct lbprm lbprm; /* load-balancing parameters */
|
|
char *cookie_domain; /* domain used to insert the cookie */
|
|
char *cookie_name; /* name of the cookie to look for */
|
|
int cookie_len; /* strlen(cookie_name), computed only once */
|
|
char *rdp_cookie_name; /* name of the RDP cookie to look for */
|
|
int rdp_cookie_len; /* strlen(rdp_cookie_name), computed only once */
|
|
char *url_param_name; /* name of the URL parameter used for hashing */
|
|
int url_param_len; /* strlen(url_param_name), computed only once */
|
|
unsigned url_param_post_limit; /* if checking POST body for URI parameter, max body to wait for */
|
|
int uri_len_limit; /* character limit for uri balancing algorithm */
|
|
int uri_dirs_depth1; /* directories+1 (slashes) limit for uri balancing algorithm */
|
|
char *hh_name; /* name of the header parameter used for hashing */
|
|
int hh_len; /* strlen(hh_name), computed only once */
|
|
int hh_match_domain; /* toggle use of special match function */
|
|
char *appsession_name; /* name of the cookie to look for */
|
|
int appsession_name_len; /* strlen(appsession_name), computed only once */
|
|
int appsession_len; /* length of the appsession cookie value to be used */
|
|
struct appsession_hash htbl_proxy; /* Per Proxy hashtable */
|
|
char *capture_name; /* beginning of the name of the cookie to capture */
|
|
int capture_namelen; /* length of the cookie name to match */
|
|
int capture_len; /* length of the string to be captured */
|
|
struct uri_auth *uri_auth; /* if non-NULL, the (list of) per-URI authentications */
|
|
char *monitor_uri; /* a special URI to which we respond with HTTP/200 OK */
|
|
int monitor_uri_len; /* length of the string above. 0 if unused */
|
|
struct list mon_fail_cond; /* list of conditions to fail monitoring requests (chained) */
|
|
struct { /* WARNING! check proxy_reset_timeouts() in proxy.h !!! */
|
|
int client; /* client I/O timeout (in ticks) */
|
|
int tarpit; /* tarpit timeout, defaults to connect if unspecified */
|
|
int queue; /* queue timeout, defaults to connect if unspecified */
|
|
int connect; /* connect timeout (in ticks) */
|
|
int server; /* server I/O timeout (in ticks) */
|
|
int appsession; /* appsession cookie expiration */
|
|
int httpreq; /* maximum time for complete HTTP request */
|
|
int httpka; /* maximum time for a new HTTP request when using keep-alive */
|
|
int check; /* maximum time for complete check */
|
|
} timeout;
|
|
char *id, *desc; /* proxy id (name) and description */
|
|
struct list pendconns; /* pending connections with no server assigned yet */
|
|
int nbpend; /* number of pending connections with no server assigned yet */
|
|
int totpend; /* total number of pending connections on this instance (for stats) */
|
|
unsigned int feconn, beconn; /* # of active frontend and backends sessions */
|
|
struct freq_ctr fe_req_per_sec; /* HTTP requests per second on the frontend */
|
|
struct freq_ctr fe_sess_per_sec; /* sessions per second on the frontend */
|
|
struct freq_ctr be_sess_per_sec; /* sessions per second on the backend */
|
|
unsigned int maxconn; /* max # of active sessions on the frontend */
|
|
unsigned int fe_sps_lim; /* limit on new sessions per second on the frontend */
|
|
unsigned int fullconn; /* #conns on backend above which servers are used at full load */
|
|
struct in_addr except_net, except_mask; /* don't x-forward-for for this address. FIXME: should support IPv6 */
|
|
struct in_addr except_to; /* don't x-original-to for this address. */
|
|
struct in_addr except_mask_to; /* the netmask for except_to. */
|
|
char *fwdfor_hdr_name; /* header to use - default: "x-forwarded-for" */
|
|
int fwdfor_hdr_len; /* length of "x-forwarded-for" header */
|
|
char *orgto_hdr_name; /* header to use - default: "x-original-to" */
|
|
int orgto_hdr_len; /* length of "x-original-to" header */
|
|
|
|
unsigned down_trans; /* up-down transitions */
|
|
unsigned down_time; /* total time the proxy was down */
|
|
time_t last_change; /* last time, when the state was changed */
|
|
|
|
int conn_retries; /* maximum number of connect retries */
|
|
int cap; /* supported capabilities (PR_CAP_*) */
|
|
struct sockaddr_in source_addr; /* the address to which we want to bind for connect() */
|
|
#if defined(CONFIG_HAP_CTTPROXY) || defined(CONFIG_HAP_LINUX_TPROXY)
|
|
struct sockaddr_in tproxy_addr; /* non-local address we want to bind to for connect() */
|
|
#endif
|
|
int iface_len; /* bind interface name length */
|
|
char *iface_name; /* bind interface name or NULL */
|
|
struct proxy *next;
|
|
struct logsrv logsrv1, logsrv2; /* 2 syslog servers */
|
|
signed char logfac1, logfac2; /* log facility for both servers. -1 = disabled */
|
|
int loglev1, loglev2; /* log level for each server, 7 by default */
|
|
int minlvl1, minlvl2; /* minimum log level for each server, 0 by default */
|
|
int to_log; /* things to be logged (LW_*) */
|
|
int stop_time; /* date to stop listening, when stopping != 0 (int ticks) */
|
|
struct hdr_exp *req_exp; /* regular expressions for request headers */
|
|
struct hdr_exp *rsp_exp; /* regular expressions for response headers */
|
|
int nb_req_cap, nb_rsp_cap; /* # of headers to be captured */
|
|
struct cap_hdr *req_cap; /* chained list of request headers to be captured */
|
|
struct cap_hdr *rsp_cap; /* chained list of response headers to be captured */
|
|
struct pool_head *req_cap_pool, /* pools of pre-allocated char ** used to build the sessions */
|
|
*rsp_cap_pool;
|
|
struct pool_head *hdr_idx_pool; /* pools of pre-allocated int* used for headers indexing */
|
|
struct list req_add, rsp_add; /* headers to be added */
|
|
struct pxcounters counters; /* statistics counters */
|
|
|
|
struct stktable table; /* table for storing sticking sessions */
|
|
|
|
int grace; /* grace time after stop request */
|
|
char *check_req; /* HTTP or SSL request to use for PR_O_HTTP_CHK|PR_O_SSL3_CHK */
|
|
int check_len; /* Length of the HTTP or SSL3 request */
|
|
struct chunk errmsg[HTTP_ERR_SIZE]; /* default or customized error messages for known errors */
|
|
int uuid; /* universally unique proxy ID, used for SNMP */
|
|
unsigned int backlog; /* force the frontend's listen backlog */
|
|
unsigned int bind_proc; /* bitmask of processes using this proxy. 0 = all. */
|
|
struct error_snapshot invalid_req, invalid_rep; /* captures of last errors */
|
|
|
|
/* used only during configuration parsing */
|
|
int no_options; /* PR_O_REDISP, PR_O_TRANSP, ... */
|
|
int no_options2; /* PR_O2_* */
|
|
|
|
struct {
|
|
const char *file; /* file where the section appears */
|
|
int line; /* line where the section appears */
|
|
struct eb32_node id; /* place in the tree of used IDs */
|
|
struct eb_root used_listener_id;/* list of listener IDs in use */
|
|
struct eb_root used_server_id; /* list of server IDs in use */
|
|
} conf; /* config information */
|
|
};
|
|
|
|
struct switching_rule {
|
|
struct list list; /* list linked to from the proxy */
|
|
struct acl_cond *cond; /* acl condition to meet */
|
|
union {
|
|
struct proxy *backend; /* target backend */
|
|
char *name; /* target backend name during config parsing */
|
|
} be;
|
|
};
|
|
|
|
struct force_persist_rule {
|
|
struct list list; /* list linked to from the proxy */
|
|
struct acl_cond *cond; /* acl condition to meet */
|
|
};
|
|
|
|
struct sticking_rule {
|
|
struct list list; /* list linked to from the proxy */
|
|
struct acl_cond *cond; /* acl condition to meet */
|
|
struct pattern_expr *expr; /* fetch expr to fetch key */
|
|
int flags; /* STK_* */
|
|
union {
|
|
struct stktable *t; /* target table */
|
|
char *name; /* target table name during config parsing */
|
|
} table;
|
|
};
|
|
|
|
|
|
struct redirect_rule {
|
|
struct list list; /* list linked to from the proxy */
|
|
struct acl_cond *cond; /* acl condition to meet */
|
|
int type;
|
|
int rdr_len;
|
|
char *rdr_str;
|
|
int code;
|
|
unsigned int flags;
|
|
int cookie_len;
|
|
char *cookie_str;
|
|
};
|
|
|
|
extern struct proxy *proxy;
|
|
extern struct eb_root used_proxy_id; /* list of proxy IDs in use */
|
|
|
|
#endif /* _TYPES_PROXY_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* c-indent-level: 8
|
|
* c-basic-offset: 8
|
|
* End:
|
|
*/
|