blob: 0f7d198597b3d90335129a34a88e22bcd6237958 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * Health-checks functions.
3 *
Willy Tarreau26c25062009-03-08 09:38:41 +01004 * Copyright 2000-2009 Willy Tarreau <w@1wt.eu>
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +02005 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
Willy Tarreaubaaee002006-06-26 02:48:02 +02006 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
Willy Tarreaub8816082008-01-18 12:18:15 +010014#include <assert.h>
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +020015#include <ctype.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020016#include <errno.h>
Simon Horman0ba0e4a2015-01-30 11:23:00 +090017#include <stdarg.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020018#include <stdio.h>
Krzysztof Oledzkib304dc72007-10-14 23:40:01 +020019#include <stdlib.h>
Willy Tarreau2dd0d472006-06-29 17:53:05 +020020#include <string.h>
Krzysztof Oledzkib304dc72007-10-14 23:40:01 +020021#include <time.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020022#include <unistd.h>
Willy Tarreau9f6dc722019-03-01 11:15:10 +010023#include <sys/resource.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020024#include <sys/socket.h>
Dmitry Sivachenkocaf58982009-08-24 15:11:06 +040025#include <sys/types.h>
Simon Horman98637e52014-06-20 12:30:16 +090026#include <sys/wait.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020027#include <netinet/in.h>
Willy Tarreau1274bc42009-07-15 07:16:31 +020028#include <netinet/tcp.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020029#include <arpa/inet.h>
30
Willy Tarreau122eba92020-06-04 10:15:32 +020031#include <haproxy/action.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020032#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/arg.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020034#include <haproxy/cfgparse.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020036#include <haproxy/chunk.h>
Willy Tarreau7c18b542020-06-11 09:23:02 +020037#include <haproxy/dgram.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020038#include <haproxy/dynbuf.h>
Willy Tarreaubcc67332020-06-05 15:31:31 +020039#include <haproxy/extcheck.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/global.h>
42#include <haproxy/h1.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020043#include <haproxy/http.h>
Willy Tarreau87735332020-06-04 09:08:41 +020044#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020045#include <haproxy/htx.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020046#include <haproxy/istbuf.h>
47#include <haproxy/list.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020048#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020049#include <haproxy/mailers.h>
50#include <haproxy/port_range.h>
51#include <haproxy/proto_tcp.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020052#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020053#include <haproxy/proxy.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020054#include <haproxy/queue.h>
55#include <haproxy/regex.h>
Emeric Brunc9437992021-02-12 19:42:55 +010056#include <haproxy/resolvers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020057#include <haproxy/sample.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020058#include <haproxy/server.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020059#include <haproxy/ssl_sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020060#include <haproxy/stats-t.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020061#include <haproxy/task.h>
Willy Tarreau51cd5952020-06-05 12:25:38 +020062#include <haproxy/tcpcheck.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020063#include <haproxy/thread.h>
64#include <haproxy/time.h>
65#include <haproxy/tools.h>
Christopher Faulet147b8c92021-04-10 09:00:38 +020066#include <haproxy/trace.h>
Willy Tarreaua1718922020-06-04 16:25:31 +020067#include <haproxy/vars.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020068
Christopher Faulet147b8c92021-04-10 09:00:38 +020069/* trace source and events */
70static void check_trace(enum trace_level level, uint64_t mask,
71 const struct trace_source *src,
72 const struct ist where, const struct ist func,
73 const void *a1, const void *a2, const void *a3, const void *a4);
74
75/* The event representation is split like this :
76 * check - check
77 *
78 * CHECK_EV_* macros are defined in <haproxy/check.h>
79 */
80static const struct trace_event check_trace_events[] = {
81 { .mask = CHK_EV_TASK_WAKE, .name = "task_wake", .desc = "Check task woken up" },
82 { .mask = CHK_EV_HCHK_START, .name = "hchck_start", .desc = "Health-check started" },
83 { .mask = CHK_EV_HCHK_WAKE, .name = "hchck_wake", .desc = "Health-check woken up" },
84 { .mask = CHK_EV_HCHK_RUN, .name = "hchck_run", .desc = "Health-check running" },
85 { .mask = CHK_EV_HCHK_END, .name = "hchck_end", .desc = "Health-check terminated" },
86 { .mask = CHK_EV_HCHK_SUCC, .name = "hchck_succ", .desc = "Health-check success" },
87 { .mask = CHK_EV_HCHK_ERR, .name = "hchck_err", .desc = "Health-check failure" },
88
89 { .mask = CHK_EV_TCPCHK_EVAL, .name = "tcp_check_eval", .desc = "tcp-check rules evaluation" },
90 { .mask = CHK_EV_TCPCHK_ERR, .name = "tcp_check_err", .desc = "tcp-check evaluation error" },
91 { .mask = CHK_EV_TCPCHK_CONN, .name = "tcp_check_conn", .desc = "tcp-check connection rule" },
92 { .mask = CHK_EV_TCPCHK_SND, .name = "tcp_check_send", .desc = "tcp-check send rule" },
93 { .mask = CHK_EV_TCPCHK_EXP, .name = "tcp_check_expect", .desc = "tcp-check expect rule" },
94 { .mask = CHK_EV_TCPCHK_ACT, .name = "tcp_check_action", .desc = "tcp-check action rule" },
95
96 { .mask = CHK_EV_RX_DATA, .name = "rx_data", .desc = "receipt of data" },
97 { .mask = CHK_EV_RX_BLK, .name = "rx_blk", .desc = "receipt blocked" },
98 { .mask = CHK_EV_RX_ERR, .name = "rx_err", .desc = "receipt error" },
99
100 { .mask = CHK_EV_TX_DATA, .name = "tx_data", .desc = "transmission of data" },
101 { .mask = CHK_EV_TX_BLK, .name = "tx_blk", .desc = "transmission blocked" },
102 { .mask = CHK_EV_TX_ERR, .name = "tx_err", .desc = "transmission error" },
103
104 {}
105};
106
107static const struct name_desc check_trace_lockon_args[4] = {
108 /* arg1 */ { /* already used by the check */ },
109 /* arg2 */ { },
110 /* arg3 */ { },
111 /* arg4 */ { }
112};
113
114static const struct name_desc check_trace_decoding[] = {
115#define CHK_VERB_CLEAN 1
116 { .name="clean", .desc="only user-friendly stuff, generally suitable for level \"user\"" },
117#define CHK_VERB_MINIMAL 2
Willy Tarreau4596fe22022-05-17 19:07:51 +0200118 { .name="minimal", .desc="report info on streams and connectors" },
Christopher Faulet147b8c92021-04-10 09:00:38 +0200119#define CHK_VERB_SIMPLE 3
120 { .name="simple", .desc="add info on request and response channels" },
121#define CHK_VERB_ADVANCED 4
122 { .name="advanced", .desc="add info on channel's buffer for data and developer levels only" },
123#define CHK_VERB_COMPLETE 5
124 { .name="complete", .desc="add info on channel's buffer" },
125 { /* end */ }
126};
127
128struct trace_source trace_check = {
129 .name = IST("check"),
130 .desc = "Health-check",
131 .arg_def = TRC_ARG1_CHK, // TRACE()'s first argument is always a stream
132 .default_cb = check_trace,
133 .known_events = check_trace_events,
134 .lockon_args = check_trace_lockon_args,
135 .decoding = check_trace_decoding,
136 .report_events = ~0, // report everything by default
137};
138
139#define TRACE_SOURCE &trace_check
140INITCALL1(STG_REGISTER, trace_register_source, TRACE_SOURCE);
141
Olivier Houchard9130a962017-10-17 17:33:43 +0200142
Gaetan Rivet05d692d2020-02-14 17:42:54 +0100143/* Dummy frontend used to create all checks sessions. */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200144struct proxy checks_fe;
Christopher Faulet31dff9b2017-10-23 15:45:20 +0200145
Christopher Faulet147b8c92021-04-10 09:00:38 +0200146
147static inline void check_trace_buf(const struct buffer *buf, size_t ofs, size_t len)
148{
149 size_t block1, block2;
150 int line, ptr, newptr;
151
152 block1 = b_contig_data(buf, ofs);
153 block2 = 0;
154 if (block1 > len)
155 block1 = len;
156 block2 = len - block1;
157
158 ofs = b_peek_ofs(buf, ofs);
159
160 line = 0;
161 ptr = ofs;
162 while (ptr < ofs + block1) {
163 newptr = dump_text_line(&trace_buf, b_orig(buf), b_size(buf), ofs + block1, &line, ptr);
164 if (newptr == ptr)
165 break;
166 ptr = newptr;
167 }
168
169 line = ptr = 0;
170 while (ptr < block2) {
171 newptr = dump_text_line(&trace_buf, b_orig(buf), b_size(buf), block2, &line, ptr);
172 if (newptr == ptr)
173 break;
174 ptr = newptr;
175 }
176}
177
178/* trace source and events */
179static void check_trace(enum trace_level level, uint64_t mask,
180 const struct trace_source *src,
181 const struct ist where, const struct ist func,
182 const void *a1, const void *a2, const void *a3, const void *a4)
183{
184 const struct check *check = a1;
185 const struct server *srv = (check ? check->server : NULL);
186 const size_t *val = a4;
187 const char *res;
188
189 if (!check || src->verbosity < CHK_VERB_CLEAN)
190 return;
191
Christopher Faulet4f1825c2022-06-08 09:12:58 +0200192 if (srv) {
193 chunk_appendf(&trace_buf, " : [%c] SRV=%s",
194 ((check->type == PR_O2_EXT_CHK) ? 'E' : (check->state & CHK_ST_AGENT ? 'A' : 'H')),
195 srv->id);
Christopher Faulet147b8c92021-04-10 09:00:38 +0200196
Christopher Faulet4f1825c2022-06-08 09:12:58 +0200197 chunk_appendf(&trace_buf, " status=%d/%d %s",
198 (check->health >= check->rise) ? check->health - check->rise + 1 : check->health,
199 (check->health >= check->rise) ? check->fall : check->rise,
200 (check->health >= check->rise) ? (srv->uweight ? "UP" : "DRAIN") : "DOWN");
201 }
202 else
203 chunk_appendf(&trace_buf, " : [EMAIL]");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200204
205 switch (check->result) {
206 case CHK_RES_NEUTRAL: res = "-"; break;
207 case CHK_RES_FAILED: res = "FAIL"; break;
208 case CHK_RES_PASSED: res = "PASS"; break;
209 case CHK_RES_CONDPASS: res = "COND"; break;
210 default: res = "UNK"; break;
211 }
212
213 if (src->verbosity == CHK_VERB_CLEAN)
214 return;
215
216 chunk_appendf(&trace_buf, " - last=%s(%d)/%s(%d)",
217 get_check_status_info(check->status), check->status,
218 res, check->result);
219
220 /* Display the value to the 4th argument (level > STATE) */
221 if (src->level > TRACE_LEVEL_STATE && val)
222 chunk_appendf(&trace_buf, " - VAL=%lu", (long)*val);
223
224 chunk_appendf(&trace_buf, " check=%p(0x%08x)", check, check->state);
225
226 if (src->verbosity == CHK_VERB_MINIMAL)
227 return;
228
229
Willy Tarreaubde14ad2022-05-27 10:04:04 +0200230 if (check->sc) {
231 struct connection *conn = sc_conn(check->sc);
Christopher Faulet0256da12021-12-15 09:50:17 +0100232
233 chunk_appendf(&trace_buf, " - conn=%p(0x%08x)", conn, conn ? conn->flags : 0);
Willy Tarreaubde14ad2022-05-27 10:04:04 +0200234 chunk_appendf(&trace_buf, " sc=%p(0x%08x)", check->sc, check->sc->flags);
Christopher Faulet147b8c92021-04-10 09:00:38 +0200235 }
236
237 if (mask & CHK_EV_TCPCHK) {
238 const char *type;
239
240 switch (check->tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK) {
241 case TCPCHK_RULES_PGSQL_CHK: type = "PGSQL"; break;
242 case TCPCHK_RULES_REDIS_CHK: type = "REDIS"; break;
243 case TCPCHK_RULES_SMTP_CHK: type = "SMTP"; break;
244 case TCPCHK_RULES_HTTP_CHK: type = "HTTP"; break;
245 case TCPCHK_RULES_MYSQL_CHK: type = "MYSQL"; break;
246 case TCPCHK_RULES_LDAP_CHK: type = "LDAP"; break;
247 case TCPCHK_RULES_SSL3_CHK: type = "SSL3"; break;
248 case TCPCHK_RULES_AGENT_CHK: type = "AGENT"; break;
249 case TCPCHK_RULES_SPOP_CHK: type = "SPOP"; break;
250 case TCPCHK_RULES_TCP_CHK: type = "TCP"; break;
251 default: type = "???"; break;
252 }
253 if (check->current_step)
254 chunk_appendf(&trace_buf, " - tcp-check=(%s,%d)", type, tcpcheck_get_step_id(check, NULL));
255 else
256 chunk_appendf(&trace_buf, " - tcp-check=(%s,-)", type);
257 }
258
259 /* Display bi and bo buffer info (level > USER & verbosity > SIMPLE) */
260 if (src->level > TRACE_LEVEL_USER) {
261 const struct buffer *buf = NULL;
262
263 chunk_appendf(&trace_buf, " bi=%u@%p+%u/%u",
264 (unsigned int)b_data(&check->bi), b_orig(&check->bi),
265 (unsigned int)b_head_ofs(&check->bi), (unsigned int)b_size(&check->bi));
266 chunk_appendf(&trace_buf, " bo=%u@%p+%u/%u",
267 (unsigned int)b_data(&check->bo), b_orig(&check->bo),
268 (unsigned int)b_head_ofs(&check->bo), (unsigned int)b_size(&check->bo));
269
270 if (src->verbosity >= CHK_VERB_ADVANCED && (mask & (CHK_EV_RX)))
271 buf = (b_is_null(&check->bi) ? NULL : &check->bi);
272 else if (src->verbosity >= CHK_VERB_ADVANCED && (mask & (CHK_EV_TX)))
273 buf = (b_is_null(&check->bo) ? NULL : &check->bo);
274
275 if (buf) {
276 if ((check->tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK) == TCPCHK_RULES_HTTP_CHK) {
277 int full = (src->verbosity == CHK_VERB_COMPLETE);
278
279 chunk_memcat(&trace_buf, "\n\t", 2);
280 htx_dump(&trace_buf, htxbuf(buf), full);
281 }
282 else {
283 int max = ((src->verbosity == CHK_VERB_COMPLETE) ? 1024 : 256);
284
285 chunk_memcat(&trace_buf, "\n", 1);
286 if (b_data(buf) > max) {
287 check_trace_buf(buf, 0, max);
288 chunk_memcat(&trace_buf, " ...\n", 6);
289 }
290 else
291 check_trace_buf(buf, 0, b_data(buf));
292 }
293
294 }
295 }
296
297}
298
299
Christopher Faulet61cc8522020-04-20 14:54:42 +0200300/**************************************************************************/
301/************************ Handle check results ****************************/
302/**************************************************************************/
303struct check_status {
304 short result; /* one of SRV_CHK_* */
305 char *info; /* human readable short info */
306 char *desc; /* long description */
307};
308
309struct analyze_status {
310 char *desc; /* description */
311 unsigned char lr[HANA_OBS_SIZE]; /* result for l4/l7: 0 = ignore, 1 - error, 2 - OK */
312};
313
Simon Horman63a4a822012-03-19 07:24:41 +0900314static const struct check_status check_statuses[HCHK_STATUS_SIZE] = {
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100315 [HCHK_STATUS_UNKNOWN] = { CHK_RES_UNKNOWN, "UNK", "Unknown" },
316 [HCHK_STATUS_INI] = { CHK_RES_UNKNOWN, "INI", "Initializing" },
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200317 [HCHK_STATUS_START] = { /* SPECIAL STATUS*/ },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200318
Willy Tarreau23964182014-05-20 20:56:30 +0200319 /* Below we have finished checks */
320 [HCHK_STATUS_CHECKED] = { CHK_RES_NEUTRAL, "CHECKED", "No status change" },
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100321 [HCHK_STATUS_HANA] = { CHK_RES_FAILED, "HANA", "Health analyze" },
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100322
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100323 [HCHK_STATUS_SOCKERR] = { CHK_RES_FAILED, "SOCKERR", "Socket error" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200324
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100325 [HCHK_STATUS_L4OK] = { CHK_RES_PASSED, "L4OK", "Layer4 check passed" },
326 [HCHK_STATUS_L4TOUT] = { CHK_RES_FAILED, "L4TOUT", "Layer4 timeout" },
327 [HCHK_STATUS_L4CON] = { CHK_RES_FAILED, "L4CON", "Layer4 connection problem" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200328
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100329 [HCHK_STATUS_L6OK] = { CHK_RES_PASSED, "L6OK", "Layer6 check passed" },
330 [HCHK_STATUS_L6TOUT] = { CHK_RES_FAILED, "L6TOUT", "Layer6 timeout" },
331 [HCHK_STATUS_L6RSP] = { CHK_RES_FAILED, "L6RSP", "Layer6 invalid response" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200332
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100333 [HCHK_STATUS_L7TOUT] = { CHK_RES_FAILED, "L7TOUT", "Layer7 timeout" },
334 [HCHK_STATUS_L7RSP] = { CHK_RES_FAILED, "L7RSP", "Layer7 invalid response" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200335
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200336 [HCHK_STATUS_L57DATA] = { /* DUMMY STATUS */ },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200337
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100338 [HCHK_STATUS_L7OKD] = { CHK_RES_PASSED, "L7OK", "Layer7 check passed" },
339 [HCHK_STATUS_L7OKCD] = { CHK_RES_CONDPASS, "L7OKC", "Layer7 check conditionally passed" },
340 [HCHK_STATUS_L7STS] = { CHK_RES_FAILED, "L7STS", "Layer7 wrong status" },
Simon Horman98637e52014-06-20 12:30:16 +0900341
342 [HCHK_STATUS_PROCERR] = { CHK_RES_FAILED, "PROCERR", "External check error" },
343 [HCHK_STATUS_PROCTOUT] = { CHK_RES_FAILED, "PROCTOUT", "External check timeout" },
Cyril Bonté77010d82014-08-07 01:55:37 +0200344 [HCHK_STATUS_PROCOK] = { CHK_RES_PASSED, "PROCOK", "External check passed" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200345};
346
Simon Horman63a4a822012-03-19 07:24:41 +0900347static const struct analyze_status analyze_statuses[HANA_STATUS_SIZE] = { /* 0: ignore, 1: error, 2: OK */
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100348 [HANA_STATUS_UNKNOWN] = { "Unknown", { 0, 0 }},
349
350 [HANA_STATUS_L4_OK] = { "L4 successful connection", { 2, 0 }},
351 [HANA_STATUS_L4_ERR] = { "L4 unsuccessful connection", { 1, 1 }},
352
353 [HANA_STATUS_HTTP_OK] = { "Correct http response", { 0, 2 }},
354 [HANA_STATUS_HTTP_STS] = { "Wrong http response", { 0, 1 }},
355 [HANA_STATUS_HTTP_HDRRSP] = { "Invalid http response (headers)", { 0, 1 }},
356 [HANA_STATUS_HTTP_RSP] = { "Invalid http response", { 0, 1 }},
357
358 [HANA_STATUS_HTTP_READ_ERROR] = { "Read error (http)", { 0, 1 }},
359 [HANA_STATUS_HTTP_READ_TIMEOUT] = { "Read timeout (http)", { 0, 1 }},
360 [HANA_STATUS_HTTP_BROKEN_PIPE] = { "Close from server (http)", { 0, 1 }},
361};
362
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100363/* checks if <err> is a real error for errno or one that can be ignored, and
364 * return 0 for these ones or <err> for real ones.
365 */
366static inline int unclean_errno(int err)
367{
Willy Tarreauacef5e22022-04-25 20:32:15 +0200368 if (err == EAGAIN || err == EWOULDBLOCK || err == EINPROGRESS ||
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100369 err == EISCONN || err == EALREADY)
370 return 0;
371 return err;
372}
373
Christopher Faulet7aa32712021-02-01 13:11:50 +0100374/* Converts check_status code to result code */
375short get_check_status_result(short check_status)
376{
377 if (check_status < HCHK_STATUS_SIZE)
378 return check_statuses[check_status].result;
379 else
380 return check_statuses[HCHK_STATUS_UNKNOWN].result;
381}
382
Christopher Faulet61cc8522020-04-20 14:54:42 +0200383/* Converts check_status code to description */
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200384const char *get_check_status_description(short check_status) {
385
386 const char *desc;
387
388 if (check_status < HCHK_STATUS_SIZE)
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200389 desc = check_statuses[check_status].desc;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200390 else
391 desc = NULL;
392
393 if (desc && *desc)
394 return desc;
395 else
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200396 return check_statuses[HCHK_STATUS_UNKNOWN].desc;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200397}
398
Christopher Faulet61cc8522020-04-20 14:54:42 +0200399/* Converts check_status code to short info */
William Dauchyb26122b2021-02-14 22:26:23 +0100400const char *get_check_status_info(short check_status)
401{
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200402 const char *info;
403
404 if (check_status < HCHK_STATUS_SIZE)
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200405 info = check_statuses[check_status].info;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200406 else
407 info = NULL;
408
409 if (info && *info)
410 return info;
411 else
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200412 return check_statuses[HCHK_STATUS_UNKNOWN].info;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200413}
414
Christopher Faulet61cc8522020-04-20 14:54:42 +0200415/* Convert analyze_status to description */
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100416const char *get_analyze_status(short analyze_status) {
417
418 const char *desc;
419
420 if (analyze_status < HANA_STATUS_SIZE)
421 desc = analyze_statuses[analyze_status].desc;
422 else
423 desc = NULL;
424
425 if (desc && *desc)
426 return desc;
427 else
428 return analyze_statuses[HANA_STATUS_UNKNOWN].desc;
429}
430
Christopher Faulet61cc8522020-04-20 14:54:42 +0200431/* Sets check->status, update check->duration and fill check->result with an
432 * adequate CHK_RES_* value. The new check->health is computed based on the
433 * result.
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200434 *
Christopher Faulet61cc8522020-04-20 14:54:42 +0200435 * Shows information in logs about failed health check if server is UP or
436 * succeeded health checks if server is DOWN.
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200437 */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200438void set_server_check_status(struct check *check, short status, const char *desc)
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100439{
Simon Horman4a741432013-02-23 15:35:38 +0900440 struct server *s = check->server;
Willy Tarreaubef1b322014-05-13 21:01:39 +0200441 short prev_status = check->status;
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200442 int report = 0;
Simon Horman4a741432013-02-23 15:35:38 +0900443
Christopher Faulet147b8c92021-04-10 09:00:38 +0200444 TRACE_POINT(CHK_EV_HCHK_RUN, check);
445
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200446 if (status == HCHK_STATUS_START) {
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100447 check->result = CHK_RES_UNKNOWN; /* no result yet */
Simon Horman4a741432013-02-23 15:35:38 +0900448 check->desc[0] = '\0';
449 check->start = now;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200450 return;
451 }
452
Simon Horman4a741432013-02-23 15:35:38 +0900453 if (!check->status)
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200454 return;
455
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200456 if (desc && *desc) {
Simon Horman4a741432013-02-23 15:35:38 +0900457 strncpy(check->desc, desc, HCHK_DESC_LEN-1);
458 check->desc[HCHK_DESC_LEN-1] = '\0';
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200459 } else
Simon Horman4a741432013-02-23 15:35:38 +0900460 check->desc[0] = '\0';
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200461
Simon Horman4a741432013-02-23 15:35:38 +0900462 check->status = status;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200463 if (check_statuses[status].result)
Simon Horman4a741432013-02-23 15:35:38 +0900464 check->result = check_statuses[status].result;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200465
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100466 if (status == HCHK_STATUS_HANA)
Simon Horman4a741432013-02-23 15:35:38 +0900467 check->duration = -1;
468 else if (!tv_iszero(&check->start)) {
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200469 /* set_server_check_status() may be called more than once */
Simon Horman4a741432013-02-23 15:35:38 +0900470 check->duration = tv_ms_elapsed(&check->start, &now);
471 tv_zero(&check->start);
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200472 }
473
Willy Tarreau23964182014-05-20 20:56:30 +0200474 /* no change is expected if no state change occurred */
475 if (check->result == CHK_RES_NEUTRAL)
476 return;
477
Olivier Houchard0923fa42019-01-11 18:43:04 +0100478 /* If the check was really just sending a mail, it won't have an
479 * associated server, so we're done now.
480 */
481 if (!s)
482 return;
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200483 report = 0;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200484
Christopher Faulet147b8c92021-04-10 09:00:38 +0200485
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200486 switch (check->result) {
487 case CHK_RES_FAILED:
Willy Tarreau12634e12014-05-23 11:32:36 +0200488 /* Failure to connect to the agent as a secondary check should not
489 * cause the server to be marked down.
490 */
491 if ((!(check->state & CHK_ST_AGENT) ||
Simon Hormaneaabd522015-02-26 11:26:17 +0900492 (check->status >= HCHK_STATUS_L57DATA)) &&
Christopher Fauletb119a792018-05-02 12:12:45 +0200493 (check->health > 0)) {
Willy Tarreau4781b152021-04-06 13:53:36 +0200494 _HA_ATOMIC_INC(&s->counters.failed_checks);
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200495 report = 1;
496 check->health--;
497 if (check->health < check->rise)
498 check->health = 0;
499 }
500 break;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200501
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200502 case CHK_RES_PASSED:
Christopher Faulet1e527cb2020-11-20 18:13:02 +0100503 case CHK_RES_CONDPASS:
504 if (check->health < check->rise + check->fall - 1) {
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200505 report = 1;
506 check->health++;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200507
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200508 if (check->health >= check->rise)
509 check->health = check->rise + check->fall - 1; /* OK now */
510 }
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200511
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200512 /* clear consecutive_errors if observing is enabled */
513 if (s->onerror)
Aurelien DARRAGON81b7c952022-12-07 14:27:42 +0100514 HA_ATOMIC_STORE(&s->consecutive_errors, 0);
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200515 break;
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100516
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200517 default:
518 break;
519 }
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200520
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200521 if (s->proxy->options2 & PR_O2_LOGHCHKS &&
522 (status != prev_status || report)) {
523 chunk_printf(&trash,
Willy Tarreau12634e12014-05-23 11:32:36 +0200524 "%s check for %sserver %s/%s %s%s",
525 (check->state & CHK_ST_AGENT) ? "Agent" : "Health",
Willy Tarreauc93cd162014-05-13 15:54:22 +0200526 s->flags & SRV_F_BACKUP ? "backup " : "",
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100527 s->proxy->id, s->id,
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100528 (check->result == CHK_RES_CONDPASS) ? "conditionally ":"",
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200529 (check->result >= CHK_RES_PASSED) ? "succeeded" : "failed");
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200530
Emeric Brun5a133512017-10-19 14:42:30 +0200531 srv_append_status(&trash, s, check, -1, 0);
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200532
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100533 chunk_appendf(&trash, ", status: %d/%d %s",
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200534 (check->health >= check->rise) ? check->health - check->rise + 1 : check->health,
535 (check->health >= check->rise) ? check->fall : check->rise,
536 (check->health >= check->rise) ? (s->uweight ? "UP" : "DRAIN") : "DOWN");
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200537
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200538 ha_warning("%s.\n", trash.area);
539 send_log(s->proxy, LOG_NOTICE, "%s.\n", trash.area);
540 send_email_alert(s, LOG_INFO, "%s", trash.area);
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200541 }
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200542}
543
Willy Tarreau4eec5472014-05-20 22:32:27 +0200544/* Marks the check <check>'s server down if the current check is already failed
545 * and the server is not down yet nor in maintenance.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200546 */
Willy Tarreaubcc67332020-06-05 15:31:31 +0200547void check_notify_failure(struct check *check)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200548{
Simon Horman4a741432013-02-23 15:35:38 +0900549 struct server *s = check->server;
Simon Hormane0d1bfb2011-06-21 14:34:58 +0900550
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200551 /* The agent secondary check should only cause a server to be marked
552 * as down if check->status is HCHK_STATUS_L7STS, which indicates
553 * that the agent returned "fail", "stopped" or "down".
554 * The implication here is that failure to connect to the agent
555 * as a secondary check should not cause the server to be marked
556 * down. */
557 if ((check->state & CHK_ST_AGENT) && check->status != HCHK_STATUS_L7STS)
558 return;
559
Willy Tarreau4eec5472014-05-20 22:32:27 +0200560 if (check->health > 0)
561 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100562
Christopher Faulet147b8c92021-04-10 09:00:38 +0200563 TRACE_STATE("health-check failed, set server DOWN", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau4eec5472014-05-20 22:32:27 +0200564 /* We only report a reason for the check if we did not do so previously */
Emeric Brun5a133512017-10-19 14:42:30 +0200565 srv_set_stopped(s, NULL, (!s->track && !(s->proxy->options2 & PR_O2_LOGHCHKS)) ? check : NULL);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200566}
567
Willy Tarreauaf549582014-05-16 17:37:50 +0200568/* Marks the check <check> as valid and tries to set its server up, provided
Willy Tarreau3e048382014-05-21 10:30:54 +0200569 * it isn't in maintenance, it is not tracking a down server and other checks
570 * comply. The rule is simple : by default, a server is up, unless any of the
571 * following conditions is true :
572 * - health check failed (check->health < rise)
573 * - agent check failed (agent->health < rise)
574 * - the server tracks a down server (track && track->state == STOPPED)
575 * Note that if the server has a slowstart, it will switch to STARTING instead
576 * of RUNNING. Also, only the health checks support the nolb mode, so the
577 * agent's success may not take the server out of this mode.
Willy Tarreauaf549582014-05-16 17:37:50 +0200578 */
Willy Tarreaubcc67332020-06-05 15:31:31 +0200579void check_notify_success(struct check *check)
Willy Tarreauaf549582014-05-16 17:37:50 +0200580{
Simon Horman4a741432013-02-23 15:35:38 +0900581 struct server *s = check->server;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100582
Emeric Brun52a91d32017-08-31 14:41:55 +0200583 if (s->next_admin & SRV_ADMF_MAINT)
Willy Tarreauaf549582014-05-16 17:37:50 +0200584 return;
Cyril Bontécd19e512010-01-31 22:34:03 +0100585
Emeric Brun52a91d32017-08-31 14:41:55 +0200586 if (s->track && s->track->next_state == SRV_ST_STOPPED)
Willy Tarreauaf549582014-05-16 17:37:50 +0200587 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100588
Willy Tarreau3e048382014-05-21 10:30:54 +0200589 if ((s->check.state & CHK_ST_ENABLED) && (s->check.health < s->check.rise))
590 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100591
Willy Tarreau3e048382014-05-21 10:30:54 +0200592 if ((s->agent.state & CHK_ST_ENABLED) && (s->agent.health < s->agent.rise))
593 return;
Willy Tarreauaf549582014-05-16 17:37:50 +0200594
Emeric Brun52a91d32017-08-31 14:41:55 +0200595 if ((check->state & CHK_ST_AGENT) && s->next_state == SRV_ST_STOPPING)
Willy Tarreau3e048382014-05-21 10:30:54 +0200596 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100597
Christopher Faulet147b8c92021-04-10 09:00:38 +0200598 TRACE_STATE("health-check succeeded, set server RUNNING", CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
Emeric Brun5a133512017-10-19 14:42:30 +0200599 srv_set_running(s, NULL, (!s->track && !(s->proxy->options2 & PR_O2_LOGHCHKS)) ? check : NULL);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100600}
601
Willy Tarreaudb58b792014-05-21 13:57:23 +0200602/* Marks the check <check> as valid and tries to set its server into stopping mode
603 * if it was running or starting, and provided it isn't in maintenance and other
604 * checks comply. The conditions for the server to be marked in stopping mode are
605 * the same as for it to be turned up. Also, only the health checks support the
606 * nolb mode.
Willy Tarreauaf549582014-05-16 17:37:50 +0200607 */
Willy Tarreaubcc67332020-06-05 15:31:31 +0200608void check_notify_stopping(struct check *check)
Willy Tarreauaf549582014-05-16 17:37:50 +0200609{
Simon Horman4a741432013-02-23 15:35:38 +0900610 struct server *s = check->server;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100611
Emeric Brun52a91d32017-08-31 14:41:55 +0200612 if (s->next_admin & SRV_ADMF_MAINT)
Willy Tarreauaf549582014-05-16 17:37:50 +0200613 return;
614
Willy Tarreaudb58b792014-05-21 13:57:23 +0200615 if (check->state & CHK_ST_AGENT)
616 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100617
Emeric Brun52a91d32017-08-31 14:41:55 +0200618 if (s->track && s->track->next_state == SRV_ST_STOPPED)
Willy Tarreaudb58b792014-05-21 13:57:23 +0200619 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100620
Willy Tarreaudb58b792014-05-21 13:57:23 +0200621 if ((s->check.state & CHK_ST_ENABLED) && (s->check.health < s->check.rise))
622 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100623
Willy Tarreaudb58b792014-05-21 13:57:23 +0200624 if ((s->agent.state & CHK_ST_ENABLED) && (s->agent.health < s->agent.rise))
625 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100626
Christopher Faulet147b8c92021-04-10 09:00:38 +0200627 TRACE_STATE("health-check condionnaly succeeded, set server STOPPING", CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
Willy Tarreaub26881a2017-12-23 11:16:49 +0100628 srv_set_stopping(s, NULL, (!s->track && !(s->proxy->options2 & PR_O2_LOGHCHKS)) ? check : NULL);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100629}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200630
Willy Tarreau9fe7aae2013-12-31 23:47:37 +0100631/* note: use health_adjust() only, which first checks that the observe mode is
Willy Tarreau4e9df272021-02-17 15:20:19 +0100632 * enabled. This will take the server lock if needed.
Willy Tarreau9fe7aae2013-12-31 23:47:37 +0100633 */
634void __health_adjust(struct server *s, short status)
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100635{
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100636 int failed;
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100637
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100638 if (s->observe >= HANA_OBS_SIZE)
639 return;
640
Willy Tarreaubb956662013-01-24 00:37:39 +0100641 if (status >= HANA_STATUS_SIZE || !analyze_statuses[status].desc)
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100642 return;
643
644 switch (analyze_statuses[status].lr[s->observe - 1]) {
645 case 1:
646 failed = 1;
647 break;
648
649 case 2:
650 failed = 0;
651 break;
652
653 default:
654 return;
655 }
656
657 if (!failed) {
658 /* good: clear consecutive_errors */
Aurelien DARRAGON81b7c952022-12-07 14:27:42 +0100659 HA_ATOMIC_STORE(&s->consecutive_errors, 0);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100660 return;
661 }
662
Aurelien DARRAGON81b7c952022-12-07 14:27:42 +0100663 if (HA_ATOMIC_ADD_FETCH(&s->consecutive_errors, 1) < s->consecutive_errors_limit)
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100664 return;
665
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100666 chunk_printf(&trash, "Detected %d consecutive errors, last one was: %s",
Aurelien DARRAGON81b7c952022-12-07 14:27:42 +0100667 HA_ATOMIC_LOAD(&s->consecutive_errors), get_analyze_status(status));
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100668
Willy Tarreau4e9df272021-02-17 15:20:19 +0100669 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
670
Aurelien DARRAGON7d541a92022-12-07 12:17:24 +0100671 /* force fastinter for upcoming check
672 * (does nothing if fastinter is not enabled)
673 */
674 s->check.state |= CHK_ST_FASTINTER;
675
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100676 switch (s->onerror) {
677 case HANA_ONERR_FASTINTER:
678 /* force fastinter - nothing to do here as all modes force it */
679 break;
680
681 case HANA_ONERR_SUDDTH:
682 /* simulate a pre-fatal failed health check */
Simon Horman58c32972013-11-25 10:46:38 +0900683 if (s->check.health > s->check.rise)
684 s->check.health = s->check.rise + 1;
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100685
Willy Tarreau36a73432022-11-14 07:31:36 +0100686 __fallthrough;
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100687
688 case HANA_ONERR_FAILCHK:
689 /* simulate a failed health check */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200690 set_server_check_status(&s->check, HCHK_STATUS_HANA,
691 trash.area);
Willy Tarreau4eec5472014-05-20 22:32:27 +0200692 check_notify_failure(&s->check);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100693 break;
694
695 case HANA_ONERR_MARKDWN:
696 /* mark server down */
Simon Horman58c32972013-11-25 10:46:38 +0900697 s->check.health = s->check.rise;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200698 set_server_check_status(&s->check, HCHK_STATUS_HANA,
699 trash.area);
Willy Tarreau4eec5472014-05-20 22:32:27 +0200700 check_notify_failure(&s->check);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100701 break;
702
703 default:
704 /* write a warning? */
705 break;
706 }
707
Willy Tarreau4e9df272021-02-17 15:20:19 +0100708 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
709
Aurelien DARRAGON81b7c952022-12-07 14:27:42 +0100710 HA_ATOMIC_STORE(&s->consecutive_errors, 0);
Willy Tarreau4781b152021-04-06 13:53:36 +0200711 _HA_ATOMIC_INC(&s->counters.failed_hana);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100712
Willy Tarreaua56798e2022-12-06 11:38:18 +0100713 if (s->check.fastinter) {
714 /* timer might need to be advanced, it might also already be
715 * running in another thread. Let's just wake the task up, it
716 * will automatically adjust its timer.
717 */
718 task_wakeup(s->check.task, TASK_WOKEN_MSG);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100719 }
Willy Tarreauef781042010-01-27 11:53:01 +0100720}
721
Christopher Faulet61cc8522020-04-20 14:54:42 +0200722/* Checks the connection. If an error has already been reported or the socket is
Willy Tarreau20a18342013-12-05 00:31:46 +0100723 * closed, keep errno intact as it is supposed to contain the valid error code.
724 * If no error is reported, check the socket's error queue using getsockopt().
725 * Warning, this must be done only once when returning from poll, and never
726 * after an I/O error was attempted, otherwise the error queue might contain
727 * inconsistent errors. If an error is detected, the CO_FL_ERROR is set on the
728 * socket. Returns non-zero if an error was reported, zero if everything is
729 * clean (including a properly closed socket).
730 */
731static int retrieve_errno_from_socket(struct connection *conn)
732{
733 int skerr;
734 socklen_t lskerr = sizeof(skerr);
735
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100736 if (conn->flags & CO_FL_ERROR && (unclean_errno(errno) || !conn->ctrl))
Willy Tarreau20a18342013-12-05 00:31:46 +0100737 return 1;
738
Willy Tarreau3c728722014-01-23 13:50:42 +0100739 if (!conn_ctrl_ready(conn))
Willy Tarreau20a18342013-12-05 00:31:46 +0100740 return 0;
741
Willy Tarreau07ecfc52022-04-11 18:07:03 +0200742 BUG_ON(conn->flags & CO_FL_FDLESS);
743
Willy Tarreau585744b2017-08-24 14:31:19 +0200744 if (getsockopt(conn->handle.fd, SOL_SOCKET, SO_ERROR, &skerr, &lskerr) == 0)
Willy Tarreau20a18342013-12-05 00:31:46 +0100745 errno = skerr;
746
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100747 errno = unclean_errno(errno);
Willy Tarreau20a18342013-12-05 00:31:46 +0100748
749 if (!errno) {
750 /* we could not retrieve an error, that does not mean there is
751 * none. Just don't change anything and only report the prior
752 * error if any.
753 */
754 if (conn->flags & CO_FL_ERROR)
755 return 1;
756 else
757 return 0;
758 }
759
760 conn->flags |= CO_FL_ERROR | CO_FL_SOCK_WR_SH | CO_FL_SOCK_RD_SH;
761 return 1;
762}
763
Christopher Faulet61cc8522020-04-20 14:54:42 +0200764/* Tries to collect as much information as possible on the connection status,
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100765 * and adjust the server status accordingly. It may make use of <errno_bck>
766 * if non-null when the caller is absolutely certain of its validity (eg:
767 * checked just after a syscall). If the caller doesn't have a valid errno,
768 * it can pass zero, and retrieve_errno_from_socket() will be called to try
769 * to extract errno from the socket. If no error is reported, it will consider
770 * the <expired> flag. This is intended to be used when a connection error was
771 * reported in conn->flags or when a timeout was reported in <expired>. The
772 * function takes care of not updating a server status which was already set.
773 * All situations where at least one of <expired> or CO_FL_ERROR are set
774 * produce a status.
775 */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200776void chk_report_conn_err(struct check *check, int errno_bck, int expired)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100777{
Willy Tarreaubde14ad2022-05-27 10:04:04 +0200778 struct stconn *sc = check->sc;
779 struct connection *conn = sc_conn(sc);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100780 const char *err_msg;
Willy Tarreau83061a82018-07-13 11:56:34 +0200781 struct buffer *chk;
Willy Tarreau213c6782014-10-02 14:51:02 +0200782 int step;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100783
Christopher Faulet147b8c92021-04-10 09:00:38 +0200784 if (check->result != CHK_RES_UNKNOWN) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100785 return;
Christopher Faulet147b8c92021-04-10 09:00:38 +0200786 }
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100787
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100788 errno = unclean_errno(errno_bck);
789 if (conn && errno)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100790 retrieve_errno_from_socket(conn);
791
Christopher Faulete4b40192022-06-13 07:59:46 +0200792 if (conn && !(conn->flags & CO_FL_ERROR) && !sc_ep_test(sc, SE_FL_ERROR) && !expired)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100793 return;
794
Christopher Faulet147b8c92021-04-10 09:00:38 +0200795 TRACE_ENTER(CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check, 0, 0, (size_t[]){expired});
796
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100797 /* we'll try to build a meaningful error message depending on the
798 * context of the error possibly present in conn->err_code, and the
799 * socket error possibly collected above. This is useful to know the
800 * exact step of the L6 layer (eg: SSL handshake).
801 */
Baptiste Assmann5ecb77f2013-10-06 23:24:13 +0200802 chk = get_trash_chunk();
803
Christopher Faulet799f3a42020-04-07 12:06:14 +0200804 if (check->type == PR_O2_TCPCHK_CHK &&
Christopher Fauletd7e63962020-04-17 20:15:59 +0200805 (check->tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK) == TCPCHK_RULES_TCP_CHK) {
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200806 step = tcpcheck_get_step_id(check, NULL);
Christopher Faulet147b8c92021-04-10 09:00:38 +0200807 if (!step) {
808 TRACE_DEVEL("initial connection failure", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200809 chunk_printf(chk, " at initial connection step of tcp-check");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200810 }
Willy Tarreau213c6782014-10-02 14:51:02 +0200811 else {
812 chunk_printf(chk, " at step %d of tcp-check", step);
813 /* we were looking for a string */
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200814 if (check->current_step && check->current_step->action == TCPCHK_ACT_CONNECT) {
815 if (check->current_step->connect.port)
816 chunk_appendf(chk, " (connect port %d)" ,check->current_step->connect.port);
Willy Tarreau213c6782014-10-02 14:51:02 +0200817 else
818 chunk_appendf(chk, " (connect)");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200819 TRACE_DEVEL("connection failure", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200820 }
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200821 else if (check->current_step && check->current_step->action == TCPCHK_ACT_EXPECT) {
822 struct tcpcheck_expect *expect = &check->current_step->expect;
Gaetan Rivetb616add2020-02-07 15:37:17 +0100823
824 switch (expect->type) {
825 case TCPCHK_EXPECT_STRING:
Christopher Fauletb61caf42020-04-21 10:57:42 +0200826 chunk_appendf(chk, " (expect string '%.*s')", (unsigned int)istlen(expect->data), istptr(expect->data));
Gaetan Rivetb616add2020-02-07 15:37:17 +0100827 break;
828 case TCPCHK_EXPECT_BINARY:
Christopher Fauletb61caf42020-04-21 10:57:42 +0200829 chunk_appendf(chk, " (expect binary '%.*s')", (unsigned int)istlen(expect->data), istptr(expect->data));
Gaetan Rivetb616add2020-02-07 15:37:17 +0100830 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200831 case TCPCHK_EXPECT_STRING_REGEX:
Willy Tarreau213c6782014-10-02 14:51:02 +0200832 chunk_appendf(chk, " (expect regex)");
Gaetan Rivetb616add2020-02-07 15:37:17 +0100833 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200834 case TCPCHK_EXPECT_BINARY_REGEX:
Gaetan Rivetefab6c62020-02-07 15:37:17 +0100835 chunk_appendf(chk, " (expect binary regex)");
836 break;
Christopher Fauletaaab0832020-05-05 15:54:22 +0200837 case TCPCHK_EXPECT_STRING_LF:
838 chunk_appendf(chk, " (expect log-format string)");
839 break;
840 case TCPCHK_EXPECT_BINARY_LF:
841 chunk_appendf(chk, " (expect log-format binary)");
842 break;
Christopher Faulete5870d82020-04-15 11:32:03 +0200843 case TCPCHK_EXPECT_HTTP_STATUS:
Christopher Faulet8021a5f2020-04-24 13:53:12 +0200844 chunk_appendf(chk, " (expect HTTP status codes)");
Christopher Faulete5870d82020-04-15 11:32:03 +0200845 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200846 case TCPCHK_EXPECT_HTTP_STATUS_REGEX:
Christopher Faulete5870d82020-04-15 11:32:03 +0200847 chunk_appendf(chk, " (expect HTTP status regex)");
848 break;
Christopher Faulet39708192020-05-05 10:47:36 +0200849 case TCPCHK_EXPECT_HTTP_HEADER:
850 chunk_appendf(chk, " (expect HTTP header pattern)");
851 break;
Christopher Faulete5870d82020-04-15 11:32:03 +0200852 case TCPCHK_EXPECT_HTTP_BODY:
Christopher Fauletb61caf42020-04-21 10:57:42 +0200853 chunk_appendf(chk, " (expect HTTP body content '%.*s')", (unsigned int)istlen(expect->data), istptr(expect->data));
Christopher Faulete5870d82020-04-15 11:32:03 +0200854 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200855 case TCPCHK_EXPECT_HTTP_BODY_REGEX:
Christopher Faulete5870d82020-04-15 11:32:03 +0200856 chunk_appendf(chk, " (expect HTTP body regex)");
857 break;
Christopher Fauletaaab0832020-05-05 15:54:22 +0200858 case TCPCHK_EXPECT_HTTP_BODY_LF:
859 chunk_appendf(chk, " (expect log-format HTTP body)");
860 break;
Christopher Faulet9e6ed152020-04-03 15:24:06 +0200861 case TCPCHK_EXPECT_CUSTOM:
862 chunk_appendf(chk, " (expect custom function)");
863 break;
Gaetan Rivetb616add2020-02-07 15:37:17 +0100864 case TCPCHK_EXPECT_UNDEF:
865 chunk_appendf(chk, " (undefined expect!)");
866 break;
867 }
Christopher Faulet147b8c92021-04-10 09:00:38 +0200868 TRACE_DEVEL("expect rule failed", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200869 }
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200870 else if (check->current_step && check->current_step->action == TCPCHK_ACT_SEND) {
Willy Tarreau213c6782014-10-02 14:51:02 +0200871 chunk_appendf(chk, " (send)");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200872 TRACE_DEVEL("send rule failed", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200873 }
Baptiste Assmann22b09d22015-05-01 08:03:04 +0200874
Christopher Faulet6f2a5e42020-04-01 13:11:41 +0200875 if (check->current_step && check->current_step->comment)
876 chunk_appendf(chk, " comment: '%s'", check->current_step->comment);
Baptiste Assmann5ecb77f2013-10-06 23:24:13 +0200877 }
878 }
879
Willy Tarreau00149122017-10-04 18:05:01 +0200880 if (conn && conn->err_code) {
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100881 if (unclean_errno(errno))
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200882 chunk_printf(&trash, "%s (%s)%s", conn_err_code_str(conn), strerror(errno),
883 chk->area);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100884 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200885 chunk_printf(&trash, "%s%s", conn_err_code_str(conn),
886 chk->area);
887 err_msg = trash.area;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100888 }
889 else {
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100890 if (unclean_errno(errno)) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200891 chunk_printf(&trash, "%s%s", strerror(errno),
892 chk->area);
893 err_msg = trash.area;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100894 }
895 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200896 err_msg = chk->area;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100897 }
898 }
899
Willy Tarreau00149122017-10-04 18:05:01 +0200900 if (check->state & CHK_ST_PORT_MISS) {
Baptiste Assmann95db2bc2016-06-13 14:15:41 +0200901 /* NOTE: this is reported after <fall> tries */
Baptiste Assmann95db2bc2016-06-13 14:15:41 +0200902 set_server_check_status(check, HCHK_STATUS_SOCKERR, err_msg);
903 }
904
Christopher Faulete4b40192022-06-13 07:59:46 +0200905 if (!conn || !conn->ctrl) {
Christopher Faulet5e293762020-10-26 11:10:49 +0100906 /* error before any connection attempt (connection allocation error or no control layer) */
Willy Tarreau00149122017-10-04 18:05:01 +0200907 set_server_check_status(check, HCHK_STATUS_SOCKERR, err_msg);
908 }
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100909 else if (conn->flags & CO_FL_WAIT_L4_CONN) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100910 /* L4 not established (yet) */
Willy Tarreaubde14ad2022-05-27 10:04:04 +0200911 if (conn->flags & CO_FL_ERROR || sc_ep_test(sc, SE_FL_ERROR))
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100912 set_server_check_status(check, HCHK_STATUS_L4CON, err_msg);
913 else if (expired)
914 set_server_check_status(check, HCHK_STATUS_L4TOUT, err_msg);
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200915
916 /*
917 * might be due to a server IP change.
918 * Let's trigger a DNS resolution if none are currently running.
919 */
Olivier Houchard0923fa42019-01-11 18:43:04 +0100920 if (check->server)
Emeric Brund30e9a12020-12-23 18:49:16 +0100921 resolv_trigger_resolution(check->server->resolv_requester);
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200922
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100923 }
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100924 else if (conn->flags & CO_FL_WAIT_L6_CONN) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100925 /* L6 not established (yet) */
Willy Tarreaubde14ad2022-05-27 10:04:04 +0200926 if (conn->flags & CO_FL_ERROR || sc_ep_test(sc, SE_FL_ERROR))
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100927 set_server_check_status(check, HCHK_STATUS_L6RSP, err_msg);
928 else if (expired)
929 set_server_check_status(check, HCHK_STATUS_L6TOUT, err_msg);
930 }
Willy Tarreaubde14ad2022-05-27 10:04:04 +0200931 else if (conn->flags & CO_FL_ERROR || sc_ep_test(sc, SE_FL_ERROR)) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100932 /* I/O error after connection was established and before we could diagnose */
933 set_server_check_status(check, HCHK_STATUS_SOCKERR, err_msg);
934 }
935 else if (expired) {
Christopher Fauletcf80f2f2020-04-01 11:04:52 +0200936 enum healthcheck_status tout = HCHK_STATUS_L7TOUT;
937
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100938 /* connection established but expired check */
Christopher Faulet1941bab2020-05-05 07:55:50 +0200939 if (check->current_step && check->current_step->action == TCPCHK_ACT_EXPECT &&
940 check->current_step->expect.tout_status != HCHK_STATUS_UNKNOWN)
Christopher Faulet811f78c2020-04-01 11:10:27 +0200941 tout = check->current_step->expect.tout_status;
942 set_server_check_status(check, tout, err_msg);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100943 }
944
Christopher Faulet147b8c92021-04-10 09:00:38 +0200945 TRACE_LEAVE(CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100946 return;
947}
948
Simon Horman98637e52014-06-20 12:30:16 +0900949
Christopher Faulet61cc8522020-04-20 14:54:42 +0200950/* Builds the server state header used by HTTP health-checks */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200951int httpchk_build_status_header(struct server *s, struct buffer *buf)
Simon Horman98637e52014-06-20 12:30:16 +0900952{
Christopher Faulet61cc8522020-04-20 14:54:42 +0200953 int sv_state;
954 int ratio;
955 char addr[46];
956 char port[6];
957 const char *srv_hlt_st[7] = { "DOWN", "DOWN %d/%d",
958 "UP %d/%d", "UP",
959 "NOLB %d/%d", "NOLB",
960 "no check" };
Simon Horman98637e52014-06-20 12:30:16 +0900961
Christopher Faulet61cc8522020-04-20 14:54:42 +0200962 if (!(s->check.state & CHK_ST_ENABLED))
963 sv_state = 6;
964 else if (s->cur_state != SRV_ST_STOPPED) {
965 if (s->check.health == s->check.rise + s->check.fall - 1)
966 sv_state = 3; /* UP */
967 else
968 sv_state = 2; /* going down */
Simon Horman98637e52014-06-20 12:30:16 +0900969
Christopher Faulet61cc8522020-04-20 14:54:42 +0200970 if (s->cur_state == SRV_ST_STOPPING)
971 sv_state += 2;
972 } else {
973 if (s->check.health)
974 sv_state = 1; /* going up */
975 else
976 sv_state = 0; /* DOWN */
Simon Horman98637e52014-06-20 12:30:16 +0900977 }
Willy Tarreaub7b24782016-06-21 15:32:29 +0200978
Christopher Faulet61cc8522020-04-20 14:54:42 +0200979 chunk_appendf(buf, srv_hlt_st[sv_state],
980 (s->cur_state != SRV_ST_STOPPED) ? (s->check.health - s->check.rise + 1) : (s->check.health),
981 (s->cur_state != SRV_ST_STOPPED) ? (s->check.fall) : (s->check.rise));
Willy Tarreaub7b24782016-06-21 15:32:29 +0200982
Christopher Faulet61cc8522020-04-20 14:54:42 +0200983 addr_to_str(&s->addr, addr, sizeof(addr));
984 if (s->addr.ss_family == AF_INET || s->addr.ss_family == AF_INET6)
985 snprintf(port, sizeof(port), "%u", s->svc_port);
986 else
987 *port = 0;
Willy Tarreaub7b24782016-06-21 15:32:29 +0200988
Christopher Faulet61cc8522020-04-20 14:54:42 +0200989 chunk_appendf(buf, "; address=%s; port=%s; name=%s/%s; node=%s; weight=%d/%d; scur=%d/%d; qcur=%d",
990 addr, port, s->proxy->id, s->id,
991 global.node,
992 (s->cur_eweight * s->proxy->lbprm.wmult + s->proxy->lbprm.wdiv - 1) / s->proxy->lbprm.wdiv,
993 (s->proxy->lbprm.tot_weight * s->proxy->lbprm.wmult + s->proxy->lbprm.wdiv - 1) / s->proxy->lbprm.wdiv,
Willy Tarreau7f3c1df2021-06-18 09:22:21 +0200994 s->cur_sess, s->proxy->beconn - s->proxy->queue.length,
Willy Tarreaua0570452021-06-18 09:30:30 +0200995 s->queue.length);
Willy Tarreau9f6dc722019-03-01 11:15:10 +0100996
Christopher Faulet61cc8522020-04-20 14:54:42 +0200997 if ((s->cur_state == SRV_ST_STARTING) &&
998 now.tv_sec < s->last_change + s->slowstart &&
999 now.tv_sec >= s->last_change) {
1000 ratio = MAX(1, 100 * (now.tv_sec - s->last_change) / s->slowstart);
1001 chunk_appendf(buf, "; throttle=%d%%", ratio);
1002 }
Christopher Fauletaaae9a02020-04-26 09:50:31 +02001003
Christopher Faulet61cc8522020-04-20 14:54:42 +02001004 return b_data(buf);
1005}
Christopher Fauletaaae9a02020-04-26 09:50:31 +02001006
Willy Tarreau51cd5952020-06-05 12:25:38 +02001007/**************************************************************************/
Willy Tarreau51cd5952020-06-05 12:25:38 +02001008/***************** Health-checks based on connections *********************/
1009/**************************************************************************/
1010/* This function is used only for server health-checks. It handles connection
1011 * status updates including errors. If necessary, it wakes the check task up.
1012 * It returns 0 on normal cases, <0 if at least one close() has happened on the
1013 * connection (eg: reconnect). It relies on tcpcheck_main().
Christopher Faulet61cc8522020-04-20 14:54:42 +02001014 */
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001015int wake_srv_chk(struct stconn *sc)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001016{
Christopher Faulet0256da12021-12-15 09:50:17 +01001017 struct connection *conn;
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001018 struct check *check = __sc_check(sc);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001019 struct email_alertq *q = container_of(check, typeof(*q), check);
1020 int ret = 0;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001021
Christopher Faulet147b8c92021-04-10 09:00:38 +02001022 TRACE_ENTER(CHK_EV_HCHK_WAKE, check);
Christopher Faulet08c8f8e2022-05-18 14:35:49 +02001023 if (check->result != CHK_RES_UNKNOWN)
1024 goto end;
1025
Willy Tarreau51cd5952020-06-05 12:25:38 +02001026 if (check->server)
1027 HA_SPIN_LOCK(SERVER_LOCK, &check->server->lock);
1028 else
1029 HA_SPIN_LOCK(EMAIL_ALERTS_LOCK, &q->lock);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001030
Willy Tarreau51cd5952020-06-05 12:25:38 +02001031 /* we may have to make progress on the TCP checks */
1032 ret = tcpcheck_main(check);
Christopher Fauletaaab0832020-05-05 15:54:22 +02001033
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001034 sc = check->sc;
1035 conn = sc_conn(sc);
Christopher Fauletaaab0832020-05-05 15:54:22 +02001036
Christopher Faulete4b40192022-06-13 07:59:46 +02001037 if (unlikely(!conn || conn->flags & CO_FL_ERROR || sc_ep_test(sc, SE_FL_ERROR))) {
Willy Tarreau51cd5952020-06-05 12:25:38 +02001038 /* We may get error reports bypassing the I/O handlers, typically
1039 * the case when sending a pure TCP check which fails, then the I/O
1040 * handlers above are not called. This is completely handled by the
1041 * main processing task so let's simply wake it up. If we get here,
1042 * we expect errno to still be valid.
1043 */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001044 TRACE_ERROR("report connection error", CHK_EV_HCHK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001045 chk_report_conn_err(check, errno, 0);
1046 task_wakeup(check->task, TASK_WOKEN_IO);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001047 }
1048
Christopher Faulet8f100422021-01-18 15:47:03 +01001049 if (check->result != CHK_RES_UNKNOWN || ret == -1) {
Christopher Faulet08c8f8e2022-05-18 14:35:49 +02001050 /* Check complete or aborted. Wake the check task up to be sure
1051 * the result is handled ASAP. */
Willy Tarreau51cd5952020-06-05 12:25:38 +02001052 ret = -1;
Willy Tarreau51cd5952020-06-05 12:25:38 +02001053 task_wakeup(check->task, TASK_WOKEN_IO);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001054 }
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001055
Willy Tarreau51cd5952020-06-05 12:25:38 +02001056 if (check->server)
1057 HA_SPIN_UNLOCK(SERVER_LOCK, &check->server->lock);
1058 else
1059 HA_SPIN_UNLOCK(EMAIL_ALERTS_LOCK, &q->lock);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001060
Christopher Faulet08c8f8e2022-05-18 14:35:49 +02001061 end:
Christopher Faulet147b8c92021-04-10 09:00:38 +02001062 TRACE_LEAVE(CHK_EV_HCHK_WAKE, check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001063 return ret;
1064}
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001065
Willy Tarreau51cd5952020-06-05 12:25:38 +02001066/* This function checks if any I/O is wanted, and if so, attempts to do so */
Christopher Faulet361417f2022-05-18 14:50:30 +02001067struct task *srv_chk_io_cb(struct task *t, void *ctx, unsigned int state)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001068{
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001069 struct stconn *sc = ctx;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001070
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001071 wake_srv_chk(sc);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001072 return NULL;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001073}
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001074
Willy Tarreau51cd5952020-06-05 12:25:38 +02001075/* manages a server health-check that uses a connection. Returns
1076 * the time the task accepts to wait, or TIME_ETERNITY for infinity.
Christopher Faulet61cc8522020-04-20 14:54:42 +02001077 *
1078 * Please do NOT place any return statement in this function and only leave
Willy Tarreau51cd5952020-06-05 12:25:38 +02001079 * via the out_unlock label.
Christopher Faulet61cc8522020-04-20 14:54:42 +02001080 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001081struct task *process_chk_conn(struct task *t, void *context, unsigned int state)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001082{
Willy Tarreau51cd5952020-06-05 12:25:38 +02001083 struct check *check = context;
1084 struct proxy *proxy = check->proxy;
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001085 struct stconn *sc;
Christopher Faulet92017a32021-05-06 16:01:18 +02001086 struct connection *conn;
Willy Tarreau51cd5952020-06-05 12:25:38 +02001087 int rv;
1088 int expired = tick_is_expired(t->expire, now_ms);
Willy Tarreaudeccd112018-06-14 18:38:55 +02001089
Christopher Faulet147b8c92021-04-10 09:00:38 +02001090 TRACE_ENTER(CHK_EV_TASK_WAKE, check);
1091
Willy Tarreaud114f4a2022-10-12 20:58:18 +02001092 if (check->state & CHK_ST_SLEEPING) {
1093 /* This check just restarted. It's still time to verify if
1094 * we're on an overloaded thread or if a more suitable one is
1095 * available. This helps spread the load over the available
1096 * threads, without migrating too often. For this we'll check
1097 * our load, and pick a random thread, check if it has less
1098 * than half of the current thread's load, and if so we'll
1099 * bounce the task there. It's possible because it's not yet
1100 * tied to the current thread. The other thread will not bounce
1101 * the task again because we're removing CHK_ST_SLEEPING.
1102 */
1103 uint my_load = HA_ATOMIC_LOAD(&th_ctx->rq_total);
1104
1105 check->state &= ~CHK_ST_SLEEPING;
1106
1107 if (my_load >= 2) {
1108 uint new_tid = statistical_prng_range(global.nbthread);
1109 uint new_load = HA_ATOMIC_LOAD(&ha_thread_ctx[new_tid].rq_total);
1110
1111 if (new_load <= my_load / 2) {
1112 /* Found one. Let's migrate the task over there. We have to
1113 * remove it from the WQ first and kill its expire time
1114 * otherwise the scheduler will reinsert it and trigger a
1115 * BUG_ON() as we're not allowed to call task_queue() for a
1116 * foreign thread. The recipient will restore the expiration.
1117 */
1118 task_unlink_wq(t);
1119 t->expire = TICK_ETERNITY;
1120 task_set_thread(t, new_tid);
1121 task_wakeup(t, TASK_WOKEN_MSG);
1122 TRACE_LEAVE(CHK_EV_TASK_WAKE, check);
1123 return t;
1124 }
1125 }
1126 }
1127
Willy Tarreau51cd5952020-06-05 12:25:38 +02001128 if (check->server)
1129 HA_SPIN_LOCK(SERVER_LOCK, &check->server->lock);
Christopher Faulet92017a32021-05-06 16:01:18 +02001130
Willy Tarreaud114f4a2022-10-12 20:58:18 +02001131 if (!(check->state & (CHK_ST_INPROGRESS|CHK_ST_IN_ALLOC|CHK_ST_OUT_ALLOC))) {
1132 /* This task might have bounced from another overloaded thread, it
1133 * needs an expiration timer that was supposed to be now, but that
1134 * was erased during the bounce.
1135 */
1136 if (!tick_isset(t->expire))
1137 t->expire = now_ms;
1138 }
1139
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001140 if (unlikely(check->state & CHK_ST_PURGE)) {
1141 TRACE_STATE("health-check state to purge", CHK_EV_TASK_WAKE, check);
1142 }
1143 else if (!(check->state & (CHK_ST_INPROGRESS))) {
Willy Tarreau9e080bf2022-12-06 18:20:56 +01001144 /* no check currently running, but we might have been woken up
1145 * before the timer's expiration to update it according to a
1146 * new state (e.g. fastinter), in which case we'll reprogram
1147 * the new timer.
1148 */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001149 if (!expired) /* woke up too early */ {
Willy Tarreau9e080bf2022-12-06 18:20:56 +01001150 if (check->server) {
1151 int new_exp = tick_add(now_ms, MS_TO_TICKS(srv_getinter(check)));
1152
1153 if (tick_is_expired(new_exp, t->expire)) {
1154 TRACE_STATE("health-check was advanced", CHK_EV_TASK_WAKE, check);
1155 goto update_timer;
1156 }
1157 }
1158
Christopher Faulet147b8c92021-04-10 09:00:38 +02001159 TRACE_STATE("health-check wake up too early", CHK_EV_TASK_WAKE, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001160 goto out_unlock;
Christopher Faulet147b8c92021-04-10 09:00:38 +02001161 }
Willy Tarreauabca5b62013-12-06 14:19:25 +01001162
Willy Tarreau51cd5952020-06-05 12:25:38 +02001163 /* we don't send any health-checks when the proxy is
1164 * stopped, the server should not be checked or the check
1165 * is disabled.
1166 */
1167 if (((check->state & (CHK_ST_ENABLED | CHK_ST_PAUSED)) != CHK_ST_ENABLED) ||
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001168 (proxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001169 TRACE_STATE("health-check paused or disabled", CHK_EV_TASK_WAKE, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001170 goto reschedule;
Christopher Faulet147b8c92021-04-10 09:00:38 +02001171 }
Christopher Faulet404f9192020-04-09 23:13:54 +02001172
Willy Tarreau51cd5952020-06-05 12:25:38 +02001173 /* we'll initiate a new check */
1174 set_server_check_status(check, HCHK_STATUS_START, NULL);
Christopher Faulet404f9192020-04-09 23:13:54 +02001175
Willy Tarreau51cd5952020-06-05 12:25:38 +02001176 check->state |= CHK_ST_INPROGRESS;
Christopher Faulet147b8c92021-04-10 09:00:38 +02001177 TRACE_STATE("init new health-check", CHK_EV_TASK_WAKE|CHK_EV_HCHK_START, check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001178
Willy Tarreaueed39112022-06-15 17:20:16 +02001179 task_set_thread(t, tid);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001180
1181 check->current_step = NULL;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01001182
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001183 check->sc = sc_new_from_check(check, SC_FL_NONE);
1184 if (!check->sc) {
Christopher Faulet177a0e62022-04-12 17:47:07 +02001185 set_server_check_status(check, HCHK_STATUS_SOCKERR, NULL);
1186 goto end;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01001187 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001188 tcpcheck_main(check);
Christopher Faulet92017a32021-05-06 16:01:18 +02001189 expired = 0;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001190 }
Christopher Faulet92017a32021-05-06 16:01:18 +02001191
Christopher Faulet92017a32021-05-06 16:01:18 +02001192 /* there was a test running.
1193 * First, let's check whether there was an uncaught error,
1194 * which can happen on connect timeout or error.
1195 */
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001196 if (check->result == CHK_RES_UNKNOWN && likely(!(check->state & CHK_ST_PURGE))) {
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001197 sc = check->sc;
Christopher Faulete4b40192022-06-13 07:59:46 +02001198 conn = sc_conn(sc);
Christopher Faulet177a0e62022-04-12 17:47:07 +02001199
Christopher Faulet92017a32021-05-06 16:01:18 +02001200 /* Here the connection must be defined. Otherwise the
1201 * error would have already been detected
Willy Tarreau51cd5952020-06-05 12:25:38 +02001202 */
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001203 if ((conn && ((conn->flags & CO_FL_ERROR) || sc_ep_test(sc, SE_FL_ERROR))) || expired) {
Christopher Faulet92017a32021-05-06 16:01:18 +02001204 TRACE_ERROR("report connection error", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
1205 chk_report_conn_err(check, 0, expired);
1206 }
1207 else {
1208 if (check->state & CHK_ST_CLOSE_CONN) {
1209 TRACE_DEVEL("closing current connection", CHK_EV_TASK_WAKE|CHK_EV_HCHK_RUN, check);
Christopher Faulet92017a32021-05-06 16:01:18 +02001210 check->state &= ~CHK_ST_CLOSE_CONN;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01001211 conn = NULL;
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001212 if (!sc_reset_endp(check->sc)) {
Christopher Fauleta6c4a482022-04-28 18:25:24 +02001213 /* error will be handled by tcpcheck_main().
Willy Tarreaub605c422022-05-17 17:04:55 +02001214 * On success, remove all flags except SE_FL_DETACHED
Christopher Fauleta6c4a482022-04-28 18:25:24 +02001215 */
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001216 sc_ep_clr(check->sc, ~SE_FL_DETACHED);
Christopher Fauleta6c4a482022-04-28 18:25:24 +02001217 }
Christopher Faulet92017a32021-05-06 16:01:18 +02001218 tcpcheck_main(check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001219 }
Christopher Faulet92017a32021-05-06 16:01:18 +02001220 if (check->result == CHK_RES_UNKNOWN) {
1221 TRACE_DEVEL("health-check not expired", CHK_EV_TASK_WAKE|CHK_EV_HCHK_RUN, check);
1222 goto out_unlock; /* timeout not reached, wait again */
Christopher Faulet8f100422021-01-18 15:47:03 +01001223 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001224 }
Christopher Faulet92017a32021-05-06 16:01:18 +02001225 }
Christopher Faulet404f9192020-04-09 23:13:54 +02001226
Christopher Faulet92017a32021-05-06 16:01:18 +02001227 /* check complete or aborted */
1228 TRACE_STATE("health-check complete or aborted", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END, check);
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001229
Christopher Faulete4b40192022-06-13 07:59:46 +02001230 /* check->sc may be NULL when the healthcheck is purged */
Christopher Faulet92017a32021-05-06 16:01:18 +02001231 check->current_step = NULL;
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001232 sc = check->sc;
1233 conn = (sc ? sc_conn(sc) : NULL);
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001234
Christopher Faulet92017a32021-05-06 16:01:18 +02001235 if (conn && conn->xprt) {
1236 /* The check was aborted and the connection was not yet closed.
1237 * This can happen upon timeout, or when an external event such
1238 * as a failed response coupled with "observe layer7" caused the
1239 * server state to be suddenly changed.
1240 */
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001241 sc_conn_drain_and_shut(sc);
Christopher Faulet92017a32021-05-06 16:01:18 +02001242 }
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001243
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001244 if (sc) {
1245 sc_destroy(sc);
1246 sc = check->sc = NULL;
Christopher Faulet177a0e62022-04-12 17:47:07 +02001247 conn = NULL;
1248 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001249
Christopher Faulet92017a32021-05-06 16:01:18 +02001250 if (check->sess != NULL) {
1251 vars_prune(&check->vars, check->sess, NULL);
1252 session_free(check->sess);
1253 check->sess = NULL;
1254 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001255
Christopher Fauletb041b232022-03-24 10:27:02 +01001256 end:
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001257 if (check->server && likely(!(check->state & CHK_ST_PURGE))) {
Christopher Faulet92017a32021-05-06 16:01:18 +02001258 if (check->result == CHK_RES_FAILED) {
1259 /* a failure or timeout detected */
1260 TRACE_DEVEL("report failure", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
1261 check_notify_failure(check);
1262 }
1263 else if (check->result == CHK_RES_CONDPASS) {
1264 /* check is OK but asks for stopping mode */
1265 TRACE_DEVEL("report conditional success", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
1266 check_notify_stopping(check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001267 }
Christopher Faulet92017a32021-05-06 16:01:18 +02001268 else if (check->result == CHK_RES_PASSED) {
1269 /* a success was detected */
1270 TRACE_DEVEL("report success", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
1271 check_notify_success(check);
1272 }
1273 }
Christopher Faulet6d781f62022-05-18 14:24:43 +02001274
1275 if (LIST_INLIST(&check->buf_wait.list))
1276 LIST_DEL_INIT(&check->buf_wait.list);
1277
Christopher Faulet92017a32021-05-06 16:01:18 +02001278 check_release_buf(check, &check->bi);
1279 check_release_buf(check, &check->bo);
1280 check->state &= ~(CHK_ST_INPROGRESS|CHK_ST_IN_ALLOC|CHK_ST_OUT_ALLOC);
Willy Tarreaud114f4a2022-10-12 20:58:18 +02001281 check->state |= CHK_ST_SLEEPING;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001282
Willy Tarreau9e080bf2022-12-06 18:20:56 +01001283 update_timer:
Christopher Faulet92017a32021-05-06 16:01:18 +02001284 if (check->server) {
1285 rv = 0;
1286 if (global.spread_checks > 0) {
1287 rv = srv_getinter(check) * global.spread_checks / 100;
Willy Tarreaua840b4a2022-10-12 21:48:17 +02001288 rv -= (int) (2 * rv * (statistical_prng() / 4294967295.0));
Christopher Faulet61cc8522020-04-20 14:54:42 +02001289 }
Christopher Faulet92017a32021-05-06 16:01:18 +02001290 t->expire = tick_add(now_ms, MS_TO_TICKS(srv_getinter(check) + rv));
Aurelien DARRAGON7d541a92022-12-07 12:17:24 +01001291 /* reset fastinter flag (if set) so that srv_getinter()
1292 * only returns fastinter if server health is degraded
1293 */
1294 check->state &= ~CHK_ST_FASTINTER;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001295 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001296
1297 reschedule:
1298 while (tick_is_expired(t->expire, now_ms))
1299 t->expire = tick_add(t->expire, MS_TO_TICKS(check->inter));
1300 out_unlock:
1301 if (check->server)
1302 HA_SPIN_UNLOCK(SERVER_LOCK, &check->server->lock);
Christopher Faulet147b8c92021-04-10 09:00:38 +02001303
1304 TRACE_LEAVE(CHK_EV_TASK_WAKE, check);
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001305
1306 /* Free the check if set to PURGE. After this, the check instance may be
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +02001307 * freed via the srv_drop invocation, so it must not be accessed after
1308 * this point.
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001309 */
1310 if (unlikely(check->state & CHK_ST_PURGE)) {
Amaury Denoyelle26cb8342021-08-10 16:23:49 +02001311 free_check(check);
Amaury Denoyelle9ba34ae2021-08-09 15:09:17 +02001312 if (check->server)
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +02001313 srv_drop(check->server);
Amaury Denoyelle26cb8342021-08-10 16:23:49 +02001314
1315 t = NULL;
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001316 }
1317
Willy Tarreau51cd5952020-06-05 12:25:38 +02001318 return t;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001319}
1320
Willy Tarreau51cd5952020-06-05 12:25:38 +02001321
Christopher Faulet61cc8522020-04-20 14:54:42 +02001322/**************************************************************************/
1323/************************** Init/deinit checks ****************************/
1324/**************************************************************************/
Christopher Fauletb381a502020-11-25 13:47:00 +01001325/*
1326 * Tries to grab a buffer and to re-enables processing on check <target>. The
1327 * check flags are used to figure what buffer was requested. It returns 1 if the
1328 * allocation succeeds, in which case the I/O tasklet is woken up, or 0 if it's
1329 * impossible to wake up and we prefer to be woken up later.
1330 */
1331int check_buf_available(void *target)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001332{
Christopher Fauletb381a502020-11-25 13:47:00 +01001333 struct check *check = target;
1334
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001335 BUG_ON(!check->sc);
Christopher Fauletc95eaef2022-05-18 15:57:15 +02001336
Willy Tarreaud68d4f12021-03-22 14:44:31 +01001337 if ((check->state & CHK_ST_IN_ALLOC) && b_alloc(&check->bi)) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001338 TRACE_STATE("unblocking check, input buffer allocated", CHK_EV_TCPCHK_EXP|CHK_EV_RX_BLK, check);
Christopher Fauletb381a502020-11-25 13:47:00 +01001339 check->state &= ~CHK_ST_IN_ALLOC;
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001340 tasklet_wakeup(check->sc->wait_event.tasklet);
Christopher Fauletb381a502020-11-25 13:47:00 +01001341 return 1;
1342 }
Willy Tarreaud68d4f12021-03-22 14:44:31 +01001343 if ((check->state & CHK_ST_OUT_ALLOC) && b_alloc(&check->bo)) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001344 TRACE_STATE("unblocking check, output buffer allocated", CHK_EV_TCPCHK_SND|CHK_EV_TX_BLK, check);
Christopher Fauletb381a502020-11-25 13:47:00 +01001345 check->state &= ~CHK_ST_OUT_ALLOC;
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001346 tasklet_wakeup(check->sc->wait_event.tasklet);
Christopher Fauletb381a502020-11-25 13:47:00 +01001347 return 1;
1348 }
1349
1350 return 0;
1351}
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001352
Christopher Fauletb381a502020-11-25 13:47:00 +01001353/*
William Dauchyf4300902021-02-06 20:47:50 +01001354 * Allocate a buffer. If it fails, it adds the check in buffer wait queue.
Christopher Fauletb381a502020-11-25 13:47:00 +01001355 */
1356struct buffer *check_get_buf(struct check *check, struct buffer *bptr)
1357{
1358 struct buffer *buf = NULL;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001359
Willy Tarreau2b718102021-04-21 07:32:39 +02001360 if (likely(!LIST_INLIST(&check->buf_wait.list)) &&
Willy Tarreaud68d4f12021-03-22 14:44:31 +01001361 unlikely((buf = b_alloc(bptr)) == NULL)) {
Christopher Fauletb381a502020-11-25 13:47:00 +01001362 check->buf_wait.target = check;
1363 check->buf_wait.wakeup_cb = check_buf_available;
Willy Tarreaub4e34762021-09-30 19:02:18 +02001364 LIST_APPEND(&th_ctx->buffer_wq, &check->buf_wait.list);
Christopher Fauletb381a502020-11-25 13:47:00 +01001365 }
1366 return buf;
1367}
1368
1369/*
1370 * Release a buffer, if any, and try to wake up entities waiting in the buffer
1371 * wait queue.
1372 */
1373void check_release_buf(struct check *check, struct buffer *bptr)
1374{
1375 if (bptr->size) {
1376 b_free(bptr);
Willy Tarreau4d77bbf2021-02-20 12:02:46 +01001377 offer_buffers(check->buf_wait.target, 1);
Christopher Fauletb381a502020-11-25 13:47:00 +01001378 }
1379}
1380
1381const char *init_check(struct check *check, int type)
1382{
1383 check->type = type;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001384
Christopher Fauletb381a502020-11-25 13:47:00 +01001385 check->bi = BUF_NULL;
1386 check->bo = BUF_NULL;
Willy Tarreau90f366b2021-02-20 11:49:49 +01001387 LIST_INIT(&check->buf_wait.list);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001388 return NULL;
1389}
1390
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001391/* Liberates the resources allocated for a check.
1392 *
Amaury Denoyelle6d7fc442021-08-10 16:22:51 +02001393 * This function must only be run by the thread owning the check.
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001394 */
Christopher Faulet61cc8522020-04-20 14:54:42 +02001395void free_check(struct check *check)
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001396{
Amaury Denoyelle6d7fc442021-08-10 16:22:51 +02001397 /* For agent-check, free the rules / vars from the server. This is not
1398 * done for health-check : the proxy is the owner of the rules / vars
1399 * in this case.
1400 */
1401 if (check->state & CHK_ST_AGENT) {
1402 free_tcpcheck_vars(&check->tcpcheck_rules->preset_vars);
1403 ha_free(&check->tcpcheck_rules);
1404 }
1405
Christopher Faulet61cc8522020-04-20 14:54:42 +02001406 task_destroy(check->task);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001407
Christopher Fauletb381a502020-11-25 13:47:00 +01001408 check_release_buf(check, &check->bi);
1409 check_release_buf(check, &check->bo);
Willy Tarreaubde14ad2022-05-27 10:04:04 +02001410 if (check->sc) {
1411 sc_destroy(check->sc);
1412 check->sc = NULL;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001413 }
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001414}
1415
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001416/* This function must be used in order to free a started check. The check will
1417 * be scheduled for a next execution in order to properly close and free all
1418 * check elements.
1419 *
1420 * Non thread-safe.
1421 */
1422void check_purge(struct check *check)
1423{
Amaury Denoyelle25fe1032021-08-10 16:21:55 +02001424 check->state |= CHK_ST_PURGE;
Amaury Denoyelleb33a0ab2021-07-29 15:51:45 +02001425 task_wakeup(check->task, TASK_WOKEN_OTHER);
1426}
1427
Christopher Faulet61cc8522020-04-20 14:54:42 +02001428/* manages a server health-check. Returns the time the task accepts to wait, or
1429 * TIME_ETERNITY for infinity.
1430 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001431struct task *process_chk(struct task *t, void *context, unsigned int state)
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001432{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001433 struct check *check = context;
1434
1435 if (check->type == PR_O2_EXT_CHK)
1436 return process_chk_proc(t, context, state);
1437 return process_chk_conn(t, context, state);
1438
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001439}
1440
Christopher Faulet61cc8522020-04-20 14:54:42 +02001441
Amaury Denoyelle3c2ab1a2021-07-22 16:04:40 +02001442int start_check_task(struct check *check, int mininter,
Christopher Faulet61cc8522020-04-20 14:54:42 +02001443 int nbcheck, int srvpos)
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001444{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001445 struct task *t;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001446
Willy Tarreaubeeabf52021-10-01 18:23:30 +02001447 /* task for the check. Process-based checks exclusively run on thread 1. */
Christopher Faulet61cc8522020-04-20 14:54:42 +02001448 if (check->type == PR_O2_EXT_CHK)
Willy Tarreaua89c1912021-10-20 18:43:30 +02001449 t = task_new_on(0);
Christopher Faulet177a0e62022-04-12 17:47:07 +02001450 else
Willy Tarreaubeeabf52021-10-01 18:23:30 +02001451 t = task_new_anywhere();
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001452
Christopher Faulet54e85cb2022-01-06 08:46:56 +01001453 if (!t)
1454 goto fail_alloc_task;
1455
Christopher Faulet61cc8522020-04-20 14:54:42 +02001456 check->task = t;
1457 t->process = process_chk;
1458 t->context = check;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001459
Christopher Faulet61cc8522020-04-20 14:54:42 +02001460 if (mininter < srv_getinter(check))
1461 mininter = srv_getinter(check);
1462
1463 if (global.max_spread_checks && mininter > global.max_spread_checks)
1464 mininter = global.max_spread_checks;
1465
1466 /* check this every ms */
1467 t->expire = tick_add(now_ms, MS_TO_TICKS(mininter * srvpos / nbcheck));
1468 check->start = now;
1469 task_queue(t);
1470
1471 return 1;
Christopher Faulet54e85cb2022-01-06 08:46:56 +01001472
1473 fail_alloc_task:
Christopher Faulet54e85cb2022-01-06 08:46:56 +01001474 ha_alert("Starting [%s:%s] check: out of memory.\n",
1475 check->server->proxy->id, check->server->id);
1476 return 0;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001477}
1478
Christopher Faulet61cc8522020-04-20 14:54:42 +02001479/*
1480 * Start health-check.
1481 * Returns 0 if OK, ERR_FATAL on error, and prints the error in this case.
1482 */
1483static int start_checks()
1484{
1485
1486 struct proxy *px;
1487 struct server *s;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001488 int nbcheck=0, mininter=0, srvpos=0;
1489
1490 /* 0- init the dummy frontend used to create all checks sessions */
1491 init_new_proxy(&checks_fe);
Christopher Faulet0f1fc232021-04-16 10:49:07 +02001492 checks_fe.id = strdup("CHECKS-FE");
Christopher Faulet61cc8522020-04-20 14:54:42 +02001493 checks_fe.cap = PR_CAP_FE | PR_CAP_BE;
1494 checks_fe.mode = PR_MODE_TCP;
1495 checks_fe.maxconn = 0;
1496 checks_fe.conn_retries = CONN_RETRIES;
1497 checks_fe.options2 |= PR_O2_INDEPSTR | PR_O2_SMARTCON | PR_O2_SMARTACC;
1498 checks_fe.timeout.client = TICK_ETERNITY;
1499
1500 /* 1- count the checkers to run simultaneously.
1501 * We also determine the minimum interval among all of those which
1502 * have an interval larger than SRV_CHK_INTER_THRES. This interval
1503 * will be used to spread their start-up date. Those which have
1504 * a shorter interval will start independently and will not dictate
1505 * too short an interval for all others.
1506 */
1507 for (px = proxies_list; px; px = px->next) {
1508 for (s = px->srv; s; s = s->next) {
Christopher Faulet61cc8522020-04-20 14:54:42 +02001509 if (s->check.state & CHK_ST_CONFIGURED) {
1510 nbcheck++;
1511 if ((srv_getinter(&s->check) >= SRV_CHK_INTER_THRES) &&
1512 (!mininter || mininter > srv_getinter(&s->check)))
1513 mininter = srv_getinter(&s->check);
Christopher Faulet5c288742020-03-31 08:15:58 +02001514 }
1515
Christopher Faulet61cc8522020-04-20 14:54:42 +02001516 if (s->agent.state & CHK_ST_CONFIGURED) {
1517 nbcheck++;
1518 if ((srv_getinter(&s->agent) >= SRV_CHK_INTER_THRES) &&
1519 (!mininter || mininter > srv_getinter(&s->agent)))
1520 mininter = srv_getinter(&s->agent);
1521 }
Christopher Faulet5c288742020-03-31 08:15:58 +02001522 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001523 }
Christopher Fauletb7d30092020-03-30 15:19:03 +02001524
Christopher Faulet61cc8522020-04-20 14:54:42 +02001525 if (!nbcheck)
Christopher Fauletfc633b62020-11-06 15:24:23 +01001526 return ERR_NONE;
Christopher Fauletb7d30092020-03-30 15:19:03 +02001527
Christopher Faulet61cc8522020-04-20 14:54:42 +02001528 srand((unsigned)time(NULL));
Christopher Fauletb7d30092020-03-30 15:19:03 +02001529
William Dauchyf4300902021-02-06 20:47:50 +01001530 /* 2- start them as far as possible from each other. For this, we will
1531 * start them after their interval is set to the min interval divided
1532 * by the number of servers, weighted by the server's position in the
1533 * list.
Christopher Faulet61cc8522020-04-20 14:54:42 +02001534 */
1535 for (px = proxies_list; px; px = px->next) {
1536 if ((px->options2 & PR_O2_CHK_ANY) == PR_O2_EXT_CHK) {
1537 if (init_pid_list()) {
1538 ha_alert("Starting [%s] check: out of memory.\n", px->id);
1539 return ERR_ALERT | ERR_FATAL;
1540 }
1541 }
Christopher Fauletb7d30092020-03-30 15:19:03 +02001542
Christopher Faulet61cc8522020-04-20 14:54:42 +02001543 for (s = px->srv; s; s = s->next) {
1544 /* A task for the main check */
1545 if (s->check.state & CHK_ST_CONFIGURED) {
1546 if (s->check.type == PR_O2_EXT_CHK) {
1547 if (!prepare_external_check(&s->check))
1548 return ERR_ALERT | ERR_FATAL;
Christopher Fauletb7d30092020-03-30 15:19:03 +02001549 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001550 if (!start_check_task(&s->check, mininter, nbcheck, srvpos))
1551 return ERR_ALERT | ERR_FATAL;
1552 srvpos++;
Christopher Faulet98572322020-03-30 13:16:44 +02001553 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001554
Christopher Faulet61cc8522020-04-20 14:54:42 +02001555 /* A task for a auxiliary agent check */
1556 if (s->agent.state & CHK_ST_CONFIGURED) {
1557 if (!start_check_task(&s->agent, mininter, nbcheck, srvpos)) {
1558 return ERR_ALERT | ERR_FATAL;
1559 }
1560 srvpos++;
1561 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001562 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001563 }
Christopher Fauletfc633b62020-11-06 15:24:23 +01001564 return ERR_NONE;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001565}
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001566
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001567
Christopher Faulet61cc8522020-04-20 14:54:42 +02001568/*
1569 * Return value:
1570 * the port to be used for the health check
1571 * 0 in case no port could be found for the check
1572 */
1573static int srv_check_healthcheck_port(struct check *chk)
1574{
1575 int i = 0;
1576 struct server *srv = NULL;
1577
1578 srv = chk->server;
1579
William Dauchyf4300902021-02-06 20:47:50 +01001580 /* by default, we use the health check port configured */
Christopher Faulet61cc8522020-04-20 14:54:42 +02001581 if (chk->port > 0)
1582 return chk->port;
1583
1584 /* try to get the port from check_core.addr if check.port not set */
1585 i = get_host_port(&chk->addr);
1586 if (i > 0)
1587 return i;
1588
1589 /* try to get the port from server address */
1590 /* prevent MAPPORTS from working at this point, since checks could
1591 * not be performed in such case (MAPPORTS impose a relative ports
1592 * based on live traffic)
1593 */
1594 if (srv->flags & SRV_F_MAPPORTS)
1595 return 0;
1596
1597 i = srv->svc_port; /* by default */
1598 if (i > 0)
1599 return i;
1600
1601 return 0;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001602}
1603
Christopher Faulet61cc8522020-04-20 14:54:42 +02001604/* Initializes an health-check attached to the server <srv>. Non-zero is returned
1605 * if an error occurred.
1606 */
Amaury Denoyelle3c2ab1a2021-07-22 16:04:40 +02001607int init_srv_check(struct server *srv)
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001608{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001609 const char *err;
1610 struct tcpcheck_rule *r;
Christopher Fauletfc633b62020-11-06 15:24:23 +01001611 int ret = ERR_NONE;
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001612 int check_type;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001613
Christopher Faulet6ecd5932021-01-12 17:29:45 +01001614 if (!srv->do_check || !(srv->proxy->cap & PR_CAP_BE))
Christopher Faulet61cc8522020-04-20 14:54:42 +02001615 goto out;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001616
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001617 check_type = srv->check.tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK;
Christopher Fauletf50f4e92020-03-30 19:52:29 +02001618
Amaury Denoyelle7d098be2022-03-09 14:20:10 +01001619 if (!(srv->flags & SRV_F_DYNAMIC)) {
1620 /* If neither a port nor an addr was specified and no check
1621 * transport layer is forced, then the transport layer used by
1622 * the checks is the same as for the production traffic.
1623 * Otherwise we use raw_sock by default, unless one is
1624 * specified.
1625 */
1626 if (!srv->check.port && !is_addr(&srv->check.addr)) {
1627 if (!srv->check.use_ssl && srv->use_ssl != -1) {
1628 srv->check.use_ssl = srv->use_ssl;
1629 srv->check.xprt = srv->xprt;
1630 }
1631 else if (srv->check.use_ssl == 1)
1632 srv->check.xprt = xprt_get(XPRT_SSL);
1633 srv->check.send_proxy |= (srv->pp_opts);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001634 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001635 else if (srv->check.use_ssl == 1)
1636 srv->check.xprt = xprt_get(XPRT_SSL);
Amaury Denoyelle7d098be2022-03-09 14:20:10 +01001637 }
1638 else {
1639 /* For dynamic servers, check-ssl and check-send-proxy must be
Ilya Shipitsin3b64a282022-07-29 22:26:53 +05001640 * explicitly defined even if the check port was not
Amaury Denoyelle7d098be2022-03-09 14:20:10 +01001641 * overridden.
1642 */
1643 if (srv->check.use_ssl == 1)
1644 srv->check.xprt = xprt_get(XPRT_SSL);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001645 }
1646
Christopher Faulet12882cf2020-04-23 15:50:18 +02001647 /* Inherit the mux protocol from the server if not already defined for
1648 * the check
1649 */
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001650 if (srv->mux_proto && !srv->check.mux_proto &&
1651 ((srv->mux_proto->mode == PROTO_MODE_HTTP && check_type == TCPCHK_RULES_HTTP_CHK) ||
1652 (srv->mux_proto->mode == PROTO_MODE_TCP && check_type != TCPCHK_RULES_HTTP_CHK))) {
Christopher Faulet12882cf2020-04-23 15:50:18 +02001653 srv->check.mux_proto = srv->mux_proto;
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001654 }
Amaury Denoyelle7c148902020-11-13 12:34:57 +01001655 /* test that check proto is valid if explicitly defined */
1656 else if (srv->check.mux_proto &&
1657 ((srv->check.mux_proto->mode == PROTO_MODE_HTTP && check_type != TCPCHK_RULES_HTTP_CHK) ||
1658 (srv->check.mux_proto->mode == PROTO_MODE_TCP && check_type == TCPCHK_RULES_HTTP_CHK))) {
1659 ha_alert("config: %s '%s': server '%s' uses an incompatible MUX protocol for the selected check type\n",
1660 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1661 ret |= ERR_ALERT | ERR_FATAL;
1662 goto out;
1663 }
Christopher Faulet12882cf2020-04-23 15:50:18 +02001664
Christopher Faulet61cc8522020-04-20 14:54:42 +02001665 /* validate <srv> server health-check settings */
Christopher Fauletf50f4e92020-03-30 19:52:29 +02001666
Christopher Faulet61cc8522020-04-20 14:54:42 +02001667 /* We need at least a service port, a check port or the first tcp-check
1668 * rule must be a 'connect' one when checking an IPv4/IPv6 server.
1669 */
1670 if ((srv_check_healthcheck_port(&srv->check) != 0) ||
1671 (!is_inet_addr(&srv->check.addr) && (is_addr(&srv->check.addr) || !is_inet_addr(&srv->addr))))
1672 goto init;
Christopher Fauletf50f4e92020-03-30 19:52:29 +02001673
Christopher Faulet61cc8522020-04-20 14:54:42 +02001674 if (!srv->proxy->tcpcheck_rules.list || LIST_ISEMPTY(srv->proxy->tcpcheck_rules.list)) {
1675 ha_alert("config: %s '%s': server '%s' has neither service port nor check port.\n",
1676 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1677 ret |= ERR_ALERT | ERR_ABORT;
1678 goto out;
1679 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001680
Christopher Faulet61cc8522020-04-20 14:54:42 +02001681 /* search the first action (connect / send / expect) in the list */
1682 r = get_first_tcpcheck_rule(&srv->proxy->tcpcheck_rules);
1683 if (!r || (r->action != TCPCHK_ACT_CONNECT) || (!r->connect.port && !get_host_port(&r->connect.addr))) {
1684 ha_alert("config: %s '%s': server '%s' has neither service port nor check port "
1685 "nor tcp_check rule 'connect' with port information.\n",
1686 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1687 ret |= ERR_ALERT | ERR_ABORT;
1688 goto out;
1689 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001690
Christopher Faulet61cc8522020-04-20 14:54:42 +02001691 /* scan the tcp-check ruleset to ensure a port has been configured */
1692 list_for_each_entry(r, srv->proxy->tcpcheck_rules.list, list) {
Willy Tarreauacff3092021-07-22 11:06:41 +02001693 if ((r->action == TCPCHK_ACT_CONNECT) && (!r->connect.port && !get_host_port(&r->connect.addr))) {
Christopher Faulet61cc8522020-04-20 14:54:42 +02001694 ha_alert("config: %s '%s': server '%s' has neither service port nor check port, "
1695 "and a tcp_check rule 'connect' with no port information.\n",
1696 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1697 ret |= ERR_ALERT | ERR_ABORT;
1698 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001699 }
Christopher Faulete5870d82020-04-15 11:32:03 +02001700 }
1701
Christopher Faulet61cc8522020-04-20 14:54:42 +02001702 init:
Christopher Faulet61cc8522020-04-20 14:54:42 +02001703 err = init_check(&srv->check, srv->proxy->options2 & PR_O2_CHK_ANY);
1704 if (err) {
1705 ha_alert("config: %s '%s': unable to init check for server '%s' (%s).\n",
1706 proxy_type_str(srv->proxy), srv->proxy->id, srv->id, err);
1707 ret |= ERR_ALERT | ERR_ABORT;
1708 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001709 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001710 srv->check.state |= CHK_ST_CONFIGURED | CHK_ST_ENABLED;
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +02001711 srv_take(srv);
Amaury Denoyelle403dce82021-07-29 15:39:43 +02001712
1713 /* Only increment maxsock for servers from the configuration. Dynamic
1714 * servers at the moment are not taken into account for the estimation
1715 * of the resources limits.
1716 */
1717 if (global.mode & MODE_STARTING)
1718 global.maxsock++;
Christopher Faulete5870d82020-04-15 11:32:03 +02001719
Christopher Faulet61cc8522020-04-20 14:54:42 +02001720 out:
1721 return ret;
Christopher Faulete5870d82020-04-15 11:32:03 +02001722}
1723
Christopher Faulet61cc8522020-04-20 14:54:42 +02001724/* Initializes an agent-check attached to the server <srv>. Non-zero is returned
1725 * if an error occurred.
1726 */
Amaury Denoyelle3c2ab1a2021-07-22 16:04:40 +02001727int init_srv_agent_check(struct server *srv)
Christopher Faulete5870d82020-04-15 11:32:03 +02001728{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001729 struct tcpcheck_rule *chk;
1730 const char *err;
Christopher Fauletfc633b62020-11-06 15:24:23 +01001731 int ret = ERR_NONE;
Christopher Faulete5870d82020-04-15 11:32:03 +02001732
Christopher Faulet6ecd5932021-01-12 17:29:45 +01001733 if (!srv->do_agent || !(srv->proxy->cap & PR_CAP_BE))
Christopher Faulet61cc8522020-04-20 14:54:42 +02001734 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001735
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05001736 /* If there is no connect rule preceding all send / expect rules, an
Christopher Faulet61cc8522020-04-20 14:54:42 +02001737 * implicit one is inserted before all others.
1738 */
1739 chk = get_first_tcpcheck_rule(srv->agent.tcpcheck_rules);
1740 if (!chk || chk->action != TCPCHK_ACT_CONNECT) {
1741 chk = calloc(1, sizeof(*chk));
1742 if (!chk) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001743 ha_alert("%s '%s': unable to add implicit tcp-check connect rule"
Christopher Faulet61cc8522020-04-20 14:54:42 +02001744 " to agent-check for server '%s' (out of memory).\n",
1745 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1746 ret |= ERR_ALERT | ERR_FATAL;
1747 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001748 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001749 chk->action = TCPCHK_ACT_CONNECT;
1750 chk->connect.options = (TCPCHK_OPT_DEFAULT_CONNECT|TCPCHK_OPT_IMPLICIT);
Willy Tarreau2b718102021-04-21 07:32:39 +02001751 LIST_INSERT(srv->agent.tcpcheck_rules->list, &chk->list);
Christopher Faulete5870d82020-04-15 11:32:03 +02001752 }
1753
Christopher Faulet871dd822022-08-24 11:38:03 +02001754 /* <chk> is always defined here and it is a CONNECT action. If there is
1755 * a preset variable, it means there is an agent string defined and data
1756 * will be sent after the connect.
1757 */
1758 if (!LIST_ISEMPTY(&srv->agent.tcpcheck_rules->preset_vars))
1759 chk->connect.options |= TCPCHK_OPT_HAS_DATA;
1760
Christopher Faulete5870d82020-04-15 11:32:03 +02001761
Christopher Faulet61cc8522020-04-20 14:54:42 +02001762 err = init_check(&srv->agent, PR_O2_TCPCHK_CHK);
1763 if (err) {
1764 ha_alert("config: %s '%s': unable to init agent-check for server '%s' (%s).\n",
1765 proxy_type_str(srv->proxy), srv->proxy->id, srv->id, err);
1766 ret |= ERR_ALERT | ERR_ABORT;
1767 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001768 }
1769
Christopher Faulet61cc8522020-04-20 14:54:42 +02001770 if (!srv->agent.inter)
1771 srv->agent.inter = srv->check.inter;
1772
1773 srv->agent.state |= CHK_ST_CONFIGURED | CHK_ST_ENABLED | CHK_ST_AGENT;
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +02001774 srv_take(srv);
Amaury Denoyelle403dce82021-07-29 15:39:43 +02001775
1776 /* Only increment maxsock for servers from the configuration. Dynamic
1777 * servers at the moment are not taken into account for the estimation
1778 * of the resources limits.
1779 */
1780 if (global.mode & MODE_STARTING)
1781 global.maxsock++;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001782
1783 out:
1784 return ret;
Christopher Faulete5870d82020-04-15 11:32:03 +02001785}
1786
Christopher Faulet61cc8522020-04-20 14:54:42 +02001787static void deinit_srv_check(struct server *srv)
1788{
1789 if (srv->check.state & CHK_ST_CONFIGURED)
1790 free_check(&srv->check);
1791 srv->check.state &= ~CHK_ST_CONFIGURED & ~CHK_ST_ENABLED;
1792 srv->do_check = 0;
1793}
Christopher Faulete5870d82020-04-15 11:32:03 +02001794
Christopher Faulet61cc8522020-04-20 14:54:42 +02001795
1796static void deinit_srv_agent_check(struct server *srv)
1797{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001798 if (srv->agent.state & CHK_ST_CONFIGURED)
1799 free_check(&srv->agent);
1800
1801 srv->agent.state &= ~CHK_ST_CONFIGURED & ~CHK_ST_ENABLED & ~CHK_ST_AGENT;
1802 srv->do_agent = 0;
Christopher Faulete5870d82020-04-15 11:32:03 +02001803}
1804
Willy Tarreaucee013e2020-06-05 11:40:38 +02001805REGISTER_POST_SERVER_CHECK(init_srv_check);
1806REGISTER_POST_SERVER_CHECK(init_srv_agent_check);
Willy Tarreaucee013e2020-06-05 11:40:38 +02001807REGISTER_POST_CHECK(start_checks);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001808
Willy Tarreaucee013e2020-06-05 11:40:38 +02001809REGISTER_SERVER_DEINIT(deinit_srv_check);
1810REGISTER_SERVER_DEINIT(deinit_srv_agent_check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001811
Christopher Faulet61cc8522020-04-20 14:54:42 +02001812
1813/**************************************************************************/
1814/************************** Check sample fetches **************************/
1815/**************************************************************************/
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001816
Christopher Faulet61cc8522020-04-20 14:54:42 +02001817static struct sample_fetch_kw_list smp_kws = {ILH, {
Christopher Faulet61cc8522020-04-20 14:54:42 +02001818 { /* END */ },
1819}};
1820
1821INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
1822
1823
1824/**************************************************************************/
1825/************************ Check's parsing functions ***********************/
1826/**************************************************************************/
Christopher Fauletce8111e2020-04-06 15:04:11 +02001827/* Parse the "addr" server keyword */
1828static int srv_parse_addr(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1829 char **errmsg)
1830{
1831 struct sockaddr_storage *sk;
Christopher Fauletce8111e2020-04-06 15:04:11 +02001832 int port1, port2, err_code = 0;
1833
1834
1835 if (!*args[*cur_arg+1]) {
1836 memprintf(errmsg, "'%s' expects <ipv4|ipv6> as argument.", args[*cur_arg]);
1837 goto error;
1838 }
1839
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001840 sk = str2sa_range(args[*cur_arg+1], NULL, &port1, &port2, NULL, NULL, errmsg, NULL, NULL,
1841 PA_O_RESOLVE | PA_O_PORT_OK | PA_O_STREAM | PA_O_CONNECT);
Christopher Fauletce8111e2020-04-06 15:04:11 +02001842 if (!sk) {
1843 memprintf(errmsg, "'%s' : %s", args[*cur_arg], *errmsg);
1844 goto error;
1845 }
1846
William Dauchy1c921cd2021-02-03 22:30:08 +01001847 srv->check.addr = *sk;
1848 /* if agentaddr was never set, we can use addr */
1849 if (!(srv->flags & SRV_F_AGENTADDR))
1850 srv->agent.addr = *sk;
Christopher Fauletce8111e2020-04-06 15:04:11 +02001851
1852 out:
1853 return err_code;
1854
1855 error:
1856 err_code |= ERR_ALERT | ERR_FATAL;
1857 goto out;
1858}
1859
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001860/* Parse the "agent-addr" server keyword */
1861static int srv_parse_agent_addr(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1862 char **errmsg)
1863{
William Dauchy1c921cd2021-02-03 22:30:08 +01001864 struct sockaddr_storage sk;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001865 int err_code = 0;
1866
1867 if (!*(args[*cur_arg+1])) {
1868 memprintf(errmsg, "'%s' expects an address as argument.", args[*cur_arg]);
1869 goto error;
1870 }
William Dauchy1c921cd2021-02-03 22:30:08 +01001871 memset(&sk, 0, sizeof(sk));
1872 if (str2ip(args[*cur_arg + 1], &sk) == NULL) {
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001873 memprintf(errmsg, "parsing agent-addr failed. Check if '%s' is correct address.", args[*cur_arg+1]);
1874 goto error;
1875 }
William Dauchy1c921cd2021-02-03 22:30:08 +01001876 set_srv_agent_addr(srv, &sk);
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001877
1878 out:
1879 return err_code;
1880
1881 error:
1882 err_code |= ERR_ALERT | ERR_FATAL;
1883 goto out;
1884}
1885
1886/* Parse the "agent-check" server keyword */
1887static int srv_parse_agent_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1888 char **errmsg)
1889{
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001890 struct tcpcheck_ruleset *rs = NULL;
1891 struct tcpcheck_rules *rules = srv->agent.tcpcheck_rules;
1892 struct tcpcheck_rule *chk;
1893 int err_code = 0;
1894
1895 if (srv->do_agent)
1896 goto out;
1897
Christopher Faulet6ecd5932021-01-12 17:29:45 +01001898 if (!(curpx->cap & PR_CAP_BE)) {
1899 memprintf(errmsg, "'%s' ignored because %s '%s' has no backend capability",
1900 args[*cur_arg], proxy_type_str(curpx), curpx->id);
1901 return ERR_WARN;
1902 }
1903
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001904 if (!rules) {
1905 rules = calloc(1, sizeof(*rules));
1906 if (!rules) {
1907 memprintf(errmsg, "out of memory.");
1908 goto error;
1909 }
1910 LIST_INIT(&rules->preset_vars);
1911 srv->agent.tcpcheck_rules = rules;
1912 }
1913 rules->list = NULL;
1914 rules->flags = 0;
1915
Christopher Faulet61cc8522020-04-20 14:54:42 +02001916 rs = find_tcpcheck_ruleset("*agent-check");
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001917 if (rs)
1918 goto ruleset_found;
1919
Christopher Faulet61cc8522020-04-20 14:54:42 +02001920 rs = create_tcpcheck_ruleset("*agent-check");
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001921 if (rs == NULL) {
1922 memprintf(errmsg, "out of memory.");
1923 goto error;
1924 }
1925
Christopher Fauletb50b3e62020-05-05 18:43:43 +02001926 chk = parse_tcpcheck_send((char *[]){"tcp-check", "send-lf", "%[var(check.agent_string)]", ""},
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001927 1, curpx, &rs->rules, srv->conf.file, srv->conf.line, errmsg);
1928 if (!chk) {
1929 memprintf(errmsg, "'%s': %s", args[*cur_arg], *errmsg);
1930 goto error;
1931 }
1932 chk->index = 0;
Willy Tarreau2b718102021-04-21 07:32:39 +02001933 LIST_APPEND(&rs->rules, &chk->list);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001934
1935 chk = parse_tcpcheck_expect((char *[]){"tcp-check", "expect", "custom", ""},
Christopher Faulete5870d82020-04-15 11:32:03 +02001936 1, curpx, &rs->rules, TCPCHK_RULES_AGENT_CHK,
1937 srv->conf.file, srv->conf.line, errmsg);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001938 if (!chk) {
1939 memprintf(errmsg, "'%s': %s", args[*cur_arg], *errmsg);
1940 goto error;
1941 }
1942 chk->expect.custom = tcpcheck_agent_expect_reply;
1943 chk->index = 1;
Willy Tarreau2b718102021-04-21 07:32:39 +02001944 LIST_APPEND(&rs->rules, &chk->list);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001945
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001946 ruleset_found:
1947 rules->list = &rs->rules;
Christopher Faulet1faf18a2020-11-25 16:43:12 +01001948 rules->flags &= ~(TCPCHK_RULES_PROTO_CHK|TCPCHK_RULES_UNUSED_RS);
Christopher Faulet404f9192020-04-09 23:13:54 +02001949 rules->flags |= TCPCHK_RULES_AGENT_CHK;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001950 srv->do_agent = 1;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001951
1952 out:
Dirkjan Bussinkdfee2172021-06-18 19:57:49 +00001953 return err_code;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001954
1955 error:
1956 deinit_srv_agent_check(srv);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001957 free_tcpcheck_ruleset(rs);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001958 err_code |= ERR_ALERT | ERR_FATAL;
1959 goto out;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001960}
1961
1962/* Parse the "agent-inter" server keyword */
1963static int srv_parse_agent_inter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1964 char **errmsg)
1965{
1966 const char *err = NULL;
1967 unsigned int delay;
1968 int err_code = 0;
1969
1970 if (!*(args[*cur_arg+1])) {
1971 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
1972 goto error;
1973 }
1974
1975 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
1976 if (err == PARSE_TIME_OVER) {
1977 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
1978 args[*cur_arg+1], args[*cur_arg], srv->id);
1979 goto error;
1980 }
1981 else if (err == PARSE_TIME_UNDER) {
1982 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
1983 args[*cur_arg+1], args[*cur_arg], srv->id);
1984 goto error;
1985 }
1986 else if (err) {
1987 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
1988 *err, srv->id);
1989 goto error;
1990 }
1991 if (delay <= 0) {
1992 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
1993 delay, args[*cur_arg], srv->id);
1994 goto error;
1995 }
1996 srv->agent.inter = delay;
1997
1998 out:
1999 return err_code;
2000
2001 error:
2002 err_code |= ERR_ALERT | ERR_FATAL;
2003 goto out;
2004}
2005
2006/* Parse the "agent-port" server keyword */
2007static int srv_parse_agent_port(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2008 char **errmsg)
2009{
2010 int err_code = 0;
2011
2012 if (!*(args[*cur_arg+1])) {
2013 memprintf(errmsg, "'%s' expects a port number as argument.", args[*cur_arg]);
2014 goto error;
2015 }
2016
Amaury Denoyelle403dce82021-07-29 15:39:43 +02002017 /* Only increment maxsock for servers from the configuration. Dynamic
2018 * servers at the moment are not taken into account for the estimation
2019 * of the resources limits.
2020 */
2021 if (global.mode & MODE_STARTING)
2022 global.maxsock++;
2023
William Dauchy4858fb22021-02-03 22:30:09 +01002024 set_srv_agent_port(srv, atol(args[*cur_arg + 1]));
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002025
2026 out:
2027 return err_code;
2028
2029 error:
2030 err_code |= ERR_ALERT | ERR_FATAL;
2031 goto out;
2032}
2033
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002034int set_srv_agent_send(struct server *srv, const char *send)
2035{
2036 struct tcpcheck_rules *rules = srv->agent.tcpcheck_rules;
2037 struct tcpcheck_var *var = NULL;
2038 char *str;
2039
2040 str = strdup(send);
Christopher Fauletb61caf42020-04-21 10:57:42 +02002041 var = create_tcpcheck_var(ist("check.agent_string"));
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002042 if (str == NULL || var == NULL)
2043 goto error;
2044
2045 free_tcpcheck_vars(&rules->preset_vars);
2046
2047 var->data.type = SMP_T_STR;
2048 var->data.u.str.area = str;
2049 var->data.u.str.data = strlen(str);
2050 LIST_INIT(&var->list);
Willy Tarreau2b718102021-04-21 07:32:39 +02002051 LIST_APPEND(&rules->preset_vars, &var->list);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002052
2053 return 1;
2054
2055 error:
2056 free(str);
2057 free(var);
2058 return 0;
2059}
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002060
2061/* Parse the "agent-send" server keyword */
2062static int srv_parse_agent_send(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2063 char **errmsg)
2064{
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002065 struct tcpcheck_rules *rules = srv->agent.tcpcheck_rules;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002066 int err_code = 0;
2067
2068 if (!*(args[*cur_arg+1])) {
2069 memprintf(errmsg, "'%s' expects a string as argument.", args[*cur_arg]);
2070 goto error;
2071 }
2072
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002073 if (!rules) {
2074 rules = calloc(1, sizeof(*rules));
2075 if (!rules) {
2076 memprintf(errmsg, "out of memory.");
2077 goto error;
2078 }
2079 LIST_INIT(&rules->preset_vars);
2080 srv->agent.tcpcheck_rules = rules;
2081 }
2082
2083 if (!set_srv_agent_send(srv, args[*cur_arg+1])) {
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002084 memprintf(errmsg, "out of memory.");
2085 goto error;
2086 }
2087
2088 out:
2089 return err_code;
2090
2091 error:
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002092 deinit_srv_agent_check(srv);
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002093 err_code |= ERR_ALERT | ERR_FATAL;
2094 goto out;
2095}
2096
2097/* Parse the "no-agent-send" server keyword */
2098static int srv_parse_no_agent_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2099 char **errmsg)
2100{
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002101 deinit_srv_agent_check(srv);
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002102 return 0;
2103}
2104
Christopher Fauletce8111e2020-04-06 15:04:11 +02002105/* Parse the "check" server keyword */
2106static int srv_parse_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2107 char **errmsg)
2108{
Christopher Faulet6ecd5932021-01-12 17:29:45 +01002109 if (!(curpx->cap & PR_CAP_BE)) {
2110 memprintf(errmsg, "'%s' ignored because %s '%s' has no backend capability",
2111 args[*cur_arg], proxy_type_str(curpx), curpx->id);
2112 return ERR_WARN;
2113 }
2114
Christopher Fauletce8111e2020-04-06 15:04:11 +02002115 srv->do_check = 1;
2116 return 0;
2117}
2118
2119/* Parse the "check-send-proxy" server keyword */
2120static int srv_parse_check_send_proxy(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2121 char **errmsg)
2122{
2123 srv->check.send_proxy = 1;
2124 return 0;
2125}
2126
2127/* Parse the "check-via-socks4" server keyword */
2128static int srv_parse_check_via_socks4(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2129 char **errmsg)
2130{
2131 srv->check.via_socks4 = 1;
2132 return 0;
2133}
2134
2135/* Parse the "no-check" server keyword */
2136static int srv_parse_no_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2137 char **errmsg)
2138{
2139 deinit_srv_check(srv);
2140 return 0;
2141}
2142
2143/* Parse the "no-check-send-proxy" server keyword */
2144static int srv_parse_no_check_send_proxy(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2145 char **errmsg)
2146{
2147 srv->check.send_proxy = 0;
2148 return 0;
2149}
2150
Christopher Fauletedc6ed92020-04-23 16:27:59 +02002151/* parse the "check-proto" server keyword */
2152static int srv_parse_check_proto(char **args, int *cur_arg,
2153 struct proxy *px, struct server *newsrv, char **err)
2154{
2155 int err_code = 0;
2156
2157 if (!*args[*cur_arg + 1]) {
2158 memprintf(err, "'%s' : missing value", args[*cur_arg]);
2159 goto error;
2160 }
Tim Duesterhusdcf753a2021-03-04 17:31:47 +01002161 newsrv->check.mux_proto = get_mux_proto(ist(args[*cur_arg + 1]));
Christopher Fauletedc6ed92020-04-23 16:27:59 +02002162 if (!newsrv->check.mux_proto) {
2163 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[*cur_arg], args[*cur_arg+1]);
2164 goto error;
2165 }
2166
2167 out:
2168 return err_code;
2169
2170 error:
2171 err_code |= ERR_ALERT | ERR_FATAL;
2172 goto out;
2173}
2174
2175
Christopher Fauletce8111e2020-04-06 15:04:11 +02002176/* Parse the "rise" server keyword */
2177static int srv_parse_check_rise(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2178 char **errmsg)
2179{
2180 int err_code = 0;
2181
2182 if (!*args[*cur_arg + 1]) {
2183 memprintf(errmsg, "'%s' expects an integer argument.", args[*cur_arg]);
2184 goto error;
2185 }
2186
2187 srv->check.rise = atol(args[*cur_arg+1]);
2188 if (srv->check.rise <= 0) {
2189 memprintf(errmsg, "'%s' has to be > 0.", args[*cur_arg]);
2190 goto error;
2191 }
2192
2193 if (srv->check.health)
2194 srv->check.health = srv->check.rise;
2195
2196 out:
2197 return err_code;
2198
2199 error:
2200 deinit_srv_agent_check(srv);
2201 err_code |= ERR_ALERT | ERR_FATAL;
2202 goto out;
Christopher Fauletce8111e2020-04-06 15:04:11 +02002203}
2204
2205/* Parse the "fall" server keyword */
2206static int srv_parse_check_fall(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2207 char **errmsg)
2208{
2209 int err_code = 0;
2210
2211 if (!*args[*cur_arg + 1]) {
2212 memprintf(errmsg, "'%s' expects an integer argument.", args[*cur_arg]);
2213 goto error;
2214 }
2215
2216 srv->check.fall = atol(args[*cur_arg+1]);
2217 if (srv->check.fall <= 0) {
2218 memprintf(errmsg, "'%s' has to be > 0.", args[*cur_arg]);
2219 goto error;
2220 }
2221
2222 out:
2223 return err_code;
2224
2225 error:
2226 deinit_srv_agent_check(srv);
2227 err_code |= ERR_ALERT | ERR_FATAL;
2228 goto out;
Christopher Fauletce8111e2020-04-06 15:04:11 +02002229}
2230
2231/* Parse the "inter" server keyword */
2232static int srv_parse_check_inter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2233 char **errmsg)
2234{
2235 const char *err = NULL;
2236 unsigned int delay;
2237 int err_code = 0;
2238
2239 if (!*(args[*cur_arg+1])) {
2240 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
2241 goto error;
2242 }
2243
2244 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
2245 if (err == PARSE_TIME_OVER) {
2246 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
2247 args[*cur_arg+1], args[*cur_arg], srv->id);
2248 goto error;
2249 }
2250 else if (err == PARSE_TIME_UNDER) {
2251 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
2252 args[*cur_arg+1], args[*cur_arg], srv->id);
2253 goto error;
2254 }
2255 else if (err) {
2256 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
2257 *err, srv->id);
2258 goto error;
2259 }
2260 if (delay <= 0) {
2261 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
2262 delay, args[*cur_arg], srv->id);
2263 goto error;
2264 }
2265 srv->check.inter = delay;
2266
2267 out:
2268 return err_code;
2269
2270 error:
2271 err_code |= ERR_ALERT | ERR_FATAL;
2272 goto out;
2273}
2274
2275
2276/* Parse the "fastinter" server keyword */
2277static int srv_parse_check_fastinter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2278 char **errmsg)
2279{
2280 const char *err = NULL;
2281 unsigned int delay;
2282 int err_code = 0;
2283
2284 if (!*(args[*cur_arg+1])) {
2285 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
2286 goto error;
2287 }
2288
2289 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
2290 if (err == PARSE_TIME_OVER) {
2291 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
2292 args[*cur_arg+1], args[*cur_arg], srv->id);
2293 goto error;
2294 }
2295 else if (err == PARSE_TIME_UNDER) {
2296 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
2297 args[*cur_arg+1], args[*cur_arg], srv->id);
2298 goto error;
2299 }
2300 else if (err) {
2301 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
2302 *err, srv->id);
2303 goto error;
2304 }
2305 if (delay <= 0) {
2306 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
2307 delay, args[*cur_arg], srv->id);
2308 goto error;
2309 }
2310 srv->check.fastinter = delay;
2311
2312 out:
2313 return err_code;
2314
2315 error:
2316 err_code |= ERR_ALERT | ERR_FATAL;
2317 goto out;
2318}
2319
2320
2321/* Parse the "downinter" server keyword */
2322static int srv_parse_check_downinter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2323 char **errmsg)
2324{
2325 const char *err = NULL;
2326 unsigned int delay;
2327 int err_code = 0;
2328
2329 if (!*(args[*cur_arg+1])) {
2330 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
2331 goto error;
2332 }
2333
2334 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
2335 if (err == PARSE_TIME_OVER) {
2336 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
2337 args[*cur_arg+1], args[*cur_arg], srv->id);
2338 goto error;
2339 }
2340 else if (err == PARSE_TIME_UNDER) {
2341 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
2342 args[*cur_arg+1], args[*cur_arg], srv->id);
2343 goto error;
2344 }
2345 else if (err) {
2346 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
2347 *err, srv->id);
2348 goto error;
2349 }
2350 if (delay <= 0) {
2351 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
2352 delay, args[*cur_arg], srv->id);
2353 goto error;
2354 }
2355 srv->check.downinter = delay;
2356
2357 out:
2358 return err_code;
2359
2360 error:
2361 err_code |= ERR_ALERT | ERR_FATAL;
2362 goto out;
2363}
2364
2365/* Parse the "port" server keyword */
2366static int srv_parse_check_port(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2367 char **errmsg)
2368{
2369 int err_code = 0;
2370
2371 if (!*(args[*cur_arg+1])) {
2372 memprintf(errmsg, "'%s' expects a port number as argument.", args[*cur_arg]);
2373 goto error;
2374 }
2375
Amaury Denoyelle403dce82021-07-29 15:39:43 +02002376 /* Only increment maxsock for servers from the configuration. Dynamic
2377 * servers at the moment are not taken into account for the estimation
2378 * of the resources limits.
2379 */
2380 if (global.mode & MODE_STARTING)
2381 global.maxsock++;
2382
Christopher Fauletce8111e2020-04-06 15:04:11 +02002383 srv->check.port = atol(args[*cur_arg+1]);
William Dauchy4858fb22021-02-03 22:30:09 +01002384 /* if agentport was never set, we can use port */
2385 if (!(srv->flags & SRV_F_AGENTPORT))
2386 srv->agent.port = srv->check.port;
Christopher Fauletce8111e2020-04-06 15:04:11 +02002387
2388 out:
2389 return err_code;
2390
2391 error:
2392 err_code |= ERR_ALERT | ERR_FATAL;
2393 goto out;
2394}
2395
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002396static struct srv_kw_list srv_kws = { "CHK", { }, {
Amaury Denoyelle9ecee0f2021-07-23 16:34:58 +02002397 { "addr", srv_parse_addr, 1, 1, 1 }, /* IP address to send health to or to probe from agent-check */
2398 { "agent-addr", srv_parse_agent_addr, 1, 1, 1 }, /* Enable an auxiliary agent check */
Amaury Denoyelleb65f4ca2021-08-04 11:33:14 +02002399 { "agent-check", srv_parse_agent_check, 0, 1, 1 }, /* Enable agent checks */
Amaury Denoyelle9ecee0f2021-07-23 16:34:58 +02002400 { "agent-inter", srv_parse_agent_inter, 1, 1, 1 }, /* Set the interval between two agent checks */
2401 { "agent-port", srv_parse_agent_port, 1, 1, 1 }, /* Set the TCP port used for agent checks. */
2402 { "agent-send", srv_parse_agent_send, 1, 1, 1 }, /* Set string to send to agent. */
Amaury Denoyelle2fc4d392021-07-22 16:04:59 +02002403 { "check", srv_parse_check, 0, 1, 1 }, /* Enable health checks */
Amaury Denoyelle9ecee0f2021-07-23 16:34:58 +02002404 { "check-proto", srv_parse_check_proto, 1, 1, 1 }, /* Set the mux protocol for health checks */
2405 { "check-send-proxy", srv_parse_check_send_proxy, 0, 1, 1 }, /* Enable PROXY protocol for health checks */
2406 { "check-via-socks4", srv_parse_check_via_socks4, 0, 1, 1 }, /* Enable socks4 proxy for health checks */
Amaury Denoyelle76e10e72021-03-08 17:08:01 +01002407 { "no-agent-check", srv_parse_no_agent_check, 0, 1, 0 }, /* Do not enable any auxiliary agent check */
2408 { "no-check", srv_parse_no_check, 0, 1, 0 }, /* Disable health checks */
2409 { "no-check-send-proxy", srv_parse_no_check_send_proxy, 0, 1, 0 }, /* Disable PROXY protocol for health checks */
Amaury Denoyelle9ecee0f2021-07-23 16:34:58 +02002410 { "rise", srv_parse_check_rise, 1, 1, 1 }, /* Set rise value for health checks */
2411 { "fall", srv_parse_check_fall, 1, 1, 1 }, /* Set fall value for health checks */
2412 { "inter", srv_parse_check_inter, 1, 1, 1 }, /* Set inter value for health checks */
2413 { "fastinter", srv_parse_check_fastinter, 1, 1, 1 }, /* Set fastinter value for health checks */
2414 { "downinter", srv_parse_check_downinter, 1, 1, 1 }, /* Set downinter value for health checks */
2415 { "port", srv_parse_check_port, 1, 1, 1 }, /* Set the TCP port used for health checks. */
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002416 { NULL, NULL, 0 },
2417}};
2418
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002419INITCALL1(STG_REGISTER, srv_register_keywords, &srv_kws);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01002420
Willy Tarreaubd741542010-03-16 18:46:54 +01002421/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02002422 * Local variables:
2423 * c-indent-level: 8
2424 * c-basic-offset: 8
2425 * End:
2426 */