blob: bedd57a2b2cebad47f946897a8c6cd410b7cb252 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * Proxy variables and functions.
3 *
Willy Tarreau3a7d2072009-03-05 23:48:25 +01004 * Copyright 2000-2009 Willy Tarreau <w@1wt.eu>
Willy Tarreaubaaee002006-06-26 02:48:02 +02005 *
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
Willy Tarreaubaaee002006-06-26 02:48:02 +020013#include <unistd.h>
Willy Tarreauc8f24f82007-11-30 18:38:35 +010014#include <string.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020015#include <sys/types.h>
16#include <sys/socket.h>
17#include <sys/stat.h>
18
Willy Tarreaub2551052020-06-09 09:07:15 +020019#include <import/eb32tree.h>
20#include <import/ebistree.h>
21
Amaury Denoyelle27fefa12021-03-24 16:13:20 +010022#include <haproxy/acl.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020023#include <haproxy/api.h>
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +020024#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/capture-t.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020026#include <haproxy/cfgparse.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020027#include <haproxy/cli.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020028#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/fd.h>
Willy Tarreauc7babd82020-06-04 21:29:29 +020030#include <haproxy/filters.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020031#include <haproxy/global.h>
Willy Tarreauc2b1ff02020-06-04 21:21:03 +020032#include <haproxy/http_ana.h>
Willy Tarreau76838932021-02-12 08:49:47 +010033#include <haproxy/http_htx.h>
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +010034#include <haproxy/http_ext.h>
Aurelien DARRAGON7abc9222023-05-11 10:30:27 +020035#include <haproxy/http_rules.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020036#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020037#include <haproxy/log.h>
Willy Tarreau8efbdfb2020-06-04 11:29:21 +020038#include <haproxy/obj_type-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020039#include <haproxy/peers.h>
Willy Tarreaud0ef4392020-06-02 09:38:52 +020040#include <haproxy/pool.h>
Willy Tarreau626f3a72020-10-07 16:52:43 +020041#include <haproxy/protocol.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/proto_tcp.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020043#include <haproxy/proxy.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020044#include <haproxy/sc_strm.h>
Frédéric Lécaille748ece62022-05-21 23:58:40 +020045#include <haproxy/quic_tp.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020046#include <haproxy/server-t.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020047#include <haproxy/signal.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020048#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020049#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020050#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020051#include <haproxy/task.h>
Willy Tarreau76838932021-02-12 08:49:47 +010052#include <haproxy/tcpcheck.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020053#include <haproxy/time.h>
Willy Tarreaue6844832021-05-08 13:02:07 +020054#include <haproxy/tools.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020055
Willy Tarreaubaaee002006-06-26 02:48:02 +020056
Willy Tarreau918ff602011-07-25 16:33:49 +020057int listeners; /* # of proxy listeners, set by cfgparse */
Olivier Houchardfbc74e82017-11-24 16:54:05 +010058struct proxy *proxies_list = NULL; /* list of all existing proxies */
Willy Tarreau53fb4ae2009-10-04 23:04:08 +020059struct eb_root used_proxy_id = EB_ROOT; /* list of proxy IDs in use */
Willy Tarreauf79d9502014-03-15 07:22:35 +010060struct eb_root proxy_by_name = EB_ROOT; /* tree of proxies sorted by name */
Willy Tarreau0a0f6a72021-02-12 13:52:11 +010061struct eb_root defproxy_by_name = EB_ROOT; /* tree of default proxies sorted by name (dups possible) */
Willy Tarreau10479e42010-12-12 14:00:34 +010062unsigned int error_snapshot_id = 0; /* global ID assigned to each error then incremented */
Willy Tarreaubaaee002006-06-26 02:48:02 +020063
Willy Tarreau72a04232022-05-05 17:00:20 +020064/* CLI context used during "show servers {state|conn}" */
65struct show_srv_ctx {
66 struct proxy *px; /* current proxy to dump or NULL */
67 struct server *sv; /* current server to dump or NULL */
68 uint only_pxid; /* dump only this proxy ID when explicit */
69 int show_conn; /* non-zero = "conn" otherwise "state" */
Willy Tarreaud741e9c2022-05-05 19:26:18 +020070 enum {
71 SHOW_SRV_HEAD = 0,
72 SHOW_SRV_LIST,
73 } state;
Willy Tarreau72a04232022-05-05 17:00:20 +020074};
75
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010076/* proxy->options */
77const struct cfg_opt cfg_opts[] =
78{
79 { "abortonclose", PR_O_ABRT_CLOSE, PR_CAP_BE, 0, 0 },
80 { "allbackups", PR_O_USE_ALL_BK, PR_CAP_BE, 0, 0 },
81 { "checkcache", PR_O_CHK_CACHE, PR_CAP_BE, 0, PR_MODE_HTTP },
82 { "clitcpka", PR_O_TCP_CLI_KA, PR_CAP_FE, 0, 0 },
83 { "contstats", PR_O_CONTSTATS, PR_CAP_FE, 0, 0 },
84 { "dontlognull", PR_O_NULLNOLOG, PR_CAP_FE, 0, 0 },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010085 { "http-buffer-request", PR_O_WREQ_BODY, PR_CAP_FE | PR_CAP_BE, 0, PR_MODE_HTTP },
86 { "http-ignore-probes", PR_O_IGNORE_PRB, PR_CAP_FE, 0, PR_MODE_HTTP },
William Dauchya9dd9012022-01-05 22:53:24 +010087 { "idle-close-on-response", PR_O_IDLE_CLOSE_RESP, PR_CAP_FE, 0, PR_MODE_HTTP },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010088 { "prefer-last-server", PR_O_PREF_LAST, PR_CAP_BE, 0, PR_MODE_HTTP },
89 { "logasap", PR_O_LOGASAP, PR_CAP_FE, 0, 0 },
90 { "nolinger", PR_O_TCP_NOLING, PR_CAP_FE | PR_CAP_BE, 0, 0 },
91 { "persist", PR_O_PERSIST, PR_CAP_BE, 0, 0 },
92 { "srvtcpka", PR_O_TCP_SRV_KA, PR_CAP_BE, 0, 0 },
Willy Tarreaue5733232019-05-22 19:24:06 +020093#ifdef USE_TPROXY
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010094 { "transparent", PR_O_TRANSP, PR_CAP_BE, 0, 0 },
95#else
96 { "transparent", 0, 0, 0, 0 },
97#endif
98
99 { NULL, 0, 0, 0, 0 }
100};
101
102/* proxy->options2 */
103const struct cfg_opt cfg_opts2[] =
104{
Willy Tarreaue5733232019-05-22 19:24:06 +0200105#ifdef USE_LINUX_SPLICE
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +0100106 { "splice-request", PR_O2_SPLIC_REQ, PR_CAP_FE|PR_CAP_BE, 0, 0 },
107 { "splice-response", PR_O2_SPLIC_RTR, PR_CAP_FE|PR_CAP_BE, 0, 0 },
108 { "splice-auto", PR_O2_SPLIC_AUT, PR_CAP_FE|PR_CAP_BE, 0, 0 },
109#else
110 { "splice-request", 0, 0, 0, 0 },
111 { "splice-response", 0, 0, 0, 0 },
112 { "splice-auto", 0, 0, 0, 0 },
113#endif
114 { "accept-invalid-http-request", PR_O2_REQBUG_OK, PR_CAP_FE, 0, PR_MODE_HTTP },
115 { "accept-invalid-http-response", PR_O2_RSPBUG_OK, PR_CAP_BE, 0, PR_MODE_HTTP },
116 { "dontlog-normal", PR_O2_NOLOGNORM, PR_CAP_FE, 0, 0 },
117 { "log-separate-errors", PR_O2_LOGERRORS, PR_CAP_FE, 0, 0 },
118 { "log-health-checks", PR_O2_LOGHCHKS, PR_CAP_BE, 0, 0 },
119 { "socket-stats", PR_O2_SOCKSTAT, PR_CAP_FE, 0, 0 },
120 { "tcp-smart-accept", PR_O2_SMARTACC, PR_CAP_FE, 0, 0 },
121 { "tcp-smart-connect", PR_O2_SMARTCON, PR_CAP_BE, 0, 0 },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +0100122 { "independent-streams", PR_O2_INDEPSTR, PR_CAP_FE|PR_CAP_BE, 0, 0 },
123 { "http-use-proxy-header", PR_O2_USE_PXHDR, PR_CAP_FE, 0, PR_MODE_HTTP },
124 { "http-pretend-keepalive", PR_O2_FAKE_KA, PR_CAP_BE, 0, PR_MODE_HTTP },
125 { "http-no-delay", PR_O2_NODELAY, PR_CAP_FE|PR_CAP_BE, 0, PR_MODE_HTTP },
Christopher Faulet98fbe952019-07-22 16:18:24 +0200126
Christopher Fauleta9e934b2022-09-06 10:09:40 +0200127 {"h1-case-adjust-bogus-client", PR_O2_H1_ADJ_BUGCLI, PR_CAP_FE, 0, 0 },
128 {"h1-case-adjust-bogus-server", PR_O2_H1_ADJ_BUGSRV, PR_CAP_BE, 0, 0 },
Christopher Faulet89aed322020-06-02 17:33:56 +0200129 {"disable-h2-upgrade", PR_O2_NO_H2_UPGRADE, PR_CAP_FE, 0, PR_MODE_HTTP },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +0100130 { NULL, 0, 0, 0 }
131};
132
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100133static void free_stick_rules(struct list *rules)
134{
135 struct sticking_rule *rule, *ruleb;
136
137 list_for_each_entry_safe(rule, ruleb, rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200138 LIST_DELETE(&rule->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100139 free_acl_cond(rule->cond);
140 release_sample_expr(rule->expr);
141 free(rule);
142 }
143}
144
145void free_proxy(struct proxy *p)
146{
Amaury Denoyellef5c1e122021-08-25 15:03:46 +0200147 struct server *s;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100148 struct cap_hdr *h,*h_next;
149 struct listener *l,*l_next;
150 struct bind_conf *bind_conf, *bind_back;
151 struct acl_cond *cond, *condb;
152 struct acl *acl, *aclb;
153 struct server_rule *srule, *sruleb;
154 struct switching_rule *rule, *ruleb;
155 struct redirect_rule *rdr, *rdrb;
156 struct logsrv *log, *logb;
157 struct logformat_node *lf, *lfb;
158 struct proxy_deinit_fct *pxdf;
159 struct server_deinit_fct *srvdf;
160
William Lallemandb0281a42021-08-20 10:16:37 +0200161 if (!p)
162 return;
163
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100164 free(p->conf.file);
165 free(p->id);
166 free(p->cookie_name);
167 free(p->cookie_domain);
168 free(p->cookie_attrs);
169 free(p->lbprm.arg_str);
Willy Tarreau7c9a0fe2022-04-25 10:25:34 +0200170 release_sample_expr(p->lbprm.expr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100171 free(p->server_state_file_name);
172 free(p->capture_name);
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +0100173 istfree(&p->monitor_uri);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100174 free(p->rdp_cookie_name);
175 free(p->invalid_rep);
176 free(p->invalid_req);
177#if defined(CONFIG_HAP_TRANSPARENT)
178 free(p->conn_src.bind_hdr_name);
179#endif
180 if (p->conf.logformat_string != default_http_log_format &&
181 p->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +0200182 p->conf.logformat_string != clf_http_log_format &&
William Lallemandbe6a8732022-12-22 15:37:01 +0100183 p->conf.logformat_string != default_https_log_format &&
184 p->conf.logformat_string != httpclient_log_format)
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100185 free(p->conf.logformat_string);
186
187 free(p->conf.lfs_file);
188 free(p->conf.uniqueid_format_string);
189 istfree(&p->header_unique_id);
190 free(p->conf.uif_file);
191 if ((p->lbprm.algo & BE_LB_LKUP) == BE_LB_LKUP_MAP)
192 free(p->lbprm.map.srv);
193
194 if (p->conf.logformat_sd_string != default_rfc5424_sd_log_format)
195 free(p->conf.logformat_sd_string);
196 free(p->conf.lfsd_file);
197
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +0200198 free(p->conf.error_logformat_string);
199 free(p->conf.elfs_file);
200
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100201 list_for_each_entry_safe(cond, condb, &p->mon_fail_cond, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200202 LIST_DELETE(&cond->list);
Aurelien DARRAGONc6100952023-05-11 12:29:51 +0200203 free_acl_cond(cond);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100204 }
205
206 EXTRA_COUNTERS_FREE(p->extra_counters_fe);
207 EXTRA_COUNTERS_FREE(p->extra_counters_be);
208
209 list_for_each_entry_safe(acl, aclb, &p->acl, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200210 LIST_DELETE(&acl->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100211 prune_acl(acl);
212 free(acl);
213 }
214
215 list_for_each_entry_safe(srule, sruleb, &p->server_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200216 LIST_DELETE(&srule->list);
Aurelien DARRAGONc6100952023-05-11 12:29:51 +0200217 free_acl_cond(srule->cond);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100218 list_for_each_entry_safe(lf, lfb, &srule->expr, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200219 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100220 release_sample_expr(lf->expr);
221 free(lf->arg);
222 free(lf);
223 }
224 free(srule->file);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100225 free(srule);
226 }
227
228 list_for_each_entry_safe(rule, ruleb, &p->switching_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200229 LIST_DELETE(&rule->list);
Aurelien DARRAGONc6100952023-05-11 12:29:51 +0200230 free_acl_cond(rule->cond);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100231 free(rule->file);
232 free(rule);
233 }
234
235 list_for_each_entry_safe(rdr, rdrb, &p->redirect_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200236 LIST_DELETE(&rdr->list);
Aurelien DARRAGON7abc9222023-05-11 10:30:27 +0200237 http_free_redirect_rule(rdr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100238 }
239
240 list_for_each_entry_safe(log, logb, &p->logsrvs, list) {
Willy Tarreau211ea252022-03-17 19:47:33 +0100241 LIST_DEL_INIT(&log->list);
242 free_logsrv(log);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100243 }
244
245 list_for_each_entry_safe(lf, lfb, &p->logformat, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200246 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100247 release_sample_expr(lf->expr);
248 free(lf->arg);
249 free(lf);
250 }
251
252 list_for_each_entry_safe(lf, lfb, &p->logformat_sd, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200253 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100254 release_sample_expr(lf->expr);
255 free(lf->arg);
256 free(lf);
257 }
258
259 list_for_each_entry_safe(lf, lfb, &p->format_unique_id, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200260 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100261 release_sample_expr(lf->expr);
262 free(lf->arg);
263 free(lf);
264 }
265
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +0200266 list_for_each_entry_safe(lf, lfb, &p->logformat_error, list) {
267 LIST_DELETE(&lf->list);
268 release_sample_expr(lf->expr);
269 free(lf->arg);
270 free(lf);
271 }
272
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100273 free_act_rules(&p->tcp_req.inspect_rules);
274 free_act_rules(&p->tcp_rep.inspect_rules);
275 free_act_rules(&p->tcp_req.l4_rules);
276 free_act_rules(&p->tcp_req.l5_rules);
277 free_act_rules(&p->http_req_rules);
278 free_act_rules(&p->http_res_rules);
279 free_act_rules(&p->http_after_res_rules);
280
281 free_stick_rules(&p->storersp_rules);
282 free_stick_rules(&p->sticking_rules);
283
284 h = p->req_cap;
285 while (h) {
Christopher Faulet57962282022-04-25 14:30:58 +0200286 if (p->defpx && h == p->defpx->req_cap)
287 break;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100288 h_next = h->next;
289 free(h->name);
290 pool_destroy(h->pool);
291 free(h);
292 h = h_next;
293 }/* end while(h) */
294
295 h = p->rsp_cap;
296 while (h) {
Christopher Faulet57962282022-04-25 14:30:58 +0200297 if (p->defpx && h == p->defpx->rsp_cap)
298 break;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100299 h_next = h->next;
300 free(h->name);
301 pool_destroy(h->pool);
302 free(h);
303 h = h_next;
304 }/* end while(h) */
305
306 s = p->srv;
307 while (s) {
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100308 list_for_each_entry(srvdf, &server_deinit_list, list)
309 srvdf->fct(s);
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +0200310 s = srv_drop(s);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100311 }/* end while(s) */
312
Aurelien DARRAGON899b5472023-06-01 12:07:43 +0200313 /* also free default-server parameters since some of them might have
314 * been dynamically allocated (e.g.: config hints, cookies, ssl..)
315 */
316 srv_free_params(&p->defsrv);
317
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100318 list_for_each_entry_safe(l, l_next, &p->conf.listeners, by_fe) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200319 LIST_DELETE(&l->by_fe);
320 LIST_DELETE(&l->by_bind);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100321 free(l->name);
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100322 free(l->per_thr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100323 free(l->counters);
324
325 EXTRA_COUNTERS_FREE(l->extra_counters);
326 free(l);
327 }
328
329 /* Release unused SSL configs. */
330 list_for_each_entry_safe(bind_conf, bind_back, &p->conf.bind, by_fe) {
331 if (bind_conf->xprt->destroy_bind_conf)
332 bind_conf->xprt->destroy_bind_conf(bind_conf);
333 free(bind_conf->file);
334 free(bind_conf->arg);
Aurelien DARRAGON12d6b9a2023-06-01 10:58:44 +0200335 free(bind_conf->settings.interface);
Willy Tarreau2b718102021-04-21 07:32:39 +0200336 LIST_DELETE(&bind_conf->by_fe);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100337 free(bind_conf);
338 }
339
340 flt_deinit(p);
341
342 list_for_each_entry(pxdf, &proxy_deinit_list, list)
343 pxdf->fct(p);
344
345 free(p->desc);
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +0100346
347 http_ext_clean(p);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100348
349 task_destroy(p->task);
350
351 pool_destroy(p->req_cap_pool);
352 pool_destroy(p->rsp_cap_pool);
Aurelien DARRAGONfebaa3e2023-11-16 16:18:14 +0100353
Aurelien DARRAGON6ce5cd02023-11-16 16:17:12 +0100354 stktable_deinit(p->table);
Aurelien DARRAGONfebaa3e2023-11-16 16:18:14 +0100355 ha_free(&p->table);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100356
357 HA_RWLOCK_DESTROY(&p->lbprm.lock);
358 HA_RWLOCK_DESTROY(&p->lock);
Christopher Faulet57962282022-04-25 14:30:58 +0200359
360 proxy_unref_defaults(p);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100361 ha_free(&p);
362}
363
Willy Tarreau977b8e42006-12-29 14:19:17 +0100364/*
Willy Tarreau816eb542007-11-04 07:04:43 +0100365 * This function returns a string containing a name describing capabilities to
366 * report comprehensible error messages. Specifically, it will return the words
Willy Tarreau80dc6fe2021-02-12 09:43:33 +0100367 * "frontend", "backend" when appropriate, "defaults" if it corresponds to a
368 * defaults section, or "proxy" for all other cases including the proxies
369 * declared in "listen" mode.
Willy Tarreau977b8e42006-12-29 14:19:17 +0100370 */
Willy Tarreau816eb542007-11-04 07:04:43 +0100371const char *proxy_cap_str(int cap)
Willy Tarreau977b8e42006-12-29 14:19:17 +0100372{
Willy Tarreau80dc6fe2021-02-12 09:43:33 +0100373 if (cap & PR_CAP_DEF)
374 return "defaults";
375
Willy Tarreau816eb542007-11-04 07:04:43 +0100376 if ((cap & PR_CAP_LISTEN) != PR_CAP_LISTEN) {
377 if (cap & PR_CAP_FE)
378 return "frontend";
379 else if (cap & PR_CAP_BE)
380 return "backend";
Willy Tarreau816eb542007-11-04 07:04:43 +0100381 }
382 return "proxy";
Willy Tarreau977b8e42006-12-29 14:19:17 +0100383}
384
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100385/*
386 * This function returns a string containing the mode of the proxy in a format
387 * suitable for error messages.
388 */
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100389const char *proxy_mode_str(int mode) {
390
391 if (mode == PR_MODE_TCP)
392 return "tcp";
393 else if (mode == PR_MODE_HTTP)
394 return "http";
William Lallemandcf62f7e2018-10-26 14:47:40 +0200395 else if (mode == PR_MODE_CLI)
396 return "cli";
William Lallemand06715af2022-03-08 11:50:59 +0100397 else if (mode == PR_MODE_SYSLOG)
398 return "syslog";
399 else if (mode == PR_MODE_PEERS)
400 return "peers";
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100401 else
402 return "unknown";
403}
404
Willy Tarreau31a3cea2021-03-15 11:11:55 +0100405/* try to find among known options the one that looks closest to <word> by
406 * counting transitions between letters, digits and other characters. Will
407 * return the best matching word if found, otherwise NULL. An optional array
408 * of extra words to compare may be passed in <extra>, but it must then be
409 * terminated by a NULL entry. If unused it may be NULL.
410 */
411const char *proxy_find_best_option(const char *word, const char **extra)
412{
413 uint8_t word_sig[1024];
414 uint8_t list_sig[1024];
415 const char *best_ptr = NULL;
416 int dist, best_dist = INT_MAX;
417 int index;
418
419 make_word_fingerprint(word_sig, word);
420
421 for (index = 0; cfg_opts[index].name; index++) {
422 make_word_fingerprint(list_sig, cfg_opts[index].name);
423 dist = word_fingerprint_distance(word_sig, list_sig);
424 if (dist < best_dist) {
425 best_dist = dist;
426 best_ptr = cfg_opts[index].name;
427 }
428 }
429
430 for (index = 0; cfg_opts2[index].name; index++) {
431 make_word_fingerprint(list_sig, cfg_opts2[index].name);
432 dist = word_fingerprint_distance(word_sig, list_sig);
433 if (dist < best_dist) {
434 best_dist = dist;
435 best_ptr = cfg_opts2[index].name;
436 }
437 }
438
439 while (extra && *extra) {
440 make_word_fingerprint(list_sig, *extra);
441 dist = word_fingerprint_distance(word_sig, list_sig);
442 if (dist < best_dist) {
443 best_dist = dist;
444 best_ptr = *extra;
445 }
446 extra++;
447 }
448
449 if (best_dist > 2 * strlen(word) || (best_ptr && best_dist > 2 * strlen(best_ptr)))
450 best_ptr = NULL;
451 return best_ptr;
452}
453
Willy Tarreauf3950172009-10-10 18:35:51 +0200454/*
455 * This function scans the list of backends and servers to retrieve the first
456 * backend and the first server with the given names, and sets them in both
457 * parameters. It returns zero if either is not found, or non-zero and sets
458 * the ones it did not found to NULL. If a NULL pointer is passed for the
459 * backend, only the pointer to the server will be updated.
460 */
461int get_backend_server(const char *bk_name, const char *sv_name,
462 struct proxy **bk, struct server **sv)
463{
464 struct proxy *p;
465 struct server *s;
Willy Tarreau7ecc4202014-03-15 07:57:11 +0100466 int sid;
Willy Tarreauf3950172009-10-10 18:35:51 +0200467
468 *sv = NULL;
469
Willy Tarreau050536d2012-10-04 08:47:34 +0200470 sid = -1;
Willy Tarreaucfeaa472009-10-10 22:33:08 +0200471 if (*sv_name == '#')
472 sid = atoi(sv_name + 1);
473
Willy Tarreau9e0bb102015-05-26 11:24:42 +0200474 p = proxy_be_by_name(bk_name);
Willy Tarreauf3950172009-10-10 18:35:51 +0200475 if (bk)
476 *bk = p;
477 if (!p)
478 return 0;
479
480 for (s = p->srv; s; s = s->next)
Willy Tarreau4055a102012-11-15 00:15:18 +0100481 if ((sid >= 0 && s->puid == sid) ||
482 (sid < 0 && strcmp(s->id, sv_name) == 0))
Willy Tarreauf3950172009-10-10 18:35:51 +0200483 break;
484 *sv = s;
485 if (!s)
486 return 0;
487 return 1;
488}
489
Willy Tarreaue219db72007-12-03 01:30:13 +0100490/* This function parses a "timeout" statement in a proxy section. It returns
491 * -1 if there is any error, 1 for a warning, otherwise zero. If it does not
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200492 * return zero, it will write an error or warning message into a preallocated
493 * buffer returned at <err>. The trailing is not be written. The function must
494 * be called with <args> pointing to the first command line word, with <proxy>
495 * pointing to the proxy being parsed, and <defpx> to the default proxy or NULL.
496 * As a special case for compatibility with older configs, it also accepts
497 * "{cli|srv|con}timeout" in args[0].
Willy Tarreaue219db72007-12-03 01:30:13 +0100498 */
Willy Tarreau9de1bbd2008-07-09 20:34:27 +0200499static int proxy_parse_timeout(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100500 const struct proxy *defpx, const char *file, int line,
Willy Tarreau28a47d62012-09-18 20:02:48 +0200501 char **err)
Willy Tarreaue219db72007-12-03 01:30:13 +0100502{
503 unsigned timeout;
504 int retval, cap;
505 const char *res, *name;
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200506 int *tv = NULL;
Willy Tarreau01825162021-03-09 09:53:46 +0100507 const int *td = NULL;
Willy Tarreaue219db72007-12-03 01:30:13 +0100508
509 retval = 0;
Willy Tarreau9de1bbd2008-07-09 20:34:27 +0200510
511 /* simply skip "timeout" but remain compatible with old form */
512 if (strcmp(args[0], "timeout") == 0)
513 args++;
514
Willy Tarreaue219db72007-12-03 01:30:13 +0100515 name = args[0];
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100516 if (strcmp(args[0], "client") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100517 name = "client";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100518 tv = &proxy->timeout.client;
519 td = &defpx->timeout.client;
Willy Tarreaue219db72007-12-03 01:30:13 +0100520 cap = PR_CAP_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100521 } else if (strcmp(args[0], "tarpit") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100522 tv = &proxy->timeout.tarpit;
523 td = &defpx->timeout.tarpit;
Willy Tarreau51c9bde2008-01-06 13:40:03 +0100524 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100525 } else if (strcmp(args[0], "http-keep-alive") == 0) {
Willy Tarreaub16a5742010-01-10 14:46:16 +0100526 tv = &proxy->timeout.httpka;
527 td = &defpx->timeout.httpka;
528 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100529 } else if (strcmp(args[0], "http-request") == 0) {
Willy Tarreau036fae02008-01-06 13:24:40 +0100530 tv = &proxy->timeout.httpreq;
531 td = &defpx->timeout.httpreq;
Willy Tarreaucd7afc02009-07-12 10:03:17 +0200532 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100533 } else if (strcmp(args[0], "server") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100534 name = "server";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100535 tv = &proxy->timeout.server;
536 td = &defpx->timeout.server;
Willy Tarreaue219db72007-12-03 01:30:13 +0100537 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100538 } else if (strcmp(args[0], "connect") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100539 name = "connect";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100540 tv = &proxy->timeout.connect;
541 td = &defpx->timeout.connect;
Willy Tarreaue219db72007-12-03 01:30:13 +0100542 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100543 } else if (strcmp(args[0], "check") == 0) {
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +0100544 tv = &proxy->timeout.check;
545 td = &defpx->timeout.check;
546 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100547 } else if (strcmp(args[0], "queue") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100548 tv = &proxy->timeout.queue;
549 td = &defpx->timeout.queue;
550 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100551 } else if (strcmp(args[0], "tunnel") == 0) {
Willy Tarreauce887fd2012-05-12 12:50:00 +0200552 tv = &proxy->timeout.tunnel;
553 td = &defpx->timeout.tunnel;
554 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100555 } else if (strcmp(args[0], "client-fin") == 0) {
Willy Tarreau05cdd962014-05-10 14:30:07 +0200556 tv = &proxy->timeout.clientfin;
557 td = &defpx->timeout.clientfin;
558 cap = PR_CAP_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100559 } else if (strcmp(args[0], "server-fin") == 0) {
Willy Tarreau05cdd962014-05-10 14:30:07 +0200560 tv = &proxy->timeout.serverfin;
561 td = &defpx->timeout.serverfin;
562 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100563 } else if (strcmp(args[0], "clitimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200564 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout client'.", args[0]);
565 return -1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100566 } else if (strcmp(args[0], "srvtimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200567 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout server'.", args[0]);
568 return -1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100569 } else if (strcmp(args[0], "contimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200570 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout connect'.", args[0]);
571 return -1;
Willy Tarreaue219db72007-12-03 01:30:13 +0100572 } else {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200573 memprintf(err,
574 "'timeout' supports 'client', 'server', 'connect', 'check', "
Willy Tarreau05cdd962014-05-10 14:30:07 +0200575 "'queue', 'http-keep-alive', 'http-request', 'tunnel', 'tarpit', "
576 "'client-fin' and 'server-fin' (got '%s')",
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200577 args[0]);
Willy Tarreaue219db72007-12-03 01:30:13 +0100578 return -1;
579 }
580
581 if (*args[1] == 0) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200582 memprintf(err, "'timeout %s' expects an integer value (in milliseconds)", name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100583 return -1;
584 }
585
586 res = parse_time_err(args[1], &timeout, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +0200587 if (res == PARSE_TIME_OVER) {
588 memprintf(err, "timer overflow in argument '%s' to 'timeout %s' (maximum value is 2147483647 ms or ~24.8 days)",
589 args[1], name);
590 return -1;
591 }
592 else if (res == PARSE_TIME_UNDER) {
593 memprintf(err, "timer underflow in argument '%s' to 'timeout %s' (minimum non-null value is 1 ms)",
594 args[1], name);
595 return -1;
596 }
597 else if (res) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200598 memprintf(err, "unexpected character '%c' in 'timeout %s'", *res, name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100599 return -1;
600 }
601
602 if (!(proxy->cap & cap)) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200603 memprintf(err, "'timeout %s' will be ignored because %s '%s' has no %s capability",
604 name, proxy_type_str(proxy), proxy->id,
605 (cap & PR_CAP_BE) ? "backend" : "frontend");
Willy Tarreaue219db72007-12-03 01:30:13 +0100606 retval = 1;
607 }
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200608 else if (defpx && *tv != *td) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200609 memprintf(err, "overwriting 'timeout %s' which was already specified", name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100610 retval = 1;
611 }
612
Willy Tarreaufac5b592014-05-22 08:24:46 +0200613 if (*args[2] != 0) {
614 memprintf(err, "'timeout %s' : unexpected extra argument '%s' after value '%s'.", name, args[2], args[1]);
615 retval = -1;
616 }
617
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200618 *tv = MS_TO_TICKS(timeout);
Willy Tarreaue219db72007-12-03 01:30:13 +0100619 return retval;
620}
621
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100622/* This function parses a "rate-limit" statement in a proxy section. It returns
623 * -1 if there is any error, 1 for a warning, otherwise zero. If it does not
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200624 * return zero, it will write an error or warning message into a preallocated
625 * buffer returned at <err>. The function must be called with <args> pointing
626 * to the first command line word, with <proxy> pointing to the proxy being
627 * parsed, and <defpx> to the default proxy or NULL.
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100628 */
629static int proxy_parse_rate_limit(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100630 const struct proxy *defpx, const char *file, int line,
Willy Tarreau28a47d62012-09-18 20:02:48 +0200631 char **err)
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100632{
William Dauchybb9da0b2020-01-16 01:34:27 +0100633 int retval;
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200634 char *res;
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100635 unsigned int *tv = NULL;
Willy Tarreau01825162021-03-09 09:53:46 +0100636 const unsigned int *td = NULL;
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100637 unsigned int val;
638
639 retval = 0;
640
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200641 if (strcmp(args[1], "sessions") == 0) {
Willy Tarreau13a34bd2009-05-10 18:52:49 +0200642 tv = &proxy->fe_sps_lim;
643 td = &defpx->fe_sps_lim;
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200644 }
645 else {
646 memprintf(err, "'%s' only supports 'sessions' (got '%s')", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100647 return -1;
648 }
649
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200650 if (*args[2] == 0) {
651 memprintf(err, "'%s %s' expects expects an integer value (in sessions/second)", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100652 return -1;
653 }
654
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200655 val = strtoul(args[2], &res, 0);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100656 if (*res) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200657 memprintf(err, "'%s %s' : unexpected character '%c' in integer value '%s'", args[0], args[1], *res, args[2]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100658 return -1;
659 }
660
William Dauchybb9da0b2020-01-16 01:34:27 +0100661 if (!(proxy->cap & PR_CAP_FE)) {
662 memprintf(err, "%s %s will be ignored because %s '%s' has no frontend capability",
663 args[0], args[1], proxy_type_str(proxy), proxy->id);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100664 retval = 1;
665 }
666 else if (defpx && *tv != *td) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200667 memprintf(err, "overwriting %s %s which was already specified", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100668 retval = 1;
669 }
670
671 *tv = val;
672 return retval;
673}
674
Willy Tarreauc35362a2014-04-25 13:58:37 +0200675/* This function parses a "max-keep-alive-queue" statement in a proxy section.
676 * It returns -1 if there is any error, 1 for a warning, otherwise zero. If it
677 * does not return zero, it will write an error or warning message into a
678 * preallocated buffer returned at <err>. The function must be called with
679 * <args> pointing to the first command line word, with <proxy> pointing to
680 * the proxy being parsed, and <defpx> to the default proxy or NULL.
681 */
682static int proxy_parse_max_ka_queue(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100683 const struct proxy *defpx, const char *file, int line,
Willy Tarreauc35362a2014-04-25 13:58:37 +0200684 char **err)
685{
686 int retval;
687 char *res;
688 unsigned int val;
689
690 retval = 0;
691
692 if (*args[1] == 0) {
693 memprintf(err, "'%s' expects expects an integer value (or -1 to disable)", args[0]);
694 return -1;
695 }
696
697 val = strtol(args[1], &res, 0);
698 if (*res) {
699 memprintf(err, "'%s' : unexpected character '%c' in integer value '%s'", args[0], *res, args[1]);
700 return -1;
701 }
702
703 if (!(proxy->cap & PR_CAP_BE)) {
704 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
705 args[0], proxy_type_str(proxy), proxy->id);
706 retval = 1;
707 }
708
709 /* we store <val+1> so that a user-facing value of -1 is stored as zero (default) */
710 proxy->max_ka_queue = val + 1;
711 return retval;
712}
713
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200714/* This function parses a "declare" statement in a proxy section. It returns -1
715 * if there is any error, 1 for warning, otherwise 0. If it does not return zero,
716 * it will write an error or warning message into a preallocated buffer returned
717 * at <err>. The function must be called with <args> pointing to the first command
718 * line word, with <proxy> pointing to the proxy being parsed, and <defpx> to the
719 * default proxy or NULL.
720 */
721static int proxy_parse_declare(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100722 const struct proxy *defpx, const char *file, int line,
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200723 char **err)
724{
725 /* Capture keyword wannot be declared in a default proxy. */
726 if (curpx == defpx) {
Joseph Herlant9edebb82018-11-15 11:50:44 -0800727 memprintf(err, "'%s' not available in default section", args[0]);
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200728 return -1;
729 }
730
Thayne McCombs8f0cc5c2021-01-07 21:35:52 -0700731 /* Capture keyword is only available in frontend. */
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200732 if (!(curpx->cap & PR_CAP_FE)) {
Joseph Herlant9edebb82018-11-15 11:50:44 -0800733 memprintf(err, "'%s' only available in frontend or listen section", args[0]);
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200734 return -1;
735 }
736
737 /* Check mandatory second keyword. */
738 if (!args[1] || !*args[1]) {
739 memprintf(err, "'%s' needs a second keyword that specify the type of declaration ('capture')", args[0]);
740 return -1;
741 }
742
Joseph Herlant59dd2952018-11-15 11:46:55 -0800743 /* Actually, declare is only available for declaring capture
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200744 * slot, but in the future it can declare maps or variables.
Joseph Herlant59dd2952018-11-15 11:46:55 -0800745 * So, this section permits to check and switch according with
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200746 * the second keyword.
747 */
748 if (strcmp(args[1], "capture") == 0) {
749 char *error = NULL;
750 long len;
751 struct cap_hdr *hdr;
752
753 /* Check the next keyword. */
754 if (!args[2] || !*args[2] ||
755 (strcmp(args[2], "response") != 0 &&
756 strcmp(args[2], "request") != 0)) {
757 memprintf(err, "'%s %s' requires a direction ('request' or 'response')", args[0], args[1]);
758 return -1;
759 }
760
761 /* Check the 'len' keyword. */
762 if (!args[3] || !*args[3] || strcmp(args[3], "len") != 0) {
763 memprintf(err, "'%s %s' requires a capture length ('len')", args[0], args[1]);
764 return -1;
765 }
766
767 /* Check the length value. */
768 if (!args[4] || !*args[4]) {
769 memprintf(err, "'%s %s': 'len' requires a numeric value that represents the "
770 "capture length",
771 args[0], args[1]);
772 return -1;
773 }
774
775 /* convert the length value. */
776 len = strtol(args[4], &error, 10);
777 if (*error != '\0') {
778 memprintf(err, "'%s %s': cannot parse the length '%s'.",
779 args[0], args[1], args[3]);
780 return -1;
781 }
782
783 /* check length. */
784 if (len <= 0) {
785 memprintf(err, "length must be > 0");
786 return -1;
787 }
788
789 /* register the capture. */
Vincent Bernat02779b62016-04-03 13:48:43 +0200790 hdr = calloc(1, sizeof(*hdr));
Remi Tricot-Le Breton55ba0d62021-05-12 18:04:46 +0200791 if (!hdr) {
792 memprintf(err, "proxy '%s': out of memory while registering a capture", curpx->id);
793 return -1;
794 }
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200795 hdr->name = NULL; /* not a header capture */
796 hdr->namelen = 0;
797 hdr->len = len;
798 hdr->pool = create_pool("caphdr", hdr->len + 1, MEM_F_SHARED);
799
800 if (strcmp(args[2], "request") == 0) {
801 hdr->next = curpx->req_cap;
802 hdr->index = curpx->nb_req_cap++;
803 curpx->req_cap = hdr;
804 }
805 if (strcmp(args[2], "response") == 0) {
806 hdr->next = curpx->rsp_cap;
807 hdr->index = curpx->nb_rsp_cap++;
808 curpx->rsp_cap = hdr;
809 }
810 return 0;
811 }
812 else {
813 memprintf(err, "unknown declaration type '%s' (supports 'capture')", args[1]);
814 return -1;
815 }
816}
817
Olivier Houcharda254a372019-04-05 15:30:12 +0200818/* This function parses a "retry-on" statement */
819static int
820proxy_parse_retry_on(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100821 const struct proxy *defpx, const char *file, int line,
Olivier Houcharda254a372019-04-05 15:30:12 +0200822 char **err)
823{
824 int i;
825
826 if (!(*args[1])) {
827 memprintf(err, "'%s' needs at least one keyword to specify when to retry", args[0]);
828 return -1;
829 }
830 if (!(curpx->cap & PR_CAP_BE)) {
831 memprintf(err, "'%s' only available in backend or listen section", args[0]);
832 return -1;
833 }
834 curpx->retry_type = 0;
835 for (i = 1; *(args[i]); i++) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100836 if (strcmp(args[i], "conn-failure") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200837 curpx->retry_type |= PR_RE_CONN_FAILED;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100838 else if (strcmp(args[i], "empty-response") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200839 curpx->retry_type |= PR_RE_DISCONNECTED;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100840 else if (strcmp(args[i], "response-timeout") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200841 curpx->retry_type |= PR_RE_TIMEOUT;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100842 else if (strcmp(args[i], "401") == 0)
Julien Pivotto2de240a2020-11-12 11:14:05 +0100843 curpx->retry_type |= PR_RE_401;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100844 else if (strcmp(args[i], "403") == 0)
Julien Pivotto2de240a2020-11-12 11:14:05 +0100845 curpx->retry_type |= PR_RE_403;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100846 else if (strcmp(args[i], "404") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200847 curpx->retry_type |= PR_RE_404;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100848 else if (strcmp(args[i], "408") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200849 curpx->retry_type |= PR_RE_408;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100850 else if (strcmp(args[i], "425") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200851 curpx->retry_type |= PR_RE_425;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100852 else if (strcmp(args[i], "500") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200853 curpx->retry_type |= PR_RE_500;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100854 else if (strcmp(args[i], "501") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200855 curpx->retry_type |= PR_RE_501;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100856 else if (strcmp(args[i], "502") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200857 curpx->retry_type |= PR_RE_502;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100858 else if (strcmp(args[i], "503") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200859 curpx->retry_type |= PR_RE_503;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100860 else if (strcmp(args[i], "504") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200861 curpx->retry_type |= PR_RE_504;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100862 else if (strcmp(args[i], "0rtt-rejected") == 0)
Olivier Houchard865d8392019-05-03 22:46:27 +0200863 curpx->retry_type |= PR_RE_EARLY_ERROR;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100864 else if (strcmp(args[i], "junk-response") == 0)
Olivier Houcharde3249a92019-05-03 23:01:47 +0200865 curpx->retry_type |= PR_RE_JUNK_REQUEST;
Olivier Houchardddf0e032019-05-10 18:05:40 +0200866 else if (!(strcmp(args[i], "all-retryable-errors")))
867 curpx->retry_type |= PR_RE_CONN_FAILED | PR_RE_DISCONNECTED |
868 PR_RE_TIMEOUT | PR_RE_500 | PR_RE_502 |
869 PR_RE_503 | PR_RE_504 | PR_RE_EARLY_ERROR |
870 PR_RE_JUNK_REQUEST;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100871 else if (strcmp(args[i], "none") == 0) {
Olivier Houcharda254a372019-04-05 15:30:12 +0200872 if (i != 1 || *args[i + 1]) {
873 memprintf(err, "'%s' 'none' keyworld only usable alone", args[0]);
874 return -1;
875 }
876 } else {
877 memprintf(err, "'%s': unknown keyword '%s'", args[0], args[i]);
878 return -1;
879 }
880
881 }
882
883
884 return 0;
885}
886
Willy Tarreau52543212020-07-09 05:58:51 +0200887#ifdef TCP_KEEPCNT
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900888/* This function parses "{cli|srv}tcpka-cnt" statements */
889static int proxy_parse_tcpka_cnt(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100890 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900891 char **err)
892{
893 int retval;
894 char *res;
895 unsigned int tcpka_cnt;
896
897 retval = 0;
898
899 if (*args[1] == 0) {
900 memprintf(err, "'%s' expects an integer value", args[0]);
901 return -1;
902 }
903
904 tcpka_cnt = strtol(args[1], &res, 0);
905 if (*res) {
906 memprintf(err, "'%s' : unexpected character '%c' in integer value '%s'", args[0], *res, args[1]);
907 return -1;
908 }
909
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100910 if (strcmp(args[0], "clitcpka-cnt") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900911 if (!(proxy->cap & PR_CAP_FE)) {
912 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
913 args[0], proxy_type_str(proxy), proxy->id);
914 retval = 1;
915 }
916 proxy->clitcpka_cnt = tcpka_cnt;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100917 } else if (strcmp(args[0], "srvtcpka-cnt") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900918 if (!(proxy->cap & PR_CAP_BE)) {
919 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
920 args[0], proxy_type_str(proxy), proxy->id);
921 retval = 1;
922 }
923 proxy->srvtcpka_cnt = tcpka_cnt;
924 } else {
925 /* unreachable */
926 memprintf(err, "'%s': unknown keyword", args[0]);
927 return -1;
928 }
929
930 return retval;
931}
Willy Tarreau52543212020-07-09 05:58:51 +0200932#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900933
Willy Tarreau52543212020-07-09 05:58:51 +0200934#ifdef TCP_KEEPIDLE
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900935/* This function parses "{cli|srv}tcpka-idle" statements */
936static int proxy_parse_tcpka_idle(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100937 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900938 char **err)
939{
940 int retval;
941 const char *res;
942 unsigned int tcpka_idle;
943
944 retval = 0;
945
946 if (*args[1] == 0) {
947 memprintf(err, "'%s' expects an integer value", args[0]);
948 return -1;
949 }
950 res = parse_time_err(args[1], &tcpka_idle, TIME_UNIT_S);
951 if (res == PARSE_TIME_OVER) {
952 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
953 args[1], args[0]);
954 return -1;
955 }
956 else if (res == PARSE_TIME_UNDER) {
957 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
958 args[1], args[0]);
959 return -1;
960 }
961 else if (res) {
962 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
963 return -1;
964 }
965
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100966 if (strcmp(args[0], "clitcpka-idle") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900967 if (!(proxy->cap & PR_CAP_FE)) {
968 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
969 args[0], proxy_type_str(proxy), proxy->id);
970 retval = 1;
971 }
972 proxy->clitcpka_idle = tcpka_idle;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100973 } else if (strcmp(args[0], "srvtcpka-idle") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900974 if (!(proxy->cap & PR_CAP_BE)) {
975 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
976 args[0], proxy_type_str(proxy), proxy->id);
977 retval = 1;
978 }
979 proxy->srvtcpka_idle = tcpka_idle;
980 } else {
981 /* unreachable */
982 memprintf(err, "'%s': unknown keyword", args[0]);
983 return -1;
984 }
985
986 return retval;
987}
Willy Tarreau52543212020-07-09 05:58:51 +0200988#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900989
Willy Tarreau52543212020-07-09 05:58:51 +0200990#ifdef TCP_KEEPINTVL
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900991/* This function parses "{cli|srv}tcpka-intvl" statements */
992static int proxy_parse_tcpka_intvl(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100993 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900994 char **err)
995{
996 int retval;
997 const char *res;
998 unsigned int tcpka_intvl;
999
1000 retval = 0;
1001
1002 if (*args[1] == 0) {
1003 memprintf(err, "'%s' expects an integer value", args[0]);
1004 return -1;
1005 }
1006 res = parse_time_err(args[1], &tcpka_intvl, TIME_UNIT_S);
1007 if (res == PARSE_TIME_OVER) {
1008 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
1009 args[1], args[0]);
1010 return -1;
1011 }
1012 else if (res == PARSE_TIME_UNDER) {
1013 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
1014 args[1], args[0]);
1015 return -1;
1016 }
1017 else if (res) {
1018 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
1019 return -1;
1020 }
1021
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001022 if (strcmp(args[0], "clitcpka-intvl") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001023 if (!(proxy->cap & PR_CAP_FE)) {
1024 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
1025 args[0], proxy_type_str(proxy), proxy->id);
1026 retval = 1;
1027 }
1028 proxy->clitcpka_intvl = tcpka_intvl;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001029 } else if (strcmp(args[0], "srvtcpka-intvl") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001030 if (!(proxy->cap & PR_CAP_BE)) {
1031 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
1032 args[0], proxy_type_str(proxy), proxy->id);
1033 retval = 1;
1034 }
1035 proxy->srvtcpka_intvl = tcpka_intvl;
1036 } else {
1037 /* unreachable */
1038 memprintf(err, "'%s': unknown keyword", args[0]);
1039 return -1;
1040 }
1041
1042 return retval;
1043}
Willy Tarreau52543212020-07-09 05:58:51 +02001044#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001045
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001046/* This function inserts proxy <px> into the tree of known proxies (regular
1047 * ones or defaults depending on px->cap & PR_CAP_DEF). The proxy's name is
1048 * used as the storing key so it must already have been initialized.
Willy Tarreauf79d9502014-03-15 07:22:35 +01001049 */
1050void proxy_store_name(struct proxy *px)
1051{
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001052 struct eb_root *root = (px->cap & PR_CAP_DEF) ? &defproxy_by_name : &proxy_by_name;
1053
Willy Tarreauf79d9502014-03-15 07:22:35 +01001054 px->conf.by_name.key = px->id;
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001055 ebis_insert(root, &px->conf.by_name);
Willy Tarreauf79d9502014-03-15 07:22:35 +01001056}
1057
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001058/* Returns a pointer to the first proxy matching capabilities <cap> and id
1059 * <id>. NULL is returned if no match is found. If <table> is non-zero, it
1060 * only considers proxies having a table.
Willy Tarreaubc216c42011-08-02 11:25:54 +02001061 */
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001062struct proxy *proxy_find_by_id(int id, int cap, int table)
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001063{
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001064 struct eb32_node *n;
Willy Tarreaubc216c42011-08-02 11:25:54 +02001065
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001066 for (n = eb32_lookup(&used_proxy_id, id); n; n = eb32_next(n)) {
1067 struct proxy *px = container_of(n, struct proxy, conf.id);
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001068
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001069 if (px->uuid != id)
1070 break;
Alex Williams96532db2009-11-01 21:27:13 -05001071
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001072 if ((px->cap & cap) != cap)
1073 continue;
Alex Williams96532db2009-11-01 21:27:13 -05001074
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001075 if (table && (!px->table || !px->table->size))
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001076 continue;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001077
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001078 return px;
1079 }
1080 return NULL;
1081}
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001082
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001083/* Returns a pointer to the first proxy matching either name <name>, or id
1084 * <name> if <name> begins with a '#'. NULL is returned if no match is found.
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001085 * If <table> is non-zero, it only considers proxies having a table. The search
1086 * is made into the regular proxies, unless <cap> has PR_CAP_DEF set in which
1087 * case it's searched into the defproxy tree.
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001088 */
1089struct proxy *proxy_find_by_name(const char *name, int cap, int table)
1090{
1091 struct proxy *curproxy;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001092
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001093 if (*name == '#' && !(cap & PR_CAP_DEF)) {
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001094 curproxy = proxy_find_by_id(atoi(name + 1), cap, table);
1095 if (curproxy)
Willy Tarreauc739aa82015-05-26 11:35:41 +02001096 return curproxy;
Alex Williams96532db2009-11-01 21:27:13 -05001097 }
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001098 else {
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001099 struct eb_root *root;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001100 struct ebpt_node *node;
1101
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001102 root = (cap & PR_CAP_DEF) ? &defproxy_by_name : &proxy_by_name;
1103 for (node = ebis_lookup(root, name); node; node = ebpt_next(node)) {
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001104 curproxy = container_of(node, struct proxy, conf.by_name);
Alex Williams96532db2009-11-01 21:27:13 -05001105
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001106 if (strcmp(curproxy->id, name) != 0)
1107 break;
1108
1109 if ((curproxy->cap & cap) != cap)
1110 continue;
1111
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001112 if (table && (!curproxy->table || !curproxy->table->size))
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001113 continue;
1114
Willy Tarreauc739aa82015-05-26 11:35:41 +02001115 return curproxy;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001116 }
1117 }
Willy Tarreauc739aa82015-05-26 11:35:41 +02001118 return NULL;
Alex Williams96532db2009-11-01 21:27:13 -05001119}
1120
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001121/* Finds the best match for a proxy with capabilities <cap>, name <name> and id
1122 * <id>. At most one of <id> or <name> may be different provided that <cap> is
1123 * valid. Either <id> or <name> may be left unspecified (0). The purpose is to
1124 * find a proxy based on some information from a previous configuration, across
1125 * reloads or during information exchange between peers.
1126 *
1127 * Names are looked up first if present, then IDs are compared if present. In
1128 * case of an inexact match whatever is forced in the configuration has
1129 * precedence in the following order :
1130 * - 1) forced ID (proves a renaming / change of proxy type)
1131 * - 2) proxy name+type (may indicate a move if ID differs)
1132 * - 3) automatic ID+type (may indicate a renaming)
1133 *
1134 * Depending on what is found, we can end up in the following situations :
1135 *
1136 * name id cap | possible causes
1137 * -------------+-----------------
1138 * -- -- -- | nothing found
1139 * -- -- ok | nothing found
1140 * -- ok -- | proxy deleted, ID points to next one
1141 * -- ok ok | proxy renamed, or deleted with ID pointing to next one
1142 * ok -- -- | proxy deleted, but other half with same name still here (before)
1143 * ok -- ok | proxy's ID changed (proxy moved in the config file)
1144 * ok ok -- | proxy deleted, but other half with same name still here (after)
1145 * ok ok ok | perfect match
1146 *
1147 * Upon return if <diff> is not NULL, it is zeroed then filled with up to 3 bits :
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001148 * - PR_FBM_MISMATCH_ID : proxy was found but ID differs
1149 * (and ID was not zero)
1150 * - PR_FBM_MISMATCH_NAME : proxy was found by ID but name differs
1151 * (and name was not NULL)
1152 * - PR_FBM_MISMATCH_PROXYTYPE : a proxy of different type was found with
1153 * the same name and/or id
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001154 *
1155 * Only a valid proxy is returned. If capabilities do not match, NULL is
1156 * returned. The caller can check <diff> to report detailed warnings / errors,
1157 * and decide whether or not to use what was found.
1158 */
1159struct proxy *proxy_find_best_match(int cap, const char *name, int id, int *diff)
1160{
1161 struct proxy *byname;
1162 struct proxy *byid;
1163
1164 if (!name && !id)
1165 return NULL;
1166
1167 if (diff)
1168 *diff = 0;
1169
1170 byname = byid = NULL;
1171
1172 if (name) {
1173 byname = proxy_find_by_name(name, cap, 0);
1174 if (byname && (!id || byname->uuid == id))
1175 return byname;
1176 }
1177
Joseph Herlant59dd2952018-11-15 11:46:55 -08001178 /* remaining possibilities :
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001179 * - name not set
1180 * - name set but not found
1181 * - name found, but ID doesn't match.
1182 */
1183 if (id) {
1184 byid = proxy_find_by_id(id, cap, 0);
1185 if (byid) {
1186 if (byname) {
1187 /* id+type found, name+type found, but not all 3.
1188 * ID wins only if forced, otherwise name wins.
1189 */
1190 if (byid->options & PR_O_FORCED_ID) {
1191 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001192 *diff |= PR_FBM_MISMATCH_NAME;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001193 return byid;
1194 }
1195 else {
1196 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001197 *diff |= PR_FBM_MISMATCH_ID;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001198 return byname;
1199 }
1200 }
1201
Joseph Herlant59dd2952018-11-15 11:46:55 -08001202 /* remaining possibilities :
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001203 * - name not set
1204 * - name set but not found
1205 */
1206 if (name && diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001207 *diff |= PR_FBM_MISMATCH_NAME;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001208 return byid;
1209 }
1210
1211 /* ID not found */
1212 if (byname) {
1213 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001214 *diff |= PR_FBM_MISMATCH_ID;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001215 return byname;
1216 }
1217 }
1218
Joseph Herlant59dd2952018-11-15 11:46:55 -08001219 /* All remaining possibilities will lead to NULL. If we can report more
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001220 * detailed information to the caller about changed types and/or name,
1221 * we'll do it. For example, we could detect that "listen foo" was
1222 * split into "frontend foo_ft" and "backend foo_bk" if IDs are forced.
1223 * - name not set, ID not found
1224 * - name not found, ID not set
1225 * - name not found, ID not found
1226 */
1227 if (!diff)
1228 return NULL;
1229
1230 if (name) {
1231 byname = proxy_find_by_name(name, 0, 0);
1232 if (byname && (!id || byname->uuid == id))
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001233 *diff |= PR_FBM_MISMATCH_PROXYTYPE;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001234 }
1235
1236 if (id) {
1237 byid = proxy_find_by_id(id, 0, 0);
1238 if (byid) {
1239 if (!name)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001240 *diff |= PR_FBM_MISMATCH_PROXYTYPE; /* only type changed */
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001241 else if (byid->options & PR_O_FORCED_ID)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001242 *diff |= PR_FBM_MISMATCH_NAME | PR_FBM_MISMATCH_PROXYTYPE; /* name and type changed */
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001243 /* otherwise it's a different proxy that was returned */
1244 }
1245 }
1246 return NULL;
1247}
1248
Willy Tarreaubaaee002006-06-26 02:48:02 +02001249/*
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001250 * This function finds a server with matching name within selected proxy.
1251 * It also checks if there are more matching servers with
1252 * requested name as this often leads into unexpected situations.
1253 */
1254
1255struct server *findserver(const struct proxy *px, const char *name) {
1256
1257 struct server *cursrv, *target = NULL;
1258
1259 if (!px)
1260 return NULL;
1261
1262 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001263 if (strcmp(cursrv->id, name) != 0)
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001264 continue;
1265
1266 if (!target) {
1267 target = cursrv;
1268 continue;
1269 }
1270
Christopher Faulet767a84b2017-11-24 16:50:31 +01001271 ha_alert("Refusing to use duplicated server '%s' found in proxy: %s!\n",
1272 name, px->id);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001273
1274 return NULL;
1275 }
1276
1277 return target;
1278}
1279
Aurelien DARRAGON4e5e2662023-02-22 09:55:05 +01001280/*
1281 * This function finds a server with matching "<puid> x <rid>" within
1282 * selected proxy <px>.
1283 * Using the combination of proxy-uid + revision id ensures that the function
1284 * will either return the server we're expecting or NULL if it has been removed
1285 * from the proxy.
1286 */
1287struct server *findserver_unique_id(const struct proxy *px, int puid, uint32_t rid) {
1288
1289 struct server *cursrv;
1290
1291 if (!px)
1292 return NULL;
1293
1294 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
1295 if (cursrv->puid == puid && cursrv->rid == rid)
1296 return cursrv;
1297 }
1298
1299 return NULL;
1300}
1301
1302/*
1303 * This function finds a server with matching "<name> x <rid>" within
1304 * selected proxy <px>.
1305 * Using the combination of name + revision id ensures that the function will
1306 * either return the server we're expecting or NULL if it has been removed
1307 * from the proxy.
1308 */
1309struct server *findserver_unique_name(const struct proxy *px, const char *name, uint32_t rid) {
1310
1311 struct server *cursrv;
1312
1313 if (!px)
1314 return NULL;
1315
1316 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
1317 if (!strcmp(cursrv->id, name) && cursrv->rid == rid)
1318 return cursrv;
1319 }
1320
1321 return NULL;
1322}
1323
Willy Tarreauff01a212009-03-15 13:46:16 +01001324/* This function checks that the designated proxy has no http directives
1325 * enabled. It will output a warning if there are, and will fix some of them.
1326 * It returns the number of fatal errors encountered. This should be called
1327 * at the end of the configuration parsing if the proxy is not in http mode.
1328 * The <file> argument is used to construct the error message.
1329 */
Willy Tarreau915e1eb2009-06-22 15:48:36 +02001330int proxy_cfg_ensure_no_http(struct proxy *curproxy)
Willy Tarreauff01a212009-03-15 13:46:16 +01001331{
1332 if (curproxy->cookie_name != NULL) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001333 ha_warning("cookie will be ignored for %s '%s' (needs 'mode http').\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001334 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001335 }
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001336 if (isttest(curproxy->monitor_uri)) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001337 ha_warning("monitor-uri will be ignored for %s '%s' (needs 'mode http').\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001338 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001339 }
Willy Tarreauf3e49f92009-10-03 12:21:20 +02001340 if (curproxy->lbprm.algo & BE_LB_NEED_HTTP) {
Willy Tarreauff01a212009-03-15 13:46:16 +01001341 curproxy->lbprm.algo &= ~BE_LB_ALGO;
1342 curproxy->lbprm.algo |= BE_LB_ALGO_RR;
Amaury Denoyelle11124302021-06-04 18:22:08 +02001343 ha_warning("Layer 7 hash not possible for %s '%s' (needs 'mode http'). Falling back to round robin.\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001344 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001345 }
Willy Tarreau17804162009-11-09 21:27:51 +01001346 if (curproxy->to_log & (LW_REQ | LW_RESP)) {
1347 curproxy->to_log &= ~(LW_REQ | LW_RESP);
Christopher Faulet767a84b2017-11-24 16:50:31 +01001348 ha_warning("parsing [%s:%d] : HTTP log/header format not usable with %s '%s' (needs 'mode http').\n",
1349 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1350 proxy_type_str(curproxy), curproxy->id);
Willy Tarreau17804162009-11-09 21:27:51 +01001351 }
Willy Tarreau62a61232013-04-12 18:13:46 +02001352 if (curproxy->conf.logformat_string == default_http_log_format ||
1353 curproxy->conf.logformat_string == clf_http_log_format) {
1354 /* Note: we don't change the directive's file:line number */
1355 curproxy->conf.logformat_string = default_tcp_log_format;
Christopher Faulet767a84b2017-11-24 16:50:31 +01001356 ha_warning("parsing [%s:%d] : 'option httplog' not usable with %s '%s' (needs 'mode http'). Falling back to 'option tcplog'.\n",
1357 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1358 proxy_type_str(curproxy), curproxy->id);
Willy Tarreau196729e2012-05-31 19:30:26 +02001359 }
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001360 else if (curproxy->conf.logformat_string == default_https_log_format) {
1361 /* Note: we don't change the directive's file:line number */
1362 curproxy->conf.logformat_string = default_tcp_log_format;
1363 ha_warning("parsing [%s:%d] : 'option httpslog' not usable with %s '%s' (needs 'mode http'). Falling back to 'option tcplog'.\n",
1364 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1365 proxy_type_str(curproxy), curproxy->id);
1366 }
Willy Tarreau196729e2012-05-31 19:30:26 +02001367
Willy Tarreauff01a212009-03-15 13:46:16 +01001368 return 0;
1369}
1370
Willy Tarreau237250c2011-07-29 01:49:03 +02001371/* Perform the most basic initialization of a proxy :
1372 * memset(), list_init(*), reset_timeouts(*).
Willy Tarreaub249e842011-09-07 18:41:08 +02001373 * Any new proxy or peer should be initialized via this function.
Willy Tarreau237250c2011-07-29 01:49:03 +02001374 */
1375void init_new_proxy(struct proxy *p)
1376{
1377 memset(p, 0, sizeof(struct proxy));
Willy Tarreau3fdb3662012-11-12 00:42:33 +01001378 p->obj_type = OBJ_TYPE_PROXY;
Willy Tarreaucdc83e02021-06-23 16:11:02 +02001379 queue_init(&p->queue, p, NULL);
Willy Tarreau237250c2011-07-29 01:49:03 +02001380 LIST_INIT(&p->acl);
1381 LIST_INIT(&p->http_req_rules);
Willy Tarreaue365c0b2013-06-11 16:06:12 +02001382 LIST_INIT(&p->http_res_rules);
Christopher Faulet6d0c3df2020-01-22 09:26:35 +01001383 LIST_INIT(&p->http_after_res_rules);
Willy Tarreau237250c2011-07-29 01:49:03 +02001384 LIST_INIT(&p->redirect_rules);
1385 LIST_INIT(&p->mon_fail_cond);
1386 LIST_INIT(&p->switching_rules);
Willy Tarreau4a5cade2012-04-05 21:09:48 +02001387 LIST_INIT(&p->server_rules);
Willy Tarreau237250c2011-07-29 01:49:03 +02001388 LIST_INIT(&p->persist_rules);
1389 LIST_INIT(&p->sticking_rules);
1390 LIST_INIT(&p->storersp_rules);
1391 LIST_INIT(&p->tcp_req.inspect_rules);
1392 LIST_INIT(&p->tcp_rep.inspect_rules);
1393 LIST_INIT(&p->tcp_req.l4_rules);
Willy Tarreau620408f2016-10-21 16:37:51 +02001394 LIST_INIT(&p->tcp_req.l5_rules);
Olivier Houchard859dc802019-08-08 15:47:21 +02001395 MT_LIST_INIT(&p->listener_queue);
William Lallemand0f99e342011-10-12 17:50:54 +02001396 LIST_INIT(&p->logsrvs);
William Lallemand723b73a2012-02-08 16:37:49 +01001397 LIST_INIT(&p->logformat);
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001398 LIST_INIT(&p->logformat_sd);
William Lallemanda73203e2012-03-12 12:48:57 +01001399 LIST_INIT(&p->format_unique_id);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001400 LIST_INIT(&p->logformat_error);
Willy Tarreau2a65ff02012-09-13 17:54:29 +02001401 LIST_INIT(&p->conf.bind);
Willy Tarreau4348fad2012-09-20 16:48:07 +02001402 LIST_INIT(&p->conf.listeners);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001403 LIST_INIT(&p->conf.errors);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001404 LIST_INIT(&p->conf.args.list);
Christopher Faulet443ea1a2016-02-04 13:40:26 +01001405 LIST_INIT(&p->filter_configs);
Christopher Faulet7a1e2e12020-04-02 18:05:11 +02001406 LIST_INIT(&p->tcpcheck_rules.preset_vars);
Willy Tarreau237250c2011-07-29 01:49:03 +02001407
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001408 p->defsrv.id = "default-server";
1409 p->conf.used_listener_id = EB_ROOT;
1410 p->conf.used_server_id = EB_ROOT;
1411 p->used_server_addr = EB_ROOT_UNIQUE;
1412
Willy Tarreau237250c2011-07-29 01:49:03 +02001413 /* Timeouts are defined as -1 */
1414 proxy_reset_timeouts(p);
1415 p->tcp_rep.inspect_delay = TICK_ETERNITY;
Willy Tarreau050536d2012-10-04 08:47:34 +02001416
1417 /* initial uuid is unassigned (-1) */
1418 p->uuid = -1;
Christopher Fauletff8abcd2017-06-02 15:33:24 +02001419
Olivier Houcharda254a372019-04-05 15:30:12 +02001420 /* Default to only allow L4 retries */
1421 p->retry_type = PR_RE_CONN_FAILED;
1422
Amaury Denoyelle7f8f6cb2020-11-10 14:24:31 +01001423 p->extra_counters_fe = NULL;
1424 p->extra_counters_be = NULL;
1425
Willy Tarreauac66d6b2020-10-20 17:24:27 +02001426 HA_RWLOCK_INIT(&p->lock);
Willy Tarreau489f0742023-11-13 09:17:05 +01001427
1428 /* initialize the default settings */
1429 proxy_preset_defaults(p);
Willy Tarreau237250c2011-07-29 01:49:03 +02001430}
1431
Willy Tarreau144289b2021-02-12 08:19:01 +01001432/* Preset default settings onto proxy <defproxy>. */
1433void proxy_preset_defaults(struct proxy *defproxy)
1434{
1435 defproxy->mode = PR_MODE_TCP;
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001436 defproxy->flags = 0;
William Lallemand6bb77b92021-07-28 15:48:16 +02001437 if (!(defproxy->cap & PR_CAP_INT)) {
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001438 defproxy->maxconn = cfg_maxpconn;
1439 defproxy->conn_retries = CONN_RETRIES;
1440 }
Willy Tarreau144289b2021-02-12 08:19:01 +01001441 defproxy->redispatch_after = 0;
1442 defproxy->options = PR_O_REUSE_SAFE;
William Lallemand6bb77b92021-07-28 15:48:16 +02001443 if (defproxy->cap & PR_CAP_INT)
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001444 defproxy->options2 |= PR_O2_INDEPSTR;
Willy Tarreau144289b2021-02-12 08:19:01 +01001445 defproxy->max_out_conns = MAX_SRV_LIST;
1446
1447 defproxy->defsrv.check.inter = DEF_CHKINTR;
1448 defproxy->defsrv.check.fastinter = 0;
1449 defproxy->defsrv.check.downinter = 0;
1450 defproxy->defsrv.agent.inter = DEF_CHKINTR;
1451 defproxy->defsrv.agent.fastinter = 0;
1452 defproxy->defsrv.agent.downinter = 0;
1453 defproxy->defsrv.check.rise = DEF_RISETIME;
1454 defproxy->defsrv.check.fall = DEF_FALLTIME;
1455 defproxy->defsrv.agent.rise = DEF_AGENT_RISETIME;
1456 defproxy->defsrv.agent.fall = DEF_AGENT_FALLTIME;
1457 defproxy->defsrv.check.port = 0;
1458 defproxy->defsrv.agent.port = 0;
1459 defproxy->defsrv.maxqueue = 0;
1460 defproxy->defsrv.minconn = 0;
1461 defproxy->defsrv.maxconn = 0;
1462 defproxy->defsrv.max_reuse = -1;
1463 defproxy->defsrv.max_idle_conns = -1;
1464 defproxy->defsrv.pool_purge_delay = 5000;
1465 defproxy->defsrv.slowstart = 0;
1466 defproxy->defsrv.onerror = DEF_HANA_ONERR;
1467 defproxy->defsrv.consecutive_errors_limit = DEF_HANA_ERRLIMIT;
1468 defproxy->defsrv.uweight = defproxy->defsrv.iweight = 1;
1469
1470 defproxy->email_alert.level = LOG_ALERT;
1471 defproxy->load_server_state_from_file = PR_SRV_STATE_FILE_UNSPEC;
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001472
William Lallemand6bb77b92021-07-28 15:48:16 +02001473 if (defproxy->cap & PR_CAP_INT)
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001474 defproxy->timeout.connect = 5000;
Willy Tarreau144289b2021-02-12 08:19:01 +01001475}
1476
Willy Tarreaua3320a02021-02-12 10:38:49 +01001477/* Frees all dynamic settings allocated on a default proxy that's about to be
1478 * destroyed. This is a subset of the complete proxy deinit code, but these
1479 * should probably be merged ultimately. Note that most of the fields are not
1480 * even reset, so extreme care is required here, and calling
1481 * proxy_preset_defaults() afterwards would be safer.
1482 */
1483void proxy_free_defaults(struct proxy *defproxy)
1484{
Christopher Faulet6db9a972021-10-15 14:33:34 +02001485 struct acl *acl, *aclb;
Willy Tarreau211ea252022-03-17 19:47:33 +01001486 struct logsrv *log, *logb;
Christopher Faulet57962282022-04-25 14:30:58 +02001487 struct cap_hdr *h,*h_next;
Christopher Faulet6db9a972021-10-15 14:33:34 +02001488
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001489 ha_free(&defproxy->id);
1490 ha_free(&defproxy->conf.file);
Willy Tarreau8bb771a2023-11-23 14:28:14 +01001491 ha_free((char **)&defproxy->defsrv.conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001492 ha_free(&defproxy->check_command);
1493 ha_free(&defproxy->check_path);
1494 ha_free(&defproxy->cookie_name);
1495 ha_free(&defproxy->rdp_cookie_name);
1496 ha_free(&defproxy->dyncookie_key);
1497 ha_free(&defproxy->cookie_domain);
1498 ha_free(&defproxy->cookie_attrs);
1499 ha_free(&defproxy->lbprm.arg_str);
1500 ha_free(&defproxy->capture_name);
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001501 istfree(&defproxy->monitor_uri);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001502 ha_free(&defproxy->defbe.name);
1503 ha_free(&defproxy->conn_src.iface_name);
Tim Duesterhusb4b03772022-03-05 00:52:43 +01001504 istfree(&defproxy->server_id_hdr_name);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001505
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +01001506 http_ext_clean(defproxy);
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +01001507
Christopher Faulet6db9a972021-10-15 14:33:34 +02001508 list_for_each_entry_safe(acl, aclb, &defproxy->acl, list) {
1509 LIST_DELETE(&acl->list);
1510 prune_acl(acl);
1511 free(acl);
1512 }
1513
1514 free_act_rules(&defproxy->tcp_req.inspect_rules);
1515 free_act_rules(&defproxy->tcp_rep.inspect_rules);
1516 free_act_rules(&defproxy->tcp_req.l4_rules);
1517 free_act_rules(&defproxy->tcp_req.l5_rules);
1518 free_act_rules(&defproxy->http_req_rules);
1519 free_act_rules(&defproxy->http_res_rules);
1520 free_act_rules(&defproxy->http_after_res_rules);
1521
Christopher Faulet57962282022-04-25 14:30:58 +02001522 h = defproxy->req_cap;
1523 while (h) {
1524 h_next = h->next;
1525 free(h->name);
1526 pool_destroy(h->pool);
1527 free(h);
1528 h = h_next;
1529 }
1530
1531 h = defproxy->rsp_cap;
1532 while (h) {
1533 h_next = h->next;
1534 free(h->name);
1535 pool_destroy(h->pool);
1536 free(h);
1537 h = h_next;
1538 }
1539
Willy Tarreaua3320a02021-02-12 10:38:49 +01001540 if (defproxy->conf.logformat_string != default_http_log_format &&
1541 defproxy->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001542 defproxy->conf.logformat_string != clf_http_log_format &&
1543 defproxy->conf.logformat_string != default_https_log_format) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001544 ha_free(&defproxy->conf.logformat_string);
Willy Tarreau818ec782021-02-12 10:48:53 +01001545 }
Willy Tarreaua3320a02021-02-12 10:38:49 +01001546
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001547 if (defproxy->conf.logformat_sd_string != default_rfc5424_sd_log_format)
1548 ha_free(&defproxy->conf.logformat_sd_string);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001549
Willy Tarreau211ea252022-03-17 19:47:33 +01001550 list_for_each_entry_safe(log, logb, &defproxy->logsrvs, list) {
1551 LIST_DEL_INIT(&log->list);
1552 free_logsrv(log);
1553 }
1554
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001555 ha_free(&defproxy->conf.uniqueid_format_string);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001556 ha_free(&defproxy->conf.error_logformat_string);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001557 ha_free(&defproxy->conf.lfs_file);
1558 ha_free(&defproxy->conf.lfsd_file);
1559 ha_free(&defproxy->conf.uif_file);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001560 ha_free(&defproxy->conf.elfs_file);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001561 chunk_destroy(&defproxy->log_tag);
1562
1563 free_email_alert(defproxy);
1564 proxy_release_conf_errors(defproxy);
1565 deinit_proxy_tcpcheck(defproxy);
1566
1567 /* FIXME: we cannot free uri_auth because it might already be used by
1568 * another proxy (legacy code for stats URI ...). Refcount anyone ?
1569 */
1570}
1571
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001572/* delete a defproxy from the tree if still in it, frees its content and its
1573 * storage. Nothing is done if <px> is NULL or if it doesn't have PR_CAP_DEF
1574 * set, allowing to pass it the direct result of a lookup function.
1575 */
1576void proxy_destroy_defaults(struct proxy *px)
1577{
1578 if (!px)
1579 return;
1580 if (!(px->cap & PR_CAP_DEF))
1581 return;
Christopher Faulet27c8d202021-10-13 09:50:53 +02001582 BUG_ON(px->conf.refcount != 0);
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001583 ebpt_delete(&px->conf.by_name);
1584 proxy_free_defaults(px);
1585 free(px);
1586}
1587
Christopher Faulet27c8d202021-10-13 09:50:53 +02001588/* delete all unreferenced default proxies. A default proxy is unreferenced if
1589 * its refcount is equal to zero.
1590 */
1591void proxy_destroy_all_unref_defaults()
Willy Tarreaue90904d2021-02-12 14:08:31 +01001592{
1593 struct ebpt_node *n;
1594
Christopher Faulet27c8d202021-10-13 09:50:53 +02001595 n = ebpt_first(&defproxy_by_name);
1596 while (n) {
Willy Tarreaue90904d2021-02-12 14:08:31 +01001597 struct proxy *px = container_of(n, struct proxy, conf.by_name);
1598 BUG_ON(!(px->cap & PR_CAP_DEF));
Christopher Faulet27c8d202021-10-13 09:50:53 +02001599 n = ebpt_next(n);
1600 if (!px->conf.refcount)
1601 proxy_destroy_defaults(px);
Willy Tarreaue90904d2021-02-12 14:08:31 +01001602 }
1603}
1604
Christopher Faulet27c8d202021-10-13 09:50:53 +02001605/* Add a reference on the default proxy <defpx> for the proxy <px> Nothing is
1606 * done if <px> already references <defpx>. Otherwise, the default proxy
1607 * refcount is incremented by one. For now, this operation is not thread safe
1608 * and is perform during init stage only.
1609 */
1610void proxy_ref_defaults(struct proxy *px, struct proxy *defpx)
1611{
1612 if (px->defpx == defpx)
1613 return;
1614 BUG_ON(px->defpx != NULL);
1615 px->defpx = defpx;
1616 defpx->conf.refcount++;
1617}
1618
1619/* proxy <px> removes its reference on its default proxy. The default proxy
1620 * refcount is decremented by one. If it was the last reference, the
1621 * corresponding default proxy is destroyed. For now this operation is not
1622 * thread safe and is performed during deinit staged only.
1623*/
1624void proxy_unref_defaults(struct proxy *px)
1625{
1626 if (px->defpx == NULL)
1627 return;
1628 if (!--px->defpx->conf.refcount)
1629 proxy_destroy_defaults(px->defpx);
1630 px->defpx = NULL;
1631}
1632
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001633/* Allocates a new proxy <name> of type <cap>.
1634 * Returns the proxy instance on success. On error, NULL is returned.
Willy Tarreau76838932021-02-12 08:49:47 +01001635 */
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001636struct proxy *alloc_new_proxy(const char *name, unsigned int cap, char **errmsg)
Willy Tarreau76838932021-02-12 08:49:47 +01001637{
Willy Tarreau76838932021-02-12 08:49:47 +01001638 struct proxy *curproxy;
Willy Tarreau76838932021-02-12 08:49:47 +01001639
1640 if ((curproxy = calloc(1, sizeof(*curproxy))) == NULL) {
1641 memprintf(errmsg, "proxy '%s': out of memory", name);
1642 goto fail;
1643 }
1644
1645 init_new_proxy(curproxy);
Willy Tarreau69530f52023-04-28 09:16:15 +02001646 curproxy->last_change = ns_to_sec(now_ns);
Willy Tarreau76838932021-02-12 08:49:47 +01001647 curproxy->id = strdup(name);
1648 curproxy->cap = cap;
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001649
William Lallemand6bb77b92021-07-28 15:48:16 +02001650 if (!(cap & PR_CAP_INT))
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001651 proxy_store_name(curproxy);
Willy Tarreau76838932021-02-12 08:49:47 +01001652
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001653 done:
1654 return curproxy;
1655
1656 fail:
1657 /* Note: in case of fatal error here, we WILL make valgrind unhappy,
1658 * but its not worth trying to unroll everything here just before
1659 * quitting.
1660 */
1661 free(curproxy);
1662 return NULL;
1663}
1664
1665/* Copy the proxy settings from <defproxy> to <curproxy>.
1666 * Returns 0 on success.
1667 * Returns 1 on error. <errmsg> will be allocated with an error description.
1668 */
1669static int proxy_defproxy_cpy(struct proxy *curproxy, const struct proxy *defproxy,
1670 char **errmsg)
1671{
1672 struct logsrv *tmplogsrv;
1673 char *tmpmsg = NULL;
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001674
1675 /* set default values from the specified default proxy */
Christopher Faulet6bb86532022-08-03 11:31:55 +02001676 srv_settings_cpy(&curproxy->defsrv, &defproxy->defsrv, 0);
Willy Tarreau76838932021-02-12 08:49:47 +01001677
Christopher Faulet56717802021-10-13 10:10:09 +02001678 curproxy->flags = (defproxy->flags & PR_FL_DISABLED); /* Only inherit from disabled flag */
Willy Tarreau76838932021-02-12 08:49:47 +01001679 curproxy->options = defproxy->options;
1680 curproxy->options2 = defproxy->options2;
1681 curproxy->no_options = defproxy->no_options;
1682 curproxy->no_options2 = defproxy->no_options2;
Willy Tarreau76838932021-02-12 08:49:47 +01001683 curproxy->retry_type = defproxy->retry_type;
Christopher Fauletee08d6c2021-10-13 15:40:15 +02001684 curproxy->tcp_req.inspect_delay = defproxy->tcp_req.inspect_delay;
1685 curproxy->tcp_rep.inspect_delay = defproxy->tcp_rep.inspect_delay;
Willy Tarreau76838932021-02-12 08:49:47 +01001686
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +01001687 http_ext_clean(curproxy);
1688 http_ext_dup(defproxy, curproxy);
Willy Tarreau76838932021-02-12 08:49:47 +01001689
Tim Duesterhusb4b03772022-03-05 00:52:43 +01001690 if (isttest(defproxy->server_id_hdr_name))
1691 curproxy->server_id_hdr_name = istdup(defproxy->server_id_hdr_name);
Willy Tarreau76838932021-02-12 08:49:47 +01001692
1693 /* initialize error relocations */
1694 if (!proxy_dup_default_conf_errors(curproxy, defproxy, &tmpmsg)) {
1695 memprintf(errmsg, "proxy '%s' : %s", curproxy->id, tmpmsg);
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001696 free(tmpmsg);
1697 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001698 }
1699
1700 if (curproxy->cap & PR_CAP_FE) {
1701 curproxy->maxconn = defproxy->maxconn;
1702 curproxy->backlog = defproxy->backlog;
1703 curproxy->fe_sps_lim = defproxy->fe_sps_lim;
1704
1705 curproxy->to_log = defproxy->to_log & ~LW_COOKIE & ~LW_REQHDR & ~ LW_RSPHDR;
1706 curproxy->max_out_conns = defproxy->max_out_conns;
1707
1708 curproxy->clitcpka_cnt = defproxy->clitcpka_cnt;
1709 curproxy->clitcpka_idle = defproxy->clitcpka_idle;
1710 curproxy->clitcpka_intvl = defproxy->clitcpka_intvl;
1711 }
1712
1713 if (curproxy->cap & PR_CAP_BE) {
1714 curproxy->lbprm.algo = defproxy->lbprm.algo;
1715 curproxy->lbprm.hash_balance_factor = defproxy->lbprm.hash_balance_factor;
1716 curproxy->fullconn = defproxy->fullconn;
1717 curproxy->conn_retries = defproxy->conn_retries;
1718 curproxy->redispatch_after = defproxy->redispatch_after;
1719 curproxy->max_ka_queue = defproxy->max_ka_queue;
1720
1721 curproxy->tcpcheck_rules.flags = (defproxy->tcpcheck_rules.flags & ~TCPCHK_RULES_UNUSED_RS);
1722 curproxy->tcpcheck_rules.list = defproxy->tcpcheck_rules.list;
1723 if (!LIST_ISEMPTY(&defproxy->tcpcheck_rules.preset_vars)) {
1724 if (!dup_tcpcheck_vars(&curproxy->tcpcheck_rules.preset_vars,
1725 &defproxy->tcpcheck_rules.preset_vars)) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001726 memprintf(errmsg, "proxy '%s': failed to duplicate tcpcheck preset-vars", curproxy->id);
1727 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001728 }
1729 }
1730
1731 curproxy->ck_opts = defproxy->ck_opts;
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +01001732
Willy Tarreau76838932021-02-12 08:49:47 +01001733 if (defproxy->cookie_name)
1734 curproxy->cookie_name = strdup(defproxy->cookie_name);
1735 curproxy->cookie_len = defproxy->cookie_len;
1736
1737 if (defproxy->dyncookie_key)
1738 curproxy->dyncookie_key = strdup(defproxy->dyncookie_key);
1739 if (defproxy->cookie_domain)
1740 curproxy->cookie_domain = strdup(defproxy->cookie_domain);
1741
1742 if (defproxy->cookie_maxidle)
1743 curproxy->cookie_maxidle = defproxy->cookie_maxidle;
1744
1745 if (defproxy->cookie_maxlife)
1746 curproxy->cookie_maxlife = defproxy->cookie_maxlife;
1747
1748 if (defproxy->rdp_cookie_name)
1749 curproxy->rdp_cookie_name = strdup(defproxy->rdp_cookie_name);
1750 curproxy->rdp_cookie_len = defproxy->rdp_cookie_len;
1751
1752 if (defproxy->cookie_attrs)
1753 curproxy->cookie_attrs = strdup(defproxy->cookie_attrs);
1754
1755 if (defproxy->lbprm.arg_str)
1756 curproxy->lbprm.arg_str = strdup(defproxy->lbprm.arg_str);
1757 curproxy->lbprm.arg_len = defproxy->lbprm.arg_len;
1758 curproxy->lbprm.arg_opt1 = defproxy->lbprm.arg_opt1;
1759 curproxy->lbprm.arg_opt2 = defproxy->lbprm.arg_opt2;
1760 curproxy->lbprm.arg_opt3 = defproxy->lbprm.arg_opt3;
1761
1762 if (defproxy->conn_src.iface_name)
1763 curproxy->conn_src.iface_name = strdup(defproxy->conn_src.iface_name);
1764 curproxy->conn_src.iface_len = defproxy->conn_src.iface_len;
1765 curproxy->conn_src.opts = defproxy->conn_src.opts;
1766#if defined(CONFIG_HAP_TRANSPARENT)
1767 curproxy->conn_src.tproxy_addr = defproxy->conn_src.tproxy_addr;
1768#endif
1769 curproxy->load_server_state_from_file = defproxy->load_server_state_from_file;
1770
1771 curproxy->srvtcpka_cnt = defproxy->srvtcpka_cnt;
1772 curproxy->srvtcpka_idle = defproxy->srvtcpka_idle;
1773 curproxy->srvtcpka_intvl = defproxy->srvtcpka_intvl;
1774 }
1775
1776 if (curproxy->cap & PR_CAP_FE) {
1777 if (defproxy->capture_name)
1778 curproxy->capture_name = strdup(defproxy->capture_name);
1779 curproxy->capture_namelen = defproxy->capture_namelen;
1780 curproxy->capture_len = defproxy->capture_len;
Christopher Faulet57962282022-04-25 14:30:58 +02001781
1782 curproxy->nb_req_cap = defproxy->nb_req_cap;
1783 curproxy->req_cap = defproxy->req_cap;
1784
1785 curproxy->nb_rsp_cap = defproxy->nb_rsp_cap;
1786 curproxy->rsp_cap = defproxy->rsp_cap;
Willy Tarreau76838932021-02-12 08:49:47 +01001787 }
1788
1789 if (curproxy->cap & PR_CAP_FE) {
1790 curproxy->timeout.client = defproxy->timeout.client;
1791 curproxy->timeout.clientfin = defproxy->timeout.clientfin;
1792 curproxy->timeout.tarpit = defproxy->timeout.tarpit;
1793 curproxy->timeout.httpreq = defproxy->timeout.httpreq;
1794 curproxy->timeout.httpka = defproxy->timeout.httpka;
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001795 if (isttest(defproxy->monitor_uri))
1796 curproxy->monitor_uri = istdup(defproxy->monitor_uri);
Willy Tarreau76838932021-02-12 08:49:47 +01001797 if (defproxy->defbe.name)
1798 curproxy->defbe.name = strdup(defproxy->defbe.name);
1799
1800 /* get either a pointer to the logformat string or a copy of it */
1801 curproxy->conf.logformat_string = defproxy->conf.logformat_string;
1802 if (curproxy->conf.logformat_string &&
1803 curproxy->conf.logformat_string != default_http_log_format &&
1804 curproxy->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001805 curproxy->conf.logformat_string != clf_http_log_format &&
1806 curproxy->conf.logformat_string != default_https_log_format)
Willy Tarreau76838932021-02-12 08:49:47 +01001807 curproxy->conf.logformat_string = strdup(curproxy->conf.logformat_string);
1808
1809 if (defproxy->conf.lfs_file) {
1810 curproxy->conf.lfs_file = strdup(defproxy->conf.lfs_file);
1811 curproxy->conf.lfs_line = defproxy->conf.lfs_line;
1812 }
1813
1814 /* get either a pointer to the logformat string for RFC5424 structured-data or a copy of it */
1815 curproxy->conf.logformat_sd_string = defproxy->conf.logformat_sd_string;
1816 if (curproxy->conf.logformat_sd_string &&
1817 curproxy->conf.logformat_sd_string != default_rfc5424_sd_log_format)
1818 curproxy->conf.logformat_sd_string = strdup(curproxy->conf.logformat_sd_string);
1819
1820 if (defproxy->conf.lfsd_file) {
1821 curproxy->conf.lfsd_file = strdup(defproxy->conf.lfsd_file);
1822 curproxy->conf.lfsd_line = defproxy->conf.lfsd_line;
1823 }
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001824
1825 curproxy->conf.error_logformat_string = defproxy->conf.error_logformat_string;
1826 if (curproxy->conf.error_logformat_string)
1827 curproxy->conf.error_logformat_string = strdup(curproxy->conf.error_logformat_string);
1828
1829 if (defproxy->conf.elfs_file) {
1830 curproxy->conf.elfs_file = strdup(defproxy->conf.elfs_file);
1831 curproxy->conf.elfs_line = defproxy->conf.elfs_line;
1832 }
Willy Tarreau76838932021-02-12 08:49:47 +01001833 }
1834
1835 if (curproxy->cap & PR_CAP_BE) {
1836 curproxy->timeout.connect = defproxy->timeout.connect;
1837 curproxy->timeout.server = defproxy->timeout.server;
1838 curproxy->timeout.serverfin = defproxy->timeout.serverfin;
1839 curproxy->timeout.check = defproxy->timeout.check;
1840 curproxy->timeout.queue = defproxy->timeout.queue;
1841 curproxy->timeout.tarpit = defproxy->timeout.tarpit;
1842 curproxy->timeout.httpreq = defproxy->timeout.httpreq;
1843 curproxy->timeout.httpka = defproxy->timeout.httpka;
1844 curproxy->timeout.tunnel = defproxy->timeout.tunnel;
1845 curproxy->conn_src.source_addr = defproxy->conn_src.source_addr;
1846 }
1847
1848 curproxy->mode = defproxy->mode;
1849 curproxy->uri_auth = defproxy->uri_auth; /* for stats */
1850
1851 /* copy default logsrvs to curproxy */
1852 list_for_each_entry(tmplogsrv, &defproxy->logsrvs, list) {
1853 struct logsrv *node = malloc(sizeof(*node));
1854
1855 if (!node) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001856 memprintf(errmsg, "proxy '%s': out of memory", curproxy->id);
1857 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001858 }
1859 memcpy(node, tmplogsrv, sizeof(struct logsrv));
1860 node->ref = tmplogsrv->ref;
1861 LIST_INIT(&node->list);
Willy Tarreau2b718102021-04-21 07:32:39 +02001862 LIST_APPEND(&curproxy->logsrvs, &node->list);
Willy Tarreau211ea252022-03-17 19:47:33 +01001863 node->ring_name = tmplogsrv->ring_name ? strdup(tmplogsrv->ring_name) : NULL;
1864 node->conf.file = strdup(tmplogsrv->conf.file);
1865 node->conf.line = tmplogsrv->conf.line;
Willy Tarreau76838932021-02-12 08:49:47 +01001866 }
1867
1868 curproxy->conf.uniqueid_format_string = defproxy->conf.uniqueid_format_string;
1869 if (curproxy->conf.uniqueid_format_string)
1870 curproxy->conf.uniqueid_format_string = strdup(curproxy->conf.uniqueid_format_string);
1871
1872 chunk_dup(&curproxy->log_tag, &defproxy->log_tag);
1873
1874 if (defproxy->conf.uif_file) {
1875 curproxy->conf.uif_file = strdup(defproxy->conf.uif_file);
1876 curproxy->conf.uif_line = defproxy->conf.uif_line;
1877 }
1878
1879 /* copy default header unique id */
1880 if (isttest(defproxy->header_unique_id)) {
1881 const struct ist copy = istdup(defproxy->header_unique_id);
1882
1883 if (!isttest(copy)) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001884 memprintf(errmsg, "proxy '%s': out of memory for unique-id-header", curproxy->id);
1885 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001886 }
1887 curproxy->header_unique_id = copy;
1888 }
1889
1890 /* default compression options */
1891 if (defproxy->comp != NULL) {
1892 curproxy->comp = calloc(1, sizeof(*curproxy->comp));
Remi Tricot-Le Breton18a82ba2021-05-12 18:07:27 +02001893 if (!curproxy->comp) {
1894 memprintf(errmsg, "proxy '%s': out of memory for default compression options", curproxy->id);
1895 return 1;
1896 }
Olivier Houcharddb573e92023-04-05 17:32:36 +02001897 curproxy->comp->algos_res = defproxy->comp->algos_res;
1898 curproxy->comp->algo_req = defproxy->comp->algo_req;
1899 curproxy->comp->types_res = defproxy->comp->types_res;
1900 curproxy->comp->types_req = defproxy->comp->types_req;
Willy Tarreau862588a2023-05-10 16:39:00 +02001901 curproxy->comp->flags = defproxy->comp->flags;
Willy Tarreau76838932021-02-12 08:49:47 +01001902 }
1903
Willy Tarreau76838932021-02-12 08:49:47 +01001904 if (defproxy->check_path)
1905 curproxy->check_path = strdup(defproxy->check_path);
1906 if (defproxy->check_command)
1907 curproxy->check_command = strdup(defproxy->check_command);
1908
1909 if (defproxy->email_alert.mailers.name)
1910 curproxy->email_alert.mailers.name = strdup(defproxy->email_alert.mailers.name);
1911 if (defproxy->email_alert.from)
1912 curproxy->email_alert.from = strdup(defproxy->email_alert.from);
1913 if (defproxy->email_alert.to)
1914 curproxy->email_alert.to = strdup(defproxy->email_alert.to);
1915 if (defproxy->email_alert.myhostname)
1916 curproxy->email_alert.myhostname = strdup(defproxy->email_alert.myhostname);
1917 curproxy->email_alert.level = defproxy->email_alert.level;
1918 curproxy->email_alert.set = defproxy->email_alert.set;
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001919
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001920 return 0;
1921}
1922
1923/* Allocates a new proxy <name> of type <cap> found at position <file:linenum>,
1924 * preset it from the defaults of <defproxy> and returns it. In case of error,
1925 * an alert is printed and NULL is returned.
1926 */
1927struct proxy *parse_new_proxy(const char *name, unsigned int cap,
1928 const char *file, int linenum,
1929 const struct proxy *defproxy)
1930{
1931 struct proxy *curproxy = NULL;
Willy Tarreau282b6a72022-02-24 16:37:19 +01001932 char *errmsg = NULL;
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001933
1934 if (!(curproxy = alloc_new_proxy(name, cap, &errmsg))) {
1935 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
1936 free(errmsg);
1937 return NULL;
1938 }
1939
1940 if (defproxy) {
1941 if (proxy_defproxy_cpy(curproxy, defproxy, &errmsg)) {
1942 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
1943 free(errmsg);
1944
1945 ha_free(&curproxy);
1946 return NULL;
1947 }
1948 }
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001949
1950 curproxy->conf.args.file = curproxy->conf.file = strdup(file);
1951 curproxy->conf.args.line = curproxy->conf.line = linenum;
1952
Willy Tarreau76838932021-02-12 08:49:47 +01001953 return curproxy;
Willy Tarreau76838932021-02-12 08:49:47 +01001954}
1955
Aurelien DARRAGONd46f4372022-09-09 15:51:37 +02001956/* to be called under the proxy lock after pausing some listeners. This will
1957 * automatically update the p->flags flag
1958 */
1959void proxy_cond_pause(struct proxy *p)
1960{
1961 if (p->li_ready)
1962 return;
1963 p->flags |= PR_FL_PAUSED;
1964}
1965
1966/* to be called under the proxy lock after resuming some listeners. This will
1967 * automatically update the p->flags flag
1968 */
1969void proxy_cond_resume(struct proxy *p)
1970{
1971 if (!p->li_ready)
1972 return;
1973 p->flags &= ~PR_FL_PAUSED;
1974}
1975
Willy Tarreauacde1522020-10-07 16:31:39 +02001976/* to be called under the proxy lock after stopping some listeners. This will
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001977 * automatically update the p->flags flag after stopping the last one, and
Willy Tarreauacde1522020-10-07 16:31:39 +02001978 * will emit a log indicating the proxy's condition. The function is idempotent
1979 * so that it will not emit multiple logs; a proxy will be disabled only once.
1980 */
1981void proxy_cond_disable(struct proxy *p)
1982{
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001983 if (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauacde1522020-10-07 16:31:39 +02001984 return;
1985
1986 if (p->li_ready + p->li_paused > 0)
1987 return;
1988
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001989 p->flags |= PR_FL_STOPPED;
Willy Tarreauacde1522020-10-07 16:31:39 +02001990
Willy Tarreauacde1522020-10-07 16:31:39 +02001991 /* Note: syslog proxies use their own loggers so while it's somewhat OK
1992 * to report them being stopped as a warning, we must not spam their log
1993 * servers which are in fact production servers. For other types (CLI,
1994 * peers, etc) we must not report them at all as they're not really on
1995 * the data plane but on the control plane.
1996 */
William Lallemand7f954692023-05-14 23:23:36 +02001997 if ((p->mode == PR_MODE_TCP || p->mode == PR_MODE_HTTP || p->mode == PR_MODE_SYSLOG) && !(p->cap & PR_CAP_INT))
Willy Tarreauacde1522020-10-07 16:31:39 +02001998 ha_warning("Proxy %s stopped (cumulated conns: FE: %lld, BE: %lld).\n",
1999 p->id, p->fe_counters.cum_conn, p->be_counters.cum_conn);
2000
William Lallemand7f954692023-05-14 23:23:36 +02002001 if ((p->mode == PR_MODE_TCP || p->mode == PR_MODE_HTTP) && !(p->cap & PR_CAP_INT))
Willy Tarreauacde1522020-10-07 16:31:39 +02002002 send_log(p, LOG_WARNING, "Proxy %s stopped (cumulated conns: FE: %lld, BE: %lld).\n",
2003 p->id, p->fe_counters.cum_conn, p->be_counters.cum_conn);
2004
Willy Tarreauacde1522020-10-07 16:31:39 +02002005 if (p->table && p->table->size && p->table->sync_task)
2006 task_wakeup(p->table->sync_task, TASK_WOKEN_MSG);
2007
2008 if (p->task)
2009 task_wakeup(p->task, TASK_WOKEN_MSG);
2010}
2011
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01002012/*
Willy Tarreau918ff602011-07-25 16:33:49 +02002013 * This is the proxy management task. It enables proxies when there are enough
Willy Tarreau87b09662015-04-03 00:22:06 +02002014 * free streams, or stops them when the table is full. It is designed to be
Willy Tarreau918ff602011-07-25 16:33:49 +02002015 * called as a task which is woken up upon stopping or when rate limiting must
2016 * be enforced.
Willy Tarreaubaaee002006-06-26 02:48:02 +02002017 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01002018struct task *manage_proxy(struct task *t, void *context, unsigned int state)
Willy Tarreaubaaee002006-06-26 02:48:02 +02002019{
Olivier Houchard9f6af332018-05-25 14:04:04 +02002020 struct proxy *p = context;
Willy Tarreau918ff602011-07-25 16:33:49 +02002021 int next = TICK_ETERNITY;
Willy Tarreau79584222009-03-06 09:18:27 +01002022 unsigned int wait;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002023
Willy Tarreau918ff602011-07-25 16:33:49 +02002024 /* We should periodically try to enable listeners waiting for a
2025 * global resource here.
2026 */
Willy Tarreaubaaee002006-06-26 02:48:02 +02002027
Willy Tarreau3a925c12013-09-04 17:54:01 +02002028 /* If the proxy holds a stick table, we need to purge all unused
2029 * entries. These are all the ones in the table with ref_cnt == 0
2030 * and all the ones in the pool used to allocate new entries. Any
Willy Tarreau87b09662015-04-03 00:22:06 +02002031 * entry attached to an existing stream waiting for a store will
Willy Tarreau3a925c12013-09-04 17:54:01 +02002032 * be in neither list. Any entry being dumped will have ref_cnt > 0.
2033 * However we protect tables that are being synced to peers.
2034 */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002035 if (unlikely(stopping && (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) && p->table && p->table->current)) {
Emeric Brun2cc201f2021-04-23 12:21:26 +02002036
2037 if (!p->table->refcnt) {
2038 /* !table->refcnt means there
2039 * is no more pending full resync
2040 * to push to a new process and
2041 * we are free to flush the table.
2042 */
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002043 int budget;
2044 int cleaned_up;
2045
2046 /* We purposely enforce a budget limitation since we don't want
2047 * to spend too much time purging old entries
2048 *
2049 * This is known to cause the watchdog to occasionnaly trigger if
2050 * the table is huge and all entries become available for purge
2051 * at the same time
2052 *
2053 * Moreover, we must also anticipate the pool_gc() call which
2054 * will also be much slower if there is too much work at once
2055 */
2056 budget = MIN(p->table->current, (1 << 15)); /* max: 32K */
2057 cleaned_up = stktable_trash_oldest(p->table, budget);
2058 if (cleaned_up) {
2059 /* immediately release freed memory since we are stopping */
Aurelien DARRAGON6e1fe252023-03-28 15:14:48 +02002060 pool_gc(NULL);
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002061 if (cleaned_up > (budget / 2)) {
2062 /* most of the budget was used to purge entries,
2063 * it is very likely that there are still trashable
2064 * entries in the table, reschedule a new cleanup
2065 * attempt ASAP
2066 */
2067 t->expire = TICK_ETERNITY;
2068 task_wakeup(t, TASK_WOKEN_RES);
2069 return t;
2070 }
2071 }
Willy Tarreau3a925c12013-09-04 17:54:01 +02002072 }
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01002073 if (p->table->current) {
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002074 /* some entries still remain but are not yet available
2075 * for cleanup, let's recheck in one second
2076 */
Willy Tarreau3a925c12013-09-04 17:54:01 +02002077 next = tick_first(next, tick_add(now_ms, 1000));
2078 }
2079 }
2080
Willy Tarreau918ff602011-07-25 16:33:49 +02002081 /* the rest below is just for frontends */
2082 if (!(p->cap & PR_CAP_FE))
2083 goto out;
Willy Tarreauf3f8c702011-07-25 07:37:28 +02002084
Willy Tarreau918ff602011-07-25 16:33:49 +02002085 /* check the various reasons we may find to block the frontend */
Willy Tarreau6b3bf732020-09-24 07:35:46 +02002086 if (unlikely(p->feconn >= p->maxconn))
Willy Tarreau918ff602011-07-25 16:33:49 +02002087 goto out;
Willy Tarreau3a7d2072009-03-05 23:48:25 +01002088
Willy Tarreau918ff602011-07-25 16:33:49 +02002089 if (p->fe_sps_lim &&
2090 (wait = next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0))) {
2091 /* we're blocking because a limit was reached on the number of
2092 * requests/s on the frontend. We want to re-check ASAP, which
2093 * means in 1 ms before estimated expiration date, because the
2094 * timer will have settled down.
2095 */
2096 next = tick_first(next, tick_add(now_ms, wait));
2097 goto out;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002098 }
Willy Tarreau918ff602011-07-25 16:33:49 +02002099
2100 /* The proxy is not limited so we can re-enable any waiting listener */
Willy Tarreau241797a2019-12-10 14:10:52 +01002101 dequeue_proxy_listeners(p);
Willy Tarreau918ff602011-07-25 16:33:49 +02002102 out:
2103 t->expire = next;
2104 task_queue(t);
2105 return t;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002106}
2107
2108
Willy Tarreau10080712021-09-07 10:49:45 +02002109static int proxy_parse_grace(char **args, int section_type, struct proxy *curpx,
2110 const struct proxy *defpx, const char *file, int line,
2111 char **err)
2112{
2113 const char *res;
2114
2115 if (!*args[1]) {
2116 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2117 return -1;
2118 }
2119 res = parse_time_err(args[1], &global.grace_delay, TIME_UNIT_MS);
2120 if (res == PARSE_TIME_OVER) {
2121 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2122 args[1], args[0]);
2123 return -1;
2124 }
2125 else if (res == PARSE_TIME_UNDER) {
2126 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2127 args[1], args[0]);
2128 return -1;
2129 }
2130 else if (res) {
2131 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2132 return -1;
2133 }
2134 return 0;
2135}
2136
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002137static int proxy_parse_hard_stop_after(char **args, int section_type, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01002138 const struct proxy *defpx, const char *file, int line,
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002139 char **err)
2140{
2141 const char *res;
2142
2143 if (!*args[1]) {
2144 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2145 return -1;
2146 }
2147 res = parse_time_err(args[1], &global.hard_stop_after, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +02002148 if (res == PARSE_TIME_OVER) {
2149 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2150 args[1], args[0]);
2151 return -1;
2152 }
2153 else if (res == PARSE_TIME_UNDER) {
2154 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2155 args[1], args[0]);
2156 return -1;
2157 }
2158 else if (res) {
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002159 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2160 return -1;
2161 }
2162 return 0;
2163}
2164
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002165static int proxy_parse_close_spread_time(char **args, int section_type, struct proxy *curpx,
2166 const struct proxy *defpx, const char *file, int line,
2167 char **err)
2168{
2169 const char *res;
2170
2171 if (!*args[1]) {
2172 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2173 return -1;
2174 }
Remi Tricot-Le Breton4d7fdc62022-04-26 15:17:18 +02002175
2176 /* If close-spread-time is set to "infinite", disable the active connection
2177 * closing during soft-stop.
2178 */
2179 if (strcmp(args[1], "infinite") == 0) {
2180 global.tune.options |= GTUNE_DISABLE_ACTIVE_CLOSE;
2181 global.close_spread_time = TICK_ETERNITY;
2182 return 0;
2183 }
2184
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002185 res = parse_time_err(args[1], &global.close_spread_time, TIME_UNIT_MS);
2186 if (res == PARSE_TIME_OVER) {
2187 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2188 args[1], args[0]);
2189 return -1;
2190 }
2191 else if (res == PARSE_TIME_UNDER) {
2192 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2193 args[1], args[0]);
2194 return -1;
2195 }
2196 else if (res) {
2197 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2198 return -1;
2199 }
Remi Tricot-Le Breton4d7fdc62022-04-26 15:17:18 +02002200 global.tune.options &= ~GTUNE_DISABLE_ACTIVE_CLOSE;
2201
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002202 return 0;
2203}
2204
Willy Tarreau144f84a2021-03-02 16:09:26 +01002205struct task *hard_stop(struct task *t, void *context, unsigned int state)
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002206{
2207 struct proxy *p;
2208 struct stream *s;
Willy Tarreau0d038252021-02-24 11:13:59 +01002209 int thr;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002210
2211 if (killed) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002212 ha_warning("Some tasks resisted to hard-stop, exiting now.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002213 send_log(NULL, LOG_WARNING, "Some tasks resisted to hard-stop, exiting now.\n");
Willy Tarreau7067b3a2019-06-02 11:11:29 +02002214 killed = 2;
Willy Tarreau0d038252021-02-24 11:13:59 +01002215 for (thr = 0; thr < global.nbthread; thr++)
Willy Tarreaub2f38c12023-01-19 19:14:18 +01002216 if (_HA_ATOMIC_LOAD(&ha_thread_info[thr].tg->threads_enabled) & ha_thread_info[thr].ltid_bit)
Willy Tarreau0d038252021-02-24 11:13:59 +01002217 wake_thread(thr);
Willy Tarreau7067b3a2019-06-02 11:11:29 +02002218 t->expire = TICK_ETERNITY;
2219 return t;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002220 }
2221
Christopher Faulet767a84b2017-11-24 16:50:31 +01002222 ha_warning("soft-stop running for too long, performing a hard-stop.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002223 send_log(NULL, LOG_WARNING, "soft-stop running for too long, performing a hard-stop.\n");
Olivier Houchardfbc74e82017-11-24 16:54:05 +01002224 p = proxies_list;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002225 while (p) {
2226 if ((p->cap & PR_CAP_FE) && (p->feconn > 0)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002227 ha_warning("Proxy %s hard-stopped (%d remaining conns will be closed).\n",
2228 p->id, p->feconn);
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002229 send_log(p, LOG_WARNING, "Proxy %s hard-stopped (%d remaining conns will be closed).\n",
2230 p->id, p->feconn);
2231 }
2232 p = p->next;
2233 }
Willy Tarreau92b887e2021-02-24 11:08:56 +01002234
2235 thread_isolate();
Willy Tarreaua698eb62021-02-24 10:37:01 +01002236
2237 for (thr = 0; thr < global.nbthread; thr++) {
Willy Tarreaub4e34762021-09-30 19:02:18 +02002238 list_for_each_entry(s, &ha_thread_ctx[thr].streams, list) {
Willy Tarreaua698eb62021-02-24 10:37:01 +01002239 stream_shutdown(s, SF_ERR_KILLED);
2240 }
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002241 }
Willy Tarreaua698eb62021-02-24 10:37:01 +01002242
Willy Tarreau92b887e2021-02-24 11:08:56 +01002243 thread_release();
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002244
2245 killed = 1;
2246 t->expire = tick_add(now_ms, MS_TO_TICKS(1000));
2247 return t;
2248}
2249
Willy Tarreau10080712021-09-07 10:49:45 +02002250/* perform the soft-stop right now (i.e. unbind listeners) */
2251static void do_soft_stop_now()
Willy Tarreaubaaee002006-06-26 02:48:02 +02002252{
Christopher Faulet48678e42023-03-14 14:33:11 +01002253 struct proxy *p;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002254 struct task *task;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002255
William Dauchy3894d972019-12-28 15:36:02 +01002256 /* disable busy polling to avoid cpu eating for the new process */
2257 global.tune.options &= ~GTUNE_BUSY_POLLING;
Willy Tarreau10080712021-09-07 10:49:45 +02002258
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002259 if (tick_isset(global.close_spread_time)) {
2260 global.close_spread_end = tick_add(now_ms, global.close_spread_time);
2261 }
2262
Willy Tarreau10080712021-09-07 10:49:45 +02002263 /* schedule a hard-stop after a delay if needed */
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002264 if (tick_isset(global.hard_stop_after)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +02002265 task = task_new_anywhere();
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002266 if (task) {
2267 task->process = hard_stop;
2268 task_schedule(task, tick_add(now_ms, global.hard_stop_after));
2269 }
2270 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002271 ha_alert("out of memory trying to allocate the hard-stop task.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002272 }
2273 }
Willy Tarreau626f3a72020-10-07 16:52:43 +02002274
Willy Tarreau1b927eb2022-07-15 19:15:02 +02002275 /* we isolate so that we have a chance of stopping listeners in other groups */
2276 thread_isolate();
2277
Willy Tarreaueb778242021-06-11 16:27:10 +02002278 /* stop all stoppable listeners */
Willy Tarreau626f3a72020-10-07 16:52:43 +02002279 protocol_stop_now();
2280
Willy Tarreau1b927eb2022-07-15 19:15:02 +02002281 thread_release();
2282
Christopher Faulet48678e42023-03-14 14:33:11 +01002283 /* Loop on proxies to stop backends */
2284 p = proxies_list;
2285 while (p) {
2286 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2287 proxy_cond_disable(p);
2288 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
2289 p = p->next;
2290 }
2291
Willy Tarreaud0807c32010-08-27 18:26:11 +02002292 /* signal zero is used to broadcast the "stopping" event */
2293 signal_handler(0);
Willy Tarreaubaaee002006-06-26 02:48:02 +02002294}
2295
Willy Tarreau10080712021-09-07 10:49:45 +02002296/* triggered by a soft-stop delayed with `grace` */
2297static struct task *grace_expired(struct task *t, void *context, unsigned int state)
2298{
2299 ha_notice("Grace period expired, proceeding with soft-stop now.\n");
2300 send_log(NULL, LOG_NOTICE, "Grace period expired, proceeding with soft-stop now.\n");
2301 do_soft_stop_now();
2302 task_destroy(t);
2303 return NULL;
2304}
2305
2306/*
2307 * this function disables health-check servers so that the process will quickly be ignored
2308 * by load balancers.
2309 */
2310void soft_stop(void)
2311{
2312 struct task *task;
2313
2314 stopping = 1;
2315
2316 if (tick_isset(global.grace_delay)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +02002317 task = task_new_anywhere();
Willy Tarreau10080712021-09-07 10:49:45 +02002318 if (task) {
2319 ha_notice("Scheduling a soft-stop in %u ms.\n", global.grace_delay);
2320 send_log(NULL, LOG_WARNING, "Scheduling a soft-stop in %u ms.\n", global.grace_delay);
2321 task->process = grace_expired;
2322 task_schedule(task, tick_add(now_ms, global.grace_delay));
2323 return;
2324 }
2325 else {
2326 ha_alert("out of memory trying to allocate the stop-stop task, stopping now.\n");
2327 }
2328 }
2329
2330 /* no grace (or failure to enforce it): stop now */
2331 do_soft_stop_now();
2332}
2333
Willy Tarreaubaaee002006-06-26 02:48:02 +02002334
Willy Tarreaube58c382011-07-24 18:28:10 +02002335/* Temporarily disables listening on all of the proxy's listeners. Upon
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002336 * success, the proxy enters the PR_PAUSED state. The function returns 0
Willy Tarreauce8fe252011-09-07 19:14:57 +02002337 * if it fails, or non-zero on success.
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002338 * The function takes the proxy's lock so it's safe to
2339 * call from multiple places.
Willy Tarreaubaaee002006-06-26 02:48:02 +02002340 */
Willy Tarreauce8fe252011-09-07 19:14:57 +02002341int pause_proxy(struct proxy *p)
Willy Tarreaubaaee002006-06-26 02:48:02 +02002342{
2343 struct listener *l;
Willy Tarreauce8fe252011-09-07 19:14:57 +02002344
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002345 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2346
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002347 if (!(p->cap & PR_CAP_FE) || (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !p->li_ready)
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002348 goto end;
Willy Tarreauce8fe252011-09-07 19:14:57 +02002349
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002350 list_for_each_entry(l, &p->conf.listeners, by_fe)
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +01002351 suspend_listener(l, 1, 0);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002352
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002353 if (p->li_ready) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002354 ha_warning("%s %s failed to enter pause mode.\n", proxy_cap_str(p->cap), p->id);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002355 send_log(p, LOG_WARNING, "%s %s failed to enter pause mode.\n", proxy_cap_str(p->cap), p->id);
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002356 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002357 return 0;
2358 }
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002359end:
2360 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002361 return 1;
Willy Tarreauda250db2008-10-12 12:07:48 +02002362}
2363
Willy Tarreauda250db2008-10-12 12:07:48 +02002364/*
2365 * This function completely stops a proxy and releases its listeners. It has
2366 * to be called when going down in order to release the ports so that another
2367 * process may bind to them. It must also be called on disabled proxies at the
William Lallemandc59f9882018-11-16 16:57:21 +01002368 * end of start-up. If all listeners are closed, the proxy is set to the
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002369 * PR_STOPPED state.
2370 * The function takes the proxy's lock so it's safe to
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002371 * call from multiple places.
Willy Tarreauda250db2008-10-12 12:07:48 +02002372 */
2373void stop_proxy(struct proxy *p)
2374{
2375 struct listener *l;
2376
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002377 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002378
Willy Tarreau322b9b92020-10-07 16:20:34 +02002379 list_for_each_entry(l, &p->conf.listeners, by_fe)
Aurelien DARRAGON4059e092023-02-06 17:06:03 +01002380 stop_listener(l, 1, 0, 0);
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002381
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002382 if (!(p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) && !p->li_ready) {
Willy Tarreauba296872020-10-16 15:10:11 +02002383 /* might be just a backend */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002384 p->flags |= PR_FL_STOPPED;
Willy Tarreauba296872020-10-16 15:10:11 +02002385 }
2386
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002387 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreaubaaee002006-06-26 02:48:02 +02002388}
2389
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002390/* This function resumes listening on the specified proxy. It scans all of its
2391 * listeners and tries to enable them all. If any of them fails, the proxy is
2392 * put back to the paused state. It returns 1 upon success, or zero if an error
2393 * is encountered.
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002394 * The function takes the proxy's lock so it's safe to
2395 * call from multiple places.
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002396 */
2397int resume_proxy(struct proxy *p)
2398{
2399 struct listener *l;
2400 int fail;
2401
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002402 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2403
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002404 if ((p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !p->li_paused)
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002405 goto end;
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002406
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002407 fail = 0;
Willy Tarreau4348fad2012-09-20 16:48:07 +02002408 list_for_each_entry(l, &p->conf.listeners, by_fe) {
Aurelien DARRAGON4059e092023-02-06 17:06:03 +01002409 if (!resume_listener(l, 1, 0)) {
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002410 int port;
2411
Willy Tarreau37159062020-08-27 07:48:42 +02002412 port = get_host_port(&l->rx.addr);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002413 if (port) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002414 ha_warning("Port %d busy while trying to enable %s %s.\n",
2415 port, proxy_cap_str(p->cap), p->id);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002416 send_log(p, LOG_WARNING, "Port %d busy while trying to enable %s %s.\n",
2417 port, proxy_cap_str(p->cap), p->id);
2418 }
2419 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002420 ha_warning("Bind on socket %d busy while trying to enable %s %s.\n",
2421 l->luid, proxy_cap_str(p->cap), p->id);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002422 send_log(p, LOG_WARNING, "Bind on socket %d busy while trying to enable %s %s.\n",
2423 l->luid, proxy_cap_str(p->cap), p->id);
2424 }
2425
2426 /* Another port might have been enabled. Let's stop everything. */
2427 fail = 1;
2428 break;
2429 }
2430 }
2431
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002432 if (fail) {
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002433 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
2434 /* pause_proxy will take PROXY_LOCK */
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002435 pause_proxy(p);
2436 return 0;
2437 }
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002438end:
2439 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002440 return 1;
2441}
2442
Willy Tarreau87b09662015-04-03 00:22:06 +02002443/* Set current stream's backend to <be>. Nothing is done if the
2444 * stream already had a backend assigned, which is indicated by
Willy Tarreaue7dff022015-04-03 01:14:29 +02002445 * s->flags & SF_BE_ASSIGNED.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002446 * All flags, stats and counters which need be updated are updated.
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002447 * Returns 1 if done, 0 in case of internal error, eg: lack of resource.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002448 */
Willy Tarreau87b09662015-04-03 00:22:06 +02002449int stream_set_backend(struct stream *s, struct proxy *be)
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002450{
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002451 unsigned int req_ana;
2452
Willy Tarreaue7dff022015-04-03 01:14:29 +02002453 if (s->flags & SF_BE_ASSIGNED)
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002454 return 1;
Christopher Faulet41179042016-06-21 11:54:52 +02002455
2456 if (flt_set_stream_backend(s, be) < 0)
2457 return 0;
2458
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002459 s->be = be;
Christopher Fauletff8abcd2017-06-02 15:33:24 +02002460 HA_ATOMIC_UPDATE_MAX(&be->be_counters.conn_max,
Willy Tarreau1db42732021-04-06 11:44:07 +02002461 HA_ATOMIC_ADD_FETCH(&be->beconn, 1));
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002462 proxy_inc_be_ctr(be);
2463
Willy Tarreau87b09662015-04-03 00:22:06 +02002464 /* assign new parameters to the stream from the new backend */
Willy Tarreaucb041662022-05-17 19:44:42 +02002465 s->scb->flags &= ~SC_FL_INDEP_STR;
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02002466 if (be->options2 & PR_O2_INDEPSTR)
Willy Tarreaucb041662022-05-17 19:44:42 +02002467 s->scb->flags |= SC_FL_INDEP_STR;
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02002468
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002469 /* We want to enable the backend-specific analysers except those which
2470 * were already run as part of the frontend/listener. Note that it would
2471 * be more reliable to store the list of analysers that have been run,
2472 * but what we do here is OK for now.
2473 */
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002474 req_ana = be->be_req_ana;
2475 if (!(strm_fe(s)->options & PR_O_WREQ_BODY) && be->options & PR_O_WREQ_BODY) {
2476 /* The backend request to parse a request body while it was not
2477 * performed on the frontend, so add the corresponding analyser
2478 */
2479 req_ana |= AN_REQ_HTTP_BODY;
2480 }
2481 if (IS_HTX_STRM(s) && strm_fe(s)->mode != PR_MODE_HTTP) {
2482 /* The stream was already upgraded to HTTP, so remove analysers
2483 * set during the upgrade
2484 */
2485 req_ana &= ~(AN_REQ_WAIT_HTTP|AN_REQ_HTTP_PROCESS_FE);
2486 }
Willy Tarreau7866e8e2023-01-12 18:39:42 +01002487 s->req.analysers |= req_ana & ~(strm_li(s) ? strm_li(s)->bind_conf->analysers : 0);
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002488
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002489 if (!IS_HTX_STRM(s) && be->mode == PR_MODE_HTTP) {
Christopher Fauletbbe68542019-04-08 10:53:51 +02002490 /* If we chain a TCP frontend to an HTX backend, we must upgrade
2491 * the client mux */
Christopher Fauletae863c62021-03-15 12:03:44 +01002492 if (!stream_set_http_mode(s, NULL))
Christopher Fauleteec7f8a2019-12-20 15:59:20 +01002493 return 0;
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002494 }
2495 else if (IS_HTX_STRM(s) && be->mode != PR_MODE_HTTP) {
2496 /* If a TCP backend is assgiend to an HTX stream, return an
2497 * error. It may happens for a new stream on a previously
2498 * upgraded connections. */
2499 if (!(s->flags & SF_ERR_MASK))
2500 s->flags |= SF_ERR_INTERNAL;
2501 return 0;
2502 }
2503 else {
2504 /* If the target backend requires HTTP processing, we have to allocate
2505 * the HTTP transaction if we did not have one.
2506 */
2507 if (unlikely(!s->txn && be->http_needed && !http_create_txn(s)))
2508 return 0;
Willy Tarreaueee5b512015-04-03 23:46:31 +02002509 }
2510
2511 s->flags |= SF_BE_ASSIGNED;
Willy Tarreau96e31212011-05-30 18:10:30 +02002512 if (be->options2 & PR_O2_NODELAY) {
Christopher Faulet68ef2182023-03-17 15:38:18 +01002513 s->scf->flags |= SC_FL_SND_NEVERWAIT;
2514 s->scb->flags |= SC_FL_SND_NEVERWAIT;
Willy Tarreau96e31212011-05-30 18:10:30 +02002515 }
2516
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002517 return 1;
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002518}
2519
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002520/* Capture a bad request or response and archive it in the proxy's structure.
2521 * It is relatively protocol-agnostic so it requires that a number of elements
2522 * are passed :
2523 * - <proxy> is the proxy where the error was detected and where the snapshot
2524 * needs to be stored
Joseph Herlant59dd2952018-11-15 11:46:55 -08002525 * - <is_back> indicates that the error happened when receiving the response
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002526 * - <other_end> is a pointer to the proxy on the other side when known
2527 * - <target> is the target of the connection, usually a server or a proxy
2528 * - <sess> is the session which experienced the error
2529 * - <ctx> may be NULL or should contain any info relevant to the protocol
2530 * - <buf> is the buffer containing the offending data
2531 * - <buf_ofs> is the position of this buffer's input data in the input
2532 * stream, starting at zero. It may be passed as zero if unknown.
2533 * - <buf_out> is the portion of <buf->data> which was already forwarded and
2534 * which precedes the buffer's input. The buffer's input starts at
2535 * buf->head + buf_out.
2536 * - <err_pos> is the pointer to the faulty byte in the buffer's input.
2537 * - <show> is the callback to use to display <ctx>. It may be NULL.
2538 */
2539void proxy_capture_error(struct proxy *proxy, int is_back,
2540 struct proxy *other_end, enum obj_type *target,
2541 const struct session *sess,
2542 const struct buffer *buf, long buf_ofs,
2543 unsigned int buf_out, unsigned int err_pos,
2544 const union error_snapshot_ctx *ctx,
2545 void (*show)(struct buffer *, const struct error_snapshot *))
2546{
2547 struct error_snapshot *es;
2548 unsigned int buf_len;
2549 int len1, len2;
Willy Tarreauc55015e2018-09-07 19:02:32 +02002550 unsigned int ev_id;
2551
Willy Tarreau18515722021-04-06 11:57:41 +02002552 ev_id = HA_ATOMIC_FETCH_ADD(&error_snapshot_id, 1);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002553
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002554 buf_len = b_data(buf) - buf_out;
2555
2556 es = malloc(sizeof(*es) + buf_len);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002557 if (!es)
2558 return;
2559
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002560 es->buf_len = buf_len;
2561 es->ev_id = ev_id;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002562
Christopher Faulet47a72102020-01-06 11:37:00 +01002563 len1 = b_size(buf) - b_peek_ofs(buf, buf_out);
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002564 if (len1 > buf_len)
2565 len1 = buf_len;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002566
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002567 if (len1) {
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002568 memcpy(es->buf, b_peek(buf, buf_out), len1);
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002569 len2 = buf_len - len1;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002570 if (len2)
2571 memcpy(es->buf + len1, b_orig(buf), len2);
2572 }
2573
2574 es->buf_err = err_pos;
2575 es->when = date; // user-visible date
2576 es->srv = objt_server(target);
2577 es->oe = other_end;
Olivier Houchardbdb00c52020-03-12 15:30:17 +01002578 if (sess && objt_conn(sess->origin) && conn_get_src(__objt_conn(sess->origin)))
Willy Tarreau026efc72019-07-17 15:20:02 +02002579 es->src = *__objt_conn(sess->origin)->src;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002580 else
2581 memset(&es->src, 0, sizeof(es->src));
2582
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002583 es->buf_wrap = b_wrap(buf) - b_peek(buf, buf_out);
2584 es->buf_out = buf_out;
2585 es->buf_ofs = buf_ofs;
2586
2587 /* be sure to indicate the offset of the first IN byte */
2588 if (es->buf_ofs >= es->buf_len)
2589 es->buf_ofs -= es->buf_len;
2590 else
2591 es->buf_ofs = 0;
2592
2593 /* protocol-specific part now */
2594 if (ctx)
2595 es->ctx = *ctx;
2596 else
2597 memset(&es->ctx, 0, sizeof(es->ctx));
2598 es->show = show;
Willy Tarreauc55015e2018-09-07 19:02:32 +02002599
2600 /* note: we still lock since we have to be certain that nobody is
2601 * dumping the output while we free.
2602 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002603 HA_RWLOCK_WRLOCK(PROXY_LOCK, &proxy->lock);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002604 if (is_back) {
2605 es = HA_ATOMIC_XCHG(&proxy->invalid_rep, es);
2606 } else {
2607 es = HA_ATOMIC_XCHG(&proxy->invalid_req, es);
2608 }
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002609 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &proxy->lock);
Willy Tarreauda9f2582022-09-17 11:07:19 +02002610 ha_free(&es);
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002611}
2612
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002613/* Configure all proxies which lack a maxconn setting to use the global one by
2614 * default. This avoids the common mistake consisting in setting maxconn only
2615 * in the global section and discovering the hard way that it doesn't propagate
2616 * through the frontends. These values are also propagated through the various
Ilya Shipitsin47d17182020-06-21 21:42:57 +05002617 * targeted backends, whose fullconn is finally calculated if not yet set.
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002618 */
2619void proxy_adjust_all_maxconn()
2620{
2621 struct proxy *curproxy;
2622 struct switching_rule *swrule1, *swrule2;
2623
2624 for (curproxy = proxies_list; curproxy; curproxy = curproxy->next) {
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002625 if (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002626 continue;
2627
2628 if (!(curproxy->cap & PR_CAP_FE))
2629 continue;
2630
2631 if (!curproxy->maxconn)
2632 curproxy->maxconn = global.maxconn;
2633
2634 /* update the target backend's fullconn count : default_backend */
2635 if (curproxy->defbe.be)
2636 curproxy->defbe.be->tot_fe_maxconn += curproxy->maxconn;
2637 else if ((curproxy->cap & PR_CAP_LISTEN) == PR_CAP_LISTEN)
2638 curproxy->tot_fe_maxconn += curproxy->maxconn;
2639
2640 list_for_each_entry(swrule1, &curproxy->switching_rules, list) {
2641 /* For each target of switching rules, we update their
2642 * tot_fe_maxconn, except if a previous rule points to
2643 * the same backend or to the default backend.
2644 */
2645 if (swrule1->be.backend != curproxy->defbe.be) {
Frédéric Lécaille2365fb02019-03-07 15:02:52 +01002646 /* note: swrule1->be.backend isn't a backend if the rule
2647 * is dynamic, it's an expression instead, so it must not
2648 * be dereferenced as a backend before being certain it is.
2649 */
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002650 list_for_each_entry(swrule2, &curproxy->switching_rules, list) {
2651 if (swrule2 == swrule1) {
Frédéric Lécaille2365fb02019-03-07 15:02:52 +01002652 if (!swrule1->dynamic)
2653 swrule1->be.backend->tot_fe_maxconn += curproxy->maxconn;
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002654 break;
2655 }
2656 else if (!swrule2->dynamic && swrule2->be.backend == swrule1->be.backend) {
2657 /* there are multiple refs of this backend */
2658 break;
2659 }
2660 }
2661 }
2662 }
2663 }
2664
2665 /* automatically compute fullconn if not set. We must not do it in the
2666 * loop above because cross-references are not yet fully resolved.
2667 */
2668 for (curproxy = proxies_list; curproxy; curproxy = curproxy->next) {
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002669 if (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002670 continue;
2671
2672 /* If <fullconn> is not set, let's set it to 10% of the sum of
2673 * the possible incoming frontend's maxconns.
2674 */
2675 if (!curproxy->fullconn && (curproxy->cap & PR_CAP_BE)) {
2676 /* we have the sum of the maxconns in <total>. We only
2677 * keep 10% of that sum to set the default fullconn, with
2678 * a hard minimum of 1 (to avoid a divide by zero).
2679 */
2680 curproxy->fullconn = (curproxy->tot_fe_maxconn + 9) / 10;
2681 if (!curproxy->fullconn)
2682 curproxy->fullconn = 1;
2683 }
2684 }
2685}
2686
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002687/* Config keywords below */
2688
Willy Tarreaudc13c112013-06-21 23:16:39 +02002689static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau10080712021-09-07 10:49:45 +02002690 { CFG_GLOBAL, "grace", proxy_parse_grace },
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002691 { CFG_GLOBAL, "hard-stop-after", proxy_parse_hard_stop_after },
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002692 { CFG_GLOBAL, "close-spread-time", proxy_parse_close_spread_time },
Willy Tarreau9de1bbd2008-07-09 20:34:27 +02002693 { CFG_LISTEN, "timeout", proxy_parse_timeout },
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +02002694 { CFG_LISTEN, "clitimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
2695 { CFG_LISTEN, "contimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
2696 { CFG_LISTEN, "srvtimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
Willy Tarreau3a7d2072009-03-05 23:48:25 +01002697 { CFG_LISTEN, "rate-limit", proxy_parse_rate_limit },
Willy Tarreauc35362a2014-04-25 13:58:37 +02002698 { CFG_LISTEN, "max-keep-alive-queue", proxy_parse_max_ka_queue },
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +02002699 { CFG_LISTEN, "declare", proxy_parse_declare },
Olivier Houcharda254a372019-04-05 15:30:12 +02002700 { CFG_LISTEN, "retry-on", proxy_parse_retry_on },
Willy Tarreau52543212020-07-09 05:58:51 +02002701#ifdef TCP_KEEPCNT
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002702 { CFG_LISTEN, "clitcpka-cnt", proxy_parse_tcpka_cnt },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002703 { CFG_LISTEN, "srvtcpka-cnt", proxy_parse_tcpka_cnt },
Willy Tarreau52543212020-07-09 05:58:51 +02002704#endif
2705#ifdef TCP_KEEPIDLE
2706 { CFG_LISTEN, "clitcpka-idle", proxy_parse_tcpka_idle },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002707 { CFG_LISTEN, "srvtcpka-idle", proxy_parse_tcpka_idle },
Willy Tarreau52543212020-07-09 05:58:51 +02002708#endif
2709#ifdef TCP_KEEPINTVL
2710 { CFG_LISTEN, "clitcpka-intvl", proxy_parse_tcpka_intvl },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002711 { CFG_LISTEN, "srvtcpka-intvl", proxy_parse_tcpka_intvl },
Willy Tarreau52543212020-07-09 05:58:51 +02002712#endif
Willy Tarreau9de1bbd2008-07-09 20:34:27 +02002713 { 0, NULL, NULL },
2714}};
2715
Willy Tarreau0108d902018-11-25 19:14:37 +01002716INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2717
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002718/* Expects to find a frontend named <arg> and returns it, otherwise displays various
2719 * adequate error messages and returns NULL. This function is designed to be used by
2720 * functions requiring a frontend on the CLI.
2721 */
2722struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg)
2723{
2724 struct proxy *px;
2725
2726 if (!*arg) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002727 cli_err(appctx, "A frontend name is expected.\n");
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002728 return NULL;
2729 }
2730
2731 px = proxy_fe_by_name(arg);
2732 if (!px) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002733 cli_err(appctx, "No such frontend.\n");
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002734 return NULL;
2735 }
2736 return px;
2737}
2738
Olivier Houchard614f8d72017-03-14 20:08:46 +01002739/* Expects to find a backend named <arg> and returns it, otherwise displays various
2740 * adequate error messages and returns NULL. This function is designed to be used by
2741 * functions requiring a frontend on the CLI.
2742 */
2743struct proxy *cli_find_backend(struct appctx *appctx, const char *arg)
2744{
2745 struct proxy *px;
2746
2747 if (!*arg) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002748 cli_err(appctx, "A backend name is expected.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01002749 return NULL;
2750 }
2751
2752 px = proxy_be_by_name(arg);
2753 if (!px) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002754 cli_err(appctx, "No such backend.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01002755 return NULL;
2756 }
2757 return px;
2758}
2759
2760
Willy Tarreau69f591e2020-07-01 07:00:59 +02002761/* parse a "show servers [state|conn]" CLI line, returns 0 if it wants to start
2762 * the dump or 1 if it stops immediately. If an argument is specified, it will
Willy Tarreau72a04232022-05-05 17:00:20 +02002763 * reserve a show_srv_ctx context and set the proxy pointer into ->px, its ID
2764 * into ->only_pxid, and ->show_conn to 0 for "state", or 1 for "conn".
William Lallemanda6c5f332016-11-19 02:25:36 +01002765 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002766static int cli_parse_show_servers(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemanda6c5f332016-11-19 02:25:36 +01002767{
Willy Tarreau72a04232022-05-05 17:00:20 +02002768 struct show_srv_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002769 struct proxy *px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002770
Willy Tarreau72a04232022-05-05 17:00:20 +02002771 ctx->show_conn = *args[2] == 'c'; // "conn" vs "state"
Willy Tarreau69f591e2020-07-01 07:00:59 +02002772
William Lallemanda6c5f332016-11-19 02:25:36 +01002773 /* check if a backend name has been provided */
2774 if (*args[3]) {
2775 /* read server state from local file */
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002776 px = proxy_be_by_name(args[3]);
William Lallemanda6c5f332016-11-19 02:25:36 +01002777
Willy Tarreau9d008692019-08-09 11:21:01 +02002778 if (!px)
2779 return cli_err(appctx, "Can't find backend.\n");
2780
Willy Tarreau72a04232022-05-05 17:00:20 +02002781 ctx->px = px;
2782 ctx->only_pxid = px->uuid;
William Lallemanda6c5f332016-11-19 02:25:36 +01002783 }
2784 return 0;
2785}
2786
William Dauchyd1a7b852021-02-11 22:51:26 +01002787/* helper to dump server addr */
2788static void dump_server_addr(const struct sockaddr_storage *addr, char *addr_str)
2789{
2790 addr_str[0] = '\0';
2791 switch (addr->ss_family) {
2792 case AF_INET:
2793 case AF_INET6:
2794 addr_to_str(addr, addr_str, INET6_ADDRSTRLEN + 1);
2795 break;
2796 default:
2797 memcpy(addr_str, "-\0", 2);
2798 break;
2799 }
2800}
2801
Willy Tarreau6ff81432020-07-01 07:02:42 +02002802/* dumps server state information for all the servers found in backend cli.p0.
William Lallemanda6c5f332016-11-19 02:25:36 +01002803 * These information are all the parameters which may change during HAProxy runtime.
Willy Tarreau72a04232022-05-05 17:00:20 +02002804 * By default, we only export to the last known server state file format. These
2805 * information can be used at next startup to recover same level of server
2806 * state. It takes its context from show_srv_ctx, with the proxy pointer from
2807 * ->px, the proxy's id ->only_pxid, the server's pointer from ->sv, and the
2808 * choice of what to dump from ->show_conn.
William Lallemanda6c5f332016-11-19 02:25:36 +01002809 */
Willy Tarreau475e4632022-05-27 10:26:46 +02002810static int dump_servers_state(struct stconn *sc)
William Lallemanda6c5f332016-11-19 02:25:36 +01002811{
Willy Tarreau475e4632022-05-27 10:26:46 +02002812 struct appctx *appctx = __sc_appctx(sc);
Willy Tarreau72a04232022-05-05 17:00:20 +02002813 struct show_srv_ctx *ctx = appctx->svcctx;
2814 struct proxy *px = ctx->px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002815 struct server *srv;
2816 char srv_addr[INET6_ADDRSTRLEN + 1];
William Dauchyd1a7b852021-02-11 22:51:26 +01002817 char srv_agent_addr[INET6_ADDRSTRLEN + 1];
2818 char srv_check_addr[INET6_ADDRSTRLEN + 1];
William Lallemanda6c5f332016-11-19 02:25:36 +01002819 time_t srv_time_since_last_change;
2820 int bk_f_forced_id, srv_f_forced_id;
Baptiste Assmann6d0f38f2018-07-02 17:00:54 +02002821 char *srvrecord;
William Lallemanda6c5f332016-11-19 02:25:36 +01002822
Willy Tarreau72a04232022-05-05 17:00:20 +02002823 if (!ctx->sv)
2824 ctx->sv = px->srv;
William Lallemanda6c5f332016-11-19 02:25:36 +01002825
Willy Tarreau72a04232022-05-05 17:00:20 +02002826 for (; ctx->sv != NULL; ctx->sv = srv->next) {
2827 srv = ctx->sv;
William Lallemanda6c5f332016-11-19 02:25:36 +01002828
William Dauchyd1a7b852021-02-11 22:51:26 +01002829 dump_server_addr(&srv->addr, srv_addr);
2830 dump_server_addr(&srv->check.addr, srv_check_addr);
2831 dump_server_addr(&srv->agent.addr, srv_agent_addr);
2832
Willy Tarreau69530f52023-04-28 09:16:15 +02002833 srv_time_since_last_change = ns_to_sec(now_ns) - srv->last_change;
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002834 bk_f_forced_id = px->options & PR_O_FORCED_ID ? 1 : 0;
William Lallemanda6c5f332016-11-19 02:25:36 +01002835 srv_f_forced_id = srv->flags & SRV_F_FORCED_ID ? 1 : 0;
2836
Baptiste Assmann6d0f38f2018-07-02 17:00:54 +02002837 srvrecord = NULL;
2838 if (srv->srvrq && srv->srvrq->name)
2839 srvrecord = srv->srvrq->name;
2840
Willy Tarreau72a04232022-05-05 17:00:20 +02002841 if (ctx->show_conn == 0) {
Willy Tarreau69f591e2020-07-01 07:00:59 +02002842 /* show servers state */
2843 chunk_printf(&trash,
2844 "%d %s "
2845 "%d %s %s "
2846 "%d %d %d %d %ld "
2847 "%d %d %d %d %d "
William Dauchyf6370442020-11-14 19:25:33 +01002848 "%d %d %s %u "
William Dauchyd1a7b852021-02-11 22:51:26 +01002849 "%s %d %d "
2850 "%s %s %d"
Willy Tarreau69f591e2020-07-01 07:00:59 +02002851 "\n",
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002852 px->uuid, HA_ANON_CLI(px->id),
Erwan Le Goas9ac3ccb2022-09-29 10:27:33 +02002853 srv->puid, HA_ANON_CLI(srv->id),
2854 hash_ipanon(appctx->cli_anon_key, srv_addr, 0),
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002855 srv->cur_state, srv->cur_admin, srv->uweight, srv->iweight,
2856 (long int)srv_time_since_last_change,
2857 srv->check.status, srv->check.result, srv->check.health,
Willy Tarreau99521ab2022-10-12 21:40:31 +02002858 srv->check.state & 0x0F, srv->agent.state & 0x1F,
Erwan Le Goas1caa5352022-09-29 10:28:44 +02002859 bk_f_forced_id, srv_f_forced_id,
2860 srv->hostname ? HA_ANON_CLI(srv->hostname) : "-", srv->svc_port,
William Dauchyd1a7b852021-02-11 22:51:26 +01002861 srvrecord ? srvrecord : "-", srv->use_ssl, srv->check.port,
2862 srv_check_addr, srv_agent_addr, srv->agent.port);
Willy Tarreau69f591e2020-07-01 07:00:59 +02002863 } else {
2864 /* show servers conn */
2865 int thr;
2866
2867 chunk_printf(&trash,
2868 "%s/%s %d/%d %s %u - %u %u %u %u %u %u %d %u",
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002869 HA_ANON_CLI(px->id), HA_ANON_CLI(srv->id),
Erwan Le Goas9ac3ccb2022-09-29 10:27:33 +02002870 px->uuid, srv->puid, hash_ipanon(appctx->cli_anon_key, srv_addr, 0),
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002871 srv->svc_port, srv->pool_purge_delay,
Willy Tarreau69f591e2020-07-01 07:00:59 +02002872 srv->curr_used_conns, srv->max_used_conns, srv->est_need_conns,
2873 srv->curr_idle_nb, srv->curr_safe_nb, (int)srv->max_idle_conns, srv->curr_idle_conns);
2874
Willy Tarreau42abe682020-07-02 15:19:57 +02002875 for (thr = 0; thr < global.nbthread && srv->curr_idle_thr; thr++)
Willy Tarreau69f591e2020-07-01 07:00:59 +02002876 chunk_appendf(&trash, " %u", srv->curr_idle_thr[thr]);
2877
2878 chunk_appendf(&trash, "\n");
2879 }
2880
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002881 if (applet_putchk(appctx, &trash) == -1) {
William Lallemanda6c5f332016-11-19 02:25:36 +01002882 return 0;
2883 }
2884 }
2885 return 1;
2886}
2887
2888/* Parses backend list or simply use backend name provided by the user to return
Willy Tarreau72a04232022-05-05 17:00:20 +02002889 * states of servers to stdout. It takes its context from show_srv_ctx and dumps
2890 * proxy ->px and stops if ->only_pxid is non-null.
William Lallemanda6c5f332016-11-19 02:25:36 +01002891 */
2892static int cli_io_handler_servers_state(struct appctx *appctx)
2893{
Willy Tarreau72a04232022-05-05 17:00:20 +02002894 struct show_srv_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02002895 struct stconn *sc = appctx_sc(appctx);
William Lallemanda6c5f332016-11-19 02:25:36 +01002896 struct proxy *curproxy;
2897
Willy Tarreaud741e9c2022-05-05 19:26:18 +02002898 if (ctx->state == SHOW_SRV_HEAD) {
Willy Tarreau72a04232022-05-05 17:00:20 +02002899 if (ctx->show_conn == 0)
Willy Tarreau69f591e2020-07-01 07:00:59 +02002900 chunk_printf(&trash, "%d\n# %s\n", SRV_STATE_FILE_VERSION, SRV_STATE_FILE_FIELD_NAMES);
2901 else
2902 chunk_printf(&trash,
2903 "# bkname/svname bkid/svid addr port - purge_delay used_cur used_max need_est unsafe_nb safe_nb idle_lim idle_cur idle_per_thr[%d]\n",
2904 global.nbthread);
2905
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002906 if (applet_putchk(appctx, &trash) == -1)
William Lallemanda6c5f332016-11-19 02:25:36 +01002907 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002908
Willy Tarreaud741e9c2022-05-05 19:26:18 +02002909 ctx->state = SHOW_SRV_LIST;
2910
2911 if (!ctx->px)
2912 ctx->px = proxies_list;
William Lallemanda6c5f332016-11-19 02:25:36 +01002913 }
2914
Willy Tarreau72a04232022-05-05 17:00:20 +02002915 for (; ctx->px != NULL; ctx->px = curproxy->next) {
2916 curproxy = ctx->px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002917 /* servers are only in backends */
William Lallemanda39e6262021-08-25 18:15:31 +02002918 if ((curproxy->cap & PR_CAP_BE) && !(curproxy->cap & PR_CAP_INT)) {
Willy Tarreau475e4632022-05-27 10:26:46 +02002919 if (!dump_servers_state(sc))
William Lallemanda6c5f332016-11-19 02:25:36 +01002920 return 0;
William Lallemanda6c5f332016-11-19 02:25:36 +01002921 }
2922 /* only the selected proxy is dumped */
Willy Tarreau72a04232022-05-05 17:00:20 +02002923 if (ctx->only_pxid)
William Lallemanda6c5f332016-11-19 02:25:36 +01002924 break;
2925 }
2926
2927 return 1;
2928}
2929
Willy Tarreau608ea592016-12-16 18:01:15 +01002930/* Parses backend list and simply report backend names. It keeps the proxy
Willy Tarreauacf6a442022-05-05 17:05:38 +02002931 * pointer in svcctx since there's nothing else to store there.
Willy Tarreau608ea592016-12-16 18:01:15 +01002932 */
William Lallemand933efcd2016-11-22 12:34:16 +01002933static int cli_io_handler_show_backend(struct appctx *appctx)
2934{
William Lallemand933efcd2016-11-22 12:34:16 +01002935 struct proxy *curproxy;
2936
2937 chunk_reset(&trash);
2938
Willy Tarreauacf6a442022-05-05 17:05:38 +02002939 if (!appctx->svcctx) {
William Lallemand933efcd2016-11-22 12:34:16 +01002940 chunk_printf(&trash, "# name\n");
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002941 if (applet_putchk(appctx, &trash) == -1)
William Lallemand933efcd2016-11-22 12:34:16 +01002942 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002943
Willy Tarreauacf6a442022-05-05 17:05:38 +02002944 appctx->svcctx = proxies_list;
William Lallemand933efcd2016-11-22 12:34:16 +01002945 }
2946
Willy Tarreauacf6a442022-05-05 17:05:38 +02002947 for (; appctx->svcctx != NULL; appctx->svcctx = curproxy->next) {
2948 curproxy = appctx->svcctx;
William Lallemand933efcd2016-11-22 12:34:16 +01002949
Willy Tarreau4f9f1572022-05-05 17:10:03 +02002950 /* looking for non-internal backends only */
2951 if ((curproxy->cap & (PR_CAP_BE|PR_CAP_INT)) != PR_CAP_BE)
William Lallemand933efcd2016-11-22 12:34:16 +01002952 continue;
2953
William Lallemand933efcd2016-11-22 12:34:16 +01002954 chunk_appendf(&trash, "%s\n", curproxy->id);
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002955 if (applet_putchk(appctx, &trash) == -1)
William Lallemand933efcd2016-11-22 12:34:16 +01002956 return 0;
William Lallemand933efcd2016-11-22 12:34:16 +01002957 }
2958
2959 return 1;
2960}
William Lallemanda6c5f332016-11-19 02:25:36 +01002961
Willy Tarreaua275a372018-08-21 14:50:44 +02002962/* Parses the "enable dynamic-cookies backend" directive, it always returns 1.
2963 *
2964 * Grabs the proxy lock and each server's lock.
2965 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002966static int cli_parse_enable_dyncookie_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01002967{
2968 struct proxy *px;
2969 struct server *s;
2970
2971 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
2972 return 1;
2973
2974 px = cli_find_backend(appctx, args[3]);
2975 if (!px)
2976 return 1;
2977
Willy Tarreau5e83d992019-07-30 11:59:34 +02002978 /* Note: this lock is to make sure this doesn't change while another
2979 * thread is in srv_set_dyncookie().
2980 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002981 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002982 px->ck_opts |= PR_CK_DYNAMIC;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002983 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002984
Willy Tarreaua275a372018-08-21 14:50:44 +02002985 for (s = px->srv; s != NULL; s = s->next) {
2986 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002987 srv_set_dyncookie(s);
Willy Tarreaua275a372018-08-21 14:50:44 +02002988 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
2989 }
2990
Olivier Houchard614f8d72017-03-14 20:08:46 +01002991 return 1;
2992}
2993
Willy Tarreaua275a372018-08-21 14:50:44 +02002994/* Parses the "disable dynamic-cookies backend" directive, it always returns 1.
2995 *
2996 * Grabs the proxy lock and each server's lock.
2997 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002998static int cli_parse_disable_dyncookie_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01002999{
3000 struct proxy *px;
3001 struct server *s;
3002
3003 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3004 return 1;
3005
3006 px = cli_find_backend(appctx, args[3]);
3007 if (!px)
3008 return 1;
3009
Willy Tarreau5e83d992019-07-30 11:59:34 +02003010 /* Note: this lock is to make sure this doesn't change while another
3011 * thread is in srv_set_dyncookie().
3012 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003013 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003014 px->ck_opts &= ~PR_CK_DYNAMIC;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003015 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003016
3017 for (s = px->srv; s != NULL; s = s->next) {
Willy Tarreaua275a372018-08-21 14:50:44 +02003018 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003019 if (!(s->flags & SRV_F_COOKIESET))
3020 ha_free(&s->cookie);
Willy Tarreaua275a372018-08-21 14:50:44 +02003021 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003022 }
3023
3024 return 1;
3025}
3026
Willy Tarreaua275a372018-08-21 14:50:44 +02003027/* Parses the "set dynamic-cookie-key backend" directive, it always returns 1.
3028 *
3029 * Grabs the proxy lock and each server's lock.
3030 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003031static int cli_parse_set_dyncookie_key_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01003032{
3033 struct proxy *px;
3034 struct server *s;
3035 char *newkey;
3036
3037 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3038 return 1;
3039
3040 px = cli_find_backend(appctx, args[3]);
3041 if (!px)
3042 return 1;
3043
Willy Tarreau9d008692019-08-09 11:21:01 +02003044 if (!*args[4])
3045 return cli_err(appctx, "String value expected.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01003046
3047 newkey = strdup(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02003048 if (!newkey)
3049 return cli_err(appctx, "Failed to allocate memory.\n");
Willy Tarreaua275a372018-08-21 14:50:44 +02003050
Willy Tarreau5e83d992019-07-30 11:59:34 +02003051 /* Note: this lock is to make sure this doesn't change while another
3052 * thread is in srv_set_dyncookie().
3053 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003054 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003055 free(px->dyncookie_key);
3056 px->dyncookie_key = newkey;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003057 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003058
Willy Tarreaua275a372018-08-21 14:50:44 +02003059 for (s = px->srv; s != NULL; s = s->next) {
3060 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003061 srv_set_dyncookie(s);
Willy Tarreaua275a372018-08-21 14:50:44 +02003062 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
3063 }
3064
Olivier Houchard614f8d72017-03-14 20:08:46 +01003065 return 1;
3066}
3067
Willy Tarreaua275a372018-08-21 14:50:44 +02003068/* Parses the "set maxconn frontend" directive, it always returns 1.
3069 *
3070 * Grabs the proxy lock.
3071 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003072static int cli_parse_set_maxconn_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003073{
3074 struct proxy *px;
3075 struct listener *l;
3076 int v;
3077
3078 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3079 return 1;
3080
3081 px = cli_find_frontend(appctx, args[3]);
3082 if (!px)
3083 return 1;
3084
Willy Tarreau9d008692019-08-09 11:21:01 +02003085 if (!*args[4])
3086 return cli_err(appctx, "Integer value expected.\n");
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003087
3088 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02003089 if (v < 0)
3090 return cli_err(appctx, "Value out of range.\n");
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003091
3092 /* OK, the value is fine, so we assign it to the proxy and to all of
3093 * its listeners. The blocked ones will be dequeued.
3094 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003095 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaua275a372018-08-21 14:50:44 +02003096
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003097 px->maxconn = v;
3098 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003099 if (l->state == LI_FULL)
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +01003100 relax_listener(l, 1, 0);
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003101 }
3102
Willy Tarreau241797a2019-12-10 14:10:52 +01003103 if (px->maxconn > px->feconn)
3104 dequeue_proxy_listeners(px);
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003105
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003106 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaua275a372018-08-21 14:50:44 +02003107
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003108 return 1;
3109}
3110
Willy Tarreaua275a372018-08-21 14:50:44 +02003111/* Parses the "shutdown frontend" directive, it always returns 1.
3112 *
3113 * Grabs the proxy lock.
3114 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003115static int cli_parse_shutdown_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003116{
3117 struct proxy *px;
3118
3119 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3120 return 1;
3121
3122 px = cli_find_frontend(appctx, args[2]);
3123 if (!px)
3124 return 1;
3125
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003126 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003127 return cli_msg(appctx, LOG_NOTICE, "Frontend was already shut down.\n");
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003128
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003129 stop_proxy(px);
3130 return 1;
3131}
3132
Willy Tarreaua275a372018-08-21 14:50:44 +02003133/* Parses the "disable frontend" directive, it always returns 1.
3134 *
3135 * Grabs the proxy lock.
3136 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003137static int cli_parse_disable_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau15b9e682016-11-24 11:55:28 +01003138{
3139 struct proxy *px;
Willy Tarreaua275a372018-08-21 14:50:44 +02003140 int ret;
Willy Tarreau15b9e682016-11-24 11:55:28 +01003141
3142 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3143 return 1;
3144
3145 px = cli_find_frontend(appctx, args[2]);
3146 if (!px)
3147 return 1;
3148
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003149 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003150 return cli_msg(appctx, LOG_NOTICE, "Frontend was previously shut down, cannot disable.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003151
Willy Tarreauf18d9682020-09-24 08:04:27 +02003152 if (!px->li_ready)
3153 return cli_msg(appctx, LOG_NOTICE, "All sockets are already disabled.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003154
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02003155 /* pause_proxy will take PROXY_LOCK */
Willy Tarreaua275a372018-08-21 14:50:44 +02003156 ret = pause_proxy(px);
Willy Tarreaua275a372018-08-21 14:50:44 +02003157
Willy Tarreau9d008692019-08-09 11:21:01 +02003158 if (!ret)
3159 return cli_err(appctx, "Failed to pause frontend, check logs for precise cause.\n");
3160
Willy Tarreau15b9e682016-11-24 11:55:28 +01003161 return 1;
3162}
3163
Willy Tarreaua275a372018-08-21 14:50:44 +02003164/* Parses the "enable frontend" directive, it always returns 1.
3165 *
3166 * Grabs the proxy lock.
3167 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003168static int cli_parse_enable_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau15b9e682016-11-24 11:55:28 +01003169{
3170 struct proxy *px;
Willy Tarreaua275a372018-08-21 14:50:44 +02003171 int ret;
Willy Tarreau15b9e682016-11-24 11:55:28 +01003172
3173 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3174 return 1;
3175
3176 px = cli_find_frontend(appctx, args[2]);
3177 if (!px)
3178 return 1;
3179
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003180 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003181 return cli_err(appctx, "Frontend was previously shut down, cannot enable.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003182
Willy Tarreauf18d9682020-09-24 08:04:27 +02003183 if (px->li_ready == px->li_all)
3184 return cli_msg(appctx, LOG_NOTICE, "All sockets are already enabled.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003185
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02003186 /* resume_proxy will take PROXY_LOCK */
Willy Tarreaua275a372018-08-21 14:50:44 +02003187 ret = resume_proxy(px);
Willy Tarreaua275a372018-08-21 14:50:44 +02003188
Willy Tarreau9d008692019-08-09 11:21:01 +02003189 if (!ret)
3190 return cli_err(appctx, "Failed to resume frontend, check logs for precise cause (port conflict?).\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003191 return 1;
3192}
3193
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003194/* appctx context used during "show errors" */
3195struct show_errors_ctx {
3196 struct proxy *px; /* current proxy being dumped, NULL = not started yet. */
3197 unsigned int flag; /* bit0: buffer being dumped, 0 = req, 1 = resp ; bit1=skip req ; bit2=skip resp. */
3198 unsigned int ev_id; /* event ID of error being dumped */
3199 int iid; /* if >= 0, ID of the proxy to filter on */
3200 int ptr; /* <0: headers, >=0 : text pointer to restart from */
3201 int bol; /* pointer to beginning of current line */
3202};
3203
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003204/* "show errors" handler for the CLI. Returns 0 if wants to continue, 1 to stop
3205 * now.
3206 */
3207static int cli_parse_show_errors(char **args, char *payload, struct appctx *appctx, void *private)
3208{
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003209 struct show_errors_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
3210
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003211 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
3212 return 1;
3213
3214 if (*args[2]) {
3215 struct proxy *px;
3216
3217 px = proxy_find_by_name(args[2], 0, 0);
3218 if (px)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003219 ctx->iid = px->uuid;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003220 else
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003221 ctx->iid = atoi(args[2]);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003222
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003223 if (!ctx->iid)
Willy Tarreau9d008692019-08-09 11:21:01 +02003224 return cli_err(appctx, "No such proxy.\n");
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003225 }
3226 else
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003227 ctx->iid = -1; // dump all proxies
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003228
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003229 ctx->flag = 0;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003230 if (strcmp(args[3], "request") == 0)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003231 ctx->flag |= 4; // ignore response
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003232 else if (strcmp(args[3], "response") == 0)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003233 ctx->flag |= 2; // ignore request
3234 ctx->px = NULL;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003235 return 0;
3236}
3237
Willy Tarreau4596fe22022-05-17 19:07:51 +02003238/* This function dumps all captured errors onto the stream connector's
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003239 * read buffer. It returns 0 if the output buffer is full and it needs
3240 * to be called again, otherwise non-zero.
3241 */
3242static int cli_io_handler_show_errors(struct appctx *appctx)
3243{
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003244 struct show_errors_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02003245 struct stconn *sc = appctx_sc(appctx);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003246 extern const char *monthname[12];
3247
Christopher Faulet87633c32023-04-03 18:32:50 +02003248 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02003249 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003250 return 1;
3251
3252 chunk_reset(&trash);
3253
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003254 if (!ctx->px) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003255 /* the function had not been called yet, let's prepare the
3256 * buffer for a response.
3257 */
3258 struct tm tm;
3259
3260 get_localtime(date.tv_sec, &tm);
3261 chunk_appendf(&trash, "Total events captured on [%02d/%s/%04d:%02d:%02d:%02d.%03d] : %u\n",
3262 tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3263 tm.tm_hour, tm.tm_min, tm.tm_sec, (int)(date.tv_usec/1000),
3264 error_snapshot_id);
3265
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003266 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003267 goto cant_send;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003268
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003269 ctx->px = proxies_list;
3270 ctx->bol = 0;
3271 ctx->ptr = -1;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003272 }
3273
3274 /* we have two inner loops here, one for the proxy, the other one for
3275 * the buffer.
3276 */
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003277 while (ctx->px) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003278 struct error_snapshot *es;
3279
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003280 HA_RWLOCK_RDLOCK(PROXY_LOCK, &ctx->px->lock);
Willy Tarreau36b27362018-09-07 19:55:44 +02003281
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003282 if ((ctx->flag & 1) == 0) {
3283 es = ctx->px->invalid_req;
3284 if (ctx->flag & 2) // skip req
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003285 goto next;
3286 }
3287 else {
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003288 es = ctx->px->invalid_rep;
3289 if (ctx->flag & 4) // skip resp
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003290 goto next;
3291 }
3292
Willy Tarreauc55015e2018-09-07 19:02:32 +02003293 if (!es)
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003294 goto next;
3295
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003296 if (ctx->iid >= 0 &&
3297 ctx->px->uuid != ctx->iid &&
3298 (!es->oe || es->oe->uuid != ctx->iid))
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003299 goto next;
3300
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003301 if (ctx->ptr < 0) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003302 /* just print headers now */
3303
3304 char pn[INET6_ADDRSTRLEN];
3305 struct tm tm;
3306 int port;
3307
3308 get_localtime(es->when.tv_sec, &tm);
3309 chunk_appendf(&trash, " \n[%02d/%s/%04d:%02d:%02d:%02d.%03d]",
3310 tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3311 tm.tm_hour, tm.tm_min, tm.tm_sec, (int)(es->when.tv_usec/1000));
3312
3313 switch (addr_to_str(&es->src, pn, sizeof(pn))) {
3314 case AF_INET:
3315 case AF_INET6:
3316 port = get_host_port(&es->src);
3317 break;
3318 default:
3319 port = 0;
3320 }
3321
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003322 switch (ctx->flag & 1) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003323 case 0:
3324 chunk_appendf(&trash,
3325 " frontend %s (#%d): invalid request\n"
3326 " backend %s (#%d)",
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003327 ctx->px->id, ctx->px->uuid,
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003328 (es->oe && es->oe->cap & PR_CAP_BE) ? es->oe->id : "<NONE>",
3329 (es->oe && es->oe->cap & PR_CAP_BE) ? es->oe->uuid : -1);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003330 break;
3331 case 1:
3332 chunk_appendf(&trash,
3333 " backend %s (#%d): invalid response\n"
3334 " frontend %s (#%d)",
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003335 ctx->px->id, ctx->px->uuid,
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003336 es->oe ? es->oe->id : "<NONE>" , es->oe ? es->oe->uuid : -1);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003337 break;
3338 }
3339
3340 chunk_appendf(&trash,
3341 ", server %s (#%d), event #%u, src %s:%d\n"
3342 " buffer starts at %llu (including %u out), %u free,\n"
3343 " len %u, wraps at %u, error at position %u\n",
3344 es->srv ? es->srv->id : "<NONE>",
3345 es->srv ? es->srv->puid : -1,
3346 es->ev_id, pn, port,
3347 es->buf_ofs, es->buf_out,
3348 global.tune.bufsize - es->buf_out - es->buf_len,
3349 es->buf_len, es->buf_wrap, es->buf_err);
3350
3351 if (es->show)
3352 es->show(&trash, es);
3353
3354 chunk_appendf(&trash, " \n");
3355
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003356 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003357 goto cant_send_unlock;
3358
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003359 ctx->ptr = 0;
3360 ctx->ev_id = es->ev_id;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003361 }
3362
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003363 if (ctx->ev_id != es->ev_id) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003364 /* the snapshot changed while we were dumping it */
3365 chunk_appendf(&trash,
3366 " WARNING! update detected on this snapshot, dump interrupted. Please re-check!\n");
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003367 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003368 goto cant_send_unlock;
3369
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003370 goto next;
3371 }
3372
3373 /* OK, ptr >= 0, so we have to dump the current line */
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003374 while (ctx->ptr < es->buf_len && ctx->ptr < global.tune.bufsize) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003375 int newptr;
3376 int newline;
3377
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003378 newline = ctx->bol;
3379 newptr = dump_text_line(&trash, es->buf, global.tune.bufsize, es->buf_len, &newline, ctx->ptr);
Christopher Faulet7b3d38a2023-05-05 11:28:45 +02003380 if (newptr == ctx->ptr) {
3381 sc_need_room(sc, 0);
Willy Tarreau36b27362018-09-07 19:55:44 +02003382 goto cant_send_unlock;
Christopher Faulet7b3d38a2023-05-05 11:28:45 +02003383 }
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003384
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003385 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003386 goto cant_send_unlock;
3387
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003388 ctx->ptr = newptr;
3389 ctx->bol = newline;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003390 };
3391 next:
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003392 HA_RWLOCK_RDUNLOCK(PROXY_LOCK, &ctx->px->lock);
3393 ctx->bol = 0;
3394 ctx->ptr = -1;
3395 ctx->flag ^= 1;
3396 if (!(ctx->flag & 1))
3397 ctx->px = ctx->px->next;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003398 }
3399
3400 /* dump complete */
3401 return 1;
Willy Tarreau36b27362018-09-07 19:55:44 +02003402
3403 cant_send_unlock:
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003404 HA_RWLOCK_RDUNLOCK(PROXY_LOCK, &ctx->px->lock);
Willy Tarreau36b27362018-09-07 19:55:44 +02003405 cant_send:
Willy Tarreau36b27362018-09-07 19:55:44 +02003406 return 0;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003407}
3408
William Lallemanda6c5f332016-11-19 02:25:36 +01003409/* register cli keywords */
3410static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003411 { { "disable", "frontend", NULL }, "disable frontend <frontend> : temporarily disable specific frontend", cli_parse_disable_frontend, NULL, NULL },
3412 { { "enable", "frontend", NULL }, "enable frontend <frontend> : re-enable specific frontend", cli_parse_enable_frontend, NULL, NULL },
3413 { { "set", "maxconn", "frontend", NULL }, "set maxconn frontend <frontend> <value> : change a frontend's maxconn setting", cli_parse_set_maxconn_frontend, NULL },
3414 { { "show","servers", "conn", NULL }, "show servers conn [<backend>] : dump server connections status (all or for a single backend)", cli_parse_show_servers, cli_io_handler_servers_state },
3415 { { "show","servers", "state", NULL }, "show servers state [<backend>] : dump volatile server information (all or for a single backend)", cli_parse_show_servers, cli_io_handler_servers_state },
3416 { { "show", "backend", NULL }, "show backend : list backends in the current running config", NULL, cli_io_handler_show_backend },
3417 { { "shutdown", "frontend", NULL }, "shutdown frontend <frontend> : stop a specific frontend", cli_parse_shutdown_frontend, NULL, NULL },
3418 { { "set", "dynamic-cookie-key", "backend", NULL }, "set dynamic-cookie-key backend <bk> <k> : change a backend secret key for dynamic cookies", cli_parse_set_dyncookie_key_backend, NULL },
3419 { { "enable", "dynamic-cookie", "backend", NULL }, "enable dynamic-cookie backend <bk> : enable dynamic cookies on a specific backend", cli_parse_enable_dyncookie_backend, NULL },
3420 { { "disable", "dynamic-cookie", "backend", NULL }, "disable dynamic-cookie backend <bk> : disable dynamic cookies on a specific backend", cli_parse_disable_dyncookie_backend, NULL },
3421 { { "show", "errors", NULL }, "show errors [<px>] [request|response] : report last request and/or response errors for each proxy", cli_parse_show_errors, cli_io_handler_show_errors, NULL },
William Lallemanda6c5f332016-11-19 02:25:36 +01003422 {{},}
3423}};
3424
Willy Tarreau0108d902018-11-25 19:14:37 +01003425INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
Willy Tarreaubaaee002006-06-26 02:48:02 +02003426
3427/*
3428 * Local variables:
3429 * c-indent-level: 8
3430 * c-basic-offset: 8
3431 * End:
3432 */