blob: ebdcf3c69d00ead38c61950db86f055491e997bd [file] [log] [blame]
Christopher Faulet3e3d3be2021-02-16 13:31:30 +01001/*
2 * Server-state management functions.
3 *
4 * Copyright (C) 2021 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
13#include <errno.h>
14
15#include <import/eb64tree.h>
Emeric Brun34067662021-06-11 10:48:45 +020016#include <import/ebistree.h>
Christopher Faulet3e3d3be2021-02-16 13:31:30 +010017
18#include <haproxy/api.h>
19#include <haproxy/backend.h>
20#include <haproxy/cfgparse.h>
21#include <haproxy/check.h>
22#include <haproxy/errors.h>
23#include <haproxy/global.h>
24#include <haproxy/log.h>
25#include <haproxy/port_range.h>
26#include <haproxy/proxy.h>
27#include <haproxy/resolvers.h>
28#include <haproxy/server.h>
Willy Tarreaubf1ae1a2021-05-08 13:08:34 +020029#include <haproxy/tools.h>
Tim Duesterhusd5fc8fc2021-09-11 17:51:13 +020030#include <haproxy/xxhash.h>
Christopher Faulet3e3d3be2021-02-16 13:31:30 +010031
32
33/* Update a server state using the parameters available in the params list.
34 * The caller must provide a supported version
35 * Grabs the server lock during operation.
36 */
37static void srv_state_srv_update(struct server *srv, int version, char **params)
38{
39 char *p;
40 struct buffer *msg;
41 const char *warning;
42
43 /* fields since version 1
44 * and common to all other upcoming versions
45 */
46 enum srv_state srv_op_state;
47 enum srv_admin srv_admin_state;
48 unsigned srv_uweight, srv_iweight;
49 unsigned long srv_last_time_change;
50 short srv_check_status;
51 enum chk_result srv_check_result;
52 int srv_check_health;
53 int srv_check_state, srv_agent_state;
54 int bk_f_forced_id;
55 int srv_f_forced_id;
56 int fqdn_set_by_cli;
57 const char *fqdn;
58 const char *port_st;
59 unsigned int port_svc;
60 char *srvrecord;
61 char *addr;
62 int partial_apply = 0;
63#ifdef USE_OPENSSL
64 int use_ssl;
65#endif
66
67 fqdn = NULL;
68 port_svc = 0;
69 msg = alloc_trash_chunk();
70 if (!msg)
71 goto end;
72
73 HA_SPIN_LOCK(SERVER_LOCK, &srv->lock);
74
75 /* Only version 1 supported for now, don't check it. Fields are :
76 * srv_addr: params[0]
77 * srv_op_state: params[1]
78 * srv_admin_state: params[2]
79 * srv_uweight: params[3]
80 * srv_iweight: params[4]
81 * srv_last_time_change: params[5]
82 * srv_check_status: params[6]
83 * srv_check_result: params[7]
84 * srv_check_health: params[8]
85 * srv_check_state: params[9]
86 * srv_agent_state: params[10]
87 * bk_f_forced_id: params[11]
88 * srv_f_forced_id: params[12]
89 * srv_fqdn: params[13]
90 * srv_port: params[14]
91 * srvrecord: params[15]
92 * srv_use_ssl: params[16]
93 * srv_check_port: params[17]
94 * srv_check_addr: params[18]
95 * srv_agent_addr: params[19]
96 * srv_agent_port: params[20]
97 */
98
99 /* validating srv_op_state */
100 p = NULL;
101 errno = 0;
102 srv_op_state = strtol(params[1], &p, 10);
103 if ((p == params[1]) || errno == EINVAL || errno == ERANGE ||
104 (srv_op_state != SRV_ST_STOPPED &&
105 srv_op_state != SRV_ST_STARTING &&
106 srv_op_state != SRV_ST_RUNNING &&
107 srv_op_state != SRV_ST_STOPPING)) {
108 chunk_appendf(msg, ", invalid srv_op_state value '%s'", params[1]);
109 }
110
111 /* validating srv_admin_state */
112 p = NULL;
113 errno = 0;
114 srv_admin_state = strtol(params[2], &p, 10);
115 fqdn_set_by_cli = !!(srv_admin_state & SRV_ADMF_HMAINT);
116
117 /* inherited statuses will be recomputed later.
118 * Also disable SRV_ADMF_HMAINT flag (set from stats socket fqdn).
119 */
120 srv_admin_state &= ~SRV_ADMF_IDRAIN & ~SRV_ADMF_IMAINT & ~SRV_ADMF_HMAINT & ~SRV_ADMF_RMAINT;
121
122 if ((p == params[2]) || errno == EINVAL || errno == ERANGE ||
123 (srv_admin_state != 0 &&
124 srv_admin_state != SRV_ADMF_FMAINT &&
125 srv_admin_state != SRV_ADMF_CMAINT &&
126 srv_admin_state != (SRV_ADMF_CMAINT | SRV_ADMF_FMAINT) &&
127 srv_admin_state != (SRV_ADMF_CMAINT | SRV_ADMF_FDRAIN) &&
128 srv_admin_state != SRV_ADMF_FDRAIN)) {
129 chunk_appendf(msg, ", invalid srv_admin_state value '%s'", params[2]);
130 }
131
132 /* validating srv_uweight */
133 p = NULL;
134 errno = 0;
135 srv_uweight = strtol(params[3], &p, 10);
136 if ((p == params[3]) || errno == EINVAL || errno == ERANGE || (srv_uweight > SRV_UWGHT_MAX))
137 chunk_appendf(msg, ", invalid srv_uweight value '%s'", params[3]);
138
139 /* validating srv_iweight */
140 p = NULL;
141 errno = 0;
142 srv_iweight = strtol(params[4], &p, 10);
143 if ((p == params[4]) || errno == EINVAL || errno == ERANGE || (srv_iweight > SRV_UWGHT_MAX))
144 chunk_appendf(msg, ", invalid srv_iweight value '%s'", params[4]);
145
146 /* validating srv_last_time_change */
147 p = NULL;
148 errno = 0;
149 srv_last_time_change = strtol(params[5], &p, 10);
150 if ((p == params[5]) || errno == EINVAL || errno == ERANGE)
151 chunk_appendf(msg, ", invalid srv_last_time_change value '%s'", params[5]);
152
153 /* validating srv_check_status */
154 p = NULL;
155 errno = 0;
156 srv_check_status = strtol(params[6], &p, 10);
157 if (p == params[6] || errno == EINVAL || errno == ERANGE ||
158 (srv_check_status >= HCHK_STATUS_SIZE))
159 chunk_appendf(msg, ", invalid srv_check_status value '%s'", params[6]);
160
161 /* validating srv_check_result */
162 p = NULL;
163 errno = 0;
164 srv_check_result = strtol(params[7], &p, 10);
165 if ((p == params[7]) || errno == EINVAL || errno == ERANGE ||
166 (srv_check_result != CHK_RES_UNKNOWN &&
167 srv_check_result != CHK_RES_NEUTRAL &&
168 srv_check_result != CHK_RES_FAILED &&
169 srv_check_result != CHK_RES_PASSED &&
170 srv_check_result != CHK_RES_CONDPASS)) {
171 chunk_appendf(msg, ", invalid srv_check_result value '%s'", params[7]);
172 }
173
174 /* validating srv_check_health */
175 p = NULL;
176 errno = 0;
177 srv_check_health = strtol(params[8], &p, 10);
178 if (p == params[8] || errno == EINVAL || errno == ERANGE)
179 chunk_appendf(msg, ", invalid srv_check_health value '%s'", params[8]);
180
181 /* validating srv_check_state */
182 p = NULL;
183 errno = 0;
184 srv_check_state = strtol(params[9], &p, 10);
185 if (p == params[9] || errno == EINVAL || errno == ERANGE ||
186 (srv_check_state & ~(CHK_ST_INPROGRESS | CHK_ST_CONFIGURED | CHK_ST_ENABLED | CHK_ST_PAUSED | CHK_ST_AGENT)))
187 chunk_appendf(msg, ", invalid srv_check_state value '%s'", params[9]);
188
189 /* validating srv_agent_state */
190 p = NULL;
191 errno = 0;
192 srv_agent_state = strtol(params[10], &p, 10);
193 if (p == params[10] || errno == EINVAL || errno == ERANGE ||
194 (srv_agent_state & ~(CHK_ST_INPROGRESS | CHK_ST_CONFIGURED | CHK_ST_ENABLED | CHK_ST_PAUSED | CHK_ST_AGENT)))
195 chunk_appendf(msg, ", invalid srv_agent_state value '%s'", params[10]);
196
197 /* validating bk_f_forced_id */
198 p = NULL;
199 errno = 0;
200 bk_f_forced_id = strtol(params[11], &p, 10);
201 if (p == params[11] || errno == EINVAL || errno == ERANGE || !((bk_f_forced_id == 0) || (bk_f_forced_id == 1)))
202 chunk_appendf(msg, ", invalid bk_f_forced_id value '%s'", params[11]);
203
204 /* validating srv_f_forced_id */
205 p = NULL;
206 errno = 0;
207 srv_f_forced_id = strtol(params[12], &p, 10);
208 if (p == params[12] || errno == EINVAL || errno == ERANGE || !((srv_f_forced_id == 0) || (srv_f_forced_id == 1)))
209 chunk_appendf(msg, ", invalid srv_f_forced_id value '%s'", params[12]);
210
211 /* validating srv_fqdn */
212 fqdn = params[13];
213 if (fqdn && *fqdn == '-')
214 fqdn = NULL;
215 if (fqdn && (strlen(fqdn) > DNS_MAX_NAME_SIZE || invalid_domainchar(fqdn))) {
216 chunk_appendf(msg, ", invalid srv_fqdn value '%s'", params[13]);
217 fqdn = NULL;
218 }
219
220 port_st = params[14];
221 if (port_st) {
222 port_svc = strl2uic(port_st, strlen(port_st));
223 if (port_svc > USHRT_MAX) {
224 chunk_appendf(msg, ", invalid srv_port value '%s'", port_st);
225 port_st = NULL;
226 }
227 }
228
229 /* SRV record
230 * NOTE: in HAProxy, SRV records must start with an underscore '_'
231 */
232 srvrecord = params[15];
233 if (srvrecord && *srvrecord != '_')
234 srvrecord = NULL;
235
236 /* don't apply anything if one error has been detected */
237 if (msg->data)
238 goto out;
239 partial_apply = 1;
240
241 /* recover operational state and apply it to this server
242 * and all servers tracking this one */
243 srv->check.health = srv_check_health;
244 switch (srv_op_state) {
245 case SRV_ST_STOPPED:
246 srv->check.health = 0;
Aurelien DARRAGON1746b562023-04-04 10:17:40 +0200247 srv_set_stopped(srv, SRV_OP_STCHGC_STATEFILE);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100248 break;
249 case SRV_ST_STARTING:
250 /* If rise == 1 there is no STARTING state, let's switch to
251 * RUNNING
252 */
253 if (srv->check.rise == 1) {
254 srv->check.health = srv->check.rise + srv->check.fall - 1;
Aurelien DARRAGON1746b562023-04-04 10:17:40 +0200255 srv_set_running(srv, SRV_OP_STCHGC_NONE);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100256 break;
257 }
258 if (srv->check.health < 1 || srv->check.health >= srv->check.rise)
259 srv->check.health = srv->check.rise - 1;
260 srv->next_state = srv_op_state;
261 break;
262 case SRV_ST_STOPPING:
263 /* If fall == 1 there is no STOPPING state, let's switch to
264 * STOPPED
265 */
266 if (srv->check.fall == 1) {
267 srv->check.health = 0;
Aurelien DARRAGON1746b562023-04-04 10:17:40 +0200268 srv_set_stopped(srv, SRV_OP_STCHGC_STATEFILE);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100269 break;
270 }
271 if (srv->check.health < srv->check.rise ||
272 srv->check.health > srv->check.rise + srv->check.fall - 2)
273 srv->check.health = srv->check.rise;
Aurelien DARRAGON1746b562023-04-04 10:17:40 +0200274 srv_set_stopping(srv, SRV_OP_STCHGC_STATEFILE);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100275 break;
276 case SRV_ST_RUNNING:
277 srv->check.health = srv->check.rise + srv->check.fall - 1;
Aurelien DARRAGON1746b562023-04-04 10:17:40 +0200278 srv_set_running(srv, SRV_OP_STCHGC_NONE);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100279 break;
280 }
281
282 /* When applying server state, the following rules apply:
283 * - in case of a configuration change, we apply the setting from the new
284 * configuration, regardless of old running state
285 * - if no configuration change, we apply old running state only if old running
286 * state is different from new configuration state
287 */
288 /* configuration has changed */
289 if ((srv_admin_state & SRV_ADMF_CMAINT) != (srv->next_admin & SRV_ADMF_CMAINT)) {
290 if (srv->next_admin & SRV_ADMF_CMAINT)
291 srv_adm_set_maint(srv);
292 else
293 srv_adm_set_ready(srv);
294 }
295 /* configuration is the same, let's compate old running state and new conf state */
296 else {
297 if (srv_admin_state & SRV_ADMF_FMAINT && !(srv->next_admin & SRV_ADMF_CMAINT))
298 srv_adm_set_maint(srv);
299 else if (!(srv_admin_state & SRV_ADMF_FMAINT) && (srv->next_admin & SRV_ADMF_CMAINT))
300 srv_adm_set_ready(srv);
301 }
302 /* apply drain mode if server is currently enabled */
303 if (!(srv->next_admin & SRV_ADMF_FMAINT) && (srv_admin_state & SRV_ADMF_FDRAIN)) {
304 /* The SRV_ADMF_FDRAIN flag is inherited when srv->iweight is 0
305 * (srv->iweight is the weight set up in configuration).
306 * There are two possible reasons for FDRAIN to have been present :
307 * - previous config weight was zero
308 * - "set server b/s drain" was sent to the CLI
309 *
310 * In the first case, we simply want to drop this drain state
311 * if the new weight is not zero anymore, meaning the administrator
312 * has intentionally turned the weight back to a positive value to
313 * enable the server again after an operation. In the second case,
314 * the drain state was forced on the CLI regardless of the config's
315 * weight so we don't want a change to the config weight to lose this
316 * status. What this means is :
317 * - if previous weight was 0 and new one is >0, drop the DRAIN state.
318 * - if the previous weight was >0, keep it.
319 */
320 if (srv_iweight > 0 || srv->iweight == 0)
321 srv_adm_set_drain(srv);
322 }
323
Willy Tarreau69530f52023-04-28 09:16:15 +0200324 srv->last_change = ns_to_sec(now_ns) - srv_last_time_change;
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100325 srv->check.status = srv_check_status;
326 srv->check.result = srv_check_result;
327
328 /* Only case we want to apply is removing ENABLED flag which could have been
329 * done by the "disable health" command over the stats socket
330 */
331 if ((srv->check.state & CHK_ST_CONFIGURED) &&
332 (srv_check_state & CHK_ST_CONFIGURED) &&
333 !(srv_check_state & CHK_ST_ENABLED))
334 srv->check.state &= ~CHK_ST_ENABLED;
335
336 /* Only case we want to apply is removing ENABLED flag which could have been
337 * done by the "disable agent" command over the stats socket
338 */
339 if ((srv->agent.state & CHK_ST_CONFIGURED) &&
340 (srv_agent_state & CHK_ST_CONFIGURED) &&
341 !(srv_agent_state & CHK_ST_ENABLED))
342 srv->agent.state &= ~CHK_ST_ENABLED;
343
344 /* We want to apply the previous 'running' weight (srv_uweight) only if there
345 * was no change in the configuration: both previous and new iweight are equals
346 *
347 * It means that a configuration file change has precedence over a unix socket change
348 * for server's weight
349 *
350 * by default, HAProxy applies the following weight when parsing the configuration
351 * srv->uweight = srv->iweight
352 */
353 if (srv_iweight == srv->iweight) {
354 srv->uweight = srv_uweight;
355 }
356 server_recalc_eweight(srv, 1);
357
358 /* load server IP address */
359 if (strcmp(params[0], "-") != 0)
360 srv->lastaddr = strdup(params[0]);
361
362 if (fqdn && srv->hostname) {
363 if (strcmp(srv->hostname, fqdn) == 0) {
364 /* Here we reset the 'set from stats socket FQDN' flag
365 * to support such transitions:
366 * Let's say initial FQDN value is foo1 (in configuration file).
367 * - FQDN changed from stats socket, from foo1 to foo2 value,
368 * - FQDN changed again from file configuration (with the same previous value
369 set from stats socket, from foo1 to foo2 value),
370 * - reload for any other reason than a FQDN modification,
371 * the configuration file FQDN matches the fqdn server state file value.
372 * So we must reset the 'set from stats socket FQDN' flag to be consistent with
373 * any further FQDN modification.
374 */
375 srv->next_admin &= ~SRV_ADMF_HMAINT;
376 }
377 else {
378 /* If the FDQN has been changed from stats socket,
379 * apply fqdn state file value (which is the value set
380 * from stats socket).
381 * Also ensure the runtime resolver will process this resolution.
382 */
383 if (fqdn_set_by_cli) {
384 srv_set_fqdn(srv, fqdn, 0);
385 srv->flags &= ~SRV_F_NO_RESOLUTION;
386 srv->next_admin |= SRV_ADMF_HMAINT;
387 }
388 }
389 }
390 /* If all the conditions below are validated, this means
391 * we're evaluating a server managed by SRV resolution
392 */
393 else if (fqdn && !srv->hostname && srvrecord) {
394 int res;
Emeric Brun34067662021-06-11 10:48:45 +0200395 int i;
396 char *tmp;
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100397
398 /* we can't apply previous state if SRV record has changed */
Christopher Faulet85af93b2021-06-10 16:59:53 +0200399 if (!srv->srvrq) {
400 chunk_appendf(msg, ", no SRV resolution for server '%s'. Previous state not applied", srv->id);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100401 goto out;
402 }
Christopher Faulet85af93b2021-06-10 16:59:53 +0200403 if (strcmp(srv->srvrq->name, srvrecord) != 0) {
404 chunk_appendf(msg, ", SRV record mismatch between configuration ('%s') and state file ('%s) for server '%s'. Previous state not applied", srv->srvrq->name, srvrecord, srv->id);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100405 goto out;
406 }
407
408 /* prepare DNS resolution for this server */
409 res = srv_prepare_for_resolution(srv, fqdn);
410 if (res == -1) {
411 chunk_appendf(msg, ", can't allocate memory for DNS resolution for server '%s'", srv->id);
412 goto out;
413 }
414
Emeric Brun34067662021-06-11 10:48:45 +0200415 /* Remove from available list and insert in tree
416 * since this server has an hostname
417 */
418 LIST_DEL_INIT(&srv->srv_rec_item);
419 srv->host_dn.key = tmp = strdup(srv->hostname_dn);
420
421 /* convert the key in lowercase because tree
422 * lookup is case sensitive but we don't care
423 */
424 for (i = 0; tmp[i]; i++)
425 tmp[i] = tolower(tmp[i]);
426
Christopher Fauletdcac4182021-06-15 16:17:17 +0200427 /* insert in tree and set the srvrq expiration date */
Emeric Brun34067662021-06-11 10:48:45 +0200428 ebis_insert(&srv->srvrq->named_servers, &srv->host_dn);
Christopher Fauletdcac4182021-06-15 16:17:17 +0200429 task_schedule(srv->srvrq_check, tick_add(now_ms, srv->srvrq->resolvers->hold.timeout));
Emeric Brun34067662021-06-11 10:48:45 +0200430
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100431 /* Unset SRV_F_MAPPORTS for SRV records.
432 * SRV_F_MAPPORTS is unfortunately set by parse_server()
433 * because no ports are provided in the configuration file.
434 * This is because HAProxy will use the port found into the SRV record.
435 */
436 srv->flags &= ~SRV_F_MAPPORTS;
437 }
438
439 if (port_st)
440 srv->svc_port = port_svc;
441
442
443 if (params[16]) {
444#ifdef USE_OPENSSL
445 use_ssl = strtol(params[16], &p, 10);
446
447 /* configure ssl if connection has been initiated at startup */
448 if (srv->ssl_ctx.ctx != NULL)
Willy Tarreaua8a72c62021-10-06 11:48:34 +0200449 srv_set_ssl(srv, use_ssl);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100450#endif
451 }
452
453 port_st = NULL;
454 if (params[17] && strcmp(params[17], "0") != 0)
455 port_st = params[17];
456 addr = NULL;
457 if (params[18] && strcmp(params[18], "-") != 0)
458 addr = params[18];
459 if (addr || port_st) {
460 warning = srv_update_check_addr_port(srv, addr, port_st);
461 if (warning) {
462 chunk_appendf(msg, ", %s", warning);
463 goto out;
464 }
465 }
466
467 port_st = NULL;
468 if (params[20] && strcmp(params[20], "0") != 0)
469 port_st = params[20];
470 addr = NULL;
471 if (params[19] && strcmp(params[19], "-") != 0)
472 addr = params[19];
473 if (addr || port_st) {
474 warning = srv_update_agent_addr_port(srv, addr, port_st);
475 if (warning) {
476 chunk_appendf(msg, ", %s", warning);
477 goto out;
478 }
479 }
480
481 out:
482 HA_SPIN_UNLOCK(SERVER_LOCK, &srv->lock);
483 if (msg->data) {
484 if (partial_apply == 1)
485 ha_warning("server-state partially applied for server '%s/%s'%s\n",
486 srv->proxy->id, srv->id, msg->area);
487 else
488 ha_warning("server-state application failed for server '%s/%s'%s\n",
489 srv->proxy->id, srv->id, msg->area);
490 }
491 end:
492 free_trash_chunk(msg);
493}
494
495/*
496 * Loop on the proxy's servers and try to load its state from <st_tree> using
497 * srv_state_srv_update(). The proxy name and the server name are concatenated
498 * to form the key. If found the entry is removed from the tree.
499 */
500static void srv_state_px_update(const struct proxy *px, int vsn, struct eb_root *st_tree)
501{
502 struct server_state_line *st_line;
503 struct eb64_node *node;
504 struct server *srv;
505 unsigned long key;
506
507 for (srv = px->srv; srv; srv = srv->next) {
508 chunk_printf(&trash, "%s %s", px->id, srv->id);
509 key = XXH3(trash.area, trash.data, 0);
510 node = eb64_lookup(st_tree, key);
511 if (!node)
512 continue; /* next server */
513 st_line = eb64_entry(node, typeof(*st_line), node);
514 srv_state_srv_update(srv, vsn, st_line->params+4);
515
516 /* the node may be released now */
517 eb64_delete(node);
518 free(st_line->line);
519 free(st_line);
520 }
521}
522
523/*
524 * read next line from file <f> and return the server state version if one found.
Marcos de Oliveira4820c6e2023-07-20 17:21:10 -0300525 * If file is empty, then -1 is returned
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100526 * If no version is found, then 0 is returned
527 * Note that this should be the first read on <f>
528 */
529static int srv_state_get_version(FILE *f) {
530 char mybuf[SRV_STATE_LINE_MAXLEN];
531 char *endptr;
532 long int vsn;
533
534 /* first character of first line of the file must contain the version of the export */
535 if (fgets(mybuf, SRV_STATE_LINE_MAXLEN, f) == NULL)
Marcos de Oliveira4820c6e2023-07-20 17:21:10 -0300536 return -1;
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100537
538 vsn = strtol(mybuf, &endptr, 10);
539 if (endptr == mybuf || *endptr != '\n') {
540 /* Empty or truncated line */
541 return 0;
542 }
543
544 if (vsn < SRV_STATE_FILE_VERSION_MIN || vsn > SRV_STATE_FILE_VERSION_MAX) {
545 /* Wrong version number */
546 return 0;
547 }
548
549 return vsn;
550}
551
552
553/*
554 * parses server state line stored in <buf> and supposedly in version <version>.
555 * Set <params> accordingly on success. It returns 1 on success, 0 if the line
556 * must be ignored and -1 on error.
557 * The caller must provide a supported version
558 */
559static int srv_state_parse_line(char *buf, const int version, char **params)
560{
561 int buflen, arg, ret;
562 char *cur;
563
564 buflen = strlen(buf);
565 cur = buf;
566 ret = 1; /* be optimistic and pretend a success */
567
568 /* we need at least one character and a non-truncated line */
569 if (buflen == 0 || buf[buflen - 1] != '\n') {
570 ret = -1;
571 goto out;
572 }
573
574 /* skip blank characters at the beginning of the line */
Willy Tarreau74bc9912022-01-28 09:32:43 +0100575 while (*cur == ' ' || *cur == '\t')
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100576 ++cur;
577
578 /* ignore empty or commented lines */
579 if (!*cur || *cur == '\n' || *cur == '#') {
580 ret = 0;
581 goto out;
582 }
583
584 /* Removes trailing '\n' to ease parsing */
585 buf[buflen - 1] = '\0';
586
587 /* we're now ready to move the line into <params> */
588 memset(params, 0, SRV_STATE_FILE_MAX_FIELDS * sizeof(*params));
589 arg = 0;
590 while (*cur) {
591 /* first of all, stop if there are too many fields */
592 if (arg >= SRV_STATE_FILE_MAX_FIELDS)
593 break;
594
595 /* then skip leading spaces */
Willy Tarreau74bc9912022-01-28 09:32:43 +0100596 while (*cur && (*cur == ' ' || *cur == '\t')) {
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100597 ++cur;
598 if (!*cur)
599 break;
600 }
601
602 /*
603 * idx:
604 * be_id: params[0]
605 * be_name: params[1]
606 * srv_id: params[2]
607 * srv_name: params[3]
608 * v1
609 * srv_addr: params[4]
610 * srv_op_state: params[5]
611 * srv_admin_state: params[6]
612 * srv_uweight: params[7]
613 * srv_iweight: params[8]
614 * srv_last_time_change: params[9]
615 * srv_check_status: params[10]
616 * srv_check_result: params[11]
617 * srv_check_health: params[12]
618 * srv_check_state: params[13]
619 * srv_agent_state: params[14]
620 * bk_f_forced_id: params[15]
621 * srv_f_forced_id: params[16]
622 * srv_fqdn: params[17]
623 * srv_port: params[18]
624 * srvrecord: params[19]
625 *
626 * srv_use_ssl: params[20] (optional field)
627 * srv_check_port: params[21] (optional field)
628 * srv_check_addr: params[22] (optional field)
629 * srv_agent_addr: params[23] (optional field)
630 * srv_agent_port: params[24] (optional field)
631 *
632 */
633 params[arg++] = cur;
634
635 /* look for the end of the current field */
Willy Tarreau74bc9912022-01-28 09:32:43 +0100636 while (*cur && *cur != ' ' && *cur != '\t') {
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100637 ++cur;
638 if (!*cur)
639 break;
640 }
641
642 /* otherwise, cut the field and move to the next one */
643 *cur++ = '\0';
644 }
645
646 /* if the number of fields does not match the version, then return an error */
647 if (version == 1 &&
648 (arg < SRV_STATE_FILE_MIN_FIELDS_VERSION_1 ||
649 arg > SRV_STATE_FILE_MAX_FIELDS_VERSION_1))
650 ret = -1;
651
652 out:
653 return ret;
654}
655
656
657/*
658 * parses a server state line using srv_state_parse_line() and store the result
659 * in <st_tree>. If an error occurred during the parsing, the line is
660 * ignored. if <px> is defined, it is used to check the backend id/name against
661 * the parsed params and to compute the key of the line.
662 */
663static int srv_state_parse_and_store_line(char *line, int vsn, struct eb_root *st_tree,
664 struct proxy *px)
665{
666 struct server_state_line *st_line;
667 int ret = 0;
668
669 /* store line in tree and duplicate the line */
670 st_line = calloc(1, sizeof(*st_line));
671 if (st_line == NULL)
672 goto skip_line;
673 st_line->line = strdup(line);
674 if (st_line->line == NULL)
675 goto skip_line;
676
677 ret = srv_state_parse_line(st_line->line, vsn, st_line->params);
678 if (ret <= 0)
679 goto skip_line;
680
681 /* Check backend name against params if <px> is defined */
682 if (px) {
683 int check_id = (atoi(st_line->params[0]) == px->uuid);
684 int check_name = (strcmp(px->id, st_line->params[1]) == 0);
685 int bk_f_forced_id = (atoi(st_line->params[15]) & PR_O_FORCED_ID);
686
687
688 if (!check_id && !check_name) {
689 /* backend does not match at all: skip the line */
690 goto skip_line;
691 }
692 else if (!check_id) {
693 /* Id mismatch: warn but continue */
694 ha_warning("Proxy '%s': backend ID mismatch: from server state file: '%s', from running config '%d'\n",
695 px->id, st_line->params[0], px->uuid);
696 send_log(px, LOG_NOTICE, "backend ID mismatch: from server state file: '%s', from running config '%d'\n",
697 st_line->params[0], px->uuid);
698 }
699 else if (!check_name) {
700 /* Name mismatch: warn and skip the line, except if the backend id was forced
701 * in the previous configuration */
702 ha_warning("Proxy '%s': backend name mismatch: from server state file: '%s', from running config '%s'\n",
703 px->id, st_line->params[1], px->id);
704 send_log(px, LOG_NOTICE, "backend name mismatch: from server state file: '%s', from running config '%s'\n",
705 st_line->params[1], px->id);
706 if (!bk_f_forced_id)
707 goto skip_line;
708 }
709 }
710
711 /*
712 * The key: "be_name srv_name"
713 * if <px> is defined: be_name == px->id
714 * otherwise: be_name == params[1]
715 */
716 chunk_printf(&trash, "%s %s", (px ? px->id : st_line->params[1]), st_line->params[3]);
717 st_line->node.key = XXH3(trash.area, trash.data, 0);
718 if (eb64_insert(st_tree, &st_line->node) != &st_line->node) {
719 /* this is a duplicate key, probably a hand-crafted file, drop it! */
720 goto skip_line;
721 }
722
723 return ret;
724
725 skip_line:
726 /* free up memory in case of error during the processing of the line */
727 if (st_line) {
728 free(st_line->line);
729 free(st_line);
730 }
731 return ret;
732}
733
734/* Helper function to get the server-state file path.
735 * If <filename> starts with a '/', it is considered as an absolute path. In
736 * this case or if <global.server_state_base> is not set, <filename> only is
737 * considered. Otherwise, the <global.server_state_base> is concatenated to
738 * <filename> to produce the file path and copied to <dst_path>. in both cases,
739 * the result must not exceeds <maxpathlen>.
740 *
741 * The len is returned on success or -1 if the path is too long. On error, the
742 * caller must not rely on <dst_path>.
743 */
744static inline int srv_state_get_filepath(char *dst_path, int maxpathlen, const char *filename)
745{
Willy Tarreau6d4173e2021-03-12 13:57:19 +0100746 char *sep;
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100747 int len = 0;
748
749 /* create the globalfilepath variable */
750 if (*filename == '/' || !global.server_state_base) {
751 /* absolute path or no base directory provided */
Willy Tarreau47a30c42021-03-12 14:09:10 +0100752 len = strlcpy2(dst_path, filename, maxpathlen);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100753 }
754 else {
755 /* concat base directory and global server-state file */
Willy Tarreau6d4173e2021-03-12 13:57:19 +0100756 sep = (global.server_state_base[strlen(global.server_state_base)-1] != '/' ? "/": "");
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100757 len = snprintf(dst_path, maxpathlen, "%s%s%s", global.server_state_base, sep, filename);
758 }
759 return (len < maxpathlen ? len: -1);
760}
761
762
763/* This function parses all the proxies and only take care of the backends (since we're looking for server)
764 * For each proxy, it does the following:
765 * - opens its server state file (either one or local one)
766 * - read whole file, line by line
767 * - analyse each line to check if it matches our current backend:
768 * - backend name matches
769 * - backend id matches if id is forced and name doesn't match
770 * - if the server pointed by the line is found, then state is applied
771 *
772 * If the running backend uuid or id differs from the state file, then HAProxy reports
773 * a warning.
774 *
775 * Grabs the server's lock via srv_state_srv_update().
776 */
777void apply_server_state(void)
778{
779 /* tree where global state_file is loaded */
780 struct eb_root global_state_tree = EB_ROOT_UNIQUE;
781 struct proxy *curproxy;
782 struct server_state_line *st_line;
783 struct eb64_node *node, *next_node;
784 FILE *f;
785 char mybuf[SRV_STATE_LINE_MAXLEN];
786 char file[MAXPATHLEN];
787 int local_vsn, global_vsn, len, linenum;
788
789 global_vsn = 0; /* no global file */
790 if (!global.server_state_file)
791 goto no_globalfile;
792 len = srv_state_get_filepath(file, MAXPATHLEN, global.server_state_file);
793 if (len == -1) {
794 ha_warning("config: Can't load global server state file: file too long.\n");
795 goto no_globalfile;
796 }
797
798 /* Load global server state in a tree */
799 errno = 0;
800 f = fopen(file, "r");
801 if (!f) {
Marcos de Oliveira7b79f7c2023-07-20 17:21:09 -0300802 if (errno == ENOENT)
803 ha_notice("config: Can't open global server state file '%s': %s\n", file, strerror(errno));
804 else
805 ha_warning("config: Can't open global server state file '%s': %s\n", file, strerror(errno));
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100806 goto no_globalfile;
807 }
808
809 global_vsn = srv_state_get_version(f);
Marcos de Oliveira4820c6e2023-07-20 17:21:10 -0300810 if (global_vsn < 1) {
811 if (global_vsn == -1)
812 ha_notice("config: Empty global server state file '%s'.\n",
813 file);
814 if (global_vsn == 0)
815 ha_warning("config: Can't get version of the global server state file '%s'.\n",
816 file);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100817 goto close_globalfile;
818 }
819
820 for (linenum = 1; fgets(mybuf, SRV_STATE_LINE_MAXLEN, f); linenum++) {
821 int ret;
822
823 ret = srv_state_parse_and_store_line(mybuf, global_vsn, &global_state_tree, NULL);
824 if (ret == -1) {
825 ha_warning("config: corrupted global server state file '%s' at line %d.\n",
826 file, linenum);
827 global_vsn = 0;
828 break;
829 }
830 }
831
832 close_globalfile:
833 fclose(f);
834
835 no_globalfile:
836 /* parse all proxies and load states form tree (global file) or from local file */
837 for (curproxy = proxies_list; curproxy != NULL; curproxy = curproxy->next) {
838 struct eb_root local_state_tree = EB_ROOT_UNIQUE;
839
Christopher Faulet6f691102021-03-04 16:35:26 +0100840 /* Must be an enabled backend with at least a server */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +0200841 if (!(curproxy->cap & PR_CAP_BE) || (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !curproxy->srv)
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100842 continue; /* next proxy */
843
Christopher Faulet6f691102021-03-04 16:35:26 +0100844 /* Mode must be specified */
845 BUG_ON(curproxy->load_server_state_from_file == PR_SRV_STATE_FILE_UNSPEC);
846
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100847 /* No server-state file for this proxy */
848 if (curproxy->load_server_state_from_file == PR_SRV_STATE_FILE_NONE)
849 continue; /* next proxy */
850
851 if (curproxy->load_server_state_from_file == PR_SRV_STATE_FILE_GLOBAL) {
852 /* when global file is used, we get data from the tree
853 * Note that in such case we don't check backend name neither uuid.
854 * Backend name can't be wrong since it's used as a key to retrieve the server state
855 * line from the tree.
856 */
857 if (global_vsn)
858 srv_state_px_update(curproxy, global_vsn, &global_state_tree);
859 continue; /* next proxy */
860 }
861
862 /*
863 * Here we load a local server state-file
864 */
865
866 /* create file variable */
867 len = srv_state_get_filepath(file, MAXPATHLEN, curproxy->server_state_file_name);
868 if (len == -1) {
869 ha_warning("Proxy '%s': Can't load local server state file: file too long.\n", curproxy->id);
870 continue; /* next proxy */
871 }
872
873 /* Load local server state in a tree */
874 errno = 0;
875 f = fopen(file, "r");
876 if (!f) {
Marcos de Oliveira7b79f7c2023-07-20 17:21:09 -0300877 if (errno == ENOENT)
878 ha_notice("Proxy '%s': Can't open server state file '%s': %s.\n",
879 curproxy->id, file, strerror(errno));
880 else
881 ha_warning("Proxy '%s': Can't open server state file '%s': %s.\n",
882 curproxy->id, file, strerror(errno));
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100883 continue; /* next proxy */
884 }
885
886 /* first character of first line of the file must contain the version of the export */
887 local_vsn = srv_state_get_version(f);
Marcos de Oliveira4820c6e2023-07-20 17:21:10 -0300888 if (local_vsn < 1) {
889 if (local_vsn == -1)
890 ha_notice("Proxy '%s': Empty server state file '%s'.\n",
891 curproxy->id, file);
892 if (local_vsn == 0)
893 ha_warning("Proxy '%s': Can't get version of the server state file '%s'.\n",
894 curproxy->id, file);
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100895 goto close_localfile;
896 }
897
898 /* First, parse lines of the local server-state file and store them in a eb-tree */
899 for (linenum = 1; fgets(mybuf, SRV_STATE_LINE_MAXLEN, f); linenum++) {
900 int ret;
901
902 ret = srv_state_parse_and_store_line(mybuf, local_vsn, &local_state_tree, curproxy);
903 if (ret == -1) {
904 ha_warning("Proxy '%s': corrupted server state file '%s' at line %d.\n",
905 curproxy->id, file, linenum);
906 local_vsn = 0;
907 break;
908 }
909 }
910
911 if (local_vsn)
912 srv_state_px_update(curproxy, local_vsn, &local_state_tree);
913
Ilya Shipitsind7a988c2021-03-04 23:26:15 +0500914 /* Remove unused server-state lines */
Christopher Faulet3e3d3be2021-02-16 13:31:30 +0100915 node = eb64_first(&local_state_tree);
916 while (node) {
917 st_line = eb64_entry(node, typeof(*st_line), node);
918 next_node = eb64_next(node);
919 eb64_delete(node);
920
921 if (local_vsn) {
922 /* if no server found, then warn */
923 ha_warning("Proxy '%s': can't find server '%s' in backend '%s'\n",
924 curproxy->id, st_line->params[3], curproxy->id);
925 send_log(curproxy, LOG_NOTICE, "can't find server '%s' in backend '%s'\n",
926 st_line->params[3], curproxy->id);
927 }
928
929 free(st_line->line);
930 free(st_line);
931 node = next_node;
932 }
933
934 close_localfile:
935 fclose(f);
936 }
937
938 node = eb64_first(&global_state_tree);
939 while (node) {
940 st_line = eb64_entry(node, typeof(*st_line), node);
941 next_node = eb64_next(node);
942 eb64_delete(node);
943 free(st_line->line);
944 free(st_line);
945 node = next_node;
946 }
947}