blob: 6193bdc73b2f4379315849720fea2037781a25ed [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
31 * default, BUFSIZE=16384 bytes and MAXREWRITE=BUFSIZE/2, so the maximum length
32 * of headers accepted is 8192 bytes, which is in line with Apache's limits.
33 */
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
54#define MAXREWRITE (BUFSIZE / 2)
55#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
Willy Tarreau5ca791d2009-08-16 19:06:42 +020077// max # args on a stats socket
Willy Tarreau47060b62013-08-01 21:11:42 +020078// This should cover at least 5 + twice the # of data_types
79#define MAX_STATS_ARGS 64
Krzysztof Piotr Oledzki2c6962c2008-03-02 02:42:14 +010080
Willy Tarreaubaaee002006-06-26 02:48:02 +020081// max # of matches per regexp
82#define MAX_MATCH 10
83
Willy Tarreaue5f20dc2006-12-03 15:21:35 +010084// max # of headers in one HTTP request or response
Willy Tarreauac1932d2011-10-24 19:14:41 +020085// By default, about 100 headers (+1 for the first line)
Willy Tarreaue5f20dc2006-12-03 15:21:35 +010086#ifndef MAX_HTTP_HDR
Willy Tarreauac1932d2011-10-24 19:14:41 +020087#define MAX_HTTP_HDR 101
Willy Tarreaue5f20dc2006-12-03 15:21:35 +010088#endif
89
Willy Tarreaubce70882009-09-07 11:51:47 +020090// max # of headers in history when looking for header #-X
91#ifndef MAX_HDR_HISTORY
92#define MAX_HDR_HISTORY 10
93#endif
94
Willy Tarreaub4c84932013-07-23 19:15:30 +020095// max # of stick counters per session (at least 3 for sc0..sc2)
Willy Tarreaub4c84932013-07-23 19:15:30 +020096#ifndef MAX_SESS_STKCTR
97#define MAX_SESS_STKCTR 3
98#endif
99
Willy Tarreauedee1d62014-07-15 16:44:27 +0200100// max # of extra stick-table data types that can be registred at runtime
101#ifndef STKTABLE_EXTRA_DATA_TYPES
102#define STKTABLE_EXTRA_DATA_TYPES 0
103#endif
104
Willy Tarreaub8949f12007-03-23 22:39:59 +0100105// max # of loops we can perform around a read() which succeeds.
106// It's very frequent that the system returns a few TCP segments at a time.
107#ifndef MAX_READ_POLL_LOOPS
108#define MAX_READ_POLL_LOOPS 4
109#endif
110
Willy Tarreau6f4a82c2009-03-21 20:43:57 +0100111// minimum number of bytes read at once above which we don't try to read
112// more, in order not to risk facing an EAGAIN. Most often, if we read
113// at least 10 kB, we can consider that the system has tried to read a
114// full buffer and got multiple segments (>1 MSS for jumbo frames, >7 MSS
115// for normal frames) did not bother truncating the last segment.
116#ifndef MIN_RECV_AT_ONCE_ENOUGH
117#define MIN_RECV_AT_ONCE_ENOUGH (7*1448)
118#endif
119
Willy Tarreau14acc702011-05-11 20:47:24 +0200120// The minimum number of bytes to be forwarded that is worth trying to splice.
121// Below 4kB, it's not worth allocating pipes nor pretending to zero-copy.
122#ifndef MIN_SPLICE_FORWARD
123#define MIN_SPLICE_FORWARD 4096
124#endif
125
Willy Tarreau1db37712007-06-03 17:16:49 +0200126// the max number of events returned in one call to poll/epoll. Too small a
127// value will cause lots of calls, and too high a value may cause high latency.
128#ifndef MAX_POLL_EVENTS
129#define MAX_POLL_EVENTS 200
130#endif
131
Willy Tarreaubaaee002006-06-26 02:48:02 +0200132// cookie delimitor in "prefix" mode. This character is inserted between the
133// persistence cookie and the original value. The '~' is allowed by RFC2965,
134// and should not be too common in server names.
135#ifndef COOKIE_DELIM
136#define COOKIE_DELIM '~'
137#endif
138
Willy Tarreaubca99692010-10-06 19:25:55 +0200139// this delimitor is used between a server's name and a last visit date in
140// cookies exchanged with the client.
141#ifndef COOKIE_DELIM_DATE
142#define COOKIE_DELIM_DATE '|'
143#endif
144
Willy Tarreaubaaee002006-06-26 02:48:02 +0200145#define CONN_RETRIES 3
146
147#define CHK_CONNTIME 2000
148#define DEF_CHKINTR 2000
149#define DEF_FALLTIME 3
150#define DEF_RISETIME 2
Simon Horman58c32972013-11-25 10:46:38 +0900151#define DEF_AGENT_FALLTIME 1
152#define DEF_AGENT_RISETIME 1
Willy Tarreaue9d87882010-01-27 11:28:42 +0100153#define DEF_CHECK_REQ "OPTIONS / HTTP/1.0\r\n"
Simon Horman98637e52014-06-20 12:30:16 +0900154#define DEF_CHECK_PATH ""
Willy Tarreau23677902007-05-08 23:50:35 +0200155#define DEF_SMTP_CHECK_REQ "HELO localhost\r\n"
Gabor Lekenyb4c81e42010-09-29 18:17:05 +0200156#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 +0200157#define DEF_REDIS_CHECK_REQ "*1\r\n$4\r\nPING\r\n"
Willy Tarreaubaaee002006-06-26 02:48:02 +0200158
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100159#define DEF_HANA_ONERR HANA_ONERR_FAILCHK
160#define DEF_HANA_ERRLIMIT 10
161
Ross Westaf72a1d2008-08-03 10:51:45 +0200162// X-Forwarded-For header default
163#define DEF_XFORWARDFOR_HDR "X-Forwarded-For"
164
Maik Broemme2850cb42009-04-17 18:53:21 +0200165// X-Original-To header default
166#define DEF_XORIGINALTO_HDR "X-Original-To"
167
Willy Tarreaubaaee002006-06-26 02:48:02 +0200168/* Default connections limit.
169 *
170 * A system limit can be enforced at build time in order to avoid using haproxy
171 * beyond reasonable system limits. For this, just define SYSTEM_MAXCONN to the
172 * absolute limit accepted by the system. If the configuration specifies a
173 * higher value, it will be capped to SYSTEM_MAXCONN and a warning will be
174 * emitted. The only way to override this limit will be to set it via the
175 * command-line '-n' argument.
176 */
177#ifndef SYSTEM_MAXCONN
Willy Tarreauc9fe4562009-06-15 16:33:36 +0200178#ifndef DEFAULT_MAXCONN
Willy Tarreaubaaee002006-06-26 02:48:02 +0200179#define DEFAULT_MAXCONN 2000
Willy Tarreauc9fe4562009-06-15 16:33:36 +0200180#endif
Willy Tarreaubaaee002006-06-26 02:48:02 +0200181#else
Willy Tarreauc9fe4562009-06-15 16:33:36 +0200182#undef DEFAULT_MAXCONN
Willy Tarreaubaaee002006-06-26 02:48:02 +0200183#define DEFAULT_MAXCONN SYSTEM_MAXCONN
184#endif
185
Willy Tarreau2c43a1e2007-10-14 23:05:39 +0200186/* Minimum check interval for spread health checks. Servers with intervals
187 * greater than or equal to this value will have their checks spread apart
188 * and will be considered when searching the minimal interval.
189 * Others will be ignored for the minimal interval and will have their checks
190 * scheduled on a different basis.
191 */
192#ifndef SRV_CHK_INTER_THRES
193#define SRV_CHK_INTER_THRES 1000
194#endif
195
Krzysztof Oledzkid9db9272007-10-15 10:05:11 +0200196/* Specifies the string used to report the version and release date on the
197 * statistics page. May be defined to the empty string ("") to permanently
198 * disable the feature.
199 */
200#ifndef STATS_VERSION_STRING
201#define STATS_VERSION_STRING " version " HAPROXY_VERSION ", released " HAPROXY_DATE
202#endif
203
Willy Tarreau8f38bd02009-05-10 08:53:33 +0200204/* Maximum signal queue size, and also number of different signals we can
205 * handle.
206 */
207#ifndef MAX_SIGNAL
208#define MAX_SIGNAL 256
209#endif
210
Willy Tarreau3ad6a762009-08-16 10:08:02 +0200211/* Maximum host name length */
212#ifndef MAX_HOSTNAME_LEN
Willy Tarreau75abcb32015-01-14 11:48:58 +0100213#if MAXHOSTNAMELEN
214#define MAX_HOSTNAME_LEN MAXHOSTNAMELEN
215#else
216#define MAX_HOSTNAME_LEN 64
217#endif // MAXHOSTNAMELEN
218#endif // MAX_HOSTNAME_LEN
Willy Tarreau3ad6a762009-08-16 10:08:02 +0200219
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200220/* Maximum health check description length */
221#ifndef HCHK_DESC_LEN
222#define HCHK_DESC_LEN 128
223#endif
224
Emeric Brun76d88952012-10-05 15:47:31 +0200225/* ciphers used as defaults on connect */
226#ifndef CONNECT_DEFAULT_CIPHERS
227#define CONNECT_DEFAULT_CIPHERS NULL
228#endif
229
230/* ciphers used as defaults on listeners */
231#ifndef LISTEN_DEFAULT_CIPHERS
232#define LISTEN_DEFAULT_CIPHERS NULL
233#endif
234
Emeric Brun6924ef82013-03-06 14:08:53 +0100235/* named curve used as defaults for ECDHE ciphers */
236#ifndef ECDHE_DEFAULT_CURVE
237#define ECDHE_DEFAULT_CURVE "prime256v1"
238#endif
239
Emeric Brun46635772012-11-14 11:32:56 +0100240/* ssl cache size */
241#ifndef SSLCACHESIZE
242#define SSLCACHESIZE 20000
243#endif
244
Remi Gacognef46cd6e2014-06-12 14:58:40 +0200245/* ssl max dh param size */
246#ifndef SSL_DEFAULT_DH_PARAM
247#define SSL_DEFAULT_DH_PARAM 0
248#endif
249
Willy Tarreaud92aa5c2015-01-15 21:34:39 +0100250/* max memory cost per SSL session */
251#ifndef SSL_SESSION_MAX_COST
252#define SSL_SESSION_MAX_COST (16*1024) // measured
253#endif
254
255/* max memory cost per SSL handshake (on top of session) */
256#ifndef SSL_HANDSHAKE_MAX_COST
257#define SSL_HANDSHAKE_MAX_COST (76*1024) // measured
258#endif
Willy Tarreaud0256482015-01-15 21:45:22 +0100259
Willy Tarreau87b09662015-04-03 00:22:06 +0200260/* approximate stream size (for maxconn estimate) */
261#ifndef STREAM_MAX_COST
262#define STREAM_MAX_COST (sizeof(struct stream) + \
Willy Tarreaud0256482015-01-15 21:45:22 +0100263 2 * sizeof(struct channel) + \
264 2 * sizeof(struct connection) + \
265 REQURI_LEN + \
266 2 * global.tune.cookie_len)
267#endif
268
269/* available memory estimate : count about 3% of overhead in various structures */
270#ifndef MEM_USABLE_RATIO
271#define MEM_USABLE_RATIO 0.97
Willy Tarreaud92aa5c2015-01-15 21:34:39 +0100272#endif
273
Willy Tarreau4bfc5802014-06-17 12:19:18 +0200274/* Number of samples used to compute the times reported in stats. A power of
275 * two is highly recommended, and this value multiplied by the largest response
276 * time must not overflow and unsigned int. See freq_ctr.h for more information.
277 * We consider that values are accurate to 95% with two batches of samples below,
278 * so in order to advertise accurate times across 1k samples, we effectively
279 * measure over 512.
280 */
281#ifndef TIME_STATS_SAMPLES
282#define TIME_STATS_SAMPLES 512
283#endif
284
Emeric Brun4147b2e2014-06-16 18:36:30 +0200285/* max ocsp cert id asn1 encoded length */
286#ifndef OCSP_MAX_CERTID_ASN1_LENGTH
287#define OCSP_MAX_CERTID_ASN1_LENGTH 128
288#endif
289
Emeric Brunc8b27b62014-06-19 14:16:17 +0200290#ifndef OCSP_MAX_RESPONSE_TIME_SKEW
291#define OCSP_MAX_RESPONSE_TIME_SKEW 300
292#endif
Nenad Merdanovic05552d42015-02-27 19:56:49 +0100293
294/* Number of TLS tickets to check, used for rotation */
295#ifndef TLS_TICKETS_NO
296#define TLS_TICKETS_NO 3
297#endif
Willy Tarreauf3045d22015-04-29 16:24:50 +0200298
299/* pattern lookup default cache size, in number of entries :
300 * 10k entries at 10k req/s mean 1% risk of a collision after 60 years, that's
301 * already much less than the memory's reliability in most machines and more
302 * durable than most admin's life expectancy. A collision will result in a
303 * valid result to be returned for a different entry from the same list.
304 */
305#ifndef DEFAULT_PAT_LRU_SIZE
306#define DEFAULT_PAT_LRU_SIZE 10000
307#endif
308
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200309#endif /* _COMMON_DEFAULTS_H */