blob: 1618ab40f74457cd3c4c5dc6687ac0d4b7c0422c [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreaudeb9ed82010-01-03 21:03:22 +01002 * include/common/defaults.h
3 * Miscellaneous default values.
4 *
5 * Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020021
Willy Tarreau2dd0d472006-06-29 17:53:05 +020022#ifndef _COMMON_DEFAULTS_H
23#define _COMMON_DEFAULTS_H
Willy Tarreaubaaee002006-06-26 02:48:02 +020024
Willy Tarreaubaaee002006-06-26 02:48:02 +020025/*
26 * BUFSIZE defines the size of a read and write buffer. It is the maximum
Willy Tarreau87b09662015-04-03 00:22:06 +020027 * amount of bytes which can be stored by the proxy for each stream. However,
Willy Tarreaubaaee002006-06-26 02:48:02 +020028 * when reading HTTP headers, the proxy needs some spare space to add or rewrite
29 * headers if needed. The size of this spare is defined with MAXREWRITE. So it
30 * is not possible to process headers longer than BUFSIZE-MAXREWRITE bytes. By
Willy Tarreau27097842015-09-28 13:53:23 +020031 * default, BUFSIZE=16384 bytes and MAXREWRITE=min(1024,BUFSIZE/2), so the
32 * maximum length of headers accepted is 15360 bytes.
Willy Tarreaubaaee002006-06-26 02:48:02 +020033 */
34#ifndef BUFSIZE
35#define BUFSIZE 16384
36#endif
37
Willy Tarreaua24adf02014-11-27 01:11:56 +010038/* certain buffers may only be allocated for responses in order to avoid
39 * deadlocks caused by request queuing. 2 buffers is the absolute minimum
40 * acceptable to ensure that a request gaining access to a server can get
41 * a response buffer even if it doesn't completely flush the request buffer.
42 * The worst case is an applet making use of a request buffer that cannot
43 * completely be sent while the server starts to respond, and all unreserved
44 * buffers are allocated by request buffers from pending connections in the
45 * queue waiting for this one to flush. Both buffers reserved buffers may
46 * thus be used at the same time.
47 */
48#ifndef RESERVED_BUFS
49#define RESERVED_BUFS 2
50#endif
51
Willy Tarreaubaaee002006-06-26 02:48:02 +020052// reserved buffer space for header rewriting
53#ifndef MAXREWRITE
Willy Tarreau27097842015-09-28 13:53:23 +020054#define MAXREWRITE 1024
Willy Tarreaubaaee002006-06-26 02:48:02 +020055#endif
56
Willy Tarreaubf43f6e2013-06-03 15:52:52 +020057#ifndef REQURI_LEN
Willy Tarreaubaaee002006-06-26 02:48:02 +020058#define REQURI_LEN 1024
Willy Tarreaubf43f6e2013-06-03 15:52:52 +020059#endif
60
61#ifndef CAPTURE_LEN
Willy Tarreaubaaee002006-06-26 02:48:02 +020062#define CAPTURE_LEN 64
Willy Tarreaubf43f6e2013-06-03 15:52:52 +020063#endif
Willy Tarreaubaaee002006-06-26 02:48:02 +020064
Willy Tarreau4e957902014-06-27 18:08:49 +020065#ifndef MAX_SYSLOG_LEN
66#define MAX_SYSLOG_LEN 1024
67#endif
68
Krzysztof Piotr Oledzkie6bbd742007-11-01 00:33:12 +010069// maximum line size when parsing config
70#ifndef LINESIZE
71#define LINESIZE 2048
72#endif
73
Willy Tarreaubaaee002006-06-26 02:48:02 +020074// max # args on a configuration line
Krzysztof Piotr Oledzkie6bbd742007-11-01 00:33:12 +010075#define MAX_LINE_ARGS 64
Willy Tarreaubaaee002006-06-26 02:48:02 +020076
Emmanuel Hocdet98263292016-12-29 18:26:15 +010077// maximum line size when parsing crt-bind-list config
78#define CRT_LINESIZE 65536
79
80// max # args on crt-bind-list configuration line
81#define MAX_CRT_ARGS 2048
Emmanuel Hocdet5e0e6e42016-05-13 11:18:50 +020082
Willy Tarreau5ca791d2009-08-16 19:06:42 +020083// max # args on a stats socket
Willy Tarreau47060b62013-08-01 21:11:42 +020084// This should cover at least 5 + twice the # of data_types
85#define MAX_STATS_ARGS 64
Krzysztof Piotr Oledzki2c6962c2008-03-02 02:42:14 +010086
Willy Tarreaubaaee002006-06-26 02:48:02 +020087// max # of matches per regexp
88#define MAX_MATCH 10
89
Willy Tarreaue5f20dc2006-12-03 15:21:35 +010090// max # of headers in one HTTP request or response
Willy Tarreauac1932d2011-10-24 19:14:41 +020091// By default, about 100 headers (+1 for the first line)
Willy Tarreaue5f20dc2006-12-03 15:21:35 +010092#ifndef MAX_HTTP_HDR
Willy Tarreauac1932d2011-10-24 19:14:41 +020093#define MAX_HTTP_HDR 101
Willy Tarreaue5f20dc2006-12-03 15:21:35 +010094#endif
95
Willy Tarreaubce70882009-09-07 11:51:47 +020096// max # of headers in history when looking for header #-X
97#ifndef MAX_HDR_HISTORY
98#define MAX_HDR_HISTORY 10
99#endif
100
Willy Tarreaub4c84932013-07-23 19:15:30 +0200101// max # of stick counters per session (at least 3 for sc0..sc2)
Willy Tarreaub4c84932013-07-23 19:15:30 +0200102#ifndef MAX_SESS_STKCTR
103#define MAX_SESS_STKCTR 3
104#endif
105
Willy Tarreauedee1d62014-07-15 16:44:27 +0200106// max # of extra stick-table data types that can be registred at runtime
107#ifndef STKTABLE_EXTRA_DATA_TYPES
108#define STKTABLE_EXTRA_DATA_TYPES 0
109#endif
110
Willy Tarreaub8949f12007-03-23 22:39:59 +0100111// max # of loops we can perform around a read() which succeeds.
112// It's very frequent that the system returns a few TCP segments at a time.
113#ifndef MAX_READ_POLL_LOOPS
114#define MAX_READ_POLL_LOOPS 4
115#endif
116
Willy Tarreau6f4a82c2009-03-21 20:43:57 +0100117// minimum number of bytes read at once above which we don't try to read
118// more, in order not to risk facing an EAGAIN. Most often, if we read
119// at least 10 kB, we can consider that the system has tried to read a
120// full buffer and got multiple segments (>1 MSS for jumbo frames, >7 MSS
121// for normal frames) did not bother truncating the last segment.
122#ifndef MIN_RECV_AT_ONCE_ENOUGH
123#define MIN_RECV_AT_ONCE_ENOUGH (7*1448)
124#endif
125
Willy Tarreau14acc702011-05-11 20:47:24 +0200126// The minimum number of bytes to be forwarded that is worth trying to splice.
127// Below 4kB, it's not worth allocating pipes nor pretending to zero-copy.
128#ifndef MIN_SPLICE_FORWARD
129#define MIN_SPLICE_FORWARD 4096
130#endif
131
Willy Tarreau1db37712007-06-03 17:16:49 +0200132// the max number of events returned in one call to poll/epoll. Too small a
133// value will cause lots of calls, and too high a value may cause high latency.
134#ifndef MAX_POLL_EVENTS
135#define MAX_POLL_EVENTS 200
136#endif
137
Willy Tarreaubaaee002006-06-26 02:48:02 +0200138// cookie delimitor in "prefix" mode. This character is inserted between the
139// persistence cookie and the original value. The '~' is allowed by RFC2965,
140// and should not be too common in server names.
141#ifndef COOKIE_DELIM
142#define COOKIE_DELIM '~'
143#endif
144
Willy Tarreaubca99692010-10-06 19:25:55 +0200145// this delimitor is used between a server's name and a last visit date in
146// cookies exchanged with the client.
147#ifndef COOKIE_DELIM_DATE
148#define COOKIE_DELIM_DATE '|'
149#endif
150
Willy Tarreaubaaee002006-06-26 02:48:02 +0200151#define CONN_RETRIES 3
152
153#define CHK_CONNTIME 2000
154#define DEF_CHKINTR 2000
Pieter Baauw46af1702016-02-12 14:35:20 +0100155#define DEF_MAILALERTTIME 10000
Willy Tarreaubaaee002006-06-26 02:48:02 +0200156#define DEF_FALLTIME 3
157#define DEF_RISETIME 2
Simon Horman58c32972013-11-25 10:46:38 +0900158#define DEF_AGENT_FALLTIME 1
159#define DEF_AGENT_RISETIME 1
Willy Tarreaue9d87882010-01-27 11:28:42 +0100160#define DEF_CHECK_REQ "OPTIONS / HTTP/1.0\r\n"
Simon Horman98637e52014-06-20 12:30:16 +0900161#define DEF_CHECK_PATH ""
Willy Tarreau23677902007-05-08 23:50:35 +0200162#define DEF_SMTP_CHECK_REQ "HELO localhost\r\n"
Gabor Lekenyb4c81e42010-09-29 18:17:05 +0200163#define DEF_LDAP_CHECK_REQ "\x30\x0c\x02\x01\x01\x60\x07\x02\x01\x03\x04\x00\x80\x00"
Hervé COMMOWICKec032d62011-08-05 16:23:48 +0200164#define DEF_REDIS_CHECK_REQ "*1\r\n$4\r\nPING\r\n"
Willy Tarreaubaaee002006-06-26 02:48:02 +0200165
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100166#define DEF_HANA_ONERR HANA_ONERR_FAILCHK
167#define DEF_HANA_ERRLIMIT 10
168
Ross Westaf72a1d2008-08-03 10:51:45 +0200169// X-Forwarded-For header default
170#define DEF_XFORWARDFOR_HDR "X-Forwarded-For"
171
Maik Broemme2850cb42009-04-17 18:53:21 +0200172// X-Original-To header default
173#define DEF_XORIGINALTO_HDR "X-Original-To"
174
Willy Tarreaubaaee002006-06-26 02:48:02 +0200175/* Default connections limit.
176 *
177 * A system limit can be enforced at build time in order to avoid using haproxy
178 * beyond reasonable system limits. For this, just define SYSTEM_MAXCONN to the
179 * absolute limit accepted by the system. If the configuration specifies a
180 * higher value, it will be capped to SYSTEM_MAXCONN and a warning will be
181 * emitted. The only way to override this limit will be to set it via the
182 * command-line '-n' argument.
183 */
184#ifndef SYSTEM_MAXCONN
Willy Tarreauc9fe4562009-06-15 16:33:36 +0200185#ifndef DEFAULT_MAXCONN
Willy Tarreaubaaee002006-06-26 02:48:02 +0200186#define DEFAULT_MAXCONN 2000
Willy Tarreauc9fe4562009-06-15 16:33:36 +0200187#endif
Willy Tarreaubaaee002006-06-26 02:48:02 +0200188#else
Willy Tarreauc9fe4562009-06-15 16:33:36 +0200189#undef DEFAULT_MAXCONN
Willy Tarreaubaaee002006-06-26 02:48:02 +0200190#define DEFAULT_MAXCONN SYSTEM_MAXCONN
191#endif
192
Willy Tarreau2c43a1e2007-10-14 23:05:39 +0200193/* Minimum check interval for spread health checks. Servers with intervals
194 * greater than or equal to this value will have their checks spread apart
195 * and will be considered when searching the minimal interval.
196 * Others will be ignored for the minimal interval and will have their checks
197 * scheduled on a different basis.
198 */
199#ifndef SRV_CHK_INTER_THRES
200#define SRV_CHK_INTER_THRES 1000
201#endif
202
Krzysztof Oledzkid9db9272007-10-15 10:05:11 +0200203/* Specifies the string used to report the version and release date on the
204 * statistics page. May be defined to the empty string ("") to permanently
205 * disable the feature.
206 */
207#ifndef STATS_VERSION_STRING
208#define STATS_VERSION_STRING " version " HAPROXY_VERSION ", released " HAPROXY_DATE
209#endif
210
Willy Tarreau8f38bd02009-05-10 08:53:33 +0200211/* Maximum signal queue size, and also number of different signals we can
212 * handle.
213 */
214#ifndef MAX_SIGNAL
215#define MAX_SIGNAL 256
216#endif
217
Willy Tarreau3ad6a762009-08-16 10:08:02 +0200218/* Maximum host name length */
219#ifndef MAX_HOSTNAME_LEN
Willy Tarreau75abcb32015-01-14 11:48:58 +0100220#if MAXHOSTNAMELEN
221#define MAX_HOSTNAME_LEN MAXHOSTNAMELEN
222#else
223#define MAX_HOSTNAME_LEN 64
224#endif // MAXHOSTNAMELEN
225#endif // MAX_HOSTNAME_LEN
Willy Tarreau3ad6a762009-08-16 10:08:02 +0200226
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200227/* Maximum health check description length */
228#ifndef HCHK_DESC_LEN
229#define HCHK_DESC_LEN 128
230#endif
231
Emeric Brun76d88952012-10-05 15:47:31 +0200232/* ciphers used as defaults on connect */
233#ifndef CONNECT_DEFAULT_CIPHERS
234#define CONNECT_DEFAULT_CIPHERS NULL
235#endif
236
237/* ciphers used as defaults on listeners */
238#ifndef LISTEN_DEFAULT_CIPHERS
239#define LISTEN_DEFAULT_CIPHERS NULL
240#endif
241
Emeric Brun6924ef82013-03-06 14:08:53 +0100242/* named curve used as defaults for ECDHE ciphers */
243#ifndef ECDHE_DEFAULT_CURVE
244#define ECDHE_DEFAULT_CURVE "prime256v1"
245#endif
246
Emeric Brun46635772012-11-14 11:32:56 +0100247/* ssl cache size */
248#ifndef SSLCACHESIZE
249#define SSLCACHESIZE 20000
250#endif
251
Remi Gacognef46cd6e2014-06-12 14:58:40 +0200252/* ssl max dh param size */
253#ifndef SSL_DEFAULT_DH_PARAM
254#define SSL_DEFAULT_DH_PARAM 0
255#endif
256
Willy Tarreaud92aa5c2015-01-15 21:34:39 +0100257/* max memory cost per SSL session */
258#ifndef SSL_SESSION_MAX_COST
259#define SSL_SESSION_MAX_COST (16*1024) // measured
260#endif
261
262/* max memory cost per SSL handshake (on top of session) */
263#ifndef SSL_HANDSHAKE_MAX_COST
264#define SSL_HANDSHAKE_MAX_COST (76*1024) // measured
265#endif
Willy Tarreaud0256482015-01-15 21:45:22 +0100266
Christopher Faulet31af49d2015-06-09 17:29:50 +0200267#ifndef DEFAULT_SSL_CTX_CACHE
268#define DEFAULT_SSL_CTX_CACHE 1000
269#endif
270
Willy Tarreau87b09662015-04-03 00:22:06 +0200271/* approximate stream size (for maxconn estimate) */
272#ifndef STREAM_MAX_COST
273#define STREAM_MAX_COST (sizeof(struct stream) + \
Willy Tarreaud0256482015-01-15 21:45:22 +0100274 2 * sizeof(struct channel) + \
275 2 * sizeof(struct connection) + \
276 REQURI_LEN + \
277 2 * global.tune.cookie_len)
278#endif
279
280/* available memory estimate : count about 3% of overhead in various structures */
281#ifndef MEM_USABLE_RATIO
282#define MEM_USABLE_RATIO 0.97
Willy Tarreaud92aa5c2015-01-15 21:34:39 +0100283#endif
284
Willy Tarreau4bfc5802014-06-17 12:19:18 +0200285/* Number of samples used to compute the times reported in stats. A power of
286 * two is highly recommended, and this value multiplied by the largest response
287 * time must not overflow and unsigned int. See freq_ctr.h for more information.
288 * We consider that values are accurate to 95% with two batches of samples below,
289 * so in order to advertise accurate times across 1k samples, we effectively
290 * measure over 512.
291 */
292#ifndef TIME_STATS_SAMPLES
293#define TIME_STATS_SAMPLES 512
294#endif
295
Emeric Brun4147b2e2014-06-16 18:36:30 +0200296/* max ocsp cert id asn1 encoded length */
297#ifndef OCSP_MAX_CERTID_ASN1_LENGTH
298#define OCSP_MAX_CERTID_ASN1_LENGTH 128
299#endif
300
Emeric Brunc8b27b62014-06-19 14:16:17 +0200301#ifndef OCSP_MAX_RESPONSE_TIME_SKEW
302#define OCSP_MAX_RESPONSE_TIME_SKEW 300
303#endif
Nenad Merdanovic05552d42015-02-27 19:56:49 +0100304
305/* Number of TLS tickets to check, used for rotation */
306#ifndef TLS_TICKETS_NO
307#define TLS_TICKETS_NO 3
308#endif
Willy Tarreauf3045d22015-04-29 16:24:50 +0200309
310/* pattern lookup default cache size, in number of entries :
311 * 10k entries at 10k req/s mean 1% risk of a collision after 60 years, that's
312 * already much less than the memory's reliability in most machines and more
313 * durable than most admin's life expectancy. A collision will result in a
314 * valid result to be returned for a different entry from the same list.
315 */
316#ifndef DEFAULT_PAT_LRU_SIZE
317#define DEFAULT_PAT_LRU_SIZE 10000
318#endif
319
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200320#endif /* _COMMON_DEFAULTS_H */