blob: 4c625efa61cb13f2a64db4fc3b970a026723a385 [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>
17#include <fcntl.h>
Simon Horman0ba0e4a2015-01-30 11:23:00 +090018#include <stdarg.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020019#include <stdio.h>
Krzysztof Oledzkib304dc72007-10-14 23:40:01 +020020#include <stdlib.h>
Willy Tarreau2dd0d472006-06-29 17:53:05 +020021#include <string.h>
Krzysztof Oledzkib304dc72007-10-14 23:40:01 +020022#include <time.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020023#include <unistd.h>
Willy Tarreau9f6dc722019-03-01 11:15:10 +010024#include <sys/resource.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020025#include <sys/socket.h>
Dmitry Sivachenkocaf58982009-08-24 15:11:06 +040026#include <sys/types.h>
Simon Horman98637e52014-06-20 12:30:16 +090027#include <sys/wait.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020028#include <netinet/in.h>
Willy Tarreau1274bc42009-07-15 07:16:31 +020029#include <netinet/tcp.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020030#include <arpa/inet.h>
31
Willy Tarreau122eba92020-06-04 10:15:32 +020032#include <haproxy/action.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020033#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020034#include <haproxy/arg.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020035#include <haproxy/cfgparse.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020036#include <haproxy/check.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020037#include <haproxy/chunk.h>
Willy Tarreau7c18b542020-06-11 09:23:02 +020038#include <haproxy/dgram.h>
Christopher Fauletb381a502020-11-25 13:47:00 +010039#include <haproxy/dynbuf-t.h>
Willy Tarreaubcc67332020-06-05 15:31:31 +020040#include <haproxy/extcheck.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020041#include <haproxy/fd.h>
42#include <haproxy/global.h>
43#include <haproxy/h1.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020044#include <haproxy/http.h>
Willy Tarreau87735332020-06-04 09:08:41 +020045#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020046#include <haproxy/htx.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020047#include <haproxy/istbuf.h>
48#include <haproxy/list.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020049#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/mailers.h>
51#include <haproxy/port_range.h>
52#include <haproxy/proto_tcp.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020053#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020054#include <haproxy/proxy.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020055#include <haproxy/queue.h>
56#include <haproxy/regex.h>
Emeric Brunc9437992021-02-12 19:42:55 +010057#include <haproxy/resolvers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020058#include <haproxy/sample.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020059#include <haproxy/server.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020060#include <haproxy/ssl_sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020061#include <haproxy/stats-t.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020062#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020063#include <haproxy/task.h>
Willy Tarreau51cd5952020-06-05 12:25:38 +020064#include <haproxy/tcpcheck.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020065#include <haproxy/thread.h>
66#include <haproxy/time.h>
67#include <haproxy/tools.h>
Christopher Faulet147b8c92021-04-10 09:00:38 +020068#include <haproxy/trace.h>
Willy Tarreaua1718922020-06-04 16:25:31 +020069#include <haproxy/vars.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020070
Christopher Faulet147b8c92021-04-10 09:00:38 +020071/* trace source and events */
72static void check_trace(enum trace_level level, uint64_t mask,
73 const struct trace_source *src,
74 const struct ist where, const struct ist func,
75 const void *a1, const void *a2, const void *a3, const void *a4);
76
77/* The event representation is split like this :
78 * check - check
79 *
80 * CHECK_EV_* macros are defined in <haproxy/check.h>
81 */
82static const struct trace_event check_trace_events[] = {
83 { .mask = CHK_EV_TASK_WAKE, .name = "task_wake", .desc = "Check task woken up" },
84 { .mask = CHK_EV_HCHK_START, .name = "hchck_start", .desc = "Health-check started" },
85 { .mask = CHK_EV_HCHK_WAKE, .name = "hchck_wake", .desc = "Health-check woken up" },
86 { .mask = CHK_EV_HCHK_RUN, .name = "hchck_run", .desc = "Health-check running" },
87 { .mask = CHK_EV_HCHK_END, .name = "hchck_end", .desc = "Health-check terminated" },
88 { .mask = CHK_EV_HCHK_SUCC, .name = "hchck_succ", .desc = "Health-check success" },
89 { .mask = CHK_EV_HCHK_ERR, .name = "hchck_err", .desc = "Health-check failure" },
90
91 { .mask = CHK_EV_TCPCHK_EVAL, .name = "tcp_check_eval", .desc = "tcp-check rules evaluation" },
92 { .mask = CHK_EV_TCPCHK_ERR, .name = "tcp_check_err", .desc = "tcp-check evaluation error" },
93 { .mask = CHK_EV_TCPCHK_CONN, .name = "tcp_check_conn", .desc = "tcp-check connection rule" },
94 { .mask = CHK_EV_TCPCHK_SND, .name = "tcp_check_send", .desc = "tcp-check send rule" },
95 { .mask = CHK_EV_TCPCHK_EXP, .name = "tcp_check_expect", .desc = "tcp-check expect rule" },
96 { .mask = CHK_EV_TCPCHK_ACT, .name = "tcp_check_action", .desc = "tcp-check action rule" },
97
98 { .mask = CHK_EV_RX_DATA, .name = "rx_data", .desc = "receipt of data" },
99 { .mask = CHK_EV_RX_BLK, .name = "rx_blk", .desc = "receipt blocked" },
100 { .mask = CHK_EV_RX_ERR, .name = "rx_err", .desc = "receipt error" },
101
102 { .mask = CHK_EV_TX_DATA, .name = "tx_data", .desc = "transmission of data" },
103 { .mask = CHK_EV_TX_BLK, .name = "tx_blk", .desc = "transmission blocked" },
104 { .mask = CHK_EV_TX_ERR, .name = "tx_err", .desc = "transmission error" },
105
106 {}
107};
108
109static const struct name_desc check_trace_lockon_args[4] = {
110 /* arg1 */ { /* already used by the check */ },
111 /* arg2 */ { },
112 /* arg3 */ { },
113 /* arg4 */ { }
114};
115
116static const struct name_desc check_trace_decoding[] = {
117#define CHK_VERB_CLEAN 1
118 { .name="clean", .desc="only user-friendly stuff, generally suitable for level \"user\"" },
119#define CHK_VERB_MINIMAL 2
120 { .name="minimal", .desc="report info on stream and stream-interfaces" },
121#define CHK_VERB_SIMPLE 3
122 { .name="simple", .desc="add info on request and response channels" },
123#define CHK_VERB_ADVANCED 4
124 { .name="advanced", .desc="add info on channel's buffer for data and developer levels only" },
125#define CHK_VERB_COMPLETE 5
126 { .name="complete", .desc="add info on channel's buffer" },
127 { /* end */ }
128};
129
130struct trace_source trace_check = {
131 .name = IST("check"),
132 .desc = "Health-check",
133 .arg_def = TRC_ARG1_CHK, // TRACE()'s first argument is always a stream
134 .default_cb = check_trace,
135 .known_events = check_trace_events,
136 .lockon_args = check_trace_lockon_args,
137 .decoding = check_trace_decoding,
138 .report_events = ~0, // report everything by default
139};
140
141#define TRACE_SOURCE &trace_check
142INITCALL1(STG_REGISTER, trace_register_source, TRACE_SOURCE);
143
Olivier Houchard9130a962017-10-17 17:33:43 +0200144
Christopher Faulet61cc8522020-04-20 14:54:42 +0200145static int wake_srv_chk(struct conn_stream *cs);
146struct data_cb check_conn_cb = {
147 .wake = wake_srv_chk,
148 .name = "CHCK",
149};
Christopher Fauletd7e63962020-04-17 20:15:59 +0200150
Christopher Faulet5d503fc2020-03-30 20:34:34 +0200151
Gaetan Rivet05d692d2020-02-14 17:42:54 +0100152/* Dummy frontend used to create all checks sessions. */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200153struct proxy checks_fe;
Christopher Faulet31dff9b2017-10-23 15:45:20 +0200154
Christopher Faulet147b8c92021-04-10 09:00:38 +0200155
156static inline void check_trace_buf(const struct buffer *buf, size_t ofs, size_t len)
157{
158 size_t block1, block2;
159 int line, ptr, newptr;
160
161 block1 = b_contig_data(buf, ofs);
162 block2 = 0;
163 if (block1 > len)
164 block1 = len;
165 block2 = len - block1;
166
167 ofs = b_peek_ofs(buf, ofs);
168
169 line = 0;
170 ptr = ofs;
171 while (ptr < ofs + block1) {
172 newptr = dump_text_line(&trace_buf, b_orig(buf), b_size(buf), ofs + block1, &line, ptr);
173 if (newptr == ptr)
174 break;
175 ptr = newptr;
176 }
177
178 line = ptr = 0;
179 while (ptr < block2) {
180 newptr = dump_text_line(&trace_buf, b_orig(buf), b_size(buf), block2, &line, ptr);
181 if (newptr == ptr)
182 break;
183 ptr = newptr;
184 }
185}
186
187/* trace source and events */
188static void check_trace(enum trace_level level, uint64_t mask,
189 const struct trace_source *src,
190 const struct ist where, const struct ist func,
191 const void *a1, const void *a2, const void *a3, const void *a4)
192{
193 const struct check *check = a1;
194 const struct server *srv = (check ? check->server : NULL);
195 const size_t *val = a4;
196 const char *res;
197
198 if (!check || src->verbosity < CHK_VERB_CLEAN)
199 return;
200
201 chunk_appendf(&trace_buf, " : [%c] SRV=%s",
202 ((check->type == PR_O2_EXT_CHK) ? 'E' : (check->state & CHK_ST_AGENT ? 'A' : 'H')),
203 srv->id);
204
205 chunk_appendf(&trace_buf, " status=%d/%d %s",
206 (check->health >= check->rise) ? check->health - check->rise + 1 : check->health,
207 (check->health >= check->rise) ? check->fall : check->rise,
208 (check->health >= check->rise) ? (srv->uweight ? "UP" : "DRAIN") : "DOWN");
209
210 switch (check->result) {
211 case CHK_RES_NEUTRAL: res = "-"; break;
212 case CHK_RES_FAILED: res = "FAIL"; break;
213 case CHK_RES_PASSED: res = "PASS"; break;
214 case CHK_RES_CONDPASS: res = "COND"; break;
215 default: res = "UNK"; break;
216 }
217
218 if (src->verbosity == CHK_VERB_CLEAN)
219 return;
220
221 chunk_appendf(&trace_buf, " - last=%s(%d)/%s(%d)",
222 get_check_status_info(check->status), check->status,
223 res, check->result);
224
225 /* Display the value to the 4th argument (level > STATE) */
226 if (src->level > TRACE_LEVEL_STATE && val)
227 chunk_appendf(&trace_buf, " - VAL=%lu", (long)*val);
228
229 chunk_appendf(&trace_buf, " check=%p(0x%08x)", check, check->state);
230
231 if (src->verbosity == CHK_VERB_MINIMAL)
232 return;
233
234
235 if (check->cs) {
236 chunk_appendf(&trace_buf, " - conn=%p(0x%08x)", check->cs->conn, check->cs->conn->flags);
237 chunk_appendf(&trace_buf, " cs=%p(0x%08x)", check->cs, check->cs->flags);
238 }
239
240 if (mask & CHK_EV_TCPCHK) {
241 const char *type;
242
243 switch (check->tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK) {
244 case TCPCHK_RULES_PGSQL_CHK: type = "PGSQL"; break;
245 case TCPCHK_RULES_REDIS_CHK: type = "REDIS"; break;
246 case TCPCHK_RULES_SMTP_CHK: type = "SMTP"; break;
247 case TCPCHK_RULES_HTTP_CHK: type = "HTTP"; break;
248 case TCPCHK_RULES_MYSQL_CHK: type = "MYSQL"; break;
249 case TCPCHK_RULES_LDAP_CHK: type = "LDAP"; break;
250 case TCPCHK_RULES_SSL3_CHK: type = "SSL3"; break;
251 case TCPCHK_RULES_AGENT_CHK: type = "AGENT"; break;
252 case TCPCHK_RULES_SPOP_CHK: type = "SPOP"; break;
253 case TCPCHK_RULES_TCP_CHK: type = "TCP"; break;
254 default: type = "???"; break;
255 }
256 if (check->current_step)
257 chunk_appendf(&trace_buf, " - tcp-check=(%s,%d)", type, tcpcheck_get_step_id(check, NULL));
258 else
259 chunk_appendf(&trace_buf, " - tcp-check=(%s,-)", type);
260 }
261
262 /* Display bi and bo buffer info (level > USER & verbosity > SIMPLE) */
263 if (src->level > TRACE_LEVEL_USER) {
264 const struct buffer *buf = NULL;
265
266 chunk_appendf(&trace_buf, " bi=%u@%p+%u/%u",
267 (unsigned int)b_data(&check->bi), b_orig(&check->bi),
268 (unsigned int)b_head_ofs(&check->bi), (unsigned int)b_size(&check->bi));
269 chunk_appendf(&trace_buf, " bo=%u@%p+%u/%u",
270 (unsigned int)b_data(&check->bo), b_orig(&check->bo),
271 (unsigned int)b_head_ofs(&check->bo), (unsigned int)b_size(&check->bo));
272
273 if (src->verbosity >= CHK_VERB_ADVANCED && (mask & (CHK_EV_RX)))
274 buf = (b_is_null(&check->bi) ? NULL : &check->bi);
275 else if (src->verbosity >= CHK_VERB_ADVANCED && (mask & (CHK_EV_TX)))
276 buf = (b_is_null(&check->bo) ? NULL : &check->bo);
277
278 if (buf) {
279 if ((check->tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK) == TCPCHK_RULES_HTTP_CHK) {
280 int full = (src->verbosity == CHK_VERB_COMPLETE);
281
282 chunk_memcat(&trace_buf, "\n\t", 2);
283 htx_dump(&trace_buf, htxbuf(buf), full);
284 }
285 else {
286 int max = ((src->verbosity == CHK_VERB_COMPLETE) ? 1024 : 256);
287
288 chunk_memcat(&trace_buf, "\n", 1);
289 if (b_data(buf) > max) {
290 check_trace_buf(buf, 0, max);
291 chunk_memcat(&trace_buf, " ...\n", 6);
292 }
293 else
294 check_trace_buf(buf, 0, b_data(buf));
295 }
296
297 }
298 }
299
300}
301
302
Christopher Faulet61cc8522020-04-20 14:54:42 +0200303/**************************************************************************/
304/************************ Handle check results ****************************/
305/**************************************************************************/
306struct check_status {
307 short result; /* one of SRV_CHK_* */
308 char *info; /* human readable short info */
309 char *desc; /* long description */
310};
311
312struct analyze_status {
313 char *desc; /* description */
314 unsigned char lr[HANA_OBS_SIZE]; /* result for l4/l7: 0 = ignore, 1 - error, 2 - OK */
315};
316
Simon Horman63a4a822012-03-19 07:24:41 +0900317static const struct check_status check_statuses[HCHK_STATUS_SIZE] = {
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100318 [HCHK_STATUS_UNKNOWN] = { CHK_RES_UNKNOWN, "UNK", "Unknown" },
319 [HCHK_STATUS_INI] = { CHK_RES_UNKNOWN, "INI", "Initializing" },
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200320 [HCHK_STATUS_START] = { /* SPECIAL STATUS*/ },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200321
Willy Tarreau23964182014-05-20 20:56:30 +0200322 /* Below we have finished checks */
323 [HCHK_STATUS_CHECKED] = { CHK_RES_NEUTRAL, "CHECKED", "No status change" },
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100324 [HCHK_STATUS_HANA] = { CHK_RES_FAILED, "HANA", "Health analyze" },
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100325
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100326 [HCHK_STATUS_SOCKERR] = { CHK_RES_FAILED, "SOCKERR", "Socket error" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200327
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100328 [HCHK_STATUS_L4OK] = { CHK_RES_PASSED, "L4OK", "Layer4 check passed" },
329 [HCHK_STATUS_L4TOUT] = { CHK_RES_FAILED, "L4TOUT", "Layer4 timeout" },
330 [HCHK_STATUS_L4CON] = { CHK_RES_FAILED, "L4CON", "Layer4 connection problem" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200331
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100332 [HCHK_STATUS_L6OK] = { CHK_RES_PASSED, "L6OK", "Layer6 check passed" },
333 [HCHK_STATUS_L6TOUT] = { CHK_RES_FAILED, "L6TOUT", "Layer6 timeout" },
334 [HCHK_STATUS_L6RSP] = { CHK_RES_FAILED, "L6RSP", "Layer6 invalid response" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200335
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100336 [HCHK_STATUS_L7TOUT] = { CHK_RES_FAILED, "L7TOUT", "Layer7 timeout" },
337 [HCHK_STATUS_L7RSP] = { CHK_RES_FAILED, "L7RSP", "Layer7 invalid response" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200338
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200339 [HCHK_STATUS_L57DATA] = { /* DUMMY STATUS */ },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200340
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100341 [HCHK_STATUS_L7OKD] = { CHK_RES_PASSED, "L7OK", "Layer7 check passed" },
342 [HCHK_STATUS_L7OKCD] = { CHK_RES_CONDPASS, "L7OKC", "Layer7 check conditionally passed" },
343 [HCHK_STATUS_L7STS] = { CHK_RES_FAILED, "L7STS", "Layer7 wrong status" },
Simon Horman98637e52014-06-20 12:30:16 +0900344
345 [HCHK_STATUS_PROCERR] = { CHK_RES_FAILED, "PROCERR", "External check error" },
346 [HCHK_STATUS_PROCTOUT] = { CHK_RES_FAILED, "PROCTOUT", "External check timeout" },
Cyril Bonté77010d82014-08-07 01:55:37 +0200347 [HCHK_STATUS_PROCOK] = { CHK_RES_PASSED, "PROCOK", "External check passed" },
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200348};
349
Simon Horman63a4a822012-03-19 07:24:41 +0900350static const struct analyze_status analyze_statuses[HANA_STATUS_SIZE] = { /* 0: ignore, 1: error, 2: OK */
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100351 [HANA_STATUS_UNKNOWN] = { "Unknown", { 0, 0 }},
352
353 [HANA_STATUS_L4_OK] = { "L4 successful connection", { 2, 0 }},
354 [HANA_STATUS_L4_ERR] = { "L4 unsuccessful connection", { 1, 1 }},
355
356 [HANA_STATUS_HTTP_OK] = { "Correct http response", { 0, 2 }},
357 [HANA_STATUS_HTTP_STS] = { "Wrong http response", { 0, 1 }},
358 [HANA_STATUS_HTTP_HDRRSP] = { "Invalid http response (headers)", { 0, 1 }},
359 [HANA_STATUS_HTTP_RSP] = { "Invalid http response", { 0, 1 }},
360
361 [HANA_STATUS_HTTP_READ_ERROR] = { "Read error (http)", { 0, 1 }},
362 [HANA_STATUS_HTTP_READ_TIMEOUT] = { "Read timeout (http)", { 0, 1 }},
363 [HANA_STATUS_HTTP_BROKEN_PIPE] = { "Close from server (http)", { 0, 1 }},
364};
365
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100366/* checks if <err> is a real error for errno or one that can be ignored, and
367 * return 0 for these ones or <err> for real ones.
368 */
369static inline int unclean_errno(int err)
370{
371 if (err == EAGAIN || err == EINPROGRESS ||
372 err == EISCONN || err == EALREADY)
373 return 0;
374 return err;
375}
376
Christopher Faulet7aa32712021-02-01 13:11:50 +0100377/* Converts check_status code to result code */
378short get_check_status_result(short check_status)
379{
380 if (check_status < HCHK_STATUS_SIZE)
381 return check_statuses[check_status].result;
382 else
383 return check_statuses[HCHK_STATUS_UNKNOWN].result;
384}
385
Christopher Faulet61cc8522020-04-20 14:54:42 +0200386/* Converts check_status code to description */
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200387const char *get_check_status_description(short check_status) {
388
389 const char *desc;
390
391 if (check_status < HCHK_STATUS_SIZE)
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200392 desc = check_statuses[check_status].desc;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200393 else
394 desc = NULL;
395
396 if (desc && *desc)
397 return desc;
398 else
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200399 return check_statuses[HCHK_STATUS_UNKNOWN].desc;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200400}
401
Christopher Faulet61cc8522020-04-20 14:54:42 +0200402/* Converts check_status code to short info */
William Dauchyb26122b2021-02-14 22:26:23 +0100403const char *get_check_status_info(short check_status)
404{
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200405 const char *info;
406
407 if (check_status < HCHK_STATUS_SIZE)
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200408 info = check_statuses[check_status].info;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200409 else
410 info = NULL;
411
412 if (info && *info)
413 return info;
414 else
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200415 return check_statuses[HCHK_STATUS_UNKNOWN].info;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200416}
417
Christopher Faulet61cc8522020-04-20 14:54:42 +0200418/* Convert analyze_status to description */
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100419const char *get_analyze_status(short analyze_status) {
420
421 const char *desc;
422
423 if (analyze_status < HANA_STATUS_SIZE)
424 desc = analyze_statuses[analyze_status].desc;
425 else
426 desc = NULL;
427
428 if (desc && *desc)
429 return desc;
430 else
431 return analyze_statuses[HANA_STATUS_UNKNOWN].desc;
432}
433
Christopher Faulet61cc8522020-04-20 14:54:42 +0200434/* Sets check->status, update check->duration and fill check->result with an
435 * adequate CHK_RES_* value. The new check->health is computed based on the
436 * result.
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200437 *
Christopher Faulet61cc8522020-04-20 14:54:42 +0200438 * Shows information in logs about failed health check if server is UP or
439 * succeeded health checks if server is DOWN.
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200440 */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200441void set_server_check_status(struct check *check, short status, const char *desc)
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100442{
Simon Horman4a741432013-02-23 15:35:38 +0900443 struct server *s = check->server;
Willy Tarreaubef1b322014-05-13 21:01:39 +0200444 short prev_status = check->status;
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200445 int report = 0;
Simon Horman4a741432013-02-23 15:35:38 +0900446
Christopher Faulet147b8c92021-04-10 09:00:38 +0200447 TRACE_POINT(CHK_EV_HCHK_RUN, check);
448
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200449 if (status == HCHK_STATUS_START) {
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100450 check->result = CHK_RES_UNKNOWN; /* no result yet */
Simon Horman4a741432013-02-23 15:35:38 +0900451 check->desc[0] = '\0';
452 check->start = now;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200453 return;
454 }
455
Simon Horman4a741432013-02-23 15:35:38 +0900456 if (!check->status)
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200457 return;
458
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200459 if (desc && *desc) {
Simon Horman4a741432013-02-23 15:35:38 +0900460 strncpy(check->desc, desc, HCHK_DESC_LEN-1);
461 check->desc[HCHK_DESC_LEN-1] = '\0';
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200462 } else
Simon Horman4a741432013-02-23 15:35:38 +0900463 check->desc[0] = '\0';
Krzysztof Piotr Oledzkif7089f52009-10-10 21:06:49 +0200464
Simon Horman4a741432013-02-23 15:35:38 +0900465 check->status = status;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200466 if (check_statuses[status].result)
Simon Horman4a741432013-02-23 15:35:38 +0900467 check->result = check_statuses[status].result;
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200468
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100469 if (status == HCHK_STATUS_HANA)
Simon Horman4a741432013-02-23 15:35:38 +0900470 check->duration = -1;
471 else if (!tv_iszero(&check->start)) {
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200472 /* set_server_check_status() may be called more than once */
Simon Horman4a741432013-02-23 15:35:38 +0900473 check->duration = tv_ms_elapsed(&check->start, &now);
474 tv_zero(&check->start);
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200475 }
476
Willy Tarreau23964182014-05-20 20:56:30 +0200477 /* no change is expected if no state change occurred */
478 if (check->result == CHK_RES_NEUTRAL)
479 return;
480
Olivier Houchard0923fa42019-01-11 18:43:04 +0100481 /* If the check was really just sending a mail, it won't have an
482 * associated server, so we're done now.
483 */
484 if (!s)
485 return;
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200486 report = 0;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200487
Christopher Faulet147b8c92021-04-10 09:00:38 +0200488
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200489 switch (check->result) {
490 case CHK_RES_FAILED:
Willy Tarreau12634e12014-05-23 11:32:36 +0200491 /* Failure to connect to the agent as a secondary check should not
492 * cause the server to be marked down.
493 */
494 if ((!(check->state & CHK_ST_AGENT) ||
Simon Hormaneaabd522015-02-26 11:26:17 +0900495 (check->status >= HCHK_STATUS_L57DATA)) &&
Christopher Fauletb119a792018-05-02 12:12:45 +0200496 (check->health > 0)) {
Willy Tarreau4781b152021-04-06 13:53:36 +0200497 _HA_ATOMIC_INC(&s->counters.failed_checks);
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200498 report = 1;
499 check->health--;
500 if (check->health < check->rise)
501 check->health = 0;
502 }
503 break;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200504
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200505 case CHK_RES_PASSED:
Christopher Faulet1e527cb2020-11-20 18:13:02 +0100506 case CHK_RES_CONDPASS:
507 if (check->health < check->rise + check->fall - 1) {
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200508 report = 1;
509 check->health++;
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200510
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200511 if (check->health >= check->rise)
512 check->health = check->rise + check->fall - 1; /* OK now */
513 }
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200514
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200515 /* clear consecutive_errors if observing is enabled */
516 if (s->onerror)
517 s->consecutive_errors = 0;
518 break;
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100519
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200520 default:
521 break;
522 }
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200523
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200524 if (s->proxy->options2 & PR_O2_LOGHCHKS &&
525 (status != prev_status || report)) {
526 chunk_printf(&trash,
Willy Tarreau12634e12014-05-23 11:32:36 +0200527 "%s check for %sserver %s/%s %s%s",
528 (check->state & CHK_ST_AGENT) ? "Agent" : "Health",
Willy Tarreauc93cd162014-05-13 15:54:22 +0200529 s->flags & SRV_F_BACKUP ? "backup " : "",
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100530 s->proxy->id, s->id,
Willy Tarreau6aaa1b82013-12-11 17:09:34 +0100531 (check->result == CHK_RES_CONDPASS) ? "conditionally ":"",
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200532 (check->result >= CHK_RES_PASSED) ? "succeeded" : "failed");
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200533
Emeric Brun5a133512017-10-19 14:42:30 +0200534 srv_append_status(&trash, s, check, -1, 0);
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200535
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100536 chunk_appendf(&trash, ", status: %d/%d %s",
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200537 (check->health >= check->rise) ? check->health - check->rise + 1 : check->health,
538 (check->health >= check->rise) ? check->fall : check->rise,
539 (check->health >= check->rise) ? (s->uweight ? "UP" : "DRAIN") : "DOWN");
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200540
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200541 ha_warning("%s.\n", trash.area);
542 send_log(s->proxy, LOG_NOTICE, "%s.\n", trash.area);
543 send_email_alert(s, LOG_INFO, "%s", trash.area);
Krzysztof Piotr Oledzki213014e2009-09-27 15:50:02 +0200544 }
Krzysztof Piotr Oledzki09605412009-09-23 22:09:24 +0200545}
546
Willy Tarreau4eec5472014-05-20 22:32:27 +0200547/* Marks the check <check>'s server down if the current check is already failed
548 * and the server is not down yet nor in maintenance.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200549 */
Willy Tarreaubcc67332020-06-05 15:31:31 +0200550void check_notify_failure(struct check *check)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200551{
Simon Horman4a741432013-02-23 15:35:38 +0900552 struct server *s = check->server;
Simon Hormane0d1bfb2011-06-21 14:34:58 +0900553
Willy Tarreau7b1d47c2014-05-20 14:55:13 +0200554 /* The agent secondary check should only cause a server to be marked
555 * as down if check->status is HCHK_STATUS_L7STS, which indicates
556 * that the agent returned "fail", "stopped" or "down".
557 * The implication here is that failure to connect to the agent
558 * as a secondary check should not cause the server to be marked
559 * down. */
560 if ((check->state & CHK_ST_AGENT) && check->status != HCHK_STATUS_L7STS)
561 return;
562
Willy Tarreau4eec5472014-05-20 22:32:27 +0200563 if (check->health > 0)
564 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100565
Christopher Faulet147b8c92021-04-10 09:00:38 +0200566 TRACE_STATE("health-check failed, set server DOWN", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau4eec5472014-05-20 22:32:27 +0200567 /* We only report a reason for the check if we did not do so previously */
Emeric Brun5a133512017-10-19 14:42:30 +0200568 srv_set_stopped(s, NULL, (!s->track && !(s->proxy->options2 & PR_O2_LOGHCHKS)) ? check : NULL);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200569}
570
Willy Tarreauaf549582014-05-16 17:37:50 +0200571/* Marks the check <check> as valid and tries to set its server up, provided
Willy Tarreau3e048382014-05-21 10:30:54 +0200572 * it isn't in maintenance, it is not tracking a down server and other checks
573 * comply. The rule is simple : by default, a server is up, unless any of the
574 * following conditions is true :
575 * - health check failed (check->health < rise)
576 * - agent check failed (agent->health < rise)
577 * - the server tracks a down server (track && track->state == STOPPED)
578 * Note that if the server has a slowstart, it will switch to STARTING instead
579 * of RUNNING. Also, only the health checks support the nolb mode, so the
580 * agent's success may not take the server out of this mode.
Willy Tarreauaf549582014-05-16 17:37:50 +0200581 */
Willy Tarreaubcc67332020-06-05 15:31:31 +0200582void check_notify_success(struct check *check)
Willy Tarreauaf549582014-05-16 17:37:50 +0200583{
Simon Horman4a741432013-02-23 15:35:38 +0900584 struct server *s = check->server;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100585
Emeric Brun52a91d32017-08-31 14:41:55 +0200586 if (s->next_admin & SRV_ADMF_MAINT)
Willy Tarreauaf549582014-05-16 17:37:50 +0200587 return;
Cyril Bontécd19e512010-01-31 22:34:03 +0100588
Emeric Brun52a91d32017-08-31 14:41:55 +0200589 if (s->track && s->track->next_state == SRV_ST_STOPPED)
Willy Tarreauaf549582014-05-16 17:37:50 +0200590 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100591
Willy Tarreau3e048382014-05-21 10:30:54 +0200592 if ((s->check.state & CHK_ST_ENABLED) && (s->check.health < s->check.rise))
593 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100594
Willy Tarreau3e048382014-05-21 10:30:54 +0200595 if ((s->agent.state & CHK_ST_ENABLED) && (s->agent.health < s->agent.rise))
596 return;
Willy Tarreauaf549582014-05-16 17:37:50 +0200597
Emeric Brun52a91d32017-08-31 14:41:55 +0200598 if ((check->state & CHK_ST_AGENT) && s->next_state == SRV_ST_STOPPING)
Willy Tarreau3e048382014-05-21 10:30:54 +0200599 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100600
Christopher Faulet147b8c92021-04-10 09:00:38 +0200601 TRACE_STATE("health-check succeeded, set server RUNNING", CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
Emeric Brun5a133512017-10-19 14:42:30 +0200602 srv_set_running(s, NULL, (!s->track && !(s->proxy->options2 & PR_O2_LOGHCHKS)) ? check : NULL);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100603}
604
Willy Tarreaudb58b792014-05-21 13:57:23 +0200605/* Marks the check <check> as valid and tries to set its server into stopping mode
606 * if it was running or starting, and provided it isn't in maintenance and other
607 * checks comply. The conditions for the server to be marked in stopping mode are
608 * the same as for it to be turned up. Also, only the health checks support the
609 * nolb mode.
Willy Tarreauaf549582014-05-16 17:37:50 +0200610 */
Willy Tarreaubcc67332020-06-05 15:31:31 +0200611void check_notify_stopping(struct check *check)
Willy Tarreauaf549582014-05-16 17:37:50 +0200612{
Simon Horman4a741432013-02-23 15:35:38 +0900613 struct server *s = check->server;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100614
Emeric Brun52a91d32017-08-31 14:41:55 +0200615 if (s->next_admin & SRV_ADMF_MAINT)
Willy Tarreauaf549582014-05-16 17:37:50 +0200616 return;
617
Willy Tarreaudb58b792014-05-21 13:57:23 +0200618 if (check->state & CHK_ST_AGENT)
619 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100620
Emeric Brun52a91d32017-08-31 14:41:55 +0200621 if (s->track && s->track->next_state == SRV_ST_STOPPED)
Willy Tarreaudb58b792014-05-21 13:57:23 +0200622 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100623
Willy Tarreaudb58b792014-05-21 13:57:23 +0200624 if ((s->check.state & CHK_ST_ENABLED) && (s->check.health < s->check.rise))
625 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100626
Willy Tarreaudb58b792014-05-21 13:57:23 +0200627 if ((s->agent.state & CHK_ST_ENABLED) && (s->agent.health < s->agent.rise))
628 return;
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100629
Christopher Faulet147b8c92021-04-10 09:00:38 +0200630 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 +0100631 srv_set_stopping(s, NULL, (!s->track && !(s->proxy->options2 & PR_O2_LOGHCHKS)) ? check : NULL);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +0100632}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200633
Willy Tarreau9fe7aae2013-12-31 23:47:37 +0100634/* note: use health_adjust() only, which first checks that the observe mode is
Willy Tarreau4e9df272021-02-17 15:20:19 +0100635 * enabled. This will take the server lock if needed.
Willy Tarreau9fe7aae2013-12-31 23:47:37 +0100636 */
637void __health_adjust(struct server *s, short status)
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100638{
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100639 int failed;
640 int expire;
641
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100642 if (s->observe >= HANA_OBS_SIZE)
643 return;
644
Willy Tarreaubb956662013-01-24 00:37:39 +0100645 if (status >= HANA_STATUS_SIZE || !analyze_statuses[status].desc)
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100646 return;
647
648 switch (analyze_statuses[status].lr[s->observe - 1]) {
649 case 1:
650 failed = 1;
651 break;
652
653 case 2:
654 failed = 0;
655 break;
656
657 default:
658 return;
659 }
660
661 if (!failed) {
662 /* good: clear consecutive_errors */
663 s->consecutive_errors = 0;
664 return;
665 }
666
Willy Tarreau4781b152021-04-06 13:53:36 +0200667 _HA_ATOMIC_INC(&s->consecutive_errors);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100668
669 if (s->consecutive_errors < s->consecutive_errors_limit)
670 return;
671
Willy Tarreau19d14ef2012-10-29 16:51:55 +0100672 chunk_printf(&trash, "Detected %d consecutive errors, last one was: %s",
673 s->consecutive_errors, get_analyze_status(status));
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100674
Willy Tarreau4e9df272021-02-17 15:20:19 +0100675 if (s->check.fastinter)
676 expire = tick_add(now_ms, MS_TO_TICKS(s->check.fastinter));
677 else
678 expire = TICK_ETERNITY;
679
680 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
681
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100682 switch (s->onerror) {
683 case HANA_ONERR_FASTINTER:
684 /* force fastinter - nothing to do here as all modes force it */
685 break;
686
687 case HANA_ONERR_SUDDTH:
688 /* simulate a pre-fatal failed health check */
Simon Horman58c32972013-11-25 10:46:38 +0900689 if (s->check.health > s->check.rise)
690 s->check.health = s->check.rise + 1;
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100691
Tim Duesterhus588b3142020-05-29 14:35:51 +0200692 /* fall through */
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100693
694 case HANA_ONERR_FAILCHK:
695 /* simulate a failed health check */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200696 set_server_check_status(&s->check, HCHK_STATUS_HANA,
697 trash.area);
Willy Tarreau4eec5472014-05-20 22:32:27 +0200698 check_notify_failure(&s->check);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100699 break;
700
701 case HANA_ONERR_MARKDWN:
702 /* mark server down */
Simon Horman58c32972013-11-25 10:46:38 +0900703 s->check.health = s->check.rise;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200704 set_server_check_status(&s->check, HCHK_STATUS_HANA,
705 trash.area);
Willy Tarreau4eec5472014-05-20 22:32:27 +0200706 check_notify_failure(&s->check);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100707 break;
708
709 default:
710 /* write a warning? */
711 break;
712 }
713
Willy Tarreau4e9df272021-02-17 15:20:19 +0100714 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
715
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100716 s->consecutive_errors = 0;
Willy Tarreau4781b152021-04-06 13:53:36 +0200717 _HA_ATOMIC_INC(&s->counters.failed_hana);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100718
Willy Tarreau4e9df272021-02-17 15:20:19 +0100719 if (tick_is_lt(expire, s->check.task->expire)) {
720 /* requeue check task with new expire */
721 task_schedule(s->check.task, expire);
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +0100722 }
Willy Tarreauef781042010-01-27 11:53:01 +0100723}
724
Christopher Faulet61cc8522020-04-20 14:54:42 +0200725/* Checks the connection. If an error has already been reported or the socket is
Willy Tarreau20a18342013-12-05 00:31:46 +0100726 * closed, keep errno intact as it is supposed to contain the valid error code.
727 * If no error is reported, check the socket's error queue using getsockopt().
728 * Warning, this must be done only once when returning from poll, and never
729 * after an I/O error was attempted, otherwise the error queue might contain
730 * inconsistent errors. If an error is detected, the CO_FL_ERROR is set on the
731 * socket. Returns non-zero if an error was reported, zero if everything is
732 * clean (including a properly closed socket).
733 */
734static int retrieve_errno_from_socket(struct connection *conn)
735{
736 int skerr;
737 socklen_t lskerr = sizeof(skerr);
738
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100739 if (conn->flags & CO_FL_ERROR && (unclean_errno(errno) || !conn->ctrl))
Willy Tarreau20a18342013-12-05 00:31:46 +0100740 return 1;
741
Willy Tarreau3c728722014-01-23 13:50:42 +0100742 if (!conn_ctrl_ready(conn))
Willy Tarreau20a18342013-12-05 00:31:46 +0100743 return 0;
744
Willy Tarreau585744b2017-08-24 14:31:19 +0200745 if (getsockopt(conn->handle.fd, SOL_SOCKET, SO_ERROR, &skerr, &lskerr) == 0)
Willy Tarreau20a18342013-12-05 00:31:46 +0100746 errno = skerr;
747
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100748 errno = unclean_errno(errno);
Willy Tarreau20a18342013-12-05 00:31:46 +0100749
750 if (!errno) {
751 /* we could not retrieve an error, that does not mean there is
752 * none. Just don't change anything and only report the prior
753 * error if any.
754 */
755 if (conn->flags & CO_FL_ERROR)
756 return 1;
757 else
758 return 0;
759 }
760
761 conn->flags |= CO_FL_ERROR | CO_FL_SOCK_WR_SH | CO_FL_SOCK_RD_SH;
762 return 1;
763}
764
Christopher Faulet61cc8522020-04-20 14:54:42 +0200765/* Tries to collect as much information as possible on the connection status,
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100766 * and adjust the server status accordingly. It may make use of <errno_bck>
767 * if non-null when the caller is absolutely certain of its validity (eg:
768 * checked just after a syscall). If the caller doesn't have a valid errno,
769 * it can pass zero, and retrieve_errno_from_socket() will be called to try
770 * to extract errno from the socket. If no error is reported, it will consider
771 * the <expired> flag. This is intended to be used when a connection error was
772 * reported in conn->flags or when a timeout was reported in <expired>. The
773 * function takes care of not updating a server status which was already set.
774 * All situations where at least one of <expired> or CO_FL_ERROR are set
775 * produce a status.
776 */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200777void chk_report_conn_err(struct check *check, int errno_bck, int expired)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100778{
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200779 struct conn_stream *cs = check->cs;
780 struct connection *conn = cs_conn(cs);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100781 const char *err_msg;
Willy Tarreau83061a82018-07-13 11:56:34 +0200782 struct buffer *chk;
Willy Tarreau213c6782014-10-02 14:51:02 +0200783 int step;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100784
Christopher Faulet147b8c92021-04-10 09:00:38 +0200785 if (check->result != CHK_RES_UNKNOWN) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100786 return;
Christopher Faulet147b8c92021-04-10 09:00:38 +0200787 }
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100788
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100789 errno = unclean_errno(errno_bck);
790 if (conn && errno)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100791 retrieve_errno_from_socket(conn);
792
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200793 if (conn && !(conn->flags & CO_FL_ERROR) &&
794 !(cs->flags & CS_FL_ERROR) && !expired)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100795 return;
796
Christopher Faulet147b8c92021-04-10 09:00:38 +0200797 TRACE_ENTER(CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check, 0, 0, (size_t[]){expired});
798
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100799 /* we'll try to build a meaningful error message depending on the
800 * context of the error possibly present in conn->err_code, and the
801 * socket error possibly collected above. This is useful to know the
802 * exact step of the L6 layer (eg: SSL handshake).
803 */
Baptiste Assmann5ecb77f2013-10-06 23:24:13 +0200804 chk = get_trash_chunk();
805
Christopher Faulet799f3a42020-04-07 12:06:14 +0200806 if (check->type == PR_O2_TCPCHK_CHK &&
Christopher Fauletd7e63962020-04-17 20:15:59 +0200807 (check->tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK) == TCPCHK_RULES_TCP_CHK) {
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200808 step = tcpcheck_get_step_id(check, NULL);
Christopher Faulet147b8c92021-04-10 09:00:38 +0200809 if (!step) {
810 TRACE_DEVEL("initial connection failure", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200811 chunk_printf(chk, " at initial connection step of tcp-check");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200812 }
Willy Tarreau213c6782014-10-02 14:51:02 +0200813 else {
814 chunk_printf(chk, " at step %d of tcp-check", step);
815 /* we were looking for a string */
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200816 if (check->current_step && check->current_step->action == TCPCHK_ACT_CONNECT) {
817 if (check->current_step->connect.port)
818 chunk_appendf(chk, " (connect port %d)" ,check->current_step->connect.port);
Willy Tarreau213c6782014-10-02 14:51:02 +0200819 else
820 chunk_appendf(chk, " (connect)");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200821 TRACE_DEVEL("connection failure", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200822 }
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200823 else if (check->current_step && check->current_step->action == TCPCHK_ACT_EXPECT) {
824 struct tcpcheck_expect *expect = &check->current_step->expect;
Gaetan Rivetb616add2020-02-07 15:37:17 +0100825
826 switch (expect->type) {
827 case TCPCHK_EXPECT_STRING:
Christopher Fauletb61caf42020-04-21 10:57:42 +0200828 chunk_appendf(chk, " (expect string '%.*s')", (unsigned int)istlen(expect->data), istptr(expect->data));
Gaetan Rivetb616add2020-02-07 15:37:17 +0100829 break;
830 case TCPCHK_EXPECT_BINARY:
Christopher Fauletb61caf42020-04-21 10:57:42 +0200831 chunk_appendf(chk, " (expect binary '%.*s')", (unsigned int)istlen(expect->data), istptr(expect->data));
Gaetan Rivetb616add2020-02-07 15:37:17 +0100832 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200833 case TCPCHK_EXPECT_STRING_REGEX:
Willy Tarreau213c6782014-10-02 14:51:02 +0200834 chunk_appendf(chk, " (expect regex)");
Gaetan Rivetb616add2020-02-07 15:37:17 +0100835 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200836 case TCPCHK_EXPECT_BINARY_REGEX:
Gaetan Rivetefab6c62020-02-07 15:37:17 +0100837 chunk_appendf(chk, " (expect binary regex)");
838 break;
Christopher Fauletaaab0832020-05-05 15:54:22 +0200839 case TCPCHK_EXPECT_STRING_LF:
840 chunk_appendf(chk, " (expect log-format string)");
841 break;
842 case TCPCHK_EXPECT_BINARY_LF:
843 chunk_appendf(chk, " (expect log-format binary)");
844 break;
Christopher Faulete5870d82020-04-15 11:32:03 +0200845 case TCPCHK_EXPECT_HTTP_STATUS:
Christopher Faulet8021a5f2020-04-24 13:53:12 +0200846 chunk_appendf(chk, " (expect HTTP status codes)");
Christopher Faulete5870d82020-04-15 11:32:03 +0200847 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200848 case TCPCHK_EXPECT_HTTP_STATUS_REGEX:
Christopher Faulete5870d82020-04-15 11:32:03 +0200849 chunk_appendf(chk, " (expect HTTP status regex)");
850 break;
Christopher Faulet39708192020-05-05 10:47:36 +0200851 case TCPCHK_EXPECT_HTTP_HEADER:
852 chunk_appendf(chk, " (expect HTTP header pattern)");
853 break;
Christopher Faulete5870d82020-04-15 11:32:03 +0200854 case TCPCHK_EXPECT_HTTP_BODY:
Christopher Fauletb61caf42020-04-21 10:57:42 +0200855 chunk_appendf(chk, " (expect HTTP body content '%.*s')", (unsigned int)istlen(expect->data), istptr(expect->data));
Christopher Faulete5870d82020-04-15 11:32:03 +0200856 break;
Christopher Faulet67a23452020-05-05 18:10:01 +0200857 case TCPCHK_EXPECT_HTTP_BODY_REGEX:
Christopher Faulete5870d82020-04-15 11:32:03 +0200858 chunk_appendf(chk, " (expect HTTP body regex)");
859 break;
Christopher Fauletaaab0832020-05-05 15:54:22 +0200860 case TCPCHK_EXPECT_HTTP_BODY_LF:
861 chunk_appendf(chk, " (expect log-format HTTP body)");
862 break;
Christopher Faulet9e6ed152020-04-03 15:24:06 +0200863 case TCPCHK_EXPECT_CUSTOM:
864 chunk_appendf(chk, " (expect custom function)");
865 break;
Gaetan Rivetb616add2020-02-07 15:37:17 +0100866 case TCPCHK_EXPECT_UNDEF:
867 chunk_appendf(chk, " (undefined expect!)");
868 break;
869 }
Christopher Faulet147b8c92021-04-10 09:00:38 +0200870 TRACE_DEVEL("expect rule failed", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200871 }
Christopher Fauletb2c2e0f2020-03-30 11:05:10 +0200872 else if (check->current_step && check->current_step->action == TCPCHK_ACT_SEND) {
Willy Tarreau213c6782014-10-02 14:51:02 +0200873 chunk_appendf(chk, " (send)");
Christopher Faulet147b8c92021-04-10 09:00:38 +0200874 TRACE_DEVEL("send rule failed", CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau213c6782014-10-02 14:51:02 +0200875 }
Baptiste Assmann22b09d22015-05-01 08:03:04 +0200876
Christopher Faulet6f2a5e42020-04-01 13:11:41 +0200877 if (check->current_step && check->current_step->comment)
878 chunk_appendf(chk, " comment: '%s'", check->current_step->comment);
Baptiste Assmann5ecb77f2013-10-06 23:24:13 +0200879 }
880 }
881
Willy Tarreau00149122017-10-04 18:05:01 +0200882 if (conn && conn->err_code) {
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100883 if (unclean_errno(errno))
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200884 chunk_printf(&trash, "%s (%s)%s", conn_err_code_str(conn), strerror(errno),
885 chk->area);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100886 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200887 chunk_printf(&trash, "%s%s", conn_err_code_str(conn),
888 chk->area);
889 err_msg = trash.area;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100890 }
891 else {
Willy Tarreauc8dc20a2019-12-27 12:03:27 +0100892 if (unclean_errno(errno)) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200893 chunk_printf(&trash, "%s%s", strerror(errno),
894 chk->area);
895 err_msg = trash.area;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100896 }
897 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200898 err_msg = chk->area;
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100899 }
900 }
901
Willy Tarreau00149122017-10-04 18:05:01 +0200902 if (check->state & CHK_ST_PORT_MISS) {
Baptiste Assmann95db2bc2016-06-13 14:15:41 +0200903 /* NOTE: this is reported after <fall> tries */
Baptiste Assmann95db2bc2016-06-13 14:15:41 +0200904 set_server_check_status(check, HCHK_STATUS_SOCKERR, err_msg);
905 }
906
Christopher Faulet5e293762020-10-26 11:10:49 +0100907 if (!conn || !conn->ctrl) {
908 /* error before any connection attempt (connection allocation error or no control layer) */
Willy Tarreau00149122017-10-04 18:05:01 +0200909 set_server_check_status(check, HCHK_STATUS_SOCKERR, err_msg);
910 }
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100911 else if (conn->flags & CO_FL_WAIT_L4_CONN) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100912 /* L4 not established (yet) */
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200913 if (conn->flags & CO_FL_ERROR || cs->flags & CS_FL_ERROR)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100914 set_server_check_status(check, HCHK_STATUS_L4CON, err_msg);
915 else if (expired)
916 set_server_check_status(check, HCHK_STATUS_L4TOUT, err_msg);
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200917
918 /*
919 * might be due to a server IP change.
920 * Let's trigger a DNS resolution if none are currently running.
921 */
Olivier Houchard0923fa42019-01-11 18:43:04 +0100922 if (check->server)
Emeric Brund30e9a12020-12-23 18:49:16 +0100923 resolv_trigger_resolution(check->server->resolv_requester);
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200924
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100925 }
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100926 else if (conn->flags & CO_FL_WAIT_L6_CONN) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100927 /* L6 not established (yet) */
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200928 if (conn->flags & CO_FL_ERROR || cs->flags & CS_FL_ERROR)
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100929 set_server_check_status(check, HCHK_STATUS_L6RSP, err_msg);
930 else if (expired)
931 set_server_check_status(check, HCHK_STATUS_L6TOUT, err_msg);
932 }
Willy Tarreau4ff3b892017-10-16 15:17:17 +0200933 else if (conn->flags & CO_FL_ERROR || cs->flags & CS_FL_ERROR) {
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100934 /* I/O error after connection was established and before we could diagnose */
935 set_server_check_status(check, HCHK_STATUS_SOCKERR, err_msg);
936 }
937 else if (expired) {
Christopher Fauletcf80f2f2020-04-01 11:04:52 +0200938 enum healthcheck_status tout = HCHK_STATUS_L7TOUT;
939
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100940 /* connection established but expired check */
Christopher Faulet1941bab2020-05-05 07:55:50 +0200941 if (check->current_step && check->current_step->action == TCPCHK_ACT_EXPECT &&
942 check->current_step->expect.tout_status != HCHK_STATUS_UNKNOWN)
Christopher Faulet811f78c2020-04-01 11:10:27 +0200943 tout = check->current_step->expect.tout_status;
944 set_server_check_status(check, tout, err_msg);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100945 }
946
Christopher Faulet147b8c92021-04-10 09:00:38 +0200947 TRACE_LEAVE(CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau25e2ab52013-12-04 11:17:05 +0100948 return;
949}
950
Simon Horman98637e52014-06-20 12:30:16 +0900951
Christopher Faulet61cc8522020-04-20 14:54:42 +0200952/* Builds the server state header used by HTTP health-checks */
Willy Tarreau51cd5952020-06-05 12:25:38 +0200953int httpchk_build_status_header(struct server *s, struct buffer *buf)
Simon Horman98637e52014-06-20 12:30:16 +0900954{
Christopher Faulet61cc8522020-04-20 14:54:42 +0200955 int sv_state;
956 int ratio;
957 char addr[46];
958 char port[6];
959 const char *srv_hlt_st[7] = { "DOWN", "DOWN %d/%d",
960 "UP %d/%d", "UP",
961 "NOLB %d/%d", "NOLB",
962 "no check" };
Simon Horman98637e52014-06-20 12:30:16 +0900963
Christopher Faulet61cc8522020-04-20 14:54:42 +0200964 if (!(s->check.state & CHK_ST_ENABLED))
965 sv_state = 6;
966 else if (s->cur_state != SRV_ST_STOPPED) {
967 if (s->check.health == s->check.rise + s->check.fall - 1)
968 sv_state = 3; /* UP */
969 else
970 sv_state = 2; /* going down */
Simon Horman98637e52014-06-20 12:30:16 +0900971
Christopher Faulet61cc8522020-04-20 14:54:42 +0200972 if (s->cur_state == SRV_ST_STOPPING)
973 sv_state += 2;
974 } else {
975 if (s->check.health)
976 sv_state = 1; /* going up */
977 else
978 sv_state = 0; /* DOWN */
Simon Horman98637e52014-06-20 12:30:16 +0900979 }
Willy Tarreaub7b24782016-06-21 15:32:29 +0200980
Christopher Faulet61cc8522020-04-20 14:54:42 +0200981 chunk_appendf(buf, srv_hlt_st[sv_state],
982 (s->cur_state != SRV_ST_STOPPED) ? (s->check.health - s->check.rise + 1) : (s->check.health),
983 (s->cur_state != SRV_ST_STOPPED) ? (s->check.fall) : (s->check.rise));
Willy Tarreaub7b24782016-06-21 15:32:29 +0200984
Christopher Faulet61cc8522020-04-20 14:54:42 +0200985 addr_to_str(&s->addr, addr, sizeof(addr));
986 if (s->addr.ss_family == AF_INET || s->addr.ss_family == AF_INET6)
987 snprintf(port, sizeof(port), "%u", s->svc_port);
988 else
989 *port = 0;
Willy Tarreaub7b24782016-06-21 15:32:29 +0200990
Christopher Faulet61cc8522020-04-20 14:54:42 +0200991 chunk_appendf(buf, "; address=%s; port=%s; name=%s/%s; node=%s; weight=%d/%d; scur=%d/%d; qcur=%d",
992 addr, port, s->proxy->id, s->id,
993 global.node,
994 (s->cur_eweight * s->proxy->lbprm.wmult + s->proxy->lbprm.wdiv - 1) / s->proxy->lbprm.wdiv,
995 (s->proxy->lbprm.tot_weight * s->proxy->lbprm.wmult + s->proxy->lbprm.wdiv - 1) / s->proxy->lbprm.wdiv,
996 s->cur_sess, s->proxy->beconn - s->proxy->nbpend,
997 s->nbpend);
Willy Tarreau9f6dc722019-03-01 11:15:10 +0100998
Christopher Faulet61cc8522020-04-20 14:54:42 +0200999 if ((s->cur_state == SRV_ST_STARTING) &&
1000 now.tv_sec < s->last_change + s->slowstart &&
1001 now.tv_sec >= s->last_change) {
1002 ratio = MAX(1, 100 * (now.tv_sec - s->last_change) / s->slowstart);
1003 chunk_appendf(buf, "; throttle=%d%%", ratio);
1004 }
Christopher Fauletaaae9a02020-04-26 09:50:31 +02001005
Christopher Faulet61cc8522020-04-20 14:54:42 +02001006 return b_data(buf);
1007}
Christopher Fauletaaae9a02020-04-26 09:50:31 +02001008
Willy Tarreau51cd5952020-06-05 12:25:38 +02001009/**************************************************************************/
Willy Tarreau51cd5952020-06-05 12:25:38 +02001010/***************** Health-checks based on connections *********************/
1011/**************************************************************************/
1012/* This function is used only for server health-checks. It handles connection
1013 * status updates including errors. If necessary, it wakes the check task up.
1014 * It returns 0 on normal cases, <0 if at least one close() has happened on the
1015 * connection (eg: reconnect). It relies on tcpcheck_main().
Christopher Faulet61cc8522020-04-20 14:54:42 +02001016 */
Willy Tarreau51cd5952020-06-05 12:25:38 +02001017static int wake_srv_chk(struct conn_stream *cs)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001018{
Willy Tarreau51cd5952020-06-05 12:25:38 +02001019 struct connection *conn = cs->conn;
1020 struct check *check = cs->data;
1021 struct email_alertq *q = container_of(check, typeof(*q), check);
1022 int ret = 0;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001023
Christopher Faulet147b8c92021-04-10 09:00:38 +02001024 TRACE_ENTER(CHK_EV_HCHK_WAKE, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001025 if (check->server)
1026 HA_SPIN_LOCK(SERVER_LOCK, &check->server->lock);
1027 else
1028 HA_SPIN_LOCK(EMAIL_ALERTS_LOCK, &q->lock);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001029
Willy Tarreau51cd5952020-06-05 12:25:38 +02001030 /* we may have to make progress on the TCP checks */
1031 ret = tcpcheck_main(check);
Christopher Fauletaaab0832020-05-05 15:54:22 +02001032
Willy Tarreau51cd5952020-06-05 12:25:38 +02001033 cs = check->cs;
1034 conn = cs->conn;
Christopher Fauletaaab0832020-05-05 15:54:22 +02001035
Willy Tarreau51cd5952020-06-05 12:25:38 +02001036 if (unlikely(conn->flags & CO_FL_ERROR || cs->flags & CS_FL_ERROR)) {
1037 /* We may get error reports bypassing the I/O handlers, typically
1038 * the case when sending a pure TCP check which fails, then the I/O
1039 * handlers above are not called. This is completely handled by the
1040 * main processing task so let's simply wake it up. If we get here,
1041 * we expect errno to still be valid.
1042 */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001043 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 +02001044 chk_report_conn_err(check, errno, 0);
1045 task_wakeup(check->task, TASK_WOKEN_IO);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001046 }
1047
Christopher Faulet8f100422021-01-18 15:47:03 +01001048 if (check->result != CHK_RES_UNKNOWN || ret == -1) {
Willy Tarreau51cd5952020-06-05 12:25:38 +02001049 /* Check complete or aborted. If connection not yet closed do it
1050 * now and wake the check task up to be sure the result is
1051 * handled ASAP. */
Willy Tarreau30bd4ef2020-12-11 11:09:29 +01001052 cs_drain_and_close(cs);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001053 ret = -1;
Christopher Faulet8f100422021-01-18 15:47:03 +01001054
1055 if (check->wait_list.events)
1056 cs->conn->mux->unsubscribe(cs, check->wait_list.events, &check->wait_list);
1057
Willy Tarreau51cd5952020-06-05 12:25:38 +02001058 /* We may have been scheduled to run, and the
1059 * I/O handler expects to have a cs, so remove
1060 * the tasklet
1061 */
1062 tasklet_remove_from_tasklet_list(check->wait_list.tasklet);
1063 task_wakeup(check->task, TASK_WOKEN_IO);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001064 }
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001065
Willy Tarreau51cd5952020-06-05 12:25:38 +02001066 if (check->server)
1067 HA_SPIN_UNLOCK(SERVER_LOCK, &check->server->lock);
1068 else
1069 HA_SPIN_UNLOCK(EMAIL_ALERTS_LOCK, &q->lock);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001070
Christopher Faulet147b8c92021-04-10 09:00:38 +02001071 TRACE_LEAVE(CHK_EV_HCHK_WAKE, check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001072 return ret;
1073}
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001074
Willy Tarreau51cd5952020-06-05 12:25:38 +02001075/* This function checks if any I/O is wanted, and if so, attempts to do so */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001076struct task *event_srv_chk_io(struct task *t, void *ctx, unsigned int state)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001077{
Willy Tarreau51cd5952020-06-05 12:25:38 +02001078 struct check *check = ctx;
1079 struct conn_stream *cs = check->cs;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001080
Willy Tarreau51cd5952020-06-05 12:25:38 +02001081 wake_srv_chk(cs);
1082 return NULL;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001083}
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001084
Willy Tarreau51cd5952020-06-05 12:25:38 +02001085/* manages a server health-check that uses a connection. Returns
1086 * the time the task accepts to wait, or TIME_ETERNITY for infinity.
Christopher Faulet61cc8522020-04-20 14:54:42 +02001087 *
1088 * Please do NOT place any return statement in this function and only leave
Willy Tarreau51cd5952020-06-05 12:25:38 +02001089 * via the out_unlock label.
Christopher Faulet61cc8522020-04-20 14:54:42 +02001090 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001091struct task *process_chk_conn(struct task *t, void *context, unsigned int state)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001092{
Willy Tarreau51cd5952020-06-05 12:25:38 +02001093 struct check *check = context;
1094 struct proxy *proxy = check->proxy;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001095 struct conn_stream *cs = check->cs;
1096 struct connection *conn = cs_conn(cs);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001097 int rv;
1098 int expired = tick_is_expired(t->expire, now_ms);
Willy Tarreaudeccd112018-06-14 18:38:55 +02001099
Christopher Faulet147b8c92021-04-10 09:00:38 +02001100 TRACE_ENTER(CHK_EV_TASK_WAKE, check);
1101
Willy Tarreau51cd5952020-06-05 12:25:38 +02001102 if (check->server)
1103 HA_SPIN_LOCK(SERVER_LOCK, &check->server->lock);
1104 if (!(check->state & CHK_ST_INPROGRESS)) {
1105 /* no check currently running */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001106 if (!expired) /* woke up too early */ {
1107 TRACE_STATE("health-check wake up too early", CHK_EV_TASK_WAKE, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001108 goto out_unlock;
Christopher Faulet147b8c92021-04-10 09:00:38 +02001109 }
Willy Tarreauabca5b62013-12-06 14:19:25 +01001110
Willy Tarreau51cd5952020-06-05 12:25:38 +02001111 /* we don't send any health-checks when the proxy is
1112 * stopped, the server should not be checked or the check
1113 * is disabled.
1114 */
1115 if (((check->state & (CHK_ST_ENABLED | CHK_ST_PAUSED)) != CHK_ST_ENABLED) ||
Christopher Faulet147b8c92021-04-10 09:00:38 +02001116 proxy->disabled) {
1117 TRACE_STATE("health-check paused or disabled", CHK_EV_TASK_WAKE, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001118 goto reschedule;
Christopher Faulet147b8c92021-04-10 09:00:38 +02001119 }
Christopher Faulet404f9192020-04-09 23:13:54 +02001120
Willy Tarreau51cd5952020-06-05 12:25:38 +02001121 /* we'll initiate a new check */
1122 set_server_check_status(check, HCHK_STATUS_START, NULL);
Christopher Faulet404f9192020-04-09 23:13:54 +02001123
Willy Tarreau51cd5952020-06-05 12:25:38 +02001124 check->state |= CHK_ST_INPROGRESS;
Christopher Faulet147b8c92021-04-10 09:00:38 +02001125 TRACE_STATE("init new health-check", CHK_EV_TASK_WAKE|CHK_EV_HCHK_START, check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001126
Willy Tarreau51cd5952020-06-05 12:25:38 +02001127 task_set_affinity(t, tid_bit);
1128
1129 check->current_step = NULL;
1130 tcpcheck_main(check);
1131 goto out_unlock;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001132 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001133 else {
1134 /* there was a test running.
1135 * First, let's check whether there was an uncaught error,
1136 * which can happen on connect timeout or error.
1137 */
1138 if (check->result == CHK_RES_UNKNOWN) {
Christopher Fauletb1bb0692020-11-25 16:47:30 +01001139 /* Here the connection must be defined. Otherwise the
1140 * error would have already been detected
1141 */
Willy Tarreau51cd5952020-06-05 12:25:38 +02001142 if ((conn->flags & CO_FL_ERROR) || cs->flags & CS_FL_ERROR || expired) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001143 TRACE_ERROR("report connection error", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001144 chk_report_conn_err(check, 0, expired);
1145 }
Christopher Faulet8f100422021-01-18 15:47:03 +01001146 else {
1147 if (check->state & CHK_ST_CLOSE_CONN) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001148 TRACE_DEVEL("closing current connection", CHK_EV_TASK_WAKE|CHK_EV_HCHK_RUN, check);
Christopher Faulet8f100422021-01-18 15:47:03 +01001149 cs_destroy(cs);
1150 cs = NULL;
1151 conn = NULL;
1152 check->cs = NULL;
1153 check->state &= ~CHK_ST_CLOSE_CONN;
1154 tcpcheck_main(check);
1155 }
Christopher Faulet147b8c92021-04-10 09:00:38 +02001156 if (check->result == CHK_RES_UNKNOWN) {
1157 TRACE_DEVEL("health-check not expired", CHK_EV_TASK_WAKE|CHK_EV_HCHK_RUN, check);
Christopher Faulet8f100422021-01-18 15:47:03 +01001158 goto out_unlock; /* timeout not reached, wait again */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001159 }
Christopher Faulet8f100422021-01-18 15:47:03 +01001160 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001161 }
Christopher Faulet404f9192020-04-09 23:13:54 +02001162
Willy Tarreau51cd5952020-06-05 12:25:38 +02001163 /* check complete or aborted */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001164 TRACE_STATE("health-check complete or aborted", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END, check);
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001165
Willy Tarreau51cd5952020-06-05 12:25:38 +02001166 check->current_step = NULL;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001167
Willy Tarreau51cd5952020-06-05 12:25:38 +02001168 if (conn && conn->xprt) {
1169 /* The check was aborted and the connection was not yet closed.
1170 * This can happen upon timeout, or when an external event such
1171 * as a failed response coupled with "observe layer7" caused the
1172 * server state to be suddenly changed.
1173 */
Willy Tarreau30bd4ef2020-12-11 11:09:29 +01001174 cs_drain_and_close(cs);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001175 }
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001176
Willy Tarreau51cd5952020-06-05 12:25:38 +02001177 if (cs) {
1178 if (check->wait_list.events)
1179 cs->conn->mux->unsubscribe(cs, check->wait_list.events, &check->wait_list);
1180 /* We may have been scheduled to run, and the
1181 * I/O handler expects to have a cs, so remove
1182 * the tasklet
1183 */
1184 tasklet_remove_from_tasklet_list(check->wait_list.tasklet);
1185 cs_destroy(cs);
1186 cs = check->cs = NULL;
1187 conn = NULL;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001188 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001189
1190 if (check->sess != NULL) {
1191 vars_prune(&check->vars, check->sess, NULL);
1192 session_free(check->sess);
1193 check->sess = NULL;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001194 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001195
1196 if (check->server) {
1197 if (check->result == CHK_RES_FAILED) {
1198 /* a failure or timeout detected */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001199 TRACE_DEVEL("report failure", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_ERR, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001200 check_notify_failure(check);
1201 }
1202 else if (check->result == CHK_RES_CONDPASS) {
1203 /* check is OK but asks for stopping mode */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001204 TRACE_DEVEL("report conditionnal success", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001205 check_notify_stopping(check);
1206 }
1207 else if (check->result == CHK_RES_PASSED) {
1208 /* a success was detected */
Christopher Faulet147b8c92021-04-10 09:00:38 +02001209 TRACE_DEVEL("report success", CHK_EV_TASK_WAKE|CHK_EV_HCHK_END|CHK_EV_HCHK_SUCC, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001210 check_notify_success(check);
1211 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001212 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001213 task_set_affinity(t, MAX_THREADS_MASK);
Christopher Fauletb381a502020-11-25 13:47:00 +01001214 check_release_buf(check, &check->bi);
1215 check_release_buf(check, &check->bo);
1216 check->state &= ~(CHK_ST_INPROGRESS|CHK_ST_IN_ALLOC|CHK_ST_OUT_ALLOC);
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001217
Willy Tarreau51cd5952020-06-05 12:25:38 +02001218 if (check->server) {
1219 rv = 0;
1220 if (global.spread_checks > 0) {
1221 rv = srv_getinter(check) * global.spread_checks / 100;
1222 rv -= (int) (2 * rv * (ha_random32() / 4294967295.0));
Christopher Faulet61cc8522020-04-20 14:54:42 +02001223 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001224 t->expire = tick_add(now_ms, MS_TO_TICKS(srv_getinter(check) + rv));
Christopher Faulet61cc8522020-04-20 14:54:42 +02001225 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001226 }
Willy Tarreau51cd5952020-06-05 12:25:38 +02001227
1228 reschedule:
1229 while (tick_is_expired(t->expire, now_ms))
1230 t->expire = tick_add(t->expire, MS_TO_TICKS(check->inter));
1231 out_unlock:
1232 if (check->server)
1233 HA_SPIN_UNLOCK(SERVER_LOCK, &check->server->lock);
Christopher Faulet147b8c92021-04-10 09:00:38 +02001234
1235 TRACE_LEAVE(CHK_EV_TASK_WAKE, check);
Willy Tarreau51cd5952020-06-05 12:25:38 +02001236 return t;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001237}
1238
Willy Tarreau51cd5952020-06-05 12:25:38 +02001239
Christopher Faulet61cc8522020-04-20 14:54:42 +02001240/**************************************************************************/
1241/************************** Init/deinit checks ****************************/
1242/**************************************************************************/
Christopher Fauletb381a502020-11-25 13:47:00 +01001243/*
1244 * Tries to grab a buffer and to re-enables processing on check <target>. The
1245 * check flags are used to figure what buffer was requested. It returns 1 if the
1246 * allocation succeeds, in which case the I/O tasklet is woken up, or 0 if it's
1247 * impossible to wake up and we prefer to be woken up later.
1248 */
1249int check_buf_available(void *target)
Christopher Faulet61cc8522020-04-20 14:54:42 +02001250{
Christopher Fauletb381a502020-11-25 13:47:00 +01001251 struct check *check = target;
1252
Willy Tarreaud68d4f12021-03-22 14:44:31 +01001253 if ((check->state & CHK_ST_IN_ALLOC) && b_alloc(&check->bi)) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001254 TRACE_STATE("unblocking check, input buffer allocated", CHK_EV_TCPCHK_EXP|CHK_EV_RX_BLK, check);
Christopher Fauletb381a502020-11-25 13:47:00 +01001255 check->state &= ~CHK_ST_IN_ALLOC;
1256 tasklet_wakeup(check->wait_list.tasklet);
1257 return 1;
1258 }
Willy Tarreaud68d4f12021-03-22 14:44:31 +01001259 if ((check->state & CHK_ST_OUT_ALLOC) && b_alloc(&check->bo)) {
Christopher Faulet147b8c92021-04-10 09:00:38 +02001260 TRACE_STATE("unblocking check, output buffer allocated", CHK_EV_TCPCHK_SND|CHK_EV_TX_BLK, check);
Christopher Fauletb381a502020-11-25 13:47:00 +01001261 check->state &= ~CHK_ST_OUT_ALLOC;
1262 tasklet_wakeup(check->wait_list.tasklet);
1263 return 1;
1264 }
1265
1266 return 0;
1267}
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001268
Christopher Fauletb381a502020-11-25 13:47:00 +01001269/*
William Dauchyf4300902021-02-06 20:47:50 +01001270 * Allocate a buffer. If it fails, it adds the check in buffer wait queue.
Christopher Fauletb381a502020-11-25 13:47:00 +01001271 */
1272struct buffer *check_get_buf(struct check *check, struct buffer *bptr)
1273{
1274 struct buffer *buf = NULL;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001275
Willy Tarreau90f366b2021-02-20 11:49:49 +01001276 if (likely(!LIST_ADDED(&check->buf_wait.list)) &&
Willy Tarreaud68d4f12021-03-22 14:44:31 +01001277 unlikely((buf = b_alloc(bptr)) == NULL)) {
Christopher Fauletb381a502020-11-25 13:47:00 +01001278 check->buf_wait.target = check;
1279 check->buf_wait.wakeup_cb = check_buf_available;
Willy Tarreau90f366b2021-02-20 11:49:49 +01001280 LIST_ADDQ(&ti->buffer_wq, &check->buf_wait.list);
Christopher Fauletb381a502020-11-25 13:47:00 +01001281 }
1282 return buf;
1283}
1284
1285/*
1286 * Release a buffer, if any, and try to wake up entities waiting in the buffer
1287 * wait queue.
1288 */
1289void check_release_buf(struct check *check, struct buffer *bptr)
1290{
1291 if (bptr->size) {
1292 b_free(bptr);
Willy Tarreau4d77bbf2021-02-20 12:02:46 +01001293 offer_buffers(check->buf_wait.target, 1);
Christopher Fauletb381a502020-11-25 13:47:00 +01001294 }
1295}
1296
1297const char *init_check(struct check *check, int type)
1298{
1299 check->type = type;
Christopher Fauletba3c68f2020-04-01 16:27:05 +02001300
Christopher Fauletb381a502020-11-25 13:47:00 +01001301 check->bi = BUF_NULL;
1302 check->bo = BUF_NULL;
Willy Tarreau90f366b2021-02-20 11:49:49 +01001303 LIST_INIT(&check->buf_wait.list);
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001304
Christopher Faulet61cc8522020-04-20 14:54:42 +02001305 check->wait_list.tasklet = tasklet_new();
1306 if (!check->wait_list.tasklet)
1307 return "out of memory while allocating check tasklet";
1308 check->wait_list.events = 0;
1309 check->wait_list.tasklet->process = event_srv_chk_io;
1310 check->wait_list.tasklet->context = check;
1311 return NULL;
1312}
1313
1314void free_check(struct check *check)
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001315{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001316 task_destroy(check->task);
1317 if (check->wait_list.tasklet)
1318 tasklet_free(check->wait_list.tasklet);
1319
Christopher Fauletb381a502020-11-25 13:47:00 +01001320 check_release_buf(check, &check->bi);
1321 check_release_buf(check, &check->bo);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001322 if (check->cs) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001323 ha_free(&check->cs->conn);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001324 cs_free(check->cs);
1325 check->cs = NULL;
1326 }
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001327}
1328
Christopher Faulet61cc8522020-04-20 14:54:42 +02001329/* manages a server health-check. Returns the time the task accepts to wait, or
1330 * TIME_ETERNITY for infinity.
1331 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001332struct task *process_chk(struct task *t, void *context, unsigned int state)
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001333{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001334 struct check *check = context;
1335
1336 if (check->type == PR_O2_EXT_CHK)
1337 return process_chk_proc(t, context, state);
1338 return process_chk_conn(t, context, state);
1339
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001340}
1341
Christopher Faulet61cc8522020-04-20 14:54:42 +02001342
1343static int start_check_task(struct check *check, int mininter,
1344 int nbcheck, int srvpos)
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001345{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001346 struct task *t;
1347 unsigned long thread_mask = MAX_THREADS_MASK;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001348
Christopher Faulet61cc8522020-04-20 14:54:42 +02001349 if (check->type == PR_O2_EXT_CHK)
1350 thread_mask = 1;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001351
Christopher Faulet61cc8522020-04-20 14:54:42 +02001352 /* task for the check */
1353 if ((t = task_new(thread_mask)) == NULL) {
1354 ha_alert("Starting [%s:%s] check: out of memory.\n",
1355 check->server->proxy->id, check->server->id);
1356 return 0;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001357 }
1358
Christopher Faulet61cc8522020-04-20 14:54:42 +02001359 check->task = t;
1360 t->process = process_chk;
1361 t->context = check;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001362
Christopher Faulet61cc8522020-04-20 14:54:42 +02001363 if (mininter < srv_getinter(check))
1364 mininter = srv_getinter(check);
1365
1366 if (global.max_spread_checks && mininter > global.max_spread_checks)
1367 mininter = global.max_spread_checks;
1368
1369 /* check this every ms */
1370 t->expire = tick_add(now_ms, MS_TO_TICKS(mininter * srvpos / nbcheck));
1371 check->start = now;
1372 task_queue(t);
1373
1374 return 1;
Gaetan Rivet707b52f2020-02-21 18:14:59 +01001375}
1376
Christopher Faulet61cc8522020-04-20 14:54:42 +02001377/* updates the server's weight during a warmup stage. Once the final weight is
1378 * reached, the task automatically stops. Note that any server status change
1379 * must have updated s->last_change accordingly.
1380 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001381struct task *server_warmup(struct task *t, void *context, unsigned int state)
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001382{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001383 struct server *s = context;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001384
Christopher Faulet61cc8522020-04-20 14:54:42 +02001385 /* by default, plan on stopping the task */
1386 t->expire = TICK_ETERNITY;
1387 if ((s->next_admin & SRV_ADMF_MAINT) ||
1388 (s->next_state != SRV_ST_STARTING))
1389 return t;
Christopher Faulete5870d82020-04-15 11:32:03 +02001390
Christopher Faulet61cc8522020-04-20 14:54:42 +02001391 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001392
Christopher Faulet61cc8522020-04-20 14:54:42 +02001393 /* recalculate the weights and update the state */
1394 server_recalc_eweight(s, 1);
Christopher Faulet5c288742020-03-31 08:15:58 +02001395
Christopher Faulet61cc8522020-04-20 14:54:42 +02001396 /* probably that we can refill this server with a bit more connections */
1397 pendconn_grab_from_px(s);
Christopher Faulet5c288742020-03-31 08:15:58 +02001398
Christopher Faulet61cc8522020-04-20 14:54:42 +02001399 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
Christopher Faulet5c288742020-03-31 08:15:58 +02001400
Christopher Faulet61cc8522020-04-20 14:54:42 +02001401 /* get back there in 1 second or 1/20th of the slowstart interval,
1402 * whichever is greater, resulting in small 5% steps.
1403 */
1404 if (s->next_state == SRV_ST_STARTING)
1405 t->expire = tick_add(now_ms, MS_TO_TICKS(MAX(1000, s->slowstart / 20)));
1406 return t;
1407}
1408
1409/*
1410 * Start health-check.
1411 * Returns 0 if OK, ERR_FATAL on error, and prints the error in this case.
1412 */
1413static int start_checks()
1414{
1415
1416 struct proxy *px;
1417 struct server *s;
1418 struct task *t;
1419 int nbcheck=0, mininter=0, srvpos=0;
1420
1421 /* 0- init the dummy frontend used to create all checks sessions */
1422 init_new_proxy(&checks_fe);
1423 checks_fe.cap = PR_CAP_FE | PR_CAP_BE;
1424 checks_fe.mode = PR_MODE_TCP;
1425 checks_fe.maxconn = 0;
1426 checks_fe.conn_retries = CONN_RETRIES;
1427 checks_fe.options2 |= PR_O2_INDEPSTR | PR_O2_SMARTCON | PR_O2_SMARTACC;
1428 checks_fe.timeout.client = TICK_ETERNITY;
1429
1430 /* 1- count the checkers to run simultaneously.
1431 * We also determine the minimum interval among all of those which
1432 * have an interval larger than SRV_CHK_INTER_THRES. This interval
1433 * will be used to spread their start-up date. Those which have
1434 * a shorter interval will start independently and will not dictate
1435 * too short an interval for all others.
1436 */
1437 for (px = proxies_list; px; px = px->next) {
1438 for (s = px->srv; s; s = s->next) {
1439 if (s->slowstart) {
1440 if ((t = task_new(MAX_THREADS_MASK)) == NULL) {
1441 ha_alert("Starting [%s:%s] check: out of memory.\n", px->id, s->id);
1442 return ERR_ALERT | ERR_FATAL;
1443 }
1444 /* We need a warmup task that will be called when the server
1445 * state switches from down to up.
1446 */
1447 s->warmup = t;
1448 t->process = server_warmup;
1449 t->context = s;
1450 /* server can be in this state only because of */
1451 if (s->next_state == SRV_ST_STARTING)
1452 task_schedule(s->warmup, tick_add(now_ms, MS_TO_TICKS(MAX(1000, (now.tv_sec - s->last_change)) / 20)));
Christopher Faulet5c288742020-03-31 08:15:58 +02001453 }
1454
Christopher Faulet61cc8522020-04-20 14:54:42 +02001455 if (s->check.state & CHK_ST_CONFIGURED) {
1456 nbcheck++;
1457 if ((srv_getinter(&s->check) >= SRV_CHK_INTER_THRES) &&
1458 (!mininter || mininter > srv_getinter(&s->check)))
1459 mininter = srv_getinter(&s->check);
Christopher Faulet5c288742020-03-31 08:15:58 +02001460 }
1461
Christopher Faulet61cc8522020-04-20 14:54:42 +02001462 if (s->agent.state & CHK_ST_CONFIGURED) {
1463 nbcheck++;
1464 if ((srv_getinter(&s->agent) >= SRV_CHK_INTER_THRES) &&
1465 (!mininter || mininter > srv_getinter(&s->agent)))
1466 mininter = srv_getinter(&s->agent);
1467 }
Christopher Faulet5c288742020-03-31 08:15:58 +02001468 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001469 }
Christopher Fauletb7d30092020-03-30 15:19:03 +02001470
Christopher Faulet61cc8522020-04-20 14:54:42 +02001471 if (!nbcheck)
Christopher Fauletfc633b62020-11-06 15:24:23 +01001472 return ERR_NONE;
Christopher Fauletb7d30092020-03-30 15:19:03 +02001473
Christopher Faulet61cc8522020-04-20 14:54:42 +02001474 srand((unsigned)time(NULL));
Christopher Fauletb7d30092020-03-30 15:19:03 +02001475
William Dauchyf4300902021-02-06 20:47:50 +01001476 /* 2- start them as far as possible from each other. For this, we will
1477 * start them after their interval is set to the min interval divided
1478 * by the number of servers, weighted by the server's position in the
1479 * list.
Christopher Faulet61cc8522020-04-20 14:54:42 +02001480 */
1481 for (px = proxies_list; px; px = px->next) {
1482 if ((px->options2 & PR_O2_CHK_ANY) == PR_O2_EXT_CHK) {
1483 if (init_pid_list()) {
1484 ha_alert("Starting [%s] check: out of memory.\n", px->id);
1485 return ERR_ALERT | ERR_FATAL;
1486 }
1487 }
Christopher Fauletb7d30092020-03-30 15:19:03 +02001488
Christopher Faulet61cc8522020-04-20 14:54:42 +02001489 for (s = px->srv; s; s = s->next) {
1490 /* A task for the main check */
1491 if (s->check.state & CHK_ST_CONFIGURED) {
1492 if (s->check.type == PR_O2_EXT_CHK) {
1493 if (!prepare_external_check(&s->check))
1494 return ERR_ALERT | ERR_FATAL;
Christopher Fauletb7d30092020-03-30 15:19:03 +02001495 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001496 if (!start_check_task(&s->check, mininter, nbcheck, srvpos))
1497 return ERR_ALERT | ERR_FATAL;
1498 srvpos++;
Christopher Faulet98572322020-03-30 13:16:44 +02001499 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001500
Christopher Faulet61cc8522020-04-20 14:54:42 +02001501 /* A task for a auxiliary agent check */
1502 if (s->agent.state & CHK_ST_CONFIGURED) {
1503 if (!start_check_task(&s->agent, mininter, nbcheck, srvpos)) {
1504 return ERR_ALERT | ERR_FATAL;
1505 }
1506 srvpos++;
1507 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001508 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001509 }
Christopher Fauletfc633b62020-11-06 15:24:23 +01001510 return ERR_NONE;
Christopher Faulet61cc8522020-04-20 14:54:42 +02001511}
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001512
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001513
Christopher Faulet61cc8522020-04-20 14:54:42 +02001514/*
1515 * Return value:
1516 * the port to be used for the health check
1517 * 0 in case no port could be found for the check
1518 */
1519static int srv_check_healthcheck_port(struct check *chk)
1520{
1521 int i = 0;
1522 struct server *srv = NULL;
1523
1524 srv = chk->server;
1525
William Dauchyf4300902021-02-06 20:47:50 +01001526 /* by default, we use the health check port configured */
Christopher Faulet61cc8522020-04-20 14:54:42 +02001527 if (chk->port > 0)
1528 return chk->port;
1529
1530 /* try to get the port from check_core.addr if check.port not set */
1531 i = get_host_port(&chk->addr);
1532 if (i > 0)
1533 return i;
1534
1535 /* try to get the port from server address */
1536 /* prevent MAPPORTS from working at this point, since checks could
1537 * not be performed in such case (MAPPORTS impose a relative ports
1538 * based on live traffic)
1539 */
1540 if (srv->flags & SRV_F_MAPPORTS)
1541 return 0;
1542
1543 i = srv->svc_port; /* by default */
1544 if (i > 0)
1545 return i;
1546
1547 return 0;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001548}
1549
Christopher Faulet61cc8522020-04-20 14:54:42 +02001550/* Initializes an health-check attached to the server <srv>. Non-zero is returned
1551 * if an error occurred.
1552 */
1553static int init_srv_check(struct server *srv)
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001554{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001555 const char *err;
1556 struct tcpcheck_rule *r;
Christopher Fauletfc633b62020-11-06 15:24:23 +01001557 int ret = ERR_NONE;
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001558 int check_type;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001559
Christopher Faulet6ecd5932021-01-12 17:29:45 +01001560 if (!srv->do_check || !(srv->proxy->cap & PR_CAP_BE))
Christopher Faulet61cc8522020-04-20 14:54:42 +02001561 goto out;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001562
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001563 check_type = srv->check.tcpcheck_rules->flags & TCPCHK_RULES_PROTO_CHK;
Christopher Fauletf50f4e92020-03-30 19:52:29 +02001564
Christopher Faulet61cc8522020-04-20 14:54:42 +02001565 /* If neither a port nor an addr was specified and no check transport
1566 * layer is forced, then the transport layer used by the checks is the
1567 * same as for the production traffic. Otherwise we use raw_sock by
1568 * default, unless one is specified.
1569 */
1570 if (!srv->check.port && !is_addr(&srv->check.addr)) {
1571 if (!srv->check.use_ssl && srv->use_ssl != -1) {
1572 srv->check.use_ssl = srv->use_ssl;
1573 srv->check.xprt = srv->xprt;
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001574 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001575 else if (srv->check.use_ssl == 1)
1576 srv->check.xprt = xprt_get(XPRT_SSL);
1577 srv->check.send_proxy |= (srv->pp_opts);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001578 }
Christopher Faulet66163ec2020-05-20 22:36:24 +02001579 else if (srv->check.use_ssl == 1)
1580 srv->check.xprt = xprt_get(XPRT_SSL);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001581
Christopher Faulet12882cf2020-04-23 15:50:18 +02001582 /* Inherit the mux protocol from the server if not already defined for
1583 * the check
1584 */
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001585 if (srv->mux_proto && !srv->check.mux_proto &&
1586 ((srv->mux_proto->mode == PROTO_MODE_HTTP && check_type == TCPCHK_RULES_HTTP_CHK) ||
1587 (srv->mux_proto->mode == PROTO_MODE_TCP && check_type != TCPCHK_RULES_HTTP_CHK))) {
Christopher Faulet12882cf2020-04-23 15:50:18 +02001588 srv->check.mux_proto = srv->mux_proto;
Amaury Denoyelle0519bd42020-11-13 12:34:56 +01001589 }
Amaury Denoyelle7c148902020-11-13 12:34:57 +01001590 /* test that check proto is valid if explicitly defined */
1591 else if (srv->check.mux_proto &&
1592 ((srv->check.mux_proto->mode == PROTO_MODE_HTTP && check_type != TCPCHK_RULES_HTTP_CHK) ||
1593 (srv->check.mux_proto->mode == PROTO_MODE_TCP && check_type == TCPCHK_RULES_HTTP_CHK))) {
1594 ha_alert("config: %s '%s': server '%s' uses an incompatible MUX protocol for the selected check type\n",
1595 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1596 ret |= ERR_ALERT | ERR_FATAL;
1597 goto out;
1598 }
Christopher Faulet12882cf2020-04-23 15:50:18 +02001599
Christopher Faulet61cc8522020-04-20 14:54:42 +02001600 /* validate <srv> server health-check settings */
Christopher Fauletf50f4e92020-03-30 19:52:29 +02001601
Christopher Faulet61cc8522020-04-20 14:54:42 +02001602 /* We need at least a service port, a check port or the first tcp-check
1603 * rule must be a 'connect' one when checking an IPv4/IPv6 server.
1604 */
1605 if ((srv_check_healthcheck_port(&srv->check) != 0) ||
1606 (!is_inet_addr(&srv->check.addr) && (is_addr(&srv->check.addr) || !is_inet_addr(&srv->addr))))
1607 goto init;
Christopher Fauletf50f4e92020-03-30 19:52:29 +02001608
Christopher Faulet61cc8522020-04-20 14:54:42 +02001609 if (!srv->proxy->tcpcheck_rules.list || LIST_ISEMPTY(srv->proxy->tcpcheck_rules.list)) {
1610 ha_alert("config: %s '%s': server '%s' has neither service port nor check port.\n",
1611 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1612 ret |= ERR_ALERT | ERR_ABORT;
1613 goto out;
1614 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001615
Christopher Faulet61cc8522020-04-20 14:54:42 +02001616 /* search the first action (connect / send / expect) in the list */
1617 r = get_first_tcpcheck_rule(&srv->proxy->tcpcheck_rules);
1618 if (!r || (r->action != TCPCHK_ACT_CONNECT) || (!r->connect.port && !get_host_port(&r->connect.addr))) {
1619 ha_alert("config: %s '%s': server '%s' has neither service port nor check port "
1620 "nor tcp_check rule 'connect' with port information.\n",
1621 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1622 ret |= ERR_ALERT | ERR_ABORT;
1623 goto out;
1624 }
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001625
Christopher Faulet61cc8522020-04-20 14:54:42 +02001626 /* scan the tcp-check ruleset to ensure a port has been configured */
1627 list_for_each_entry(r, srv->proxy->tcpcheck_rules.list, list) {
1628 if ((r->action == TCPCHK_ACT_CONNECT) && (!r->connect.port || !get_host_port(&r->connect.addr))) {
1629 ha_alert("config: %s '%s': server '%s' has neither service port nor check port, "
1630 "and a tcp_check rule 'connect' with no port information.\n",
1631 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1632 ret |= ERR_ALERT | ERR_ABORT;
1633 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001634 }
Christopher Faulete5870d82020-04-15 11:32:03 +02001635 }
1636
Christopher Faulet61cc8522020-04-20 14:54:42 +02001637 init:
1638 if (!(srv->proxy->options2 & PR_O2_CHK_ANY)) {
1639 struct tcpcheck_ruleset *rs = NULL;
1640 struct tcpcheck_rules *rules = &srv->proxy->tcpcheck_rules;
1641 //char *errmsg = NULL;
Christopher Faulete5870d82020-04-15 11:32:03 +02001642
Christopher Faulet61cc8522020-04-20 14:54:42 +02001643 srv->proxy->options2 &= ~PR_O2_CHK_ANY;
1644 srv->proxy->options2 |= PR_O2_TCPCHK_CHK;
Christopher Faulete5870d82020-04-15 11:32:03 +02001645
Christopher Faulet61cc8522020-04-20 14:54:42 +02001646 rs = find_tcpcheck_ruleset("*tcp-check");
1647 if (!rs) {
1648 rs = create_tcpcheck_ruleset("*tcp-check");
1649 if (rs == NULL) {
1650 ha_alert("config: %s '%s': out of memory.\n",
1651 proxy_type_str(srv->proxy), srv->proxy->id);
1652 ret |= ERR_ALERT | ERR_FATAL;
1653 goto out;
1654 }
Christopher Faulete5870d82020-04-15 11:32:03 +02001655 }
1656
Christopher Faulet61cc8522020-04-20 14:54:42 +02001657 free_tcpcheck_vars(&rules->preset_vars);
1658 rules->list = &rs->rules;
1659 rules->flags = 0;
Christopher Faulete5870d82020-04-15 11:32:03 +02001660 }
1661
Christopher Faulet61cc8522020-04-20 14:54:42 +02001662 err = init_check(&srv->check, srv->proxy->options2 & PR_O2_CHK_ANY);
1663 if (err) {
1664 ha_alert("config: %s '%s': unable to init check for server '%s' (%s).\n",
1665 proxy_type_str(srv->proxy), srv->proxy->id, srv->id, err);
1666 ret |= ERR_ALERT | ERR_ABORT;
1667 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001668 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001669 srv->check.state |= CHK_ST_CONFIGURED | CHK_ST_ENABLED;
1670 global.maxsock++;
Christopher Faulete5870d82020-04-15 11:32:03 +02001671
Christopher Faulet61cc8522020-04-20 14:54:42 +02001672 out:
1673 return ret;
Christopher Faulete5870d82020-04-15 11:32:03 +02001674}
1675
Christopher Faulet61cc8522020-04-20 14:54:42 +02001676/* Initializes an agent-check attached to the server <srv>. Non-zero is returned
1677 * if an error occurred.
1678 */
1679static int init_srv_agent_check(struct server *srv)
Christopher Faulete5870d82020-04-15 11:32:03 +02001680{
Christopher Faulet61cc8522020-04-20 14:54:42 +02001681 struct tcpcheck_rule *chk;
1682 const char *err;
Christopher Fauletfc633b62020-11-06 15:24:23 +01001683 int ret = ERR_NONE;
Christopher Faulete5870d82020-04-15 11:32:03 +02001684
Christopher Faulet6ecd5932021-01-12 17:29:45 +01001685 if (!srv->do_agent || !(srv->proxy->cap & PR_CAP_BE))
Christopher Faulet61cc8522020-04-20 14:54:42 +02001686 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001687
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05001688 /* If there is no connect rule preceding all send / expect rules, an
Christopher Faulet61cc8522020-04-20 14:54:42 +02001689 * implicit one is inserted before all others.
1690 */
1691 chk = get_first_tcpcheck_rule(srv->agent.tcpcheck_rules);
1692 if (!chk || chk->action != TCPCHK_ACT_CONNECT) {
1693 chk = calloc(1, sizeof(*chk));
1694 if (!chk) {
1695 ha_alert("config : %s '%s': unable to add implicit tcp-check connect rule"
1696 " to agent-check for server '%s' (out of memory).\n",
1697 proxy_type_str(srv->proxy), srv->proxy->id, srv->id);
1698 ret |= ERR_ALERT | ERR_FATAL;
1699 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001700 }
Christopher Faulet61cc8522020-04-20 14:54:42 +02001701 chk->action = TCPCHK_ACT_CONNECT;
1702 chk->connect.options = (TCPCHK_OPT_DEFAULT_CONNECT|TCPCHK_OPT_IMPLICIT);
1703 LIST_ADD(srv->agent.tcpcheck_rules->list, &chk->list);
Christopher Faulete5870d82020-04-15 11:32:03 +02001704 }
1705
Christopher Faulete5870d82020-04-15 11:32:03 +02001706
Christopher Faulet61cc8522020-04-20 14:54:42 +02001707 err = init_check(&srv->agent, PR_O2_TCPCHK_CHK);
1708 if (err) {
1709 ha_alert("config: %s '%s': unable to init agent-check for server '%s' (%s).\n",
1710 proxy_type_str(srv->proxy), srv->proxy->id, srv->id, err);
1711 ret |= ERR_ALERT | ERR_ABORT;
1712 goto out;
Christopher Faulete5870d82020-04-15 11:32:03 +02001713 }
1714
Christopher Faulet61cc8522020-04-20 14:54:42 +02001715 if (!srv->agent.inter)
1716 srv->agent.inter = srv->check.inter;
1717
1718 srv->agent.state |= CHK_ST_CONFIGURED | CHK_ST_ENABLED | CHK_ST_AGENT;
1719 global.maxsock++;
1720
1721 out:
1722 return ret;
Christopher Faulete5870d82020-04-15 11:32:03 +02001723}
1724
Christopher Faulet61cc8522020-04-20 14:54:42 +02001725static void deinit_srv_check(struct server *srv)
1726{
1727 if (srv->check.state & CHK_ST_CONFIGURED)
1728 free_check(&srv->check);
1729 srv->check.state &= ~CHK_ST_CONFIGURED & ~CHK_ST_ENABLED;
1730 srv->do_check = 0;
1731}
Christopher Faulete5870d82020-04-15 11:32:03 +02001732
Christopher Faulet61cc8522020-04-20 14:54:42 +02001733
1734static void deinit_srv_agent_check(struct server *srv)
1735{
1736 if (srv->agent.tcpcheck_rules) {
1737 free_tcpcheck_vars(&srv->agent.tcpcheck_rules->preset_vars);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001738 ha_free(&srv->agent.tcpcheck_rules);
Christopher Faulete5870d82020-04-15 11:32:03 +02001739 }
Christopher Faulete5870d82020-04-15 11:32:03 +02001740
Christopher Faulet61cc8522020-04-20 14:54:42 +02001741 if (srv->agent.state & CHK_ST_CONFIGURED)
1742 free_check(&srv->agent);
1743
1744 srv->agent.state &= ~CHK_ST_CONFIGURED & ~CHK_ST_ENABLED & ~CHK_ST_AGENT;
1745 srv->do_agent = 0;
Christopher Faulete5870d82020-04-15 11:32:03 +02001746}
1747
Willy Tarreaucee013e2020-06-05 11:40:38 +02001748REGISTER_POST_SERVER_CHECK(init_srv_check);
1749REGISTER_POST_SERVER_CHECK(init_srv_agent_check);
Willy Tarreaucee013e2020-06-05 11:40:38 +02001750REGISTER_POST_CHECK(start_checks);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001751
Willy Tarreaucee013e2020-06-05 11:40:38 +02001752REGISTER_SERVER_DEINIT(deinit_srv_check);
1753REGISTER_SERVER_DEINIT(deinit_srv_agent_check);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001754
Christopher Faulet61cc8522020-04-20 14:54:42 +02001755
1756/**************************************************************************/
1757/************************** Check sample fetches **************************/
1758/**************************************************************************/
Christopher Fauletfd6c2292020-03-25 18:20:15 +01001759
Christopher Faulet61cc8522020-04-20 14:54:42 +02001760static struct sample_fetch_kw_list smp_kws = {ILH, {
Christopher Faulet61cc8522020-04-20 14:54:42 +02001761 { /* END */ },
1762}};
1763
1764INITCALL1(STG_REGISTER, sample_register_fetches, &smp_kws);
1765
1766
1767/**************************************************************************/
1768/************************ Check's parsing functions ***********************/
1769/**************************************************************************/
Christopher Fauletce8111e2020-04-06 15:04:11 +02001770/* Parse the "addr" server keyword */
1771static int srv_parse_addr(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1772 char **errmsg)
1773{
1774 struct sockaddr_storage *sk;
Christopher Fauletce8111e2020-04-06 15:04:11 +02001775 int port1, port2, err_code = 0;
1776
1777
1778 if (!*args[*cur_arg+1]) {
1779 memprintf(errmsg, "'%s' expects <ipv4|ipv6> as argument.", args[*cur_arg]);
1780 goto error;
1781 }
1782
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001783 sk = str2sa_range(args[*cur_arg+1], NULL, &port1, &port2, NULL, NULL, errmsg, NULL, NULL,
1784 PA_O_RESOLVE | PA_O_PORT_OK | PA_O_STREAM | PA_O_CONNECT);
Christopher Fauletce8111e2020-04-06 15:04:11 +02001785 if (!sk) {
1786 memprintf(errmsg, "'%s' : %s", args[*cur_arg], *errmsg);
1787 goto error;
1788 }
1789
William Dauchy1c921cd2021-02-03 22:30:08 +01001790 srv->check.addr = *sk;
1791 /* if agentaddr was never set, we can use addr */
1792 if (!(srv->flags & SRV_F_AGENTADDR))
1793 srv->agent.addr = *sk;
Christopher Fauletce8111e2020-04-06 15:04:11 +02001794
1795 out:
1796 return err_code;
1797
1798 error:
1799 err_code |= ERR_ALERT | ERR_FATAL;
1800 goto out;
1801}
1802
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001803/* Parse the "agent-addr" server keyword */
1804static int srv_parse_agent_addr(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1805 char **errmsg)
1806{
William Dauchy1c921cd2021-02-03 22:30:08 +01001807 struct sockaddr_storage sk;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001808 int err_code = 0;
1809
1810 if (!*(args[*cur_arg+1])) {
1811 memprintf(errmsg, "'%s' expects an address as argument.", args[*cur_arg]);
1812 goto error;
1813 }
William Dauchy1c921cd2021-02-03 22:30:08 +01001814 memset(&sk, 0, sizeof(sk));
1815 if (str2ip(args[*cur_arg + 1], &sk) == NULL) {
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001816 memprintf(errmsg, "parsing agent-addr failed. Check if '%s' is correct address.", args[*cur_arg+1]);
1817 goto error;
1818 }
William Dauchy1c921cd2021-02-03 22:30:08 +01001819 set_srv_agent_addr(srv, &sk);
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001820
1821 out:
1822 return err_code;
1823
1824 error:
1825 err_code |= ERR_ALERT | ERR_FATAL;
1826 goto out;
1827}
1828
1829/* Parse the "agent-check" server keyword */
1830static int srv_parse_agent_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1831 char **errmsg)
1832{
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001833 struct tcpcheck_ruleset *rs = NULL;
1834 struct tcpcheck_rules *rules = srv->agent.tcpcheck_rules;
1835 struct tcpcheck_rule *chk;
1836 int err_code = 0;
1837
1838 if (srv->do_agent)
1839 goto out;
1840
Christopher Faulet6ecd5932021-01-12 17:29:45 +01001841 if (!(curpx->cap & PR_CAP_BE)) {
1842 memprintf(errmsg, "'%s' ignored because %s '%s' has no backend capability",
1843 args[*cur_arg], proxy_type_str(curpx), curpx->id);
1844 return ERR_WARN;
1845 }
1846
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001847 if (!rules) {
1848 rules = calloc(1, sizeof(*rules));
1849 if (!rules) {
1850 memprintf(errmsg, "out of memory.");
1851 goto error;
1852 }
1853 LIST_INIT(&rules->preset_vars);
1854 srv->agent.tcpcheck_rules = rules;
1855 }
1856 rules->list = NULL;
1857 rules->flags = 0;
1858
Christopher Faulet61cc8522020-04-20 14:54:42 +02001859 rs = find_tcpcheck_ruleset("*agent-check");
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001860 if (rs)
1861 goto ruleset_found;
1862
Christopher Faulet61cc8522020-04-20 14:54:42 +02001863 rs = create_tcpcheck_ruleset("*agent-check");
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001864 if (rs == NULL) {
1865 memprintf(errmsg, "out of memory.");
1866 goto error;
1867 }
1868
Christopher Fauletb50b3e62020-05-05 18:43:43 +02001869 chk = parse_tcpcheck_send((char *[]){"tcp-check", "send-lf", "%[var(check.agent_string)]", ""},
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001870 1, curpx, &rs->rules, srv->conf.file, srv->conf.line, errmsg);
1871 if (!chk) {
1872 memprintf(errmsg, "'%s': %s", args[*cur_arg], *errmsg);
1873 goto error;
1874 }
1875 chk->index = 0;
1876 LIST_ADDQ(&rs->rules, &chk->list);
1877
1878 chk = parse_tcpcheck_expect((char *[]){"tcp-check", "expect", "custom", ""},
Christopher Faulete5870d82020-04-15 11:32:03 +02001879 1, curpx, &rs->rules, TCPCHK_RULES_AGENT_CHK,
1880 srv->conf.file, srv->conf.line, errmsg);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001881 if (!chk) {
1882 memprintf(errmsg, "'%s': %s", args[*cur_arg], *errmsg);
1883 goto error;
1884 }
1885 chk->expect.custom = tcpcheck_agent_expect_reply;
1886 chk->index = 1;
1887 LIST_ADDQ(&rs->rules, &chk->list);
1888
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001889 ruleset_found:
1890 rules->list = &rs->rules;
Christopher Faulet1faf18a2020-11-25 16:43:12 +01001891 rules->flags &= ~(TCPCHK_RULES_PROTO_CHK|TCPCHK_RULES_UNUSED_RS);
Christopher Faulet404f9192020-04-09 23:13:54 +02001892 rules->flags |= TCPCHK_RULES_AGENT_CHK;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001893 srv->do_agent = 1;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001894
1895 out:
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001896 return 0;
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001897
1898 error:
1899 deinit_srv_agent_check(srv);
Christopher Faulet61cc8522020-04-20 14:54:42 +02001900 free_tcpcheck_ruleset(rs);
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001901 err_code |= ERR_ALERT | ERR_FATAL;
1902 goto out;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001903}
1904
1905/* Parse the "agent-inter" server keyword */
1906static int srv_parse_agent_inter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1907 char **errmsg)
1908{
1909 const char *err = NULL;
1910 unsigned int delay;
1911 int err_code = 0;
1912
1913 if (!*(args[*cur_arg+1])) {
1914 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
1915 goto error;
1916 }
1917
1918 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
1919 if (err == PARSE_TIME_OVER) {
1920 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
1921 args[*cur_arg+1], args[*cur_arg], srv->id);
1922 goto error;
1923 }
1924 else if (err == PARSE_TIME_UNDER) {
1925 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
1926 args[*cur_arg+1], args[*cur_arg], srv->id);
1927 goto error;
1928 }
1929 else if (err) {
1930 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
1931 *err, srv->id);
1932 goto error;
1933 }
1934 if (delay <= 0) {
1935 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
1936 delay, args[*cur_arg], srv->id);
1937 goto error;
1938 }
1939 srv->agent.inter = delay;
1940
1941 out:
1942 return err_code;
1943
1944 error:
1945 err_code |= ERR_ALERT | ERR_FATAL;
1946 goto out;
1947}
1948
1949/* Parse the "agent-port" server keyword */
1950static int srv_parse_agent_port(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
1951 char **errmsg)
1952{
1953 int err_code = 0;
1954
1955 if (!*(args[*cur_arg+1])) {
1956 memprintf(errmsg, "'%s' expects a port number as argument.", args[*cur_arg]);
1957 goto error;
1958 }
1959
1960 global.maxsock++;
William Dauchy4858fb22021-02-03 22:30:09 +01001961 set_srv_agent_port(srv, atol(args[*cur_arg + 1]));
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001962
1963 out:
1964 return err_code;
1965
1966 error:
1967 err_code |= ERR_ALERT | ERR_FATAL;
1968 goto out;
1969}
1970
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001971int set_srv_agent_send(struct server *srv, const char *send)
1972{
1973 struct tcpcheck_rules *rules = srv->agent.tcpcheck_rules;
1974 struct tcpcheck_var *var = NULL;
1975 char *str;
1976
1977 str = strdup(send);
Christopher Fauletb61caf42020-04-21 10:57:42 +02001978 var = create_tcpcheck_var(ist("check.agent_string"));
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02001979 if (str == NULL || var == NULL)
1980 goto error;
1981
1982 free_tcpcheck_vars(&rules->preset_vars);
1983
1984 var->data.type = SMP_T_STR;
1985 var->data.u.str.area = str;
1986 var->data.u.str.data = strlen(str);
1987 LIST_INIT(&var->list);
1988 LIST_ADDQ(&rules->preset_vars, &var->list);
1989
1990 return 1;
1991
1992 error:
1993 free(str);
1994 free(var);
1995 return 0;
1996}
Christopher Fauletcbba66c2020-04-06 14:26:30 +02001997
William Dauchyf4300902021-02-06 20:47:50 +01001998/* set agent addr and appropriate flag */
William Dauchy1c921cd2021-02-03 22:30:08 +01001999inline void set_srv_agent_addr(struct server *srv, struct sockaddr_storage *sk)
2000{
2001 srv->agent.addr = *sk;
2002 srv->flags |= SRV_F_AGENTADDR;
2003}
2004
William Dauchyf4300902021-02-06 20:47:50 +01002005/* set agent port and appropriate flag */
William Dauchy4858fb22021-02-03 22:30:09 +01002006inline void set_srv_agent_port(struct server *srv, int port)
2007{
2008 srv->agent.port = port;
2009 srv->flags |= SRV_F_AGENTPORT;
2010}
2011
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002012/* Parse the "agent-send" server keyword */
2013static int srv_parse_agent_send(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2014 char **errmsg)
2015{
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002016 struct tcpcheck_rules *rules = srv->agent.tcpcheck_rules;
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002017 int err_code = 0;
2018
2019 if (!*(args[*cur_arg+1])) {
2020 memprintf(errmsg, "'%s' expects a string as argument.", args[*cur_arg]);
2021 goto error;
2022 }
2023
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002024 if (!rules) {
2025 rules = calloc(1, sizeof(*rules));
2026 if (!rules) {
2027 memprintf(errmsg, "out of memory.");
2028 goto error;
2029 }
2030 LIST_INIT(&rules->preset_vars);
2031 srv->agent.tcpcheck_rules = rules;
2032 }
2033
2034 if (!set_srv_agent_send(srv, args[*cur_arg+1])) {
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002035 memprintf(errmsg, "out of memory.");
2036 goto error;
2037 }
2038
2039 out:
2040 return err_code;
2041
2042 error:
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002043 deinit_srv_agent_check(srv);
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002044 err_code |= ERR_ALERT | ERR_FATAL;
2045 goto out;
2046}
2047
2048/* Parse the "no-agent-send" server keyword */
2049static int srv_parse_no_agent_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2050 char **errmsg)
2051{
Christopher Faulet0ae3d1d2020-04-06 17:54:24 +02002052 deinit_srv_agent_check(srv);
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002053 return 0;
2054}
2055
Christopher Fauletce8111e2020-04-06 15:04:11 +02002056/* Parse the "check" server keyword */
2057static int srv_parse_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2058 char **errmsg)
2059{
Christopher Faulet6ecd5932021-01-12 17:29:45 +01002060 if (!(curpx->cap & PR_CAP_BE)) {
2061 memprintf(errmsg, "'%s' ignored because %s '%s' has no backend capability",
2062 args[*cur_arg], proxy_type_str(curpx), curpx->id);
2063 return ERR_WARN;
2064 }
2065
Christopher Fauletce8111e2020-04-06 15:04:11 +02002066 srv->do_check = 1;
2067 return 0;
2068}
2069
2070/* Parse the "check-send-proxy" server keyword */
2071static int srv_parse_check_send_proxy(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2072 char **errmsg)
2073{
2074 srv->check.send_proxy = 1;
2075 return 0;
2076}
2077
2078/* Parse the "check-via-socks4" server keyword */
2079static int srv_parse_check_via_socks4(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2080 char **errmsg)
2081{
2082 srv->check.via_socks4 = 1;
2083 return 0;
2084}
2085
2086/* Parse the "no-check" server keyword */
2087static int srv_parse_no_check(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2088 char **errmsg)
2089{
2090 deinit_srv_check(srv);
2091 return 0;
2092}
2093
2094/* Parse the "no-check-send-proxy" server keyword */
2095static int srv_parse_no_check_send_proxy(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2096 char **errmsg)
2097{
2098 srv->check.send_proxy = 0;
2099 return 0;
2100}
2101
Christopher Fauletedc6ed92020-04-23 16:27:59 +02002102/* parse the "check-proto" server keyword */
2103static int srv_parse_check_proto(char **args, int *cur_arg,
2104 struct proxy *px, struct server *newsrv, char **err)
2105{
2106 int err_code = 0;
2107
2108 if (!*args[*cur_arg + 1]) {
2109 memprintf(err, "'%s' : missing value", args[*cur_arg]);
2110 goto error;
2111 }
Tim Duesterhusdcf753a2021-03-04 17:31:47 +01002112 newsrv->check.mux_proto = get_mux_proto(ist(args[*cur_arg + 1]));
Christopher Fauletedc6ed92020-04-23 16:27:59 +02002113 if (!newsrv->check.mux_proto) {
2114 memprintf(err, "'%s' : unknown MUX protocol '%s'", args[*cur_arg], args[*cur_arg+1]);
2115 goto error;
2116 }
2117
2118 out:
2119 return err_code;
2120
2121 error:
2122 err_code |= ERR_ALERT | ERR_FATAL;
2123 goto out;
2124}
2125
2126
Christopher Fauletce8111e2020-04-06 15:04:11 +02002127/* Parse the "rise" server keyword */
2128static int srv_parse_check_rise(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2129 char **errmsg)
2130{
2131 int err_code = 0;
2132
2133 if (!*args[*cur_arg + 1]) {
2134 memprintf(errmsg, "'%s' expects an integer argument.", args[*cur_arg]);
2135 goto error;
2136 }
2137
2138 srv->check.rise = atol(args[*cur_arg+1]);
2139 if (srv->check.rise <= 0) {
2140 memprintf(errmsg, "'%s' has to be > 0.", args[*cur_arg]);
2141 goto error;
2142 }
2143
2144 if (srv->check.health)
2145 srv->check.health = srv->check.rise;
2146
2147 out:
2148 return err_code;
2149
2150 error:
2151 deinit_srv_agent_check(srv);
2152 err_code |= ERR_ALERT | ERR_FATAL;
2153 goto out;
2154 return 0;
2155}
2156
2157/* Parse the "fall" server keyword */
2158static int srv_parse_check_fall(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2159 char **errmsg)
2160{
2161 int err_code = 0;
2162
2163 if (!*args[*cur_arg + 1]) {
2164 memprintf(errmsg, "'%s' expects an integer argument.", args[*cur_arg]);
2165 goto error;
2166 }
2167
2168 srv->check.fall = atol(args[*cur_arg+1]);
2169 if (srv->check.fall <= 0) {
2170 memprintf(errmsg, "'%s' has to be > 0.", args[*cur_arg]);
2171 goto error;
2172 }
2173
2174 out:
2175 return err_code;
2176
2177 error:
2178 deinit_srv_agent_check(srv);
2179 err_code |= ERR_ALERT | ERR_FATAL;
2180 goto out;
2181 return 0;
2182}
2183
2184/* Parse the "inter" server keyword */
2185static int srv_parse_check_inter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2186 char **errmsg)
2187{
2188 const char *err = NULL;
2189 unsigned int delay;
2190 int err_code = 0;
2191
2192 if (!*(args[*cur_arg+1])) {
2193 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
2194 goto error;
2195 }
2196
2197 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
2198 if (err == PARSE_TIME_OVER) {
2199 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
2200 args[*cur_arg+1], args[*cur_arg], srv->id);
2201 goto error;
2202 }
2203 else if (err == PARSE_TIME_UNDER) {
2204 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
2205 args[*cur_arg+1], args[*cur_arg], srv->id);
2206 goto error;
2207 }
2208 else if (err) {
2209 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
2210 *err, srv->id);
2211 goto error;
2212 }
2213 if (delay <= 0) {
2214 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
2215 delay, args[*cur_arg], srv->id);
2216 goto error;
2217 }
2218 srv->check.inter = delay;
2219
2220 out:
2221 return err_code;
2222
2223 error:
2224 err_code |= ERR_ALERT | ERR_FATAL;
2225 goto out;
2226}
2227
2228
2229/* Parse the "fastinter" server keyword */
2230static int srv_parse_check_fastinter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2231 char **errmsg)
2232{
2233 const char *err = NULL;
2234 unsigned int delay;
2235 int err_code = 0;
2236
2237 if (!*(args[*cur_arg+1])) {
2238 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
2239 goto error;
2240 }
2241
2242 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
2243 if (err == PARSE_TIME_OVER) {
2244 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
2245 args[*cur_arg+1], args[*cur_arg], srv->id);
2246 goto error;
2247 }
2248 else if (err == PARSE_TIME_UNDER) {
2249 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
2250 args[*cur_arg+1], args[*cur_arg], srv->id);
2251 goto error;
2252 }
2253 else if (err) {
2254 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
2255 *err, srv->id);
2256 goto error;
2257 }
2258 if (delay <= 0) {
2259 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
2260 delay, args[*cur_arg], srv->id);
2261 goto error;
2262 }
2263 srv->check.fastinter = delay;
2264
2265 out:
2266 return err_code;
2267
2268 error:
2269 err_code |= ERR_ALERT | ERR_FATAL;
2270 goto out;
2271}
2272
2273
2274/* Parse the "downinter" server keyword */
2275static int srv_parse_check_downinter(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2276 char **errmsg)
2277{
2278 const char *err = NULL;
2279 unsigned int delay;
2280 int err_code = 0;
2281
2282 if (!*(args[*cur_arg+1])) {
2283 memprintf(errmsg, "'%s' expects a delay as argument.", args[*cur_arg]);
2284 goto error;
2285 }
2286
2287 err = parse_time_err(args[*cur_arg+1], &delay, TIME_UNIT_MS);
2288 if (err == PARSE_TIME_OVER) {
2289 memprintf(errmsg, "timer overflow in argument <%s> to <%s> of server %s, maximum value is 2147483647 ms (~24.8 days).",
2290 args[*cur_arg+1], args[*cur_arg], srv->id);
2291 goto error;
2292 }
2293 else if (err == PARSE_TIME_UNDER) {
2294 memprintf(errmsg, "timer underflow in argument <%s> to <%s> of server %s, minimum non-null value is 1 ms.",
2295 args[*cur_arg+1], args[*cur_arg], srv->id);
2296 goto error;
2297 }
2298 else if (err) {
2299 memprintf(errmsg, "unexpected character '%c' in 'agent-inter' argument of server %s.",
2300 *err, srv->id);
2301 goto error;
2302 }
2303 if (delay <= 0) {
2304 memprintf(errmsg, "invalid value %d for argument '%s' of server %s.",
2305 delay, args[*cur_arg], srv->id);
2306 goto error;
2307 }
2308 srv->check.downinter = delay;
2309
2310 out:
2311 return err_code;
2312
2313 error:
2314 err_code |= ERR_ALERT | ERR_FATAL;
2315 goto out;
2316}
2317
2318/* Parse the "port" server keyword */
2319static int srv_parse_check_port(char **args, int *cur_arg, struct proxy *curpx, struct server *srv,
2320 char **errmsg)
2321{
2322 int err_code = 0;
2323
2324 if (!*(args[*cur_arg+1])) {
2325 memprintf(errmsg, "'%s' expects a port number as argument.", args[*cur_arg]);
2326 goto error;
2327 }
2328
2329 global.maxsock++;
2330 srv->check.port = atol(args[*cur_arg+1]);
William Dauchy4858fb22021-02-03 22:30:09 +01002331 /* if agentport was never set, we can use port */
2332 if (!(srv->flags & SRV_F_AGENTPORT))
2333 srv->agent.port = srv->check.port;
Christopher Fauletce8111e2020-04-06 15:04:11 +02002334
2335 out:
2336 return err_code;
2337
2338 error:
2339 err_code |= ERR_ALERT | ERR_FATAL;
2340 goto out;
2341}
2342
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002343static struct srv_kw_list srv_kws = { "CHK", { }, {
Amaury Denoyelle76e10e72021-03-08 17:08:01 +01002344 { "addr", srv_parse_addr, 1, 1, 0 }, /* IP address to send health to or to probe from agent-check */
2345 { "agent-addr", srv_parse_agent_addr, 1, 1, 0 }, /* Enable an auxiliary agent check */
2346 { "agent-check", srv_parse_agent_check, 0, 1, 0 }, /* Enable agent checks */
2347 { "agent-inter", srv_parse_agent_inter, 1, 1, 0 }, /* Set the interval between two agent checks */
2348 { "agent-port", srv_parse_agent_port, 1, 1, 0 }, /* Set the TCP port used for agent checks. */
2349 { "agent-send", srv_parse_agent_send, 1, 1, 0 }, /* Set string to send to agent. */
2350 { "check", srv_parse_check, 0, 1, 0 }, /* Enable health checks */
2351 { "check-proto", srv_parse_check_proto, 1, 1, 0 }, /* Set the mux protocol for health checks */
2352 { "check-send-proxy", srv_parse_check_send_proxy, 0, 1, 0 }, /* Enable PROXY protocol for health checks */
2353 { "check-via-socks4", srv_parse_check_via_socks4, 0, 1, 0 }, /* Enable socks4 proxy for health checks */
2354 { "no-agent-check", srv_parse_no_agent_check, 0, 1, 0 }, /* Do not enable any auxiliary agent check */
2355 { "no-check", srv_parse_no_check, 0, 1, 0 }, /* Disable health checks */
2356 { "no-check-send-proxy", srv_parse_no_check_send_proxy, 0, 1, 0 }, /* Disable PROXY protocol for health checks */
2357 { "rise", srv_parse_check_rise, 1, 1, 0 }, /* Set rise value for health checks */
2358 { "fall", srv_parse_check_fall, 1, 1, 0 }, /* Set fall value for health checks */
2359 { "inter", srv_parse_check_inter, 1, 1, 0 }, /* Set inter value for health checks */
2360 { "fastinter", srv_parse_check_fastinter, 1, 1, 0 }, /* Set fastinter value for health checks */
2361 { "downinter", srv_parse_check_downinter, 1, 1, 0 }, /* Set downinter value for health checks */
2362 { "port", srv_parse_check_port, 1, 1, 0 }, /* Set the TCP port used for health checks. */
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002363 { NULL, NULL, 0 },
2364}};
2365
Christopher Fauletcbba66c2020-04-06 14:26:30 +02002366INITCALL1(STG_REGISTER, srv_register_keywords, &srv_kws);
Christopher Fauletfd6c2292020-03-25 18:20:15 +01002367
Willy Tarreaubd741542010-03-16 18:46:54 +01002368/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02002369 * Local variables:
2370 * c-indent-level: 8
2371 * c-basic-offset: 8
2372 * End:
2373 */