blob: 71189d6d0071ab1e504cedc9c90faf44f31ac8a8 [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);
Christopher Fauletea6475c2024-04-05 20:47:34 +0200231 if (rule->dynamic) {
232 list_for_each_entry_safe(lf, lfb, &rule->be.expr, list) {
233 LIST_DELETE(&lf->list);
234 release_sample_expr(lf->expr);
235 free(lf->arg);
236 free(lf);
237 }
238 }
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100239 free(rule->file);
240 free(rule);
241 }
242
243 list_for_each_entry_safe(rdr, rdrb, &p->redirect_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200244 LIST_DELETE(&rdr->list);
Aurelien DARRAGON7abc9222023-05-11 10:30:27 +0200245 http_free_redirect_rule(rdr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100246 }
247
248 list_for_each_entry_safe(log, logb, &p->logsrvs, list) {
Willy Tarreau211ea252022-03-17 19:47:33 +0100249 LIST_DEL_INIT(&log->list);
250 free_logsrv(log);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100251 }
252
253 list_for_each_entry_safe(lf, lfb, &p->logformat, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200254 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100255 release_sample_expr(lf->expr);
256 free(lf->arg);
257 free(lf);
258 }
259
260 list_for_each_entry_safe(lf, lfb, &p->logformat_sd, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200261 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100262 release_sample_expr(lf->expr);
263 free(lf->arg);
264 free(lf);
265 }
266
267 list_for_each_entry_safe(lf, lfb, &p->format_unique_id, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200268 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100269 release_sample_expr(lf->expr);
270 free(lf->arg);
271 free(lf);
272 }
273
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +0200274 list_for_each_entry_safe(lf, lfb, &p->logformat_error, list) {
275 LIST_DELETE(&lf->list);
276 release_sample_expr(lf->expr);
277 free(lf->arg);
278 free(lf);
279 }
280
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100281 free_act_rules(&p->tcp_req.inspect_rules);
282 free_act_rules(&p->tcp_rep.inspect_rules);
283 free_act_rules(&p->tcp_req.l4_rules);
284 free_act_rules(&p->tcp_req.l5_rules);
285 free_act_rules(&p->http_req_rules);
286 free_act_rules(&p->http_res_rules);
287 free_act_rules(&p->http_after_res_rules);
288
289 free_stick_rules(&p->storersp_rules);
290 free_stick_rules(&p->sticking_rules);
291
292 h = p->req_cap;
293 while (h) {
Christopher Faulet57962282022-04-25 14:30:58 +0200294 if (p->defpx && h == p->defpx->req_cap)
295 break;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100296 h_next = h->next;
297 free(h->name);
298 pool_destroy(h->pool);
299 free(h);
300 h = h_next;
301 }/* end while(h) */
302
303 h = p->rsp_cap;
304 while (h) {
Christopher Faulet57962282022-04-25 14:30:58 +0200305 if (p->defpx && h == p->defpx->rsp_cap)
306 break;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100307 h_next = h->next;
308 free(h->name);
309 pool_destroy(h->pool);
310 free(h);
311 h = h_next;
312 }/* end while(h) */
313
314 s = p->srv;
315 while (s) {
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100316 list_for_each_entry(srvdf, &server_deinit_list, list)
317 srvdf->fct(s);
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +0200318 s = srv_drop(s);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100319 }/* end while(s) */
320
Aurelien DARRAGON899b5472023-06-01 12:07:43 +0200321 /* also free default-server parameters since some of them might have
322 * been dynamically allocated (e.g.: config hints, cookies, ssl..)
323 */
324 srv_free_params(&p->defsrv);
325
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100326 list_for_each_entry_safe(l, l_next, &p->conf.listeners, by_fe) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200327 LIST_DELETE(&l->by_fe);
328 LIST_DELETE(&l->by_bind);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100329 free(l->name);
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100330 free(l->per_thr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100331 free(l->counters);
332
333 EXTRA_COUNTERS_FREE(l->extra_counters);
334 free(l);
335 }
336
337 /* Release unused SSL configs. */
338 list_for_each_entry_safe(bind_conf, bind_back, &p->conf.bind, by_fe) {
339 if (bind_conf->xprt->destroy_bind_conf)
340 bind_conf->xprt->destroy_bind_conf(bind_conf);
341 free(bind_conf->file);
342 free(bind_conf->arg);
Aurelien DARRAGON12d6b9a2023-06-01 10:58:44 +0200343 free(bind_conf->settings.interface);
Willy Tarreau2b718102021-04-21 07:32:39 +0200344 LIST_DELETE(&bind_conf->by_fe);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100345 free(bind_conf);
346 }
347
348 flt_deinit(p);
349
350 list_for_each_entry(pxdf, &proxy_deinit_list, list)
351 pxdf->fct(p);
352
353 free(p->desc);
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +0100354
355 http_ext_clean(p);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100356
357 task_destroy(p->task);
358
359 pool_destroy(p->req_cap_pool);
360 pool_destroy(p->rsp_cap_pool);
Aurelien DARRAGONfebaa3e2023-11-16 16:18:14 +0100361
Aurelien DARRAGON6ce5cd02023-11-16 16:17:12 +0100362 stktable_deinit(p->table);
Aurelien DARRAGONfebaa3e2023-11-16 16:18:14 +0100363 ha_free(&p->table);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100364
365 HA_RWLOCK_DESTROY(&p->lbprm.lock);
366 HA_RWLOCK_DESTROY(&p->lock);
Christopher Faulet57962282022-04-25 14:30:58 +0200367
368 proxy_unref_defaults(p);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100369 ha_free(&p);
370}
371
Willy Tarreau977b8e42006-12-29 14:19:17 +0100372/*
Willy Tarreau816eb542007-11-04 07:04:43 +0100373 * This function returns a string containing a name describing capabilities to
374 * report comprehensible error messages. Specifically, it will return the words
Willy Tarreau80dc6fe2021-02-12 09:43:33 +0100375 * "frontend", "backend" when appropriate, "defaults" if it corresponds to a
376 * defaults section, or "proxy" for all other cases including the proxies
377 * declared in "listen" mode.
Willy Tarreau977b8e42006-12-29 14:19:17 +0100378 */
Willy Tarreau816eb542007-11-04 07:04:43 +0100379const char *proxy_cap_str(int cap)
Willy Tarreau977b8e42006-12-29 14:19:17 +0100380{
Willy Tarreau80dc6fe2021-02-12 09:43:33 +0100381 if (cap & PR_CAP_DEF)
382 return "defaults";
383
Willy Tarreau816eb542007-11-04 07:04:43 +0100384 if ((cap & PR_CAP_LISTEN) != PR_CAP_LISTEN) {
385 if (cap & PR_CAP_FE)
386 return "frontend";
387 else if (cap & PR_CAP_BE)
388 return "backend";
Willy Tarreau816eb542007-11-04 07:04:43 +0100389 }
390 return "proxy";
Willy Tarreau977b8e42006-12-29 14:19:17 +0100391}
392
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100393/*
394 * This function returns a string containing the mode of the proxy in a format
395 * suitable for error messages.
396 */
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100397const char *proxy_mode_str(int mode) {
398
399 if (mode == PR_MODE_TCP)
400 return "tcp";
401 else if (mode == PR_MODE_HTTP)
402 return "http";
William Lallemandcf62f7e2018-10-26 14:47:40 +0200403 else if (mode == PR_MODE_CLI)
404 return "cli";
William Lallemand06715af2022-03-08 11:50:59 +0100405 else if (mode == PR_MODE_SYSLOG)
406 return "syslog";
407 else if (mode == PR_MODE_PEERS)
408 return "peers";
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100409 else
410 return "unknown";
411}
412
Willy Tarreau31a3cea2021-03-15 11:11:55 +0100413/* try to find among known options the one that looks closest to <word> by
414 * counting transitions between letters, digits and other characters. Will
415 * return the best matching word if found, otherwise NULL. An optional array
416 * of extra words to compare may be passed in <extra>, but it must then be
417 * terminated by a NULL entry. If unused it may be NULL.
418 */
419const char *proxy_find_best_option(const char *word, const char **extra)
420{
421 uint8_t word_sig[1024];
422 uint8_t list_sig[1024];
423 const char *best_ptr = NULL;
424 int dist, best_dist = INT_MAX;
425 int index;
426
427 make_word_fingerprint(word_sig, word);
428
429 for (index = 0; cfg_opts[index].name; index++) {
430 make_word_fingerprint(list_sig, cfg_opts[index].name);
431 dist = word_fingerprint_distance(word_sig, list_sig);
432 if (dist < best_dist) {
433 best_dist = dist;
434 best_ptr = cfg_opts[index].name;
435 }
436 }
437
438 for (index = 0; cfg_opts2[index].name; index++) {
439 make_word_fingerprint(list_sig, cfg_opts2[index].name);
440 dist = word_fingerprint_distance(word_sig, list_sig);
441 if (dist < best_dist) {
442 best_dist = dist;
443 best_ptr = cfg_opts2[index].name;
444 }
445 }
446
447 while (extra && *extra) {
448 make_word_fingerprint(list_sig, *extra);
449 dist = word_fingerprint_distance(word_sig, list_sig);
450 if (dist < best_dist) {
451 best_dist = dist;
452 best_ptr = *extra;
453 }
454 extra++;
455 }
456
457 if (best_dist > 2 * strlen(word) || (best_ptr && best_dist > 2 * strlen(best_ptr)))
458 best_ptr = NULL;
459 return best_ptr;
460}
461
Willy Tarreauf3950172009-10-10 18:35:51 +0200462/*
463 * This function scans the list of backends and servers to retrieve the first
464 * backend and the first server with the given names, and sets them in both
465 * parameters. It returns zero if either is not found, or non-zero and sets
466 * the ones it did not found to NULL. If a NULL pointer is passed for the
467 * backend, only the pointer to the server will be updated.
468 */
469int get_backend_server(const char *bk_name, const char *sv_name,
470 struct proxy **bk, struct server **sv)
471{
472 struct proxy *p;
473 struct server *s;
Willy Tarreau7ecc4202014-03-15 07:57:11 +0100474 int sid;
Willy Tarreauf3950172009-10-10 18:35:51 +0200475
476 *sv = NULL;
477
Willy Tarreau050536d2012-10-04 08:47:34 +0200478 sid = -1;
Willy Tarreaucfeaa472009-10-10 22:33:08 +0200479 if (*sv_name == '#')
480 sid = atoi(sv_name + 1);
481
Willy Tarreau9e0bb102015-05-26 11:24:42 +0200482 p = proxy_be_by_name(bk_name);
Willy Tarreauf3950172009-10-10 18:35:51 +0200483 if (bk)
484 *bk = p;
485 if (!p)
486 return 0;
487
488 for (s = p->srv; s; s = s->next)
Willy Tarreau4055a102012-11-15 00:15:18 +0100489 if ((sid >= 0 && s->puid == sid) ||
490 (sid < 0 && strcmp(s->id, sv_name) == 0))
Willy Tarreauf3950172009-10-10 18:35:51 +0200491 break;
492 *sv = s;
493 if (!s)
494 return 0;
495 return 1;
496}
497
Willy Tarreaue219db72007-12-03 01:30:13 +0100498/* This function parses a "timeout" statement in a proxy section. It returns
499 * -1 if there is any error, 1 for a warning, otherwise zero. If it does not
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200500 * return zero, it will write an error or warning message into a preallocated
501 * buffer returned at <err>. The trailing is not be written. The function must
502 * be called with <args> pointing to the first command line word, with <proxy>
503 * pointing to the proxy being parsed, and <defpx> to the default proxy or NULL.
504 * As a special case for compatibility with older configs, it also accepts
505 * "{cli|srv|con}timeout" in args[0].
Willy Tarreaue219db72007-12-03 01:30:13 +0100506 */
Willy Tarreau9de1bbd2008-07-09 20:34:27 +0200507static int proxy_parse_timeout(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100508 const struct proxy *defpx, const char *file, int line,
Willy Tarreau28a47d62012-09-18 20:02:48 +0200509 char **err)
Willy Tarreaue219db72007-12-03 01:30:13 +0100510{
511 unsigned timeout;
512 int retval, cap;
513 const char *res, *name;
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200514 int *tv = NULL;
Willy Tarreau01825162021-03-09 09:53:46 +0100515 const int *td = NULL;
Willy Tarreaue219db72007-12-03 01:30:13 +0100516
517 retval = 0;
Willy Tarreau9de1bbd2008-07-09 20:34:27 +0200518
519 /* simply skip "timeout" but remain compatible with old form */
520 if (strcmp(args[0], "timeout") == 0)
521 args++;
522
Willy Tarreaue219db72007-12-03 01:30:13 +0100523 name = args[0];
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100524 if (strcmp(args[0], "client") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100525 name = "client";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100526 tv = &proxy->timeout.client;
527 td = &defpx->timeout.client;
Willy Tarreaue219db72007-12-03 01:30:13 +0100528 cap = PR_CAP_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100529 } else if (strcmp(args[0], "tarpit") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100530 tv = &proxy->timeout.tarpit;
531 td = &defpx->timeout.tarpit;
Willy Tarreau51c9bde2008-01-06 13:40:03 +0100532 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100533 } else if (strcmp(args[0], "http-keep-alive") == 0) {
Willy Tarreaub16a5742010-01-10 14:46:16 +0100534 tv = &proxy->timeout.httpka;
535 td = &defpx->timeout.httpka;
536 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100537 } else if (strcmp(args[0], "http-request") == 0) {
Willy Tarreau036fae02008-01-06 13:24:40 +0100538 tv = &proxy->timeout.httpreq;
539 td = &defpx->timeout.httpreq;
Willy Tarreaucd7afc02009-07-12 10:03:17 +0200540 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100541 } else if (strcmp(args[0], "server") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100542 name = "server";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100543 tv = &proxy->timeout.server;
544 td = &defpx->timeout.server;
Willy Tarreaue219db72007-12-03 01:30:13 +0100545 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100546 } else if (strcmp(args[0], "connect") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100547 name = "connect";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100548 tv = &proxy->timeout.connect;
549 td = &defpx->timeout.connect;
Willy Tarreaue219db72007-12-03 01:30:13 +0100550 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100551 } else if (strcmp(args[0], "check") == 0) {
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +0100552 tv = &proxy->timeout.check;
553 td = &defpx->timeout.check;
554 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100555 } else if (strcmp(args[0], "queue") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100556 tv = &proxy->timeout.queue;
557 td = &defpx->timeout.queue;
558 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100559 } else if (strcmp(args[0], "tunnel") == 0) {
Willy Tarreauce887fd2012-05-12 12:50:00 +0200560 tv = &proxy->timeout.tunnel;
561 td = &defpx->timeout.tunnel;
562 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100563 } else if (strcmp(args[0], "client-fin") == 0) {
Willy Tarreau05cdd962014-05-10 14:30:07 +0200564 tv = &proxy->timeout.clientfin;
565 td = &defpx->timeout.clientfin;
566 cap = PR_CAP_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100567 } else if (strcmp(args[0], "server-fin") == 0) {
Willy Tarreau05cdd962014-05-10 14:30:07 +0200568 tv = &proxy->timeout.serverfin;
569 td = &defpx->timeout.serverfin;
570 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100571 } else if (strcmp(args[0], "clitimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200572 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout client'.", args[0]);
573 return -1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100574 } else if (strcmp(args[0], "srvtimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200575 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout server'.", args[0]);
576 return -1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100577 } else if (strcmp(args[0], "contimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200578 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout connect'.", args[0]);
579 return -1;
Willy Tarreaue219db72007-12-03 01:30:13 +0100580 } else {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200581 memprintf(err,
582 "'timeout' supports 'client', 'server', 'connect', 'check', "
Willy Tarreau05cdd962014-05-10 14:30:07 +0200583 "'queue', 'http-keep-alive', 'http-request', 'tunnel', 'tarpit', "
584 "'client-fin' and 'server-fin' (got '%s')",
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200585 args[0]);
Willy Tarreaue219db72007-12-03 01:30:13 +0100586 return -1;
587 }
588
589 if (*args[1] == 0) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200590 memprintf(err, "'timeout %s' expects an integer value (in milliseconds)", name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100591 return -1;
592 }
593
594 res = parse_time_err(args[1], &timeout, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +0200595 if (res == PARSE_TIME_OVER) {
596 memprintf(err, "timer overflow in argument '%s' to 'timeout %s' (maximum value is 2147483647 ms or ~24.8 days)",
597 args[1], name);
598 return -1;
599 }
600 else if (res == PARSE_TIME_UNDER) {
601 memprintf(err, "timer underflow in argument '%s' to 'timeout %s' (minimum non-null value is 1 ms)",
602 args[1], name);
603 return -1;
604 }
605 else if (res) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200606 memprintf(err, "unexpected character '%c' in 'timeout %s'", *res, name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100607 return -1;
608 }
609
610 if (!(proxy->cap & cap)) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200611 memprintf(err, "'timeout %s' will be ignored because %s '%s' has no %s capability",
612 name, proxy_type_str(proxy), proxy->id,
613 (cap & PR_CAP_BE) ? "backend" : "frontend");
Willy Tarreaue219db72007-12-03 01:30:13 +0100614 retval = 1;
615 }
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200616 else if (defpx && *tv != *td) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200617 memprintf(err, "overwriting 'timeout %s' which was already specified", name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100618 retval = 1;
619 }
620
Willy Tarreaufac5b592014-05-22 08:24:46 +0200621 if (*args[2] != 0) {
622 memprintf(err, "'timeout %s' : unexpected extra argument '%s' after value '%s'.", name, args[2], args[1]);
623 retval = -1;
624 }
625
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200626 *tv = MS_TO_TICKS(timeout);
Willy Tarreaue219db72007-12-03 01:30:13 +0100627 return retval;
628}
629
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100630/* This function parses a "rate-limit" statement in a proxy section. It returns
631 * -1 if there is any error, 1 for a warning, otherwise zero. If it does not
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200632 * return zero, it will write an error or warning message into a preallocated
633 * buffer returned at <err>. The function must be called with <args> pointing
634 * to the first command line word, with <proxy> pointing to the proxy being
635 * parsed, and <defpx> to the default proxy or NULL.
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100636 */
637static int proxy_parse_rate_limit(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100638 const struct proxy *defpx, const char *file, int line,
Willy Tarreau28a47d62012-09-18 20:02:48 +0200639 char **err)
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100640{
William Dauchybb9da0b2020-01-16 01:34:27 +0100641 int retval;
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200642 char *res;
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100643 unsigned int *tv = NULL;
Willy Tarreau01825162021-03-09 09:53:46 +0100644 const unsigned int *td = NULL;
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100645 unsigned int val;
646
647 retval = 0;
648
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200649 if (strcmp(args[1], "sessions") == 0) {
Willy Tarreau13a34bd2009-05-10 18:52:49 +0200650 tv = &proxy->fe_sps_lim;
651 td = &defpx->fe_sps_lim;
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200652 }
653 else {
654 memprintf(err, "'%s' only supports 'sessions' (got '%s')", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100655 return -1;
656 }
657
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200658 if (*args[2] == 0) {
659 memprintf(err, "'%s %s' expects expects an integer value (in sessions/second)", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100660 return -1;
661 }
662
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200663 val = strtoul(args[2], &res, 0);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100664 if (*res) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200665 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 +0100666 return -1;
667 }
668
William Dauchybb9da0b2020-01-16 01:34:27 +0100669 if (!(proxy->cap & PR_CAP_FE)) {
670 memprintf(err, "%s %s will be ignored because %s '%s' has no frontend capability",
671 args[0], args[1], proxy_type_str(proxy), proxy->id);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100672 retval = 1;
673 }
674 else if (defpx && *tv != *td) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200675 memprintf(err, "overwriting %s %s which was already specified", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100676 retval = 1;
677 }
678
679 *tv = val;
680 return retval;
681}
682
Willy Tarreauc35362a2014-04-25 13:58:37 +0200683/* This function parses a "max-keep-alive-queue" statement in a proxy section.
684 * It returns -1 if there is any error, 1 for a warning, otherwise zero. If it
685 * does not return zero, it will write an error or warning message into a
686 * preallocated buffer returned at <err>. The function must be called with
687 * <args> pointing to the first command line word, with <proxy> pointing to
688 * the proxy being parsed, and <defpx> to the default proxy or NULL.
689 */
690static int proxy_parse_max_ka_queue(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100691 const struct proxy *defpx, const char *file, int line,
Willy Tarreauc35362a2014-04-25 13:58:37 +0200692 char **err)
693{
694 int retval;
695 char *res;
696 unsigned int val;
697
698 retval = 0;
699
700 if (*args[1] == 0) {
701 memprintf(err, "'%s' expects expects an integer value (or -1 to disable)", args[0]);
702 return -1;
703 }
704
705 val = strtol(args[1], &res, 0);
706 if (*res) {
707 memprintf(err, "'%s' : unexpected character '%c' in integer value '%s'", args[0], *res, args[1]);
708 return -1;
709 }
710
711 if (!(proxy->cap & PR_CAP_BE)) {
712 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
713 args[0], proxy_type_str(proxy), proxy->id);
714 retval = 1;
715 }
716
717 /* we store <val+1> so that a user-facing value of -1 is stored as zero (default) */
718 proxy->max_ka_queue = val + 1;
719 return retval;
720}
721
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200722/* This function parses a "declare" statement in a proxy section. It returns -1
723 * if there is any error, 1 for warning, otherwise 0. If it does not return zero,
724 * it will write an error or warning message into a preallocated buffer returned
725 * at <err>. The function must be called with <args> pointing to the first command
726 * line word, with <proxy> pointing to the proxy being parsed, and <defpx> to the
727 * default proxy or NULL.
728 */
729static int proxy_parse_declare(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100730 const struct proxy *defpx, const char *file, int line,
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200731 char **err)
732{
733 /* Capture keyword wannot be declared in a default proxy. */
734 if (curpx == defpx) {
Joseph Herlant9edebb82018-11-15 11:50:44 -0800735 memprintf(err, "'%s' not available in default section", args[0]);
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200736 return -1;
737 }
738
Thayne McCombs8f0cc5c2021-01-07 21:35:52 -0700739 /* Capture keyword is only available in frontend. */
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200740 if (!(curpx->cap & PR_CAP_FE)) {
Joseph Herlant9edebb82018-11-15 11:50:44 -0800741 memprintf(err, "'%s' only available in frontend or listen section", args[0]);
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200742 return -1;
743 }
744
745 /* Check mandatory second keyword. */
746 if (!args[1] || !*args[1]) {
747 memprintf(err, "'%s' needs a second keyword that specify the type of declaration ('capture')", args[0]);
748 return -1;
749 }
750
Joseph Herlant59dd2952018-11-15 11:46:55 -0800751 /* Actually, declare is only available for declaring capture
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200752 * slot, but in the future it can declare maps or variables.
Joseph Herlant59dd2952018-11-15 11:46:55 -0800753 * So, this section permits to check and switch according with
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200754 * the second keyword.
755 */
756 if (strcmp(args[1], "capture") == 0) {
757 char *error = NULL;
758 long len;
759 struct cap_hdr *hdr;
760
761 /* Check the next keyword. */
762 if (!args[2] || !*args[2] ||
763 (strcmp(args[2], "response") != 0 &&
764 strcmp(args[2], "request") != 0)) {
765 memprintf(err, "'%s %s' requires a direction ('request' or 'response')", args[0], args[1]);
766 return -1;
767 }
768
769 /* Check the 'len' keyword. */
770 if (!args[3] || !*args[3] || strcmp(args[3], "len") != 0) {
771 memprintf(err, "'%s %s' requires a capture length ('len')", args[0], args[1]);
772 return -1;
773 }
774
775 /* Check the length value. */
776 if (!args[4] || !*args[4]) {
777 memprintf(err, "'%s %s': 'len' requires a numeric value that represents the "
778 "capture length",
779 args[0], args[1]);
780 return -1;
781 }
782
783 /* convert the length value. */
784 len = strtol(args[4], &error, 10);
785 if (*error != '\0') {
786 memprintf(err, "'%s %s': cannot parse the length '%s'.",
787 args[0], args[1], args[3]);
788 return -1;
789 }
790
791 /* check length. */
792 if (len <= 0) {
793 memprintf(err, "length must be > 0");
794 return -1;
795 }
796
797 /* register the capture. */
Vincent Bernat02779b62016-04-03 13:48:43 +0200798 hdr = calloc(1, sizeof(*hdr));
Remi Tricot-Le Breton55ba0d62021-05-12 18:04:46 +0200799 if (!hdr) {
800 memprintf(err, "proxy '%s': out of memory while registering a capture", curpx->id);
801 return -1;
802 }
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200803 hdr->name = NULL; /* not a header capture */
804 hdr->namelen = 0;
805 hdr->len = len;
806 hdr->pool = create_pool("caphdr", hdr->len + 1, MEM_F_SHARED);
807
808 if (strcmp(args[2], "request") == 0) {
809 hdr->next = curpx->req_cap;
810 hdr->index = curpx->nb_req_cap++;
811 curpx->req_cap = hdr;
812 }
813 if (strcmp(args[2], "response") == 0) {
814 hdr->next = curpx->rsp_cap;
815 hdr->index = curpx->nb_rsp_cap++;
816 curpx->rsp_cap = hdr;
817 }
818 return 0;
819 }
820 else {
821 memprintf(err, "unknown declaration type '%s' (supports 'capture')", args[1]);
822 return -1;
823 }
824}
825
Olivier Houcharda254a372019-04-05 15:30:12 +0200826/* This function parses a "retry-on" statement */
827static int
828proxy_parse_retry_on(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100829 const struct proxy *defpx, const char *file, int line,
Olivier Houcharda254a372019-04-05 15:30:12 +0200830 char **err)
831{
832 int i;
833
834 if (!(*args[1])) {
835 memprintf(err, "'%s' needs at least one keyword to specify when to retry", args[0]);
836 return -1;
837 }
838 if (!(curpx->cap & PR_CAP_BE)) {
839 memprintf(err, "'%s' only available in backend or listen section", args[0]);
840 return -1;
841 }
842 curpx->retry_type = 0;
843 for (i = 1; *(args[i]); i++) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100844 if (strcmp(args[i], "conn-failure") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200845 curpx->retry_type |= PR_RE_CONN_FAILED;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100846 else if (strcmp(args[i], "empty-response") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200847 curpx->retry_type |= PR_RE_DISCONNECTED;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100848 else if (strcmp(args[i], "response-timeout") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200849 curpx->retry_type |= PR_RE_TIMEOUT;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100850 else if (strcmp(args[i], "401") == 0)
Julien Pivotto2de240a2020-11-12 11:14:05 +0100851 curpx->retry_type |= PR_RE_401;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100852 else if (strcmp(args[i], "403") == 0)
Julien Pivotto2de240a2020-11-12 11:14:05 +0100853 curpx->retry_type |= PR_RE_403;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100854 else if (strcmp(args[i], "404") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200855 curpx->retry_type |= PR_RE_404;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100856 else if (strcmp(args[i], "408") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200857 curpx->retry_type |= PR_RE_408;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100858 else if (strcmp(args[i], "425") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200859 curpx->retry_type |= PR_RE_425;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100860 else if (strcmp(args[i], "500") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200861 curpx->retry_type |= PR_RE_500;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100862 else if (strcmp(args[i], "501") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200863 curpx->retry_type |= PR_RE_501;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100864 else if (strcmp(args[i], "502") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200865 curpx->retry_type |= PR_RE_502;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100866 else if (strcmp(args[i], "503") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200867 curpx->retry_type |= PR_RE_503;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100868 else if (strcmp(args[i], "504") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200869 curpx->retry_type |= PR_RE_504;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100870 else if (strcmp(args[i], "0rtt-rejected") == 0)
Olivier Houchard865d8392019-05-03 22:46:27 +0200871 curpx->retry_type |= PR_RE_EARLY_ERROR;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100872 else if (strcmp(args[i], "junk-response") == 0)
Olivier Houcharde3249a92019-05-03 23:01:47 +0200873 curpx->retry_type |= PR_RE_JUNK_REQUEST;
Olivier Houchardddf0e032019-05-10 18:05:40 +0200874 else if (!(strcmp(args[i], "all-retryable-errors")))
875 curpx->retry_type |= PR_RE_CONN_FAILED | PR_RE_DISCONNECTED |
876 PR_RE_TIMEOUT | PR_RE_500 | PR_RE_502 |
877 PR_RE_503 | PR_RE_504 | PR_RE_EARLY_ERROR |
878 PR_RE_JUNK_REQUEST;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100879 else if (strcmp(args[i], "none") == 0) {
Olivier Houcharda254a372019-04-05 15:30:12 +0200880 if (i != 1 || *args[i + 1]) {
881 memprintf(err, "'%s' 'none' keyworld only usable alone", args[0]);
882 return -1;
883 }
884 } else {
885 memprintf(err, "'%s': unknown keyword '%s'", args[0], args[i]);
886 return -1;
887 }
888
889 }
890
891
892 return 0;
893}
894
Willy Tarreau52543212020-07-09 05:58:51 +0200895#ifdef TCP_KEEPCNT
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900896/* This function parses "{cli|srv}tcpka-cnt" statements */
897static int proxy_parse_tcpka_cnt(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100898 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900899 char **err)
900{
901 int retval;
902 char *res;
903 unsigned int tcpka_cnt;
904
905 retval = 0;
906
907 if (*args[1] == 0) {
908 memprintf(err, "'%s' expects an integer value", args[0]);
909 return -1;
910 }
911
912 tcpka_cnt = strtol(args[1], &res, 0);
913 if (*res) {
914 memprintf(err, "'%s' : unexpected character '%c' in integer value '%s'", args[0], *res, args[1]);
915 return -1;
916 }
917
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100918 if (strcmp(args[0], "clitcpka-cnt") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900919 if (!(proxy->cap & PR_CAP_FE)) {
920 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
921 args[0], proxy_type_str(proxy), proxy->id);
922 retval = 1;
923 }
924 proxy->clitcpka_cnt = tcpka_cnt;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100925 } else if (strcmp(args[0], "srvtcpka-cnt") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900926 if (!(proxy->cap & PR_CAP_BE)) {
927 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
928 args[0], proxy_type_str(proxy), proxy->id);
929 retval = 1;
930 }
931 proxy->srvtcpka_cnt = tcpka_cnt;
932 } else {
933 /* unreachable */
934 memprintf(err, "'%s': unknown keyword", args[0]);
935 return -1;
936 }
937
938 return retval;
939}
Willy Tarreau52543212020-07-09 05:58:51 +0200940#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900941
Willy Tarreau52543212020-07-09 05:58:51 +0200942#ifdef TCP_KEEPIDLE
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900943/* This function parses "{cli|srv}tcpka-idle" statements */
944static int proxy_parse_tcpka_idle(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100945 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900946 char **err)
947{
948 int retval;
949 const char *res;
950 unsigned int tcpka_idle;
951
952 retval = 0;
953
954 if (*args[1] == 0) {
955 memprintf(err, "'%s' expects an integer value", args[0]);
956 return -1;
957 }
958 res = parse_time_err(args[1], &tcpka_idle, TIME_UNIT_S);
959 if (res == PARSE_TIME_OVER) {
960 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
961 args[1], args[0]);
962 return -1;
963 }
964 else if (res == PARSE_TIME_UNDER) {
965 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
966 args[1], args[0]);
967 return -1;
968 }
969 else if (res) {
970 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
971 return -1;
972 }
973
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100974 if (strcmp(args[0], "clitcpka-idle") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900975 if (!(proxy->cap & PR_CAP_FE)) {
976 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
977 args[0], proxy_type_str(proxy), proxy->id);
978 retval = 1;
979 }
980 proxy->clitcpka_idle = tcpka_idle;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100981 } else if (strcmp(args[0], "srvtcpka-idle") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900982 if (!(proxy->cap & PR_CAP_BE)) {
983 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
984 args[0], proxy_type_str(proxy), proxy->id);
985 retval = 1;
986 }
987 proxy->srvtcpka_idle = tcpka_idle;
988 } else {
989 /* unreachable */
990 memprintf(err, "'%s': unknown keyword", args[0]);
991 return -1;
992 }
993
994 return retval;
995}
Willy Tarreau52543212020-07-09 05:58:51 +0200996#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900997
Willy Tarreau52543212020-07-09 05:58:51 +0200998#ifdef TCP_KEEPINTVL
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900999/* This function parses "{cli|srv}tcpka-intvl" statements */
1000static int proxy_parse_tcpka_intvl(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +01001001 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001002 char **err)
1003{
1004 int retval;
1005 const char *res;
1006 unsigned int tcpka_intvl;
1007
1008 retval = 0;
1009
1010 if (*args[1] == 0) {
1011 memprintf(err, "'%s' expects an integer value", args[0]);
1012 return -1;
1013 }
1014 res = parse_time_err(args[1], &tcpka_intvl, TIME_UNIT_S);
1015 if (res == PARSE_TIME_OVER) {
1016 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
1017 args[1], args[0]);
1018 return -1;
1019 }
1020 else if (res == PARSE_TIME_UNDER) {
1021 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
1022 args[1], args[0]);
1023 return -1;
1024 }
1025 else if (res) {
1026 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
1027 return -1;
1028 }
1029
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001030 if (strcmp(args[0], "clitcpka-intvl") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001031 if (!(proxy->cap & PR_CAP_FE)) {
1032 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
1033 args[0], proxy_type_str(proxy), proxy->id);
1034 retval = 1;
1035 }
1036 proxy->clitcpka_intvl = tcpka_intvl;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001037 } else if (strcmp(args[0], "srvtcpka-intvl") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001038 if (!(proxy->cap & PR_CAP_BE)) {
1039 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
1040 args[0], proxy_type_str(proxy), proxy->id);
1041 retval = 1;
1042 }
1043 proxy->srvtcpka_intvl = tcpka_intvl;
1044 } else {
1045 /* unreachable */
1046 memprintf(err, "'%s': unknown keyword", args[0]);
1047 return -1;
1048 }
1049
1050 return retval;
1051}
Willy Tarreau52543212020-07-09 05:58:51 +02001052#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001053
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001054/* This function inserts proxy <px> into the tree of known proxies (regular
1055 * ones or defaults depending on px->cap & PR_CAP_DEF). The proxy's name is
1056 * used as the storing key so it must already have been initialized.
Willy Tarreauf79d9502014-03-15 07:22:35 +01001057 */
1058void proxy_store_name(struct proxy *px)
1059{
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001060 struct eb_root *root = (px->cap & PR_CAP_DEF) ? &defproxy_by_name : &proxy_by_name;
1061
Willy Tarreauf79d9502014-03-15 07:22:35 +01001062 px->conf.by_name.key = px->id;
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001063 ebis_insert(root, &px->conf.by_name);
Willy Tarreauf79d9502014-03-15 07:22:35 +01001064}
1065
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001066/* Returns a pointer to the first proxy matching capabilities <cap> and id
1067 * <id>. NULL is returned if no match is found. If <table> is non-zero, it
1068 * only considers proxies having a table.
Willy Tarreaubc216c42011-08-02 11:25:54 +02001069 */
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001070struct proxy *proxy_find_by_id(int id, int cap, int table)
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001071{
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001072 struct eb32_node *n;
Willy Tarreaubc216c42011-08-02 11:25:54 +02001073
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001074 for (n = eb32_lookup(&used_proxy_id, id); n; n = eb32_next(n)) {
1075 struct proxy *px = container_of(n, struct proxy, conf.id);
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001076
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001077 if (px->uuid != id)
1078 break;
Alex Williams96532db2009-11-01 21:27:13 -05001079
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001080 if ((px->cap & cap) != cap)
1081 continue;
Alex Williams96532db2009-11-01 21:27:13 -05001082
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001083 if (table && (!px->table || !px->table->size))
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001084 continue;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001085
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001086 return px;
1087 }
1088 return NULL;
1089}
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001090
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001091/* Returns a pointer to the first proxy matching either name <name>, or id
1092 * <name> if <name> begins with a '#'. NULL is returned if no match is found.
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001093 * If <table> is non-zero, it only considers proxies having a table. The search
1094 * is made into the regular proxies, unless <cap> has PR_CAP_DEF set in which
1095 * case it's searched into the defproxy tree.
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001096 */
1097struct proxy *proxy_find_by_name(const char *name, int cap, int table)
1098{
1099 struct proxy *curproxy;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001100
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001101 if (*name == '#' && !(cap & PR_CAP_DEF)) {
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001102 curproxy = proxy_find_by_id(atoi(name + 1), cap, table);
1103 if (curproxy)
Willy Tarreauc739aa82015-05-26 11:35:41 +02001104 return curproxy;
Alex Williams96532db2009-11-01 21:27:13 -05001105 }
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001106 else {
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001107 struct eb_root *root;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001108 struct ebpt_node *node;
1109
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001110 root = (cap & PR_CAP_DEF) ? &defproxy_by_name : &proxy_by_name;
1111 for (node = ebis_lookup(root, name); node; node = ebpt_next(node)) {
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001112 curproxy = container_of(node, struct proxy, conf.by_name);
Alex Williams96532db2009-11-01 21:27:13 -05001113
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001114 if (strcmp(curproxy->id, name) != 0)
1115 break;
1116
1117 if ((curproxy->cap & cap) != cap)
1118 continue;
1119
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001120 if (table && (!curproxy->table || !curproxy->table->size))
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001121 continue;
1122
Willy Tarreauc739aa82015-05-26 11:35:41 +02001123 return curproxy;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001124 }
1125 }
Willy Tarreauc739aa82015-05-26 11:35:41 +02001126 return NULL;
Alex Williams96532db2009-11-01 21:27:13 -05001127}
1128
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001129/* Finds the best match for a proxy with capabilities <cap>, name <name> and id
1130 * <id>. At most one of <id> or <name> may be different provided that <cap> is
1131 * valid. Either <id> or <name> may be left unspecified (0). The purpose is to
1132 * find a proxy based on some information from a previous configuration, across
1133 * reloads or during information exchange between peers.
1134 *
1135 * Names are looked up first if present, then IDs are compared if present. In
1136 * case of an inexact match whatever is forced in the configuration has
1137 * precedence in the following order :
1138 * - 1) forced ID (proves a renaming / change of proxy type)
1139 * - 2) proxy name+type (may indicate a move if ID differs)
1140 * - 3) automatic ID+type (may indicate a renaming)
1141 *
1142 * Depending on what is found, we can end up in the following situations :
1143 *
1144 * name id cap | possible causes
1145 * -------------+-----------------
1146 * -- -- -- | nothing found
1147 * -- -- ok | nothing found
1148 * -- ok -- | proxy deleted, ID points to next one
1149 * -- ok ok | proxy renamed, or deleted with ID pointing to next one
1150 * ok -- -- | proxy deleted, but other half with same name still here (before)
1151 * ok -- ok | proxy's ID changed (proxy moved in the config file)
1152 * ok ok -- | proxy deleted, but other half with same name still here (after)
1153 * ok ok ok | perfect match
1154 *
1155 * Upon return if <diff> is not NULL, it is zeroed then filled with up to 3 bits :
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001156 * - PR_FBM_MISMATCH_ID : proxy was found but ID differs
1157 * (and ID was not zero)
1158 * - PR_FBM_MISMATCH_NAME : proxy was found by ID but name differs
1159 * (and name was not NULL)
1160 * - PR_FBM_MISMATCH_PROXYTYPE : a proxy of different type was found with
1161 * the same name and/or id
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001162 *
1163 * Only a valid proxy is returned. If capabilities do not match, NULL is
1164 * returned. The caller can check <diff> to report detailed warnings / errors,
1165 * and decide whether or not to use what was found.
1166 */
1167struct proxy *proxy_find_best_match(int cap, const char *name, int id, int *diff)
1168{
1169 struct proxy *byname;
1170 struct proxy *byid;
1171
1172 if (!name && !id)
1173 return NULL;
1174
1175 if (diff)
1176 *diff = 0;
1177
1178 byname = byid = NULL;
1179
1180 if (name) {
1181 byname = proxy_find_by_name(name, cap, 0);
1182 if (byname && (!id || byname->uuid == id))
1183 return byname;
1184 }
1185
Joseph Herlant59dd2952018-11-15 11:46:55 -08001186 /* remaining possibilities :
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001187 * - name not set
1188 * - name set but not found
1189 * - name found, but ID doesn't match.
1190 */
1191 if (id) {
1192 byid = proxy_find_by_id(id, cap, 0);
1193 if (byid) {
1194 if (byname) {
1195 /* id+type found, name+type found, but not all 3.
1196 * ID wins only if forced, otherwise name wins.
1197 */
1198 if (byid->options & PR_O_FORCED_ID) {
1199 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001200 *diff |= PR_FBM_MISMATCH_NAME;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001201 return byid;
1202 }
1203 else {
1204 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001205 *diff |= PR_FBM_MISMATCH_ID;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001206 return byname;
1207 }
1208 }
1209
Joseph Herlant59dd2952018-11-15 11:46:55 -08001210 /* remaining possibilities :
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001211 * - name not set
1212 * - name set but not found
1213 */
1214 if (name && diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001215 *diff |= PR_FBM_MISMATCH_NAME;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001216 return byid;
1217 }
1218
1219 /* ID not found */
1220 if (byname) {
1221 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001222 *diff |= PR_FBM_MISMATCH_ID;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001223 return byname;
1224 }
1225 }
1226
Joseph Herlant59dd2952018-11-15 11:46:55 -08001227 /* All remaining possibilities will lead to NULL. If we can report more
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001228 * detailed information to the caller about changed types and/or name,
1229 * we'll do it. For example, we could detect that "listen foo" was
1230 * split into "frontend foo_ft" and "backend foo_bk" if IDs are forced.
1231 * - name not set, ID not found
1232 * - name not found, ID not set
1233 * - name not found, ID not found
1234 */
1235 if (!diff)
1236 return NULL;
1237
1238 if (name) {
1239 byname = proxy_find_by_name(name, 0, 0);
1240 if (byname && (!id || byname->uuid == id))
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001241 *diff |= PR_FBM_MISMATCH_PROXYTYPE;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001242 }
1243
1244 if (id) {
1245 byid = proxy_find_by_id(id, 0, 0);
1246 if (byid) {
1247 if (!name)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001248 *diff |= PR_FBM_MISMATCH_PROXYTYPE; /* only type changed */
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001249 else if (byid->options & PR_O_FORCED_ID)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001250 *diff |= PR_FBM_MISMATCH_NAME | PR_FBM_MISMATCH_PROXYTYPE; /* name and type changed */
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001251 /* otherwise it's a different proxy that was returned */
1252 }
1253 }
1254 return NULL;
1255}
1256
Willy Tarreaubaaee002006-06-26 02:48:02 +02001257/*
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001258 * This function finds a server with matching name within selected proxy.
1259 * It also checks if there are more matching servers with
1260 * requested name as this often leads into unexpected situations.
1261 */
1262
1263struct server *findserver(const struct proxy *px, const char *name) {
1264
1265 struct server *cursrv, *target = NULL;
1266
1267 if (!px)
1268 return NULL;
1269
1270 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001271 if (strcmp(cursrv->id, name) != 0)
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001272 continue;
1273
1274 if (!target) {
1275 target = cursrv;
1276 continue;
1277 }
1278
Christopher Faulet767a84b2017-11-24 16:50:31 +01001279 ha_alert("Refusing to use duplicated server '%s' found in proxy: %s!\n",
1280 name, px->id);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001281
1282 return NULL;
1283 }
1284
1285 return target;
1286}
1287
Aurelien DARRAGON4e5e2662023-02-22 09:55:05 +01001288/*
1289 * This function finds a server with matching "<puid> x <rid>" within
1290 * selected proxy <px>.
1291 * Using the combination of proxy-uid + revision id ensures that the function
1292 * will either return the server we're expecting or NULL if it has been removed
1293 * from the proxy.
1294 */
1295struct server *findserver_unique_id(const struct proxy *px, int puid, uint32_t rid) {
1296
1297 struct server *cursrv;
1298
1299 if (!px)
1300 return NULL;
1301
1302 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
1303 if (cursrv->puid == puid && cursrv->rid == rid)
1304 return cursrv;
1305 }
1306
1307 return NULL;
1308}
1309
1310/*
1311 * This function finds a server with matching "<name> x <rid>" within
1312 * selected proxy <px>.
1313 * Using the combination of name + revision id ensures that the function will
1314 * either return the server we're expecting or NULL if it has been removed
1315 * from the proxy.
1316 */
1317struct server *findserver_unique_name(const struct proxy *px, const char *name, uint32_t rid) {
1318
1319 struct server *cursrv;
1320
1321 if (!px)
1322 return NULL;
1323
1324 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
1325 if (!strcmp(cursrv->id, name) && cursrv->rid == rid)
1326 return cursrv;
1327 }
1328
1329 return NULL;
1330}
1331
Willy Tarreauff01a212009-03-15 13:46:16 +01001332/* This function checks that the designated proxy has no http directives
1333 * enabled. It will output a warning if there are, and will fix some of them.
1334 * It returns the number of fatal errors encountered. This should be called
1335 * at the end of the configuration parsing if the proxy is not in http mode.
1336 * The <file> argument is used to construct the error message.
1337 */
Willy Tarreau915e1eb2009-06-22 15:48:36 +02001338int proxy_cfg_ensure_no_http(struct proxy *curproxy)
Willy Tarreauff01a212009-03-15 13:46:16 +01001339{
1340 if (curproxy->cookie_name != NULL) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001341 ha_warning("cookie will be ignored for %s '%s' (needs 'mode http').\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001342 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001343 }
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001344 if (isttest(curproxy->monitor_uri)) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001345 ha_warning("monitor-uri will be ignored for %s '%s' (needs 'mode http').\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001346 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001347 }
Willy Tarreauf3e49f92009-10-03 12:21:20 +02001348 if (curproxy->lbprm.algo & BE_LB_NEED_HTTP) {
Willy Tarreauff01a212009-03-15 13:46:16 +01001349 curproxy->lbprm.algo &= ~BE_LB_ALGO;
1350 curproxy->lbprm.algo |= BE_LB_ALGO_RR;
Amaury Denoyelle11124302021-06-04 18:22:08 +02001351 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 +01001352 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001353 }
Willy Tarreau17804162009-11-09 21:27:51 +01001354 if (curproxy->to_log & (LW_REQ | LW_RESP)) {
1355 curproxy->to_log &= ~(LW_REQ | LW_RESP);
Christopher Faulet767a84b2017-11-24 16:50:31 +01001356 ha_warning("parsing [%s:%d] : HTTP log/header format not usable with %s '%s' (needs 'mode http').\n",
1357 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1358 proxy_type_str(curproxy), curproxy->id);
Willy Tarreau17804162009-11-09 21:27:51 +01001359 }
Willy Tarreau62a61232013-04-12 18:13:46 +02001360 if (curproxy->conf.logformat_string == default_http_log_format ||
1361 curproxy->conf.logformat_string == clf_http_log_format) {
1362 /* Note: we don't change the directive's file:line number */
1363 curproxy->conf.logformat_string = default_tcp_log_format;
Christopher Faulet767a84b2017-11-24 16:50:31 +01001364 ha_warning("parsing [%s:%d] : 'option httplog' not usable with %s '%s' (needs 'mode http'). Falling back to 'option tcplog'.\n",
1365 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1366 proxy_type_str(curproxy), curproxy->id);
Willy Tarreau196729e2012-05-31 19:30:26 +02001367 }
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001368 else if (curproxy->conf.logformat_string == default_https_log_format) {
1369 /* Note: we don't change the directive's file:line number */
1370 curproxy->conf.logformat_string = default_tcp_log_format;
1371 ha_warning("parsing [%s:%d] : 'option httpslog' not usable with %s '%s' (needs 'mode http'). Falling back to 'option tcplog'.\n",
1372 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1373 proxy_type_str(curproxy), curproxy->id);
1374 }
Willy Tarreau196729e2012-05-31 19:30:26 +02001375
Willy Tarreauff01a212009-03-15 13:46:16 +01001376 return 0;
1377}
1378
Willy Tarreau237250c2011-07-29 01:49:03 +02001379/* Perform the most basic initialization of a proxy :
1380 * memset(), list_init(*), reset_timeouts(*).
Willy Tarreaub249e842011-09-07 18:41:08 +02001381 * Any new proxy or peer should be initialized via this function.
Willy Tarreau237250c2011-07-29 01:49:03 +02001382 */
1383void init_new_proxy(struct proxy *p)
1384{
1385 memset(p, 0, sizeof(struct proxy));
Willy Tarreau3fdb3662012-11-12 00:42:33 +01001386 p->obj_type = OBJ_TYPE_PROXY;
Willy Tarreaucdc83e02021-06-23 16:11:02 +02001387 queue_init(&p->queue, p, NULL);
Willy Tarreau237250c2011-07-29 01:49:03 +02001388 LIST_INIT(&p->acl);
1389 LIST_INIT(&p->http_req_rules);
Willy Tarreaue365c0b2013-06-11 16:06:12 +02001390 LIST_INIT(&p->http_res_rules);
Christopher Faulet6d0c3df2020-01-22 09:26:35 +01001391 LIST_INIT(&p->http_after_res_rules);
Willy Tarreau237250c2011-07-29 01:49:03 +02001392 LIST_INIT(&p->redirect_rules);
1393 LIST_INIT(&p->mon_fail_cond);
1394 LIST_INIT(&p->switching_rules);
Willy Tarreau4a5cade2012-04-05 21:09:48 +02001395 LIST_INIT(&p->server_rules);
Willy Tarreau237250c2011-07-29 01:49:03 +02001396 LIST_INIT(&p->persist_rules);
1397 LIST_INIT(&p->sticking_rules);
1398 LIST_INIT(&p->storersp_rules);
1399 LIST_INIT(&p->tcp_req.inspect_rules);
1400 LIST_INIT(&p->tcp_rep.inspect_rules);
1401 LIST_INIT(&p->tcp_req.l4_rules);
Willy Tarreau620408f2016-10-21 16:37:51 +02001402 LIST_INIT(&p->tcp_req.l5_rules);
Olivier Houchard859dc802019-08-08 15:47:21 +02001403 MT_LIST_INIT(&p->listener_queue);
William Lallemand0f99e342011-10-12 17:50:54 +02001404 LIST_INIT(&p->logsrvs);
William Lallemand723b73a2012-02-08 16:37:49 +01001405 LIST_INIT(&p->logformat);
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001406 LIST_INIT(&p->logformat_sd);
William Lallemanda73203e2012-03-12 12:48:57 +01001407 LIST_INIT(&p->format_unique_id);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001408 LIST_INIT(&p->logformat_error);
Willy Tarreau2a65ff02012-09-13 17:54:29 +02001409 LIST_INIT(&p->conf.bind);
Willy Tarreau4348fad2012-09-20 16:48:07 +02001410 LIST_INIT(&p->conf.listeners);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001411 LIST_INIT(&p->conf.errors);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001412 LIST_INIT(&p->conf.args.list);
Christopher Faulet443ea1a2016-02-04 13:40:26 +01001413 LIST_INIT(&p->filter_configs);
Christopher Faulet7a1e2e12020-04-02 18:05:11 +02001414 LIST_INIT(&p->tcpcheck_rules.preset_vars);
Willy Tarreau237250c2011-07-29 01:49:03 +02001415
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001416 p->defsrv.id = "default-server";
1417 p->conf.used_listener_id = EB_ROOT;
1418 p->conf.used_server_id = EB_ROOT;
1419 p->used_server_addr = EB_ROOT_UNIQUE;
1420
Willy Tarreau237250c2011-07-29 01:49:03 +02001421 /* Timeouts are defined as -1 */
1422 proxy_reset_timeouts(p);
1423 p->tcp_rep.inspect_delay = TICK_ETERNITY;
Willy Tarreau050536d2012-10-04 08:47:34 +02001424
1425 /* initial uuid is unassigned (-1) */
1426 p->uuid = -1;
Christopher Fauletff8abcd2017-06-02 15:33:24 +02001427
Olivier Houcharda254a372019-04-05 15:30:12 +02001428 /* Default to only allow L4 retries */
1429 p->retry_type = PR_RE_CONN_FAILED;
1430
Amaury Denoyelle7f8f6cb2020-11-10 14:24:31 +01001431 p->extra_counters_fe = NULL;
1432 p->extra_counters_be = NULL;
1433
Willy Tarreauac66d6b2020-10-20 17:24:27 +02001434 HA_RWLOCK_INIT(&p->lock);
Willy Tarreau489f0742023-11-13 09:17:05 +01001435
1436 /* initialize the default settings */
1437 proxy_preset_defaults(p);
Willy Tarreau237250c2011-07-29 01:49:03 +02001438}
1439
Willy Tarreau144289b2021-02-12 08:19:01 +01001440/* Preset default settings onto proxy <defproxy>. */
1441void proxy_preset_defaults(struct proxy *defproxy)
1442{
1443 defproxy->mode = PR_MODE_TCP;
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001444 defproxy->flags = 0;
William Lallemand6bb77b92021-07-28 15:48:16 +02001445 if (!(defproxy->cap & PR_CAP_INT)) {
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001446 defproxy->maxconn = cfg_maxpconn;
1447 defproxy->conn_retries = CONN_RETRIES;
1448 }
Willy Tarreau144289b2021-02-12 08:19:01 +01001449 defproxy->redispatch_after = 0;
1450 defproxy->options = PR_O_REUSE_SAFE;
William Lallemand6bb77b92021-07-28 15:48:16 +02001451 if (defproxy->cap & PR_CAP_INT)
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001452 defproxy->options2 |= PR_O2_INDEPSTR;
Willy Tarreau144289b2021-02-12 08:19:01 +01001453 defproxy->max_out_conns = MAX_SRV_LIST;
1454
Amaury Denoyelle5cc599e2024-02-27 15:33:59 +01001455 srv_settings_init(&defproxy->defsrv);
Willy Tarreau144289b2021-02-12 08:19:01 +01001456
1457 defproxy->email_alert.level = LOG_ALERT;
1458 defproxy->load_server_state_from_file = PR_SRV_STATE_FILE_UNSPEC;
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001459
William Lallemand6bb77b92021-07-28 15:48:16 +02001460 if (defproxy->cap & PR_CAP_INT)
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001461 defproxy->timeout.connect = 5000;
Willy Tarreau144289b2021-02-12 08:19:01 +01001462}
1463
Willy Tarreaua3320a02021-02-12 10:38:49 +01001464/* Frees all dynamic settings allocated on a default proxy that's about to be
1465 * destroyed. This is a subset of the complete proxy deinit code, but these
1466 * should probably be merged ultimately. Note that most of the fields are not
1467 * even reset, so extreme care is required here, and calling
1468 * proxy_preset_defaults() afterwards would be safer.
1469 */
1470void proxy_free_defaults(struct proxy *defproxy)
1471{
Christopher Faulet6db9a972021-10-15 14:33:34 +02001472 struct acl *acl, *aclb;
Willy Tarreau211ea252022-03-17 19:47:33 +01001473 struct logsrv *log, *logb;
Christopher Faulet57962282022-04-25 14:30:58 +02001474 struct cap_hdr *h,*h_next;
Christopher Faulet6db9a972021-10-15 14:33:34 +02001475
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001476 ha_free(&defproxy->id);
1477 ha_free(&defproxy->conf.file);
Willy Tarreau8bb771a2023-11-23 14:28:14 +01001478 ha_free((char **)&defproxy->defsrv.conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001479 ha_free(&defproxy->check_command);
1480 ha_free(&defproxy->check_path);
1481 ha_free(&defproxy->cookie_name);
1482 ha_free(&defproxy->rdp_cookie_name);
1483 ha_free(&defproxy->dyncookie_key);
1484 ha_free(&defproxy->cookie_domain);
1485 ha_free(&defproxy->cookie_attrs);
1486 ha_free(&defproxy->lbprm.arg_str);
1487 ha_free(&defproxy->capture_name);
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001488 istfree(&defproxy->monitor_uri);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001489 ha_free(&defproxy->defbe.name);
1490 ha_free(&defproxy->conn_src.iface_name);
Tim Duesterhusb4b03772022-03-05 00:52:43 +01001491 istfree(&defproxy->server_id_hdr_name);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001492
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +01001493 http_ext_clean(defproxy);
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +01001494
Christopher Faulet6db9a972021-10-15 14:33:34 +02001495 list_for_each_entry_safe(acl, aclb, &defproxy->acl, list) {
1496 LIST_DELETE(&acl->list);
1497 prune_acl(acl);
1498 free(acl);
1499 }
1500
1501 free_act_rules(&defproxy->tcp_req.inspect_rules);
1502 free_act_rules(&defproxy->tcp_rep.inspect_rules);
1503 free_act_rules(&defproxy->tcp_req.l4_rules);
1504 free_act_rules(&defproxy->tcp_req.l5_rules);
1505 free_act_rules(&defproxy->http_req_rules);
1506 free_act_rules(&defproxy->http_res_rules);
1507 free_act_rules(&defproxy->http_after_res_rules);
1508
Christopher Faulet57962282022-04-25 14:30:58 +02001509 h = defproxy->req_cap;
1510 while (h) {
1511 h_next = h->next;
1512 free(h->name);
1513 pool_destroy(h->pool);
1514 free(h);
1515 h = h_next;
1516 }
1517
1518 h = defproxy->rsp_cap;
1519 while (h) {
1520 h_next = h->next;
1521 free(h->name);
1522 pool_destroy(h->pool);
1523 free(h);
1524 h = h_next;
1525 }
1526
Willy Tarreaua3320a02021-02-12 10:38:49 +01001527 if (defproxy->conf.logformat_string != default_http_log_format &&
1528 defproxy->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001529 defproxy->conf.logformat_string != clf_http_log_format &&
1530 defproxy->conf.logformat_string != default_https_log_format) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001531 ha_free(&defproxy->conf.logformat_string);
Willy Tarreau818ec782021-02-12 10:48:53 +01001532 }
Willy Tarreaua3320a02021-02-12 10:38:49 +01001533
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001534 if (defproxy->conf.logformat_sd_string != default_rfc5424_sd_log_format)
1535 ha_free(&defproxy->conf.logformat_sd_string);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001536
Willy Tarreau211ea252022-03-17 19:47:33 +01001537 list_for_each_entry_safe(log, logb, &defproxy->logsrvs, list) {
1538 LIST_DEL_INIT(&log->list);
1539 free_logsrv(log);
1540 }
1541
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001542 ha_free(&defproxy->conf.uniqueid_format_string);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001543 ha_free(&defproxy->conf.error_logformat_string);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001544 ha_free(&defproxy->conf.lfs_file);
1545 ha_free(&defproxy->conf.lfsd_file);
1546 ha_free(&defproxy->conf.uif_file);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001547 ha_free(&defproxy->conf.elfs_file);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001548 chunk_destroy(&defproxy->log_tag);
1549
1550 free_email_alert(defproxy);
1551 proxy_release_conf_errors(defproxy);
1552 deinit_proxy_tcpcheck(defproxy);
1553
1554 /* FIXME: we cannot free uri_auth because it might already be used by
1555 * another proxy (legacy code for stats URI ...). Refcount anyone ?
1556 */
1557}
1558
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001559/* delete a defproxy from the tree if still in it, frees its content and its
1560 * storage. Nothing is done if <px> is NULL or if it doesn't have PR_CAP_DEF
1561 * set, allowing to pass it the direct result of a lookup function.
1562 */
1563void proxy_destroy_defaults(struct proxy *px)
1564{
1565 if (!px)
1566 return;
1567 if (!(px->cap & PR_CAP_DEF))
1568 return;
Christopher Faulet27c8d202021-10-13 09:50:53 +02001569 BUG_ON(px->conf.refcount != 0);
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001570 ebpt_delete(&px->conf.by_name);
1571 proxy_free_defaults(px);
1572 free(px);
1573}
1574
Christopher Faulet27c8d202021-10-13 09:50:53 +02001575/* delete all unreferenced default proxies. A default proxy is unreferenced if
1576 * its refcount is equal to zero.
1577 */
1578void proxy_destroy_all_unref_defaults()
Willy Tarreaue90904d2021-02-12 14:08:31 +01001579{
1580 struct ebpt_node *n;
1581
Christopher Faulet27c8d202021-10-13 09:50:53 +02001582 n = ebpt_first(&defproxy_by_name);
1583 while (n) {
Willy Tarreaue90904d2021-02-12 14:08:31 +01001584 struct proxy *px = container_of(n, struct proxy, conf.by_name);
1585 BUG_ON(!(px->cap & PR_CAP_DEF));
Christopher Faulet27c8d202021-10-13 09:50:53 +02001586 n = ebpt_next(n);
1587 if (!px->conf.refcount)
1588 proxy_destroy_defaults(px);
Willy Tarreaue90904d2021-02-12 14:08:31 +01001589 }
1590}
1591
Christopher Faulet27c8d202021-10-13 09:50:53 +02001592/* Add a reference on the default proxy <defpx> for the proxy <px> Nothing is
1593 * done if <px> already references <defpx>. Otherwise, the default proxy
1594 * refcount is incremented by one. For now, this operation is not thread safe
1595 * and is perform during init stage only.
1596 */
1597void proxy_ref_defaults(struct proxy *px, struct proxy *defpx)
1598{
1599 if (px->defpx == defpx)
1600 return;
1601 BUG_ON(px->defpx != NULL);
1602 px->defpx = defpx;
1603 defpx->conf.refcount++;
1604}
1605
1606/* proxy <px> removes its reference on its default proxy. The default proxy
1607 * refcount is decremented by one. If it was the last reference, the
1608 * corresponding default proxy is destroyed. For now this operation is not
1609 * thread safe and is performed during deinit staged only.
1610*/
1611void proxy_unref_defaults(struct proxy *px)
1612{
1613 if (px->defpx == NULL)
1614 return;
1615 if (!--px->defpx->conf.refcount)
1616 proxy_destroy_defaults(px->defpx);
1617 px->defpx = NULL;
1618}
1619
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001620/* Allocates a new proxy <name> of type <cap>.
1621 * Returns the proxy instance on success. On error, NULL is returned.
Willy Tarreau76838932021-02-12 08:49:47 +01001622 */
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001623struct proxy *alloc_new_proxy(const char *name, unsigned int cap, char **errmsg)
Willy Tarreau76838932021-02-12 08:49:47 +01001624{
Willy Tarreau76838932021-02-12 08:49:47 +01001625 struct proxy *curproxy;
Willy Tarreau76838932021-02-12 08:49:47 +01001626
1627 if ((curproxy = calloc(1, sizeof(*curproxy))) == NULL) {
1628 memprintf(errmsg, "proxy '%s': out of memory", name);
1629 goto fail;
1630 }
1631
1632 init_new_proxy(curproxy);
Willy Tarreau69530f52023-04-28 09:16:15 +02001633 curproxy->last_change = ns_to_sec(now_ns);
Willy Tarreau76838932021-02-12 08:49:47 +01001634 curproxy->id = strdup(name);
1635 curproxy->cap = cap;
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001636
William Lallemand6bb77b92021-07-28 15:48:16 +02001637 if (!(cap & PR_CAP_INT))
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001638 proxy_store_name(curproxy);
Willy Tarreau76838932021-02-12 08:49:47 +01001639
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001640 done:
1641 return curproxy;
1642
1643 fail:
1644 /* Note: in case of fatal error here, we WILL make valgrind unhappy,
1645 * but its not worth trying to unroll everything here just before
1646 * quitting.
1647 */
1648 free(curproxy);
1649 return NULL;
1650}
1651
1652/* Copy the proxy settings from <defproxy> to <curproxy>.
1653 * Returns 0 on success.
1654 * Returns 1 on error. <errmsg> will be allocated with an error description.
1655 */
1656static int proxy_defproxy_cpy(struct proxy *curproxy, const struct proxy *defproxy,
1657 char **errmsg)
1658{
1659 struct logsrv *tmplogsrv;
1660 char *tmpmsg = NULL;
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001661
1662 /* set default values from the specified default proxy */
Christopher Faulet6bb86532022-08-03 11:31:55 +02001663 srv_settings_cpy(&curproxy->defsrv, &defproxy->defsrv, 0);
Willy Tarreau76838932021-02-12 08:49:47 +01001664
Christopher Faulet56717802021-10-13 10:10:09 +02001665 curproxy->flags = (defproxy->flags & PR_FL_DISABLED); /* Only inherit from disabled flag */
Willy Tarreau76838932021-02-12 08:49:47 +01001666 curproxy->options = defproxy->options;
1667 curproxy->options2 = defproxy->options2;
1668 curproxy->no_options = defproxy->no_options;
1669 curproxy->no_options2 = defproxy->no_options2;
Willy Tarreau76838932021-02-12 08:49:47 +01001670 curproxy->retry_type = defproxy->retry_type;
Christopher Fauletee08d6c2021-10-13 15:40:15 +02001671 curproxy->tcp_req.inspect_delay = defproxy->tcp_req.inspect_delay;
1672 curproxy->tcp_rep.inspect_delay = defproxy->tcp_rep.inspect_delay;
Willy Tarreau76838932021-02-12 08:49:47 +01001673
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +01001674 http_ext_clean(curproxy);
1675 http_ext_dup(defproxy, curproxy);
Willy Tarreau76838932021-02-12 08:49:47 +01001676
Tim Duesterhusb4b03772022-03-05 00:52:43 +01001677 if (isttest(defproxy->server_id_hdr_name))
1678 curproxy->server_id_hdr_name = istdup(defproxy->server_id_hdr_name);
Willy Tarreau76838932021-02-12 08:49:47 +01001679
1680 /* initialize error relocations */
1681 if (!proxy_dup_default_conf_errors(curproxy, defproxy, &tmpmsg)) {
1682 memprintf(errmsg, "proxy '%s' : %s", curproxy->id, tmpmsg);
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001683 free(tmpmsg);
1684 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001685 }
1686
1687 if (curproxy->cap & PR_CAP_FE) {
1688 curproxy->maxconn = defproxy->maxconn;
1689 curproxy->backlog = defproxy->backlog;
1690 curproxy->fe_sps_lim = defproxy->fe_sps_lim;
1691
1692 curproxy->to_log = defproxy->to_log & ~LW_COOKIE & ~LW_REQHDR & ~ LW_RSPHDR;
1693 curproxy->max_out_conns = defproxy->max_out_conns;
1694
1695 curproxy->clitcpka_cnt = defproxy->clitcpka_cnt;
1696 curproxy->clitcpka_idle = defproxy->clitcpka_idle;
1697 curproxy->clitcpka_intvl = defproxy->clitcpka_intvl;
1698 }
1699
1700 if (curproxy->cap & PR_CAP_BE) {
1701 curproxy->lbprm.algo = defproxy->lbprm.algo;
1702 curproxy->lbprm.hash_balance_factor = defproxy->lbprm.hash_balance_factor;
1703 curproxy->fullconn = defproxy->fullconn;
1704 curproxy->conn_retries = defproxy->conn_retries;
1705 curproxy->redispatch_after = defproxy->redispatch_after;
1706 curproxy->max_ka_queue = defproxy->max_ka_queue;
1707
1708 curproxy->tcpcheck_rules.flags = (defproxy->tcpcheck_rules.flags & ~TCPCHK_RULES_UNUSED_RS);
1709 curproxy->tcpcheck_rules.list = defproxy->tcpcheck_rules.list;
1710 if (!LIST_ISEMPTY(&defproxy->tcpcheck_rules.preset_vars)) {
1711 if (!dup_tcpcheck_vars(&curproxy->tcpcheck_rules.preset_vars,
1712 &defproxy->tcpcheck_rules.preset_vars)) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001713 memprintf(errmsg, "proxy '%s': failed to duplicate tcpcheck preset-vars", curproxy->id);
1714 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001715 }
1716 }
1717
1718 curproxy->ck_opts = defproxy->ck_opts;
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +01001719
Willy Tarreau76838932021-02-12 08:49:47 +01001720 if (defproxy->cookie_name)
1721 curproxy->cookie_name = strdup(defproxy->cookie_name);
1722 curproxy->cookie_len = defproxy->cookie_len;
1723
1724 if (defproxy->dyncookie_key)
1725 curproxy->dyncookie_key = strdup(defproxy->dyncookie_key);
1726 if (defproxy->cookie_domain)
1727 curproxy->cookie_domain = strdup(defproxy->cookie_domain);
1728
1729 if (defproxy->cookie_maxidle)
1730 curproxy->cookie_maxidle = defproxy->cookie_maxidle;
1731
1732 if (defproxy->cookie_maxlife)
1733 curproxy->cookie_maxlife = defproxy->cookie_maxlife;
1734
1735 if (defproxy->rdp_cookie_name)
1736 curproxy->rdp_cookie_name = strdup(defproxy->rdp_cookie_name);
1737 curproxy->rdp_cookie_len = defproxy->rdp_cookie_len;
1738
1739 if (defproxy->cookie_attrs)
1740 curproxy->cookie_attrs = strdup(defproxy->cookie_attrs);
1741
1742 if (defproxy->lbprm.arg_str)
1743 curproxy->lbprm.arg_str = strdup(defproxy->lbprm.arg_str);
1744 curproxy->lbprm.arg_len = defproxy->lbprm.arg_len;
1745 curproxy->lbprm.arg_opt1 = defproxy->lbprm.arg_opt1;
1746 curproxy->lbprm.arg_opt2 = defproxy->lbprm.arg_opt2;
1747 curproxy->lbprm.arg_opt3 = defproxy->lbprm.arg_opt3;
1748
1749 if (defproxy->conn_src.iface_name)
1750 curproxy->conn_src.iface_name = strdup(defproxy->conn_src.iface_name);
1751 curproxy->conn_src.iface_len = defproxy->conn_src.iface_len;
1752 curproxy->conn_src.opts = defproxy->conn_src.opts;
1753#if defined(CONFIG_HAP_TRANSPARENT)
1754 curproxy->conn_src.tproxy_addr = defproxy->conn_src.tproxy_addr;
1755#endif
1756 curproxy->load_server_state_from_file = defproxy->load_server_state_from_file;
1757
1758 curproxy->srvtcpka_cnt = defproxy->srvtcpka_cnt;
1759 curproxy->srvtcpka_idle = defproxy->srvtcpka_idle;
1760 curproxy->srvtcpka_intvl = defproxy->srvtcpka_intvl;
1761 }
1762
1763 if (curproxy->cap & PR_CAP_FE) {
1764 if (defproxy->capture_name)
1765 curproxy->capture_name = strdup(defproxy->capture_name);
1766 curproxy->capture_namelen = defproxy->capture_namelen;
1767 curproxy->capture_len = defproxy->capture_len;
Christopher Faulet57962282022-04-25 14:30:58 +02001768
1769 curproxy->nb_req_cap = defproxy->nb_req_cap;
1770 curproxy->req_cap = defproxy->req_cap;
1771
1772 curproxy->nb_rsp_cap = defproxy->nb_rsp_cap;
1773 curproxy->rsp_cap = defproxy->rsp_cap;
Willy Tarreau76838932021-02-12 08:49:47 +01001774 }
1775
1776 if (curproxy->cap & PR_CAP_FE) {
1777 curproxy->timeout.client = defproxy->timeout.client;
1778 curproxy->timeout.clientfin = defproxy->timeout.clientfin;
1779 curproxy->timeout.tarpit = defproxy->timeout.tarpit;
1780 curproxy->timeout.httpreq = defproxy->timeout.httpreq;
1781 curproxy->timeout.httpka = defproxy->timeout.httpka;
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001782 if (isttest(defproxy->monitor_uri))
1783 curproxy->monitor_uri = istdup(defproxy->monitor_uri);
Willy Tarreau76838932021-02-12 08:49:47 +01001784 if (defproxy->defbe.name)
1785 curproxy->defbe.name = strdup(defproxy->defbe.name);
1786
1787 /* get either a pointer to the logformat string or a copy of it */
1788 curproxy->conf.logformat_string = defproxy->conf.logformat_string;
1789 if (curproxy->conf.logformat_string &&
1790 curproxy->conf.logformat_string != default_http_log_format &&
1791 curproxy->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001792 curproxy->conf.logformat_string != clf_http_log_format &&
1793 curproxy->conf.logformat_string != default_https_log_format)
Willy Tarreau76838932021-02-12 08:49:47 +01001794 curproxy->conf.logformat_string = strdup(curproxy->conf.logformat_string);
1795
1796 if (defproxy->conf.lfs_file) {
1797 curproxy->conf.lfs_file = strdup(defproxy->conf.lfs_file);
1798 curproxy->conf.lfs_line = defproxy->conf.lfs_line;
1799 }
1800
1801 /* get either a pointer to the logformat string for RFC5424 structured-data or a copy of it */
1802 curproxy->conf.logformat_sd_string = defproxy->conf.logformat_sd_string;
1803 if (curproxy->conf.logformat_sd_string &&
1804 curproxy->conf.logformat_sd_string != default_rfc5424_sd_log_format)
1805 curproxy->conf.logformat_sd_string = strdup(curproxy->conf.logformat_sd_string);
1806
1807 if (defproxy->conf.lfsd_file) {
1808 curproxy->conf.lfsd_file = strdup(defproxy->conf.lfsd_file);
1809 curproxy->conf.lfsd_line = defproxy->conf.lfsd_line;
1810 }
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001811
1812 curproxy->conf.error_logformat_string = defproxy->conf.error_logformat_string;
1813 if (curproxy->conf.error_logformat_string)
1814 curproxy->conf.error_logformat_string = strdup(curproxy->conf.error_logformat_string);
1815
1816 if (defproxy->conf.elfs_file) {
1817 curproxy->conf.elfs_file = strdup(defproxy->conf.elfs_file);
1818 curproxy->conf.elfs_line = defproxy->conf.elfs_line;
1819 }
Willy Tarreau76838932021-02-12 08:49:47 +01001820 }
1821
1822 if (curproxy->cap & PR_CAP_BE) {
1823 curproxy->timeout.connect = defproxy->timeout.connect;
1824 curproxy->timeout.server = defproxy->timeout.server;
1825 curproxy->timeout.serverfin = defproxy->timeout.serverfin;
1826 curproxy->timeout.check = defproxy->timeout.check;
1827 curproxy->timeout.queue = defproxy->timeout.queue;
1828 curproxy->timeout.tarpit = defproxy->timeout.tarpit;
1829 curproxy->timeout.httpreq = defproxy->timeout.httpreq;
1830 curproxy->timeout.httpka = defproxy->timeout.httpka;
1831 curproxy->timeout.tunnel = defproxy->timeout.tunnel;
1832 curproxy->conn_src.source_addr = defproxy->conn_src.source_addr;
1833 }
1834
1835 curproxy->mode = defproxy->mode;
1836 curproxy->uri_auth = defproxy->uri_auth; /* for stats */
1837
1838 /* copy default logsrvs to curproxy */
1839 list_for_each_entry(tmplogsrv, &defproxy->logsrvs, list) {
Aurelien DARRAGON77679312023-07-05 15:52:19 +02001840 struct logsrv *node = dup_logsrv(tmplogsrv);
Willy Tarreau76838932021-02-12 08:49:47 +01001841
1842 if (!node) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001843 memprintf(errmsg, "proxy '%s': out of memory", curproxy->id);
1844 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001845 }
Willy Tarreau2b718102021-04-21 07:32:39 +02001846 LIST_APPEND(&curproxy->logsrvs, &node->list);
Willy Tarreau76838932021-02-12 08:49:47 +01001847 }
1848
1849 curproxy->conf.uniqueid_format_string = defproxy->conf.uniqueid_format_string;
1850 if (curproxy->conf.uniqueid_format_string)
1851 curproxy->conf.uniqueid_format_string = strdup(curproxy->conf.uniqueid_format_string);
1852
1853 chunk_dup(&curproxy->log_tag, &defproxy->log_tag);
1854
1855 if (defproxy->conf.uif_file) {
1856 curproxy->conf.uif_file = strdup(defproxy->conf.uif_file);
1857 curproxy->conf.uif_line = defproxy->conf.uif_line;
1858 }
1859
1860 /* copy default header unique id */
1861 if (isttest(defproxy->header_unique_id)) {
1862 const struct ist copy = istdup(defproxy->header_unique_id);
1863
1864 if (!isttest(copy)) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001865 memprintf(errmsg, "proxy '%s': out of memory for unique-id-header", curproxy->id);
1866 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001867 }
1868 curproxy->header_unique_id = copy;
1869 }
1870
1871 /* default compression options */
1872 if (defproxy->comp != NULL) {
1873 curproxy->comp = calloc(1, sizeof(*curproxy->comp));
Remi Tricot-Le Breton18a82ba2021-05-12 18:07:27 +02001874 if (!curproxy->comp) {
1875 memprintf(errmsg, "proxy '%s': out of memory for default compression options", curproxy->id);
1876 return 1;
1877 }
Olivier Houcharddb573e92023-04-05 17:32:36 +02001878 curproxy->comp->algos_res = defproxy->comp->algos_res;
1879 curproxy->comp->algo_req = defproxy->comp->algo_req;
1880 curproxy->comp->types_res = defproxy->comp->types_res;
1881 curproxy->comp->types_req = defproxy->comp->types_req;
Willy Tarreau862588a2023-05-10 16:39:00 +02001882 curproxy->comp->flags = defproxy->comp->flags;
Willy Tarreau76838932021-02-12 08:49:47 +01001883 }
1884
Willy Tarreau76838932021-02-12 08:49:47 +01001885 if (defproxy->check_path)
1886 curproxy->check_path = strdup(defproxy->check_path);
1887 if (defproxy->check_command)
1888 curproxy->check_command = strdup(defproxy->check_command);
1889
1890 if (defproxy->email_alert.mailers.name)
1891 curproxy->email_alert.mailers.name = strdup(defproxy->email_alert.mailers.name);
1892 if (defproxy->email_alert.from)
1893 curproxy->email_alert.from = strdup(defproxy->email_alert.from);
1894 if (defproxy->email_alert.to)
1895 curproxy->email_alert.to = strdup(defproxy->email_alert.to);
1896 if (defproxy->email_alert.myhostname)
1897 curproxy->email_alert.myhostname = strdup(defproxy->email_alert.myhostname);
1898 curproxy->email_alert.level = defproxy->email_alert.level;
1899 curproxy->email_alert.set = defproxy->email_alert.set;
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001900
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001901 return 0;
1902}
1903
1904/* Allocates a new proxy <name> of type <cap> found at position <file:linenum>,
1905 * preset it from the defaults of <defproxy> and returns it. In case of error,
1906 * an alert is printed and NULL is returned.
1907 */
1908struct proxy *parse_new_proxy(const char *name, unsigned int cap,
1909 const char *file, int linenum,
1910 const struct proxy *defproxy)
1911{
1912 struct proxy *curproxy = NULL;
Willy Tarreau282b6a72022-02-24 16:37:19 +01001913 char *errmsg = NULL;
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001914
1915 if (!(curproxy = alloc_new_proxy(name, cap, &errmsg))) {
1916 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
1917 free(errmsg);
1918 return NULL;
1919 }
1920
1921 if (defproxy) {
1922 if (proxy_defproxy_cpy(curproxy, defproxy, &errmsg)) {
1923 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
1924 free(errmsg);
1925
1926 ha_free(&curproxy);
1927 return NULL;
1928 }
1929 }
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001930
1931 curproxy->conf.args.file = curproxy->conf.file = strdup(file);
1932 curproxy->conf.args.line = curproxy->conf.line = linenum;
1933
Willy Tarreau76838932021-02-12 08:49:47 +01001934 return curproxy;
Willy Tarreau76838932021-02-12 08:49:47 +01001935}
1936
Aurelien DARRAGONd46f4372022-09-09 15:51:37 +02001937/* to be called under the proxy lock after pausing some listeners. This will
1938 * automatically update the p->flags flag
1939 */
1940void proxy_cond_pause(struct proxy *p)
1941{
1942 if (p->li_ready)
1943 return;
1944 p->flags |= PR_FL_PAUSED;
1945}
1946
1947/* to be called under the proxy lock after resuming some listeners. This will
1948 * automatically update the p->flags flag
1949 */
1950void proxy_cond_resume(struct proxy *p)
1951{
1952 if (!p->li_ready)
1953 return;
1954 p->flags &= ~PR_FL_PAUSED;
1955}
1956
Willy Tarreauacde1522020-10-07 16:31:39 +02001957/* to be called under the proxy lock after stopping some listeners. This will
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001958 * automatically update the p->flags flag after stopping the last one, and
Willy Tarreauacde1522020-10-07 16:31:39 +02001959 * will emit a log indicating the proxy's condition. The function is idempotent
1960 * so that it will not emit multiple logs; a proxy will be disabled only once.
1961 */
1962void proxy_cond_disable(struct proxy *p)
1963{
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001964 if (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauacde1522020-10-07 16:31:39 +02001965 return;
1966
1967 if (p->li_ready + p->li_paused > 0)
1968 return;
1969
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001970 p->flags |= PR_FL_STOPPED;
Willy Tarreauacde1522020-10-07 16:31:39 +02001971
Willy Tarreauacde1522020-10-07 16:31:39 +02001972 /* Note: syslog proxies use their own loggers so while it's somewhat OK
1973 * to report them being stopped as a warning, we must not spam their log
1974 * servers which are in fact production servers. For other types (CLI,
1975 * peers, etc) we must not report them at all as they're not really on
1976 * the data plane but on the control plane.
1977 */
William Lallemand7f954692023-05-14 23:23:36 +02001978 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 +02001979 ha_warning("Proxy %s stopped (cumulated conns: FE: %lld, BE: %lld).\n",
Amaury Denoyelle1c8372b2024-04-04 18:08:46 +02001980 p->id, p->fe_counters.cum_conn, p->be_counters.cum_sess);
Willy Tarreauacde1522020-10-07 16:31:39 +02001981
William Lallemand7f954692023-05-14 23:23:36 +02001982 if ((p->mode == PR_MODE_TCP || p->mode == PR_MODE_HTTP) && !(p->cap & PR_CAP_INT))
Willy Tarreauacde1522020-10-07 16:31:39 +02001983 send_log(p, LOG_WARNING, "Proxy %s stopped (cumulated conns: FE: %lld, BE: %lld).\n",
Amaury Denoyelle1c8372b2024-04-04 18:08:46 +02001984 p->id, p->fe_counters.cum_conn, p->be_counters.cum_sess);
Willy Tarreauacde1522020-10-07 16:31:39 +02001985
Willy Tarreauacde1522020-10-07 16:31:39 +02001986 if (p->table && p->table->size && p->table->sync_task)
1987 task_wakeup(p->table->sync_task, TASK_WOKEN_MSG);
1988
1989 if (p->task)
1990 task_wakeup(p->task, TASK_WOKEN_MSG);
1991}
1992
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001993/*
Willy Tarreau918ff602011-07-25 16:33:49 +02001994 * This is the proxy management task. It enables proxies when there are enough
Willy Tarreau87b09662015-04-03 00:22:06 +02001995 * free streams, or stops them when the table is full. It is designed to be
Willy Tarreau918ff602011-07-25 16:33:49 +02001996 * called as a task which is woken up upon stopping or when rate limiting must
1997 * be enforced.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001998 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01001999struct task *manage_proxy(struct task *t, void *context, unsigned int state)
Willy Tarreaubaaee002006-06-26 02:48:02 +02002000{
Olivier Houchard9f6af332018-05-25 14:04:04 +02002001 struct proxy *p = context;
Willy Tarreau918ff602011-07-25 16:33:49 +02002002 int next = TICK_ETERNITY;
Willy Tarreau79584222009-03-06 09:18:27 +01002003 unsigned int wait;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002004
Willy Tarreau918ff602011-07-25 16:33:49 +02002005 /* We should periodically try to enable listeners waiting for a
2006 * global resource here.
2007 */
Willy Tarreaubaaee002006-06-26 02:48:02 +02002008
Willy Tarreau3a925c12013-09-04 17:54:01 +02002009 /* If the proxy holds a stick table, we need to purge all unused
2010 * entries. These are all the ones in the table with ref_cnt == 0
2011 * and all the ones in the pool used to allocate new entries. Any
Willy Tarreau87b09662015-04-03 00:22:06 +02002012 * entry attached to an existing stream waiting for a store will
Willy Tarreau3a925c12013-09-04 17:54:01 +02002013 * be in neither list. Any entry being dumped will have ref_cnt > 0.
2014 * However we protect tables that are being synced to peers.
2015 */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002016 if (unlikely(stopping && (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) && p->table && p->table->current)) {
Emeric Brun2cc201f2021-04-23 12:21:26 +02002017
2018 if (!p->table->refcnt) {
2019 /* !table->refcnt means there
2020 * is no more pending full resync
2021 * to push to a new process and
2022 * we are free to flush the table.
2023 */
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002024 int budget;
2025 int cleaned_up;
2026
2027 /* We purposely enforce a budget limitation since we don't want
2028 * to spend too much time purging old entries
2029 *
2030 * This is known to cause the watchdog to occasionnaly trigger if
2031 * the table is huge and all entries become available for purge
2032 * at the same time
2033 *
2034 * Moreover, we must also anticipate the pool_gc() call which
2035 * will also be much slower if there is too much work at once
2036 */
2037 budget = MIN(p->table->current, (1 << 15)); /* max: 32K */
2038 cleaned_up = stktable_trash_oldest(p->table, budget);
2039 if (cleaned_up) {
2040 /* immediately release freed memory since we are stopping */
Aurelien DARRAGON6e1fe252023-03-28 15:14:48 +02002041 pool_gc(NULL);
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002042 if (cleaned_up > (budget / 2)) {
2043 /* most of the budget was used to purge entries,
2044 * it is very likely that there are still trashable
2045 * entries in the table, reschedule a new cleanup
2046 * attempt ASAP
2047 */
2048 t->expire = TICK_ETERNITY;
2049 task_wakeup(t, TASK_WOKEN_RES);
2050 return t;
2051 }
2052 }
Willy Tarreau3a925c12013-09-04 17:54:01 +02002053 }
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01002054 if (p->table->current) {
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002055 /* some entries still remain but are not yet available
2056 * for cleanup, let's recheck in one second
2057 */
Willy Tarreau3a925c12013-09-04 17:54:01 +02002058 next = tick_first(next, tick_add(now_ms, 1000));
2059 }
2060 }
2061
Willy Tarreau918ff602011-07-25 16:33:49 +02002062 /* the rest below is just for frontends */
2063 if (!(p->cap & PR_CAP_FE))
2064 goto out;
Willy Tarreauf3f8c702011-07-25 07:37:28 +02002065
Willy Tarreau918ff602011-07-25 16:33:49 +02002066 /* check the various reasons we may find to block the frontend */
Willy Tarreau6b3bf732020-09-24 07:35:46 +02002067 if (unlikely(p->feconn >= p->maxconn))
Willy Tarreau918ff602011-07-25 16:33:49 +02002068 goto out;
Willy Tarreau3a7d2072009-03-05 23:48:25 +01002069
Willy Tarreau918ff602011-07-25 16:33:49 +02002070 if (p->fe_sps_lim &&
2071 (wait = next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0))) {
2072 /* we're blocking because a limit was reached on the number of
2073 * requests/s on the frontend. We want to re-check ASAP, which
2074 * means in 1 ms before estimated expiration date, because the
2075 * timer will have settled down.
2076 */
2077 next = tick_first(next, tick_add(now_ms, wait));
2078 goto out;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002079 }
Willy Tarreau918ff602011-07-25 16:33:49 +02002080
2081 /* The proxy is not limited so we can re-enable any waiting listener */
Willy Tarreau241797a2019-12-10 14:10:52 +01002082 dequeue_proxy_listeners(p);
Willy Tarreau918ff602011-07-25 16:33:49 +02002083 out:
2084 t->expire = next;
2085 task_queue(t);
2086 return t;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002087}
2088
2089
Willy Tarreau10080712021-09-07 10:49:45 +02002090static int proxy_parse_grace(char **args, int section_type, struct proxy *curpx,
2091 const struct proxy *defpx, const char *file, int line,
2092 char **err)
2093{
2094 const char *res;
2095
2096 if (!*args[1]) {
2097 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2098 return -1;
2099 }
2100 res = parse_time_err(args[1], &global.grace_delay, TIME_UNIT_MS);
2101 if (res == PARSE_TIME_OVER) {
2102 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2103 args[1], args[0]);
2104 return -1;
2105 }
2106 else if (res == PARSE_TIME_UNDER) {
2107 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2108 args[1], args[0]);
2109 return -1;
2110 }
2111 else if (res) {
2112 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2113 return -1;
2114 }
2115 return 0;
2116}
2117
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002118static int proxy_parse_hard_stop_after(char **args, int section_type, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01002119 const struct proxy *defpx, const char *file, int line,
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002120 char **err)
2121{
2122 const char *res;
2123
2124 if (!*args[1]) {
2125 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2126 return -1;
2127 }
2128 res = parse_time_err(args[1], &global.hard_stop_after, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +02002129 if (res == PARSE_TIME_OVER) {
2130 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2131 args[1], args[0]);
2132 return -1;
2133 }
2134 else if (res == PARSE_TIME_UNDER) {
2135 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2136 args[1], args[0]);
2137 return -1;
2138 }
2139 else if (res) {
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002140 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2141 return -1;
2142 }
2143 return 0;
2144}
2145
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002146static int proxy_parse_close_spread_time(char **args, int section_type, struct proxy *curpx,
2147 const struct proxy *defpx, const char *file, int line,
2148 char **err)
2149{
2150 const char *res;
2151
2152 if (!*args[1]) {
2153 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2154 return -1;
2155 }
Remi Tricot-Le Breton4d7fdc62022-04-26 15:17:18 +02002156
2157 /* If close-spread-time is set to "infinite", disable the active connection
2158 * closing during soft-stop.
2159 */
2160 if (strcmp(args[1], "infinite") == 0) {
2161 global.tune.options |= GTUNE_DISABLE_ACTIVE_CLOSE;
2162 global.close_spread_time = TICK_ETERNITY;
2163 return 0;
2164 }
2165
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002166 res = parse_time_err(args[1], &global.close_spread_time, TIME_UNIT_MS);
2167 if (res == PARSE_TIME_OVER) {
2168 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2169 args[1], args[0]);
2170 return -1;
2171 }
2172 else if (res == PARSE_TIME_UNDER) {
2173 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2174 args[1], args[0]);
2175 return -1;
2176 }
2177 else if (res) {
2178 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2179 return -1;
2180 }
Remi Tricot-Le Breton4d7fdc62022-04-26 15:17:18 +02002181 global.tune.options &= ~GTUNE_DISABLE_ACTIVE_CLOSE;
2182
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002183 return 0;
2184}
2185
Willy Tarreau144f84a2021-03-02 16:09:26 +01002186struct task *hard_stop(struct task *t, void *context, unsigned int state)
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002187{
2188 struct proxy *p;
2189 struct stream *s;
Willy Tarreau0d038252021-02-24 11:13:59 +01002190 int thr;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002191
2192 if (killed) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002193 ha_warning("Some tasks resisted to hard-stop, exiting now.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002194 send_log(NULL, LOG_WARNING, "Some tasks resisted to hard-stop, exiting now.\n");
Willy Tarreau7067b3a2019-06-02 11:11:29 +02002195 killed = 2;
Willy Tarreau0d038252021-02-24 11:13:59 +01002196 for (thr = 0; thr < global.nbthread; thr++)
Willy Tarreaub2f38c12023-01-19 19:14:18 +01002197 if (_HA_ATOMIC_LOAD(&ha_thread_info[thr].tg->threads_enabled) & ha_thread_info[thr].ltid_bit)
Willy Tarreau0d038252021-02-24 11:13:59 +01002198 wake_thread(thr);
Willy Tarreau7067b3a2019-06-02 11:11:29 +02002199 t->expire = TICK_ETERNITY;
2200 return t;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002201 }
2202
Christopher Faulet767a84b2017-11-24 16:50:31 +01002203 ha_warning("soft-stop running for too long, performing a hard-stop.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002204 send_log(NULL, LOG_WARNING, "soft-stop running for too long, performing a hard-stop.\n");
Olivier Houchardfbc74e82017-11-24 16:54:05 +01002205 p = proxies_list;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002206 while (p) {
2207 if ((p->cap & PR_CAP_FE) && (p->feconn > 0)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002208 ha_warning("Proxy %s hard-stopped (%d remaining conns will be closed).\n",
2209 p->id, p->feconn);
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002210 send_log(p, LOG_WARNING, "Proxy %s hard-stopped (%d remaining conns will be closed).\n",
2211 p->id, p->feconn);
2212 }
2213 p = p->next;
2214 }
Willy Tarreau92b887e2021-02-24 11:08:56 +01002215
2216 thread_isolate();
Willy Tarreaua698eb62021-02-24 10:37:01 +01002217
2218 for (thr = 0; thr < global.nbthread; thr++) {
Willy Tarreaub4e34762021-09-30 19:02:18 +02002219 list_for_each_entry(s, &ha_thread_ctx[thr].streams, list) {
Willy Tarreaua698eb62021-02-24 10:37:01 +01002220 stream_shutdown(s, SF_ERR_KILLED);
2221 }
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002222 }
Willy Tarreaua698eb62021-02-24 10:37:01 +01002223
Willy Tarreau92b887e2021-02-24 11:08:56 +01002224 thread_release();
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002225
2226 killed = 1;
2227 t->expire = tick_add(now_ms, MS_TO_TICKS(1000));
2228 return t;
2229}
2230
Willy Tarreau10080712021-09-07 10:49:45 +02002231/* perform the soft-stop right now (i.e. unbind listeners) */
2232static void do_soft_stop_now()
Willy Tarreaubaaee002006-06-26 02:48:02 +02002233{
Christopher Faulet48678e42023-03-14 14:33:11 +01002234 struct proxy *p;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002235 struct task *task;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002236
William Dauchy3894d972019-12-28 15:36:02 +01002237 /* disable busy polling to avoid cpu eating for the new process */
2238 global.tune.options &= ~GTUNE_BUSY_POLLING;
Willy Tarreau10080712021-09-07 10:49:45 +02002239
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002240 if (tick_isset(global.close_spread_time)) {
2241 global.close_spread_end = tick_add(now_ms, global.close_spread_time);
2242 }
2243
Willy Tarreau10080712021-09-07 10:49:45 +02002244 /* schedule a hard-stop after a delay if needed */
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002245 if (tick_isset(global.hard_stop_after)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +02002246 task = task_new_anywhere();
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002247 if (task) {
2248 task->process = hard_stop;
2249 task_schedule(task, tick_add(now_ms, global.hard_stop_after));
2250 }
2251 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002252 ha_alert("out of memory trying to allocate the hard-stop task.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002253 }
2254 }
Willy Tarreau626f3a72020-10-07 16:52:43 +02002255
Willy Tarreau1b927eb2022-07-15 19:15:02 +02002256 /* we isolate so that we have a chance of stopping listeners in other groups */
2257 thread_isolate();
2258
Willy Tarreaueb778242021-06-11 16:27:10 +02002259 /* stop all stoppable listeners */
Willy Tarreau626f3a72020-10-07 16:52:43 +02002260 protocol_stop_now();
2261
Willy Tarreau1b927eb2022-07-15 19:15:02 +02002262 thread_release();
2263
Christopher Faulet48678e42023-03-14 14:33:11 +01002264 /* Loop on proxies to stop backends */
2265 p = proxies_list;
2266 while (p) {
2267 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2268 proxy_cond_disable(p);
2269 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
2270 p = p->next;
2271 }
2272
Willy Tarreaud0807c32010-08-27 18:26:11 +02002273 /* signal zero is used to broadcast the "stopping" event */
2274 signal_handler(0);
Willy Tarreaubaaee002006-06-26 02:48:02 +02002275}
2276
Willy Tarreau10080712021-09-07 10:49:45 +02002277/* triggered by a soft-stop delayed with `grace` */
2278static struct task *grace_expired(struct task *t, void *context, unsigned int state)
2279{
2280 ha_notice("Grace period expired, proceeding with soft-stop now.\n");
2281 send_log(NULL, LOG_NOTICE, "Grace period expired, proceeding with soft-stop now.\n");
2282 do_soft_stop_now();
2283 task_destroy(t);
2284 return NULL;
2285}
2286
2287/*
2288 * this function disables health-check servers so that the process will quickly be ignored
2289 * by load balancers.
2290 */
2291void soft_stop(void)
2292{
2293 struct task *task;
2294
2295 stopping = 1;
2296
2297 if (tick_isset(global.grace_delay)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +02002298 task = task_new_anywhere();
Willy Tarreau10080712021-09-07 10:49:45 +02002299 if (task) {
2300 ha_notice("Scheduling a soft-stop in %u ms.\n", global.grace_delay);
2301 send_log(NULL, LOG_WARNING, "Scheduling a soft-stop in %u ms.\n", global.grace_delay);
2302 task->process = grace_expired;
2303 task_schedule(task, tick_add(now_ms, global.grace_delay));
2304 return;
2305 }
2306 else {
2307 ha_alert("out of memory trying to allocate the stop-stop task, stopping now.\n");
2308 }
2309 }
2310
2311 /* no grace (or failure to enforce it): stop now */
2312 do_soft_stop_now();
2313}
2314
Willy Tarreaubaaee002006-06-26 02:48:02 +02002315
Willy Tarreaube58c382011-07-24 18:28:10 +02002316/* Temporarily disables listening on all of the proxy's listeners. Upon
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002317 * success, the proxy enters the PR_PAUSED state. The function returns 0
Willy Tarreauce8fe252011-09-07 19:14:57 +02002318 * if it fails, or non-zero on success.
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002319 * The function takes the proxy's lock so it's safe to
2320 * call from multiple places.
Willy Tarreaubaaee002006-06-26 02:48:02 +02002321 */
Willy Tarreauce8fe252011-09-07 19:14:57 +02002322int pause_proxy(struct proxy *p)
Willy Tarreaubaaee002006-06-26 02:48:02 +02002323{
2324 struct listener *l;
Willy Tarreauce8fe252011-09-07 19:14:57 +02002325
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002326 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2327
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002328 if (!(p->cap & PR_CAP_FE) || (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !p->li_ready)
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002329 goto end;
Willy Tarreauce8fe252011-09-07 19:14:57 +02002330
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002331 list_for_each_entry(l, &p->conf.listeners, by_fe)
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +01002332 suspend_listener(l, 1, 0);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002333
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002334 if (p->li_ready) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002335 ha_warning("%s %s failed to enter pause mode.\n", proxy_cap_str(p->cap), p->id);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002336 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 +02002337 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002338 return 0;
2339 }
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002340end:
2341 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002342 return 1;
Willy Tarreauda250db2008-10-12 12:07:48 +02002343}
2344
Willy Tarreauda250db2008-10-12 12:07:48 +02002345/*
2346 * This function completely stops a proxy and releases its listeners. It has
2347 * to be called when going down in order to release the ports so that another
2348 * process may bind to them. It must also be called on disabled proxies at the
William Lallemandc59f9882018-11-16 16:57:21 +01002349 * end of start-up. If all listeners are closed, the proxy is set to the
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002350 * PR_STOPPED state.
2351 * The function takes the proxy's lock so it's safe to
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002352 * call from multiple places.
Willy Tarreauda250db2008-10-12 12:07:48 +02002353 */
2354void stop_proxy(struct proxy *p)
2355{
2356 struct listener *l;
2357
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002358 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002359
Willy Tarreau322b9b92020-10-07 16:20:34 +02002360 list_for_each_entry(l, &p->conf.listeners, by_fe)
Aurelien DARRAGON4059e092023-02-06 17:06:03 +01002361 stop_listener(l, 1, 0, 0);
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002362
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002363 if (!(p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) && !p->li_ready) {
Willy Tarreauba296872020-10-16 15:10:11 +02002364 /* might be just a backend */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002365 p->flags |= PR_FL_STOPPED;
Willy Tarreauba296872020-10-16 15:10:11 +02002366 }
2367
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002368 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreaubaaee002006-06-26 02:48:02 +02002369}
2370
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002371/* This function resumes listening on the specified proxy. It scans all of its
2372 * listeners and tries to enable them all. If any of them fails, the proxy is
2373 * put back to the paused state. It returns 1 upon success, or zero if an error
2374 * is encountered.
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002375 * The function takes the proxy's lock so it's safe to
2376 * call from multiple places.
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002377 */
2378int resume_proxy(struct proxy *p)
2379{
2380 struct listener *l;
2381 int fail;
2382
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002383 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2384
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002385 if ((p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !p->li_paused)
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002386 goto end;
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002387
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002388 fail = 0;
Willy Tarreau4348fad2012-09-20 16:48:07 +02002389 list_for_each_entry(l, &p->conf.listeners, by_fe) {
Aurelien DARRAGON4059e092023-02-06 17:06:03 +01002390 if (!resume_listener(l, 1, 0)) {
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002391 int port;
2392
Willy Tarreau37159062020-08-27 07:48:42 +02002393 port = get_host_port(&l->rx.addr);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002394 if (port) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002395 ha_warning("Port %d busy while trying to enable %s %s.\n",
2396 port, proxy_cap_str(p->cap), p->id);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002397 send_log(p, LOG_WARNING, "Port %d busy while trying to enable %s %s.\n",
2398 port, proxy_cap_str(p->cap), p->id);
2399 }
2400 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002401 ha_warning("Bind on socket %d busy while trying to enable %s %s.\n",
2402 l->luid, proxy_cap_str(p->cap), p->id);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002403 send_log(p, LOG_WARNING, "Bind on socket %d busy while trying to enable %s %s.\n",
2404 l->luid, proxy_cap_str(p->cap), p->id);
2405 }
2406
2407 /* Another port might have been enabled. Let's stop everything. */
2408 fail = 1;
2409 break;
2410 }
2411 }
2412
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002413 if (fail) {
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002414 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
2415 /* pause_proxy will take PROXY_LOCK */
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002416 pause_proxy(p);
2417 return 0;
2418 }
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002419end:
2420 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002421 return 1;
2422}
2423
Willy Tarreau87b09662015-04-03 00:22:06 +02002424/* Set current stream's backend to <be>. Nothing is done if the
2425 * stream already had a backend assigned, which is indicated by
Willy Tarreaue7dff022015-04-03 01:14:29 +02002426 * s->flags & SF_BE_ASSIGNED.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002427 * All flags, stats and counters which need be updated are updated.
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002428 * Returns 1 if done, 0 in case of internal error, eg: lack of resource.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002429 */
Willy Tarreau87b09662015-04-03 00:22:06 +02002430int stream_set_backend(struct stream *s, struct proxy *be)
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002431{
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002432 unsigned int req_ana;
2433
Willy Tarreaue7dff022015-04-03 01:14:29 +02002434 if (s->flags & SF_BE_ASSIGNED)
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002435 return 1;
Christopher Faulet41179042016-06-21 11:54:52 +02002436
2437 if (flt_set_stream_backend(s, be) < 0)
2438 return 0;
2439
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002440 s->be = be;
Christopher Fauletff8abcd2017-06-02 15:33:24 +02002441 HA_ATOMIC_UPDATE_MAX(&be->be_counters.conn_max,
Willy Tarreau1db42732021-04-06 11:44:07 +02002442 HA_ATOMIC_ADD_FETCH(&be->beconn, 1));
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002443 proxy_inc_be_ctr(be);
2444
Willy Tarreau87b09662015-04-03 00:22:06 +02002445 /* assign new parameters to the stream from the new backend */
Willy Tarreaucb041662022-05-17 19:44:42 +02002446 s->scb->flags &= ~SC_FL_INDEP_STR;
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02002447 if (be->options2 & PR_O2_INDEPSTR)
Willy Tarreaucb041662022-05-17 19:44:42 +02002448 s->scb->flags |= SC_FL_INDEP_STR;
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02002449
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002450 /* We want to enable the backend-specific analysers except those which
2451 * were already run as part of the frontend/listener. Note that it would
2452 * be more reliable to store the list of analysers that have been run,
2453 * but what we do here is OK for now.
2454 */
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002455 req_ana = be->be_req_ana;
2456 if (!(strm_fe(s)->options & PR_O_WREQ_BODY) && be->options & PR_O_WREQ_BODY) {
2457 /* The backend request to parse a request body while it was not
2458 * performed on the frontend, so add the corresponding analyser
2459 */
2460 req_ana |= AN_REQ_HTTP_BODY;
2461 }
2462 if (IS_HTX_STRM(s) && strm_fe(s)->mode != PR_MODE_HTTP) {
2463 /* The stream was already upgraded to HTTP, so remove analysers
2464 * set during the upgrade
2465 */
2466 req_ana &= ~(AN_REQ_WAIT_HTTP|AN_REQ_HTTP_PROCESS_FE);
2467 }
Willy Tarreau7866e8e2023-01-12 18:39:42 +01002468 s->req.analysers |= req_ana & ~(strm_li(s) ? strm_li(s)->bind_conf->analysers : 0);
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002469
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002470 if (!IS_HTX_STRM(s) && be->mode == PR_MODE_HTTP) {
Christopher Fauletbbe68542019-04-08 10:53:51 +02002471 /* If we chain a TCP frontend to an HTX backend, we must upgrade
2472 * the client mux */
Christopher Fauletae863c62021-03-15 12:03:44 +01002473 if (!stream_set_http_mode(s, NULL))
Christopher Fauleteec7f8a2019-12-20 15:59:20 +01002474 return 0;
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002475 }
2476 else if (IS_HTX_STRM(s) && be->mode != PR_MODE_HTTP) {
2477 /* If a TCP backend is assgiend to an HTX stream, return an
2478 * error. It may happens for a new stream on a previously
2479 * upgraded connections. */
2480 if (!(s->flags & SF_ERR_MASK))
2481 s->flags |= SF_ERR_INTERNAL;
2482 return 0;
2483 }
2484 else {
2485 /* If the target backend requires HTTP processing, we have to allocate
2486 * the HTTP transaction if we did not have one.
2487 */
2488 if (unlikely(!s->txn && be->http_needed && !http_create_txn(s)))
2489 return 0;
Willy Tarreaueee5b512015-04-03 23:46:31 +02002490 }
2491
2492 s->flags |= SF_BE_ASSIGNED;
Willy Tarreau96e31212011-05-30 18:10:30 +02002493 if (be->options2 & PR_O2_NODELAY) {
Christopher Faulet68ef2182023-03-17 15:38:18 +01002494 s->scf->flags |= SC_FL_SND_NEVERWAIT;
2495 s->scb->flags |= SC_FL_SND_NEVERWAIT;
Willy Tarreau96e31212011-05-30 18:10:30 +02002496 }
2497
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002498 return 1;
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002499}
2500
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002501/* Capture a bad request or response and archive it in the proxy's structure.
2502 * It is relatively protocol-agnostic so it requires that a number of elements
2503 * are passed :
2504 * - <proxy> is the proxy where the error was detected and where the snapshot
2505 * needs to be stored
Joseph Herlant59dd2952018-11-15 11:46:55 -08002506 * - <is_back> indicates that the error happened when receiving the response
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002507 * - <other_end> is a pointer to the proxy on the other side when known
2508 * - <target> is the target of the connection, usually a server or a proxy
2509 * - <sess> is the session which experienced the error
2510 * - <ctx> may be NULL or should contain any info relevant to the protocol
2511 * - <buf> is the buffer containing the offending data
2512 * - <buf_ofs> is the position of this buffer's input data in the input
2513 * stream, starting at zero. It may be passed as zero if unknown.
2514 * - <buf_out> is the portion of <buf->data> which was already forwarded and
2515 * which precedes the buffer's input. The buffer's input starts at
2516 * buf->head + buf_out.
2517 * - <err_pos> is the pointer to the faulty byte in the buffer's input.
2518 * - <show> is the callback to use to display <ctx>. It may be NULL.
2519 */
2520void proxy_capture_error(struct proxy *proxy, int is_back,
2521 struct proxy *other_end, enum obj_type *target,
2522 const struct session *sess,
2523 const struct buffer *buf, long buf_ofs,
2524 unsigned int buf_out, unsigned int err_pos,
2525 const union error_snapshot_ctx *ctx,
2526 void (*show)(struct buffer *, const struct error_snapshot *))
2527{
2528 struct error_snapshot *es;
2529 unsigned int buf_len;
2530 int len1, len2;
Willy Tarreauc55015e2018-09-07 19:02:32 +02002531 unsigned int ev_id;
2532
Willy Tarreau18515722021-04-06 11:57:41 +02002533 ev_id = HA_ATOMIC_FETCH_ADD(&error_snapshot_id, 1);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002534
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002535 buf_len = b_data(buf) - buf_out;
2536
2537 es = malloc(sizeof(*es) + buf_len);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002538 if (!es)
2539 return;
2540
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002541 es->buf_len = buf_len;
2542 es->ev_id = ev_id;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002543
Christopher Faulet47a72102020-01-06 11:37:00 +01002544 len1 = b_size(buf) - b_peek_ofs(buf, buf_out);
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002545 if (len1 > buf_len)
2546 len1 = buf_len;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002547
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002548 if (len1) {
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002549 memcpy(es->buf, b_peek(buf, buf_out), len1);
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002550 len2 = buf_len - len1;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002551 if (len2)
2552 memcpy(es->buf + len1, b_orig(buf), len2);
2553 }
2554
2555 es->buf_err = err_pos;
2556 es->when = date; // user-visible date
2557 es->srv = objt_server(target);
2558 es->oe = other_end;
Olivier Houchardbdb00c52020-03-12 15:30:17 +01002559 if (sess && objt_conn(sess->origin) && conn_get_src(__objt_conn(sess->origin)))
Willy Tarreau026efc72019-07-17 15:20:02 +02002560 es->src = *__objt_conn(sess->origin)->src;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002561 else
2562 memset(&es->src, 0, sizeof(es->src));
2563
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002564 es->buf_wrap = b_wrap(buf) - b_peek(buf, buf_out);
2565 es->buf_out = buf_out;
2566 es->buf_ofs = buf_ofs;
2567
2568 /* be sure to indicate the offset of the first IN byte */
2569 if (es->buf_ofs >= es->buf_len)
2570 es->buf_ofs -= es->buf_len;
2571 else
2572 es->buf_ofs = 0;
2573
2574 /* protocol-specific part now */
2575 if (ctx)
2576 es->ctx = *ctx;
2577 else
2578 memset(&es->ctx, 0, sizeof(es->ctx));
2579 es->show = show;
Willy Tarreauc55015e2018-09-07 19:02:32 +02002580
2581 /* note: we still lock since we have to be certain that nobody is
2582 * dumping the output while we free.
2583 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002584 HA_RWLOCK_WRLOCK(PROXY_LOCK, &proxy->lock);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002585 if (is_back) {
2586 es = HA_ATOMIC_XCHG(&proxy->invalid_rep, es);
2587 } else {
2588 es = HA_ATOMIC_XCHG(&proxy->invalid_req, es);
2589 }
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002590 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &proxy->lock);
Willy Tarreauda9f2582022-09-17 11:07:19 +02002591 ha_free(&es);
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002592}
2593
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002594/* Configure all proxies which lack a maxconn setting to use the global one by
2595 * default. This avoids the common mistake consisting in setting maxconn only
2596 * in the global section and discovering the hard way that it doesn't propagate
2597 * through the frontends. These values are also propagated through the various
Ilya Shipitsin47d17182020-06-21 21:42:57 +05002598 * targeted backends, whose fullconn is finally calculated if not yet set.
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002599 */
2600void proxy_adjust_all_maxconn()
2601{
2602 struct proxy *curproxy;
2603 struct switching_rule *swrule1, *swrule2;
2604
2605 for (curproxy = proxies_list; curproxy; curproxy = curproxy->next) {
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002606 if (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002607 continue;
2608
2609 if (!(curproxy->cap & PR_CAP_FE))
2610 continue;
2611
2612 if (!curproxy->maxconn)
2613 curproxy->maxconn = global.maxconn;
2614
2615 /* update the target backend's fullconn count : default_backend */
2616 if (curproxy->defbe.be)
2617 curproxy->defbe.be->tot_fe_maxconn += curproxy->maxconn;
2618 else if ((curproxy->cap & PR_CAP_LISTEN) == PR_CAP_LISTEN)
2619 curproxy->tot_fe_maxconn += curproxy->maxconn;
2620
2621 list_for_each_entry(swrule1, &curproxy->switching_rules, list) {
2622 /* For each target of switching rules, we update their
2623 * tot_fe_maxconn, except if a previous rule points to
2624 * the same backend or to the default backend.
2625 */
2626 if (swrule1->be.backend != curproxy->defbe.be) {
Frédéric Lécaille2365fb02019-03-07 15:02:52 +01002627 /* note: swrule1->be.backend isn't a backend if the rule
2628 * is dynamic, it's an expression instead, so it must not
2629 * be dereferenced as a backend before being certain it is.
2630 */
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002631 list_for_each_entry(swrule2, &curproxy->switching_rules, list) {
2632 if (swrule2 == swrule1) {
Frédéric Lécaille2365fb02019-03-07 15:02:52 +01002633 if (!swrule1->dynamic)
2634 swrule1->be.backend->tot_fe_maxconn += curproxy->maxconn;
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002635 break;
2636 }
2637 else if (!swrule2->dynamic && swrule2->be.backend == swrule1->be.backend) {
2638 /* there are multiple refs of this backend */
2639 break;
2640 }
2641 }
2642 }
2643 }
2644 }
2645
2646 /* automatically compute fullconn if not set. We must not do it in the
2647 * loop above because cross-references are not yet fully resolved.
2648 */
2649 for (curproxy = proxies_list; curproxy; curproxy = curproxy->next) {
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002650 if (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002651 continue;
2652
2653 /* If <fullconn> is not set, let's set it to 10% of the sum of
2654 * the possible incoming frontend's maxconns.
2655 */
2656 if (!curproxy->fullconn && (curproxy->cap & PR_CAP_BE)) {
2657 /* we have the sum of the maxconns in <total>. We only
2658 * keep 10% of that sum to set the default fullconn, with
2659 * a hard minimum of 1 (to avoid a divide by zero).
2660 */
2661 curproxy->fullconn = (curproxy->tot_fe_maxconn + 9) / 10;
2662 if (!curproxy->fullconn)
2663 curproxy->fullconn = 1;
2664 }
2665 }
2666}
2667
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002668/* Config keywords below */
2669
Willy Tarreaudc13c112013-06-21 23:16:39 +02002670static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau10080712021-09-07 10:49:45 +02002671 { CFG_GLOBAL, "grace", proxy_parse_grace },
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002672 { CFG_GLOBAL, "hard-stop-after", proxy_parse_hard_stop_after },
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002673 { CFG_GLOBAL, "close-spread-time", proxy_parse_close_spread_time },
Willy Tarreau9de1bbd2008-07-09 20:34:27 +02002674 { CFG_LISTEN, "timeout", proxy_parse_timeout },
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +02002675 { CFG_LISTEN, "clitimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
2676 { CFG_LISTEN, "contimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
2677 { 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 +01002678 { CFG_LISTEN, "rate-limit", proxy_parse_rate_limit },
Willy Tarreauc35362a2014-04-25 13:58:37 +02002679 { CFG_LISTEN, "max-keep-alive-queue", proxy_parse_max_ka_queue },
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +02002680 { CFG_LISTEN, "declare", proxy_parse_declare },
Olivier Houcharda254a372019-04-05 15:30:12 +02002681 { CFG_LISTEN, "retry-on", proxy_parse_retry_on },
Willy Tarreau52543212020-07-09 05:58:51 +02002682#ifdef TCP_KEEPCNT
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002683 { CFG_LISTEN, "clitcpka-cnt", proxy_parse_tcpka_cnt },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002684 { CFG_LISTEN, "srvtcpka-cnt", proxy_parse_tcpka_cnt },
Willy Tarreau52543212020-07-09 05:58:51 +02002685#endif
2686#ifdef TCP_KEEPIDLE
2687 { CFG_LISTEN, "clitcpka-idle", proxy_parse_tcpka_idle },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002688 { CFG_LISTEN, "srvtcpka-idle", proxy_parse_tcpka_idle },
Willy Tarreau52543212020-07-09 05:58:51 +02002689#endif
2690#ifdef TCP_KEEPINTVL
2691 { CFG_LISTEN, "clitcpka-intvl", proxy_parse_tcpka_intvl },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002692 { CFG_LISTEN, "srvtcpka-intvl", proxy_parse_tcpka_intvl },
Willy Tarreau52543212020-07-09 05:58:51 +02002693#endif
Willy Tarreau9de1bbd2008-07-09 20:34:27 +02002694 { 0, NULL, NULL },
2695}};
2696
Willy Tarreau0108d902018-11-25 19:14:37 +01002697INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2698
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002699/* Expects to find a frontend named <arg> and returns it, otherwise displays various
2700 * adequate error messages and returns NULL. This function is designed to be used by
2701 * functions requiring a frontend on the CLI.
2702 */
2703struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg)
2704{
2705 struct proxy *px;
2706
2707 if (!*arg) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002708 cli_err(appctx, "A frontend name is expected.\n");
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002709 return NULL;
2710 }
2711
2712 px = proxy_fe_by_name(arg);
2713 if (!px) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002714 cli_err(appctx, "No such frontend.\n");
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002715 return NULL;
2716 }
2717 return px;
2718}
2719
Olivier Houchard614f8d72017-03-14 20:08:46 +01002720/* Expects to find a backend named <arg> and returns it, otherwise displays various
2721 * adequate error messages and returns NULL. This function is designed to be used by
2722 * functions requiring a frontend on the CLI.
2723 */
2724struct proxy *cli_find_backend(struct appctx *appctx, const char *arg)
2725{
2726 struct proxy *px;
2727
2728 if (!*arg) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002729 cli_err(appctx, "A backend name is expected.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01002730 return NULL;
2731 }
2732
2733 px = proxy_be_by_name(arg);
2734 if (!px) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002735 cli_err(appctx, "No such backend.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01002736 return NULL;
2737 }
2738 return px;
2739}
2740
2741
Willy Tarreau69f591e2020-07-01 07:00:59 +02002742/* parse a "show servers [state|conn]" CLI line, returns 0 if it wants to start
2743 * the dump or 1 if it stops immediately. If an argument is specified, it will
Willy Tarreau72a04232022-05-05 17:00:20 +02002744 * reserve a show_srv_ctx context and set the proxy pointer into ->px, its ID
2745 * into ->only_pxid, and ->show_conn to 0 for "state", or 1 for "conn".
William Lallemanda6c5f332016-11-19 02:25:36 +01002746 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002747static int cli_parse_show_servers(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemanda6c5f332016-11-19 02:25:36 +01002748{
Willy Tarreau72a04232022-05-05 17:00:20 +02002749 struct show_srv_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002750 struct proxy *px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002751
Willy Tarreau72a04232022-05-05 17:00:20 +02002752 ctx->show_conn = *args[2] == 'c'; // "conn" vs "state"
Willy Tarreau69f591e2020-07-01 07:00:59 +02002753
William Lallemanda6c5f332016-11-19 02:25:36 +01002754 /* check if a backend name has been provided */
2755 if (*args[3]) {
2756 /* read server state from local file */
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002757 px = proxy_be_by_name(args[3]);
William Lallemanda6c5f332016-11-19 02:25:36 +01002758
Willy Tarreau9d008692019-08-09 11:21:01 +02002759 if (!px)
2760 return cli_err(appctx, "Can't find backend.\n");
2761
Willy Tarreau72a04232022-05-05 17:00:20 +02002762 ctx->px = px;
2763 ctx->only_pxid = px->uuid;
William Lallemanda6c5f332016-11-19 02:25:36 +01002764 }
2765 return 0;
2766}
2767
William Dauchyd1a7b852021-02-11 22:51:26 +01002768/* helper to dump server addr */
2769static void dump_server_addr(const struct sockaddr_storage *addr, char *addr_str)
2770{
2771 addr_str[0] = '\0';
2772 switch (addr->ss_family) {
2773 case AF_INET:
2774 case AF_INET6:
2775 addr_to_str(addr, addr_str, INET6_ADDRSTRLEN + 1);
2776 break;
2777 default:
2778 memcpy(addr_str, "-\0", 2);
2779 break;
2780 }
2781}
2782
Willy Tarreau6ff81432020-07-01 07:02:42 +02002783/* dumps server state information for all the servers found in backend cli.p0.
William Lallemanda6c5f332016-11-19 02:25:36 +01002784 * These information are all the parameters which may change during HAProxy runtime.
Willy Tarreau72a04232022-05-05 17:00:20 +02002785 * By default, we only export to the last known server state file format. These
2786 * information can be used at next startup to recover same level of server
2787 * state. It takes its context from show_srv_ctx, with the proxy pointer from
2788 * ->px, the proxy's id ->only_pxid, the server's pointer from ->sv, and the
2789 * choice of what to dump from ->show_conn.
William Lallemanda6c5f332016-11-19 02:25:36 +01002790 */
Willy Tarreau475e4632022-05-27 10:26:46 +02002791static int dump_servers_state(struct stconn *sc)
William Lallemanda6c5f332016-11-19 02:25:36 +01002792{
Willy Tarreau475e4632022-05-27 10:26:46 +02002793 struct appctx *appctx = __sc_appctx(sc);
Willy Tarreau72a04232022-05-05 17:00:20 +02002794 struct show_srv_ctx *ctx = appctx->svcctx;
2795 struct proxy *px = ctx->px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002796 struct server *srv;
2797 char srv_addr[INET6_ADDRSTRLEN + 1];
William Dauchyd1a7b852021-02-11 22:51:26 +01002798 char srv_agent_addr[INET6_ADDRSTRLEN + 1];
2799 char srv_check_addr[INET6_ADDRSTRLEN + 1];
William Lallemanda6c5f332016-11-19 02:25:36 +01002800 time_t srv_time_since_last_change;
2801 int bk_f_forced_id, srv_f_forced_id;
Baptiste Assmann6d0f38f2018-07-02 17:00:54 +02002802 char *srvrecord;
William Lallemanda6c5f332016-11-19 02:25:36 +01002803
Willy Tarreau72a04232022-05-05 17:00:20 +02002804 if (!ctx->sv)
2805 ctx->sv = px->srv;
William Lallemanda6c5f332016-11-19 02:25:36 +01002806
Willy Tarreau72a04232022-05-05 17:00:20 +02002807 for (; ctx->sv != NULL; ctx->sv = srv->next) {
2808 srv = ctx->sv;
William Lallemanda6c5f332016-11-19 02:25:36 +01002809
William Dauchyd1a7b852021-02-11 22:51:26 +01002810 dump_server_addr(&srv->addr, srv_addr);
2811 dump_server_addr(&srv->check.addr, srv_check_addr);
2812 dump_server_addr(&srv->agent.addr, srv_agent_addr);
2813
Willy Tarreau69530f52023-04-28 09:16:15 +02002814 srv_time_since_last_change = ns_to_sec(now_ns) - srv->last_change;
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002815 bk_f_forced_id = px->options & PR_O_FORCED_ID ? 1 : 0;
William Lallemanda6c5f332016-11-19 02:25:36 +01002816 srv_f_forced_id = srv->flags & SRV_F_FORCED_ID ? 1 : 0;
2817
Baptiste Assmann6d0f38f2018-07-02 17:00:54 +02002818 srvrecord = NULL;
2819 if (srv->srvrq && srv->srvrq->name)
2820 srvrecord = srv->srvrq->name;
2821
Willy Tarreau72a04232022-05-05 17:00:20 +02002822 if (ctx->show_conn == 0) {
Willy Tarreau69f591e2020-07-01 07:00:59 +02002823 /* show servers state */
2824 chunk_printf(&trash,
2825 "%d %s "
2826 "%d %s %s "
2827 "%d %d %d %d %ld "
2828 "%d %d %d %d %d "
William Dauchyf6370442020-11-14 19:25:33 +01002829 "%d %d %s %u "
William Dauchyd1a7b852021-02-11 22:51:26 +01002830 "%s %d %d "
2831 "%s %s %d"
Willy Tarreau69f591e2020-07-01 07:00:59 +02002832 "\n",
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002833 px->uuid, HA_ANON_CLI(px->id),
Erwan Le Goas9ac3ccb2022-09-29 10:27:33 +02002834 srv->puid, HA_ANON_CLI(srv->id),
2835 hash_ipanon(appctx->cli_anon_key, srv_addr, 0),
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002836 srv->cur_state, srv->cur_admin, srv->uweight, srv->iweight,
2837 (long int)srv_time_since_last_change,
2838 srv->check.status, srv->check.result, srv->check.health,
Willy Tarreau99521ab2022-10-12 21:40:31 +02002839 srv->check.state & 0x0F, srv->agent.state & 0x1F,
Erwan Le Goas1caa5352022-09-29 10:28:44 +02002840 bk_f_forced_id, srv_f_forced_id,
2841 srv->hostname ? HA_ANON_CLI(srv->hostname) : "-", srv->svc_port,
William Dauchyd1a7b852021-02-11 22:51:26 +01002842 srvrecord ? srvrecord : "-", srv->use_ssl, srv->check.port,
2843 srv_check_addr, srv_agent_addr, srv->agent.port);
Willy Tarreau69f591e2020-07-01 07:00:59 +02002844 } else {
2845 /* show servers conn */
2846 int thr;
2847
2848 chunk_printf(&trash,
2849 "%s/%s %d/%d %s %u - %u %u %u %u %u %u %d %u",
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002850 HA_ANON_CLI(px->id), HA_ANON_CLI(srv->id),
Erwan Le Goas9ac3ccb2022-09-29 10:27:33 +02002851 px->uuid, srv->puid, hash_ipanon(appctx->cli_anon_key, srv_addr, 0),
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002852 srv->svc_port, srv->pool_purge_delay,
Willy Tarreau69f591e2020-07-01 07:00:59 +02002853 srv->curr_used_conns, srv->max_used_conns, srv->est_need_conns,
2854 srv->curr_idle_nb, srv->curr_safe_nb, (int)srv->max_idle_conns, srv->curr_idle_conns);
2855
Willy Tarreau42abe682020-07-02 15:19:57 +02002856 for (thr = 0; thr < global.nbthread && srv->curr_idle_thr; thr++)
Willy Tarreau69f591e2020-07-01 07:00:59 +02002857 chunk_appendf(&trash, " %u", srv->curr_idle_thr[thr]);
2858
2859 chunk_appendf(&trash, "\n");
2860 }
2861
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002862 if (applet_putchk(appctx, &trash) == -1) {
William Lallemanda6c5f332016-11-19 02:25:36 +01002863 return 0;
2864 }
2865 }
2866 return 1;
2867}
2868
2869/* Parses backend list or simply use backend name provided by the user to return
Willy Tarreau72a04232022-05-05 17:00:20 +02002870 * states of servers to stdout. It takes its context from show_srv_ctx and dumps
2871 * proxy ->px and stops if ->only_pxid is non-null.
William Lallemanda6c5f332016-11-19 02:25:36 +01002872 */
2873static int cli_io_handler_servers_state(struct appctx *appctx)
2874{
Willy Tarreau72a04232022-05-05 17:00:20 +02002875 struct show_srv_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02002876 struct stconn *sc = appctx_sc(appctx);
William Lallemanda6c5f332016-11-19 02:25:36 +01002877 struct proxy *curproxy;
2878
Willy Tarreaud741e9c2022-05-05 19:26:18 +02002879 if (ctx->state == SHOW_SRV_HEAD) {
Willy Tarreau72a04232022-05-05 17:00:20 +02002880 if (ctx->show_conn == 0)
Willy Tarreau69f591e2020-07-01 07:00:59 +02002881 chunk_printf(&trash, "%d\n# %s\n", SRV_STATE_FILE_VERSION, SRV_STATE_FILE_FIELD_NAMES);
2882 else
2883 chunk_printf(&trash,
2884 "# 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",
2885 global.nbthread);
2886
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002887 if (applet_putchk(appctx, &trash) == -1)
William Lallemanda6c5f332016-11-19 02:25:36 +01002888 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002889
Willy Tarreaud741e9c2022-05-05 19:26:18 +02002890 ctx->state = SHOW_SRV_LIST;
2891
2892 if (!ctx->px)
2893 ctx->px = proxies_list;
William Lallemanda6c5f332016-11-19 02:25:36 +01002894 }
2895
Willy Tarreau72a04232022-05-05 17:00:20 +02002896 for (; ctx->px != NULL; ctx->px = curproxy->next) {
2897 curproxy = ctx->px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002898 /* servers are only in backends */
William Lallemanda39e6262021-08-25 18:15:31 +02002899 if ((curproxy->cap & PR_CAP_BE) && !(curproxy->cap & PR_CAP_INT)) {
Willy Tarreau475e4632022-05-27 10:26:46 +02002900 if (!dump_servers_state(sc))
William Lallemanda6c5f332016-11-19 02:25:36 +01002901 return 0;
William Lallemanda6c5f332016-11-19 02:25:36 +01002902 }
2903 /* only the selected proxy is dumped */
Willy Tarreau72a04232022-05-05 17:00:20 +02002904 if (ctx->only_pxid)
William Lallemanda6c5f332016-11-19 02:25:36 +01002905 break;
2906 }
2907
2908 return 1;
2909}
2910
Willy Tarreau608ea592016-12-16 18:01:15 +01002911/* Parses backend list and simply report backend names. It keeps the proxy
Willy Tarreauacf6a442022-05-05 17:05:38 +02002912 * pointer in svcctx since there's nothing else to store there.
Willy Tarreau608ea592016-12-16 18:01:15 +01002913 */
William Lallemand933efcd2016-11-22 12:34:16 +01002914static int cli_io_handler_show_backend(struct appctx *appctx)
2915{
William Lallemand933efcd2016-11-22 12:34:16 +01002916 struct proxy *curproxy;
2917
2918 chunk_reset(&trash);
2919
Willy Tarreauacf6a442022-05-05 17:05:38 +02002920 if (!appctx->svcctx) {
William Lallemand933efcd2016-11-22 12:34:16 +01002921 chunk_printf(&trash, "# name\n");
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002922 if (applet_putchk(appctx, &trash) == -1)
William Lallemand933efcd2016-11-22 12:34:16 +01002923 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002924
Willy Tarreauacf6a442022-05-05 17:05:38 +02002925 appctx->svcctx = proxies_list;
William Lallemand933efcd2016-11-22 12:34:16 +01002926 }
2927
Willy Tarreauacf6a442022-05-05 17:05:38 +02002928 for (; appctx->svcctx != NULL; appctx->svcctx = curproxy->next) {
2929 curproxy = appctx->svcctx;
William Lallemand933efcd2016-11-22 12:34:16 +01002930
Willy Tarreau4f9f1572022-05-05 17:10:03 +02002931 /* looking for non-internal backends only */
2932 if ((curproxy->cap & (PR_CAP_BE|PR_CAP_INT)) != PR_CAP_BE)
William Lallemand933efcd2016-11-22 12:34:16 +01002933 continue;
2934
William Lallemand933efcd2016-11-22 12:34:16 +01002935 chunk_appendf(&trash, "%s\n", curproxy->id);
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002936 if (applet_putchk(appctx, &trash) == -1)
William Lallemand933efcd2016-11-22 12:34:16 +01002937 return 0;
William Lallemand933efcd2016-11-22 12:34:16 +01002938 }
2939
2940 return 1;
2941}
William Lallemanda6c5f332016-11-19 02:25:36 +01002942
Willy Tarreaua275a372018-08-21 14:50:44 +02002943/* Parses the "enable dynamic-cookies backend" directive, it always returns 1.
2944 *
2945 * Grabs the proxy lock and each server's lock.
2946 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002947static int cli_parse_enable_dyncookie_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01002948{
2949 struct proxy *px;
2950 struct server *s;
2951
2952 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
2953 return 1;
2954
2955 px = cli_find_backend(appctx, args[3]);
2956 if (!px)
2957 return 1;
2958
Willy Tarreau5e83d992019-07-30 11:59:34 +02002959 /* Note: this lock is to make sure this doesn't change while another
2960 * thread is in srv_set_dyncookie().
2961 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002962 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002963 px->ck_opts |= PR_CK_DYNAMIC;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002964 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002965
Willy Tarreaua275a372018-08-21 14:50:44 +02002966 for (s = px->srv; s != NULL; s = s->next) {
2967 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002968 srv_set_dyncookie(s);
Willy Tarreaua275a372018-08-21 14:50:44 +02002969 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
2970 }
2971
Olivier Houchard614f8d72017-03-14 20:08:46 +01002972 return 1;
2973}
2974
Willy Tarreaua275a372018-08-21 14:50:44 +02002975/* Parses the "disable dynamic-cookies backend" directive, it always returns 1.
2976 *
2977 * Grabs the proxy lock and each server's lock.
2978 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002979static int cli_parse_disable_dyncookie_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01002980{
2981 struct proxy *px;
2982 struct server *s;
2983
2984 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
2985 return 1;
2986
2987 px = cli_find_backend(appctx, args[3]);
2988 if (!px)
2989 return 1;
2990
Willy Tarreau5e83d992019-07-30 11:59:34 +02002991 /* Note: this lock is to make sure this doesn't change while another
2992 * thread is in srv_set_dyncookie().
2993 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002994 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002995 px->ck_opts &= ~PR_CK_DYNAMIC;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002996 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002997
2998 for (s = px->srv; s != NULL; s = s->next) {
Willy Tarreaua275a372018-08-21 14:50:44 +02002999 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003000 if (!(s->flags & SRV_F_COOKIESET))
3001 ha_free(&s->cookie);
Willy Tarreaua275a372018-08-21 14:50:44 +02003002 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003003 }
3004
3005 return 1;
3006}
3007
Willy Tarreaua275a372018-08-21 14:50:44 +02003008/* Parses the "set dynamic-cookie-key backend" directive, it always returns 1.
3009 *
3010 * Grabs the proxy lock and each server's lock.
3011 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003012static int cli_parse_set_dyncookie_key_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01003013{
3014 struct proxy *px;
3015 struct server *s;
3016 char *newkey;
3017
3018 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3019 return 1;
3020
3021 px = cli_find_backend(appctx, args[3]);
3022 if (!px)
3023 return 1;
3024
Willy Tarreau9d008692019-08-09 11:21:01 +02003025 if (!*args[4])
3026 return cli_err(appctx, "String value expected.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01003027
3028 newkey = strdup(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02003029 if (!newkey)
3030 return cli_err(appctx, "Failed to allocate memory.\n");
Willy Tarreaua275a372018-08-21 14:50:44 +02003031
Willy Tarreau5e83d992019-07-30 11:59:34 +02003032 /* Note: this lock is to make sure this doesn't change while another
3033 * thread is in srv_set_dyncookie().
3034 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003035 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003036 free(px->dyncookie_key);
3037 px->dyncookie_key = newkey;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003038 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003039
Willy Tarreaua275a372018-08-21 14:50:44 +02003040 for (s = px->srv; s != NULL; s = s->next) {
3041 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003042 srv_set_dyncookie(s);
Willy Tarreaua275a372018-08-21 14:50:44 +02003043 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
3044 }
3045
Olivier Houchard614f8d72017-03-14 20:08:46 +01003046 return 1;
3047}
3048
Willy Tarreaua275a372018-08-21 14:50:44 +02003049/* Parses the "set maxconn frontend" directive, it always returns 1.
3050 *
3051 * Grabs the proxy lock.
3052 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003053static int cli_parse_set_maxconn_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003054{
3055 struct proxy *px;
3056 struct listener *l;
3057 int v;
3058
3059 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3060 return 1;
3061
3062 px = cli_find_frontend(appctx, args[3]);
3063 if (!px)
3064 return 1;
3065
Willy Tarreau9d008692019-08-09 11:21:01 +02003066 if (!*args[4])
3067 return cli_err(appctx, "Integer value expected.\n");
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003068
3069 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02003070 if (v < 0)
3071 return cli_err(appctx, "Value out of range.\n");
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003072
3073 /* OK, the value is fine, so we assign it to the proxy and to all of
3074 * its listeners. The blocked ones will be dequeued.
3075 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003076 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaua275a372018-08-21 14:50:44 +02003077
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003078 px->maxconn = v;
3079 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003080 if (l->state == LI_FULL)
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +01003081 relax_listener(l, 1, 0);
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003082 }
3083
Willy Tarreau241797a2019-12-10 14:10:52 +01003084 if (px->maxconn > px->feconn)
3085 dequeue_proxy_listeners(px);
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003086
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003087 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaua275a372018-08-21 14:50:44 +02003088
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003089 return 1;
3090}
3091
Willy Tarreaua275a372018-08-21 14:50:44 +02003092/* Parses the "shutdown frontend" directive, it always returns 1.
3093 *
3094 * Grabs the proxy lock.
3095 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003096static int cli_parse_shutdown_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003097{
3098 struct proxy *px;
3099
3100 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3101 return 1;
3102
3103 px = cli_find_frontend(appctx, args[2]);
3104 if (!px)
3105 return 1;
3106
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003107 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003108 return cli_msg(appctx, LOG_NOTICE, "Frontend was already shut down.\n");
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003109
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003110 stop_proxy(px);
3111 return 1;
3112}
3113
Willy Tarreaua275a372018-08-21 14:50:44 +02003114/* Parses the "disable frontend" directive, it always returns 1.
3115 *
3116 * Grabs the proxy lock.
3117 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003118static int cli_parse_disable_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau15b9e682016-11-24 11:55:28 +01003119{
3120 struct proxy *px;
Willy Tarreaua275a372018-08-21 14:50:44 +02003121 int ret;
Willy Tarreau15b9e682016-11-24 11:55:28 +01003122
3123 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3124 return 1;
3125
3126 px = cli_find_frontend(appctx, args[2]);
3127 if (!px)
3128 return 1;
3129
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003130 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003131 return cli_msg(appctx, LOG_NOTICE, "Frontend was previously shut down, cannot disable.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003132
Willy Tarreauf18d9682020-09-24 08:04:27 +02003133 if (!px->li_ready)
3134 return cli_msg(appctx, LOG_NOTICE, "All sockets are already disabled.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003135
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02003136 /* pause_proxy will take PROXY_LOCK */
Willy Tarreaua275a372018-08-21 14:50:44 +02003137 ret = pause_proxy(px);
Willy Tarreaua275a372018-08-21 14:50:44 +02003138
Willy Tarreau9d008692019-08-09 11:21:01 +02003139 if (!ret)
3140 return cli_err(appctx, "Failed to pause frontend, check logs for precise cause.\n");
3141
Willy Tarreau15b9e682016-11-24 11:55:28 +01003142 return 1;
3143}
3144
Willy Tarreaua275a372018-08-21 14:50:44 +02003145/* Parses the "enable frontend" directive, it always returns 1.
3146 *
3147 * Grabs the proxy lock.
3148 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003149static int cli_parse_enable_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau15b9e682016-11-24 11:55:28 +01003150{
3151 struct proxy *px;
Willy Tarreaua275a372018-08-21 14:50:44 +02003152 int ret;
Willy Tarreau15b9e682016-11-24 11:55:28 +01003153
3154 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3155 return 1;
3156
3157 px = cli_find_frontend(appctx, args[2]);
3158 if (!px)
3159 return 1;
3160
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003161 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003162 return cli_err(appctx, "Frontend was previously shut down, cannot enable.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003163
Willy Tarreauf18d9682020-09-24 08:04:27 +02003164 if (px->li_ready == px->li_all)
3165 return cli_msg(appctx, LOG_NOTICE, "All sockets are already enabled.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003166
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02003167 /* resume_proxy will take PROXY_LOCK */
Willy Tarreaua275a372018-08-21 14:50:44 +02003168 ret = resume_proxy(px);
Willy Tarreaua275a372018-08-21 14:50:44 +02003169
Willy Tarreau9d008692019-08-09 11:21:01 +02003170 if (!ret)
3171 return cli_err(appctx, "Failed to resume frontend, check logs for precise cause (port conflict?).\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003172 return 1;
3173}
3174
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003175/* appctx context used during "show errors" */
3176struct show_errors_ctx {
3177 struct proxy *px; /* current proxy being dumped, NULL = not started yet. */
3178 unsigned int flag; /* bit0: buffer being dumped, 0 = req, 1 = resp ; bit1=skip req ; bit2=skip resp. */
3179 unsigned int ev_id; /* event ID of error being dumped */
3180 int iid; /* if >= 0, ID of the proxy to filter on */
3181 int ptr; /* <0: headers, >=0 : text pointer to restart from */
3182 int bol; /* pointer to beginning of current line */
3183};
3184
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003185/* "show errors" handler for the CLI. Returns 0 if wants to continue, 1 to stop
3186 * now.
3187 */
3188static int cli_parse_show_errors(char **args, char *payload, struct appctx *appctx, void *private)
3189{
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003190 struct show_errors_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
3191
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003192 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
3193 return 1;
3194
3195 if (*args[2]) {
3196 struct proxy *px;
3197
3198 px = proxy_find_by_name(args[2], 0, 0);
3199 if (px)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003200 ctx->iid = px->uuid;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003201 else
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003202 ctx->iid = atoi(args[2]);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003203
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003204 if (!ctx->iid)
Willy Tarreau9d008692019-08-09 11:21:01 +02003205 return cli_err(appctx, "No such proxy.\n");
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003206 }
3207 else
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003208 ctx->iid = -1; // dump all proxies
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003209
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003210 ctx->flag = 0;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003211 if (strcmp(args[3], "request") == 0)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003212 ctx->flag |= 4; // ignore response
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003213 else if (strcmp(args[3], "response") == 0)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003214 ctx->flag |= 2; // ignore request
3215 ctx->px = NULL;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003216 return 0;
3217}
3218
Willy Tarreau4596fe22022-05-17 19:07:51 +02003219/* This function dumps all captured errors onto the stream connector's
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003220 * read buffer. It returns 0 if the output buffer is full and it needs
3221 * to be called again, otherwise non-zero.
3222 */
3223static int cli_io_handler_show_errors(struct appctx *appctx)
3224{
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003225 struct show_errors_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02003226 struct stconn *sc = appctx_sc(appctx);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003227 extern const char *monthname[12];
3228
Christopher Faulet87633c32023-04-03 18:32:50 +02003229 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02003230 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003231 return 1;
3232
3233 chunk_reset(&trash);
3234
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003235 if (!ctx->px) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003236 /* the function had not been called yet, let's prepare the
3237 * buffer for a response.
3238 */
3239 struct tm tm;
3240
3241 get_localtime(date.tv_sec, &tm);
3242 chunk_appendf(&trash, "Total events captured on [%02d/%s/%04d:%02d:%02d:%02d.%03d] : %u\n",
3243 tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3244 tm.tm_hour, tm.tm_min, tm.tm_sec, (int)(date.tv_usec/1000),
3245 error_snapshot_id);
3246
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003247 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003248 goto cant_send;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003249
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003250 ctx->px = proxies_list;
3251 ctx->bol = 0;
3252 ctx->ptr = -1;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003253 }
3254
3255 /* we have two inner loops here, one for the proxy, the other one for
3256 * the buffer.
3257 */
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003258 while (ctx->px) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003259 struct error_snapshot *es;
3260
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003261 HA_RWLOCK_RDLOCK(PROXY_LOCK, &ctx->px->lock);
Willy Tarreau36b27362018-09-07 19:55:44 +02003262
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003263 if ((ctx->flag & 1) == 0) {
3264 es = ctx->px->invalid_req;
3265 if (ctx->flag & 2) // skip req
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003266 goto next;
3267 }
3268 else {
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003269 es = ctx->px->invalid_rep;
3270 if (ctx->flag & 4) // skip resp
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003271 goto next;
3272 }
3273
Willy Tarreauc55015e2018-09-07 19:02:32 +02003274 if (!es)
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003275 goto next;
3276
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003277 if (ctx->iid >= 0 &&
3278 ctx->px->uuid != ctx->iid &&
3279 (!es->oe || es->oe->uuid != ctx->iid))
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003280 goto next;
3281
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003282 if (ctx->ptr < 0) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003283 /* just print headers now */
3284
3285 char pn[INET6_ADDRSTRLEN];
3286 struct tm tm;
3287 int port;
3288
3289 get_localtime(es->when.tv_sec, &tm);
3290 chunk_appendf(&trash, " \n[%02d/%s/%04d:%02d:%02d:%02d.%03d]",
3291 tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3292 tm.tm_hour, tm.tm_min, tm.tm_sec, (int)(es->when.tv_usec/1000));
3293
3294 switch (addr_to_str(&es->src, pn, sizeof(pn))) {
3295 case AF_INET:
3296 case AF_INET6:
3297 port = get_host_port(&es->src);
3298 break;
3299 default:
3300 port = 0;
3301 }
3302
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003303 switch (ctx->flag & 1) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003304 case 0:
3305 chunk_appendf(&trash,
3306 " frontend %s (#%d): invalid request\n"
3307 " backend %s (#%d)",
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003308 ctx->px->id, ctx->px->uuid,
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003309 (es->oe && es->oe->cap & PR_CAP_BE) ? es->oe->id : "<NONE>",
3310 (es->oe && es->oe->cap & PR_CAP_BE) ? es->oe->uuid : -1);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003311 break;
3312 case 1:
3313 chunk_appendf(&trash,
3314 " backend %s (#%d): invalid response\n"
3315 " frontend %s (#%d)",
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003316 ctx->px->id, ctx->px->uuid,
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003317 es->oe ? es->oe->id : "<NONE>" , es->oe ? es->oe->uuid : -1);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003318 break;
3319 }
3320
3321 chunk_appendf(&trash,
3322 ", server %s (#%d), event #%u, src %s:%d\n"
3323 " buffer starts at %llu (including %u out), %u free,\n"
3324 " len %u, wraps at %u, error at position %u\n",
3325 es->srv ? es->srv->id : "<NONE>",
3326 es->srv ? es->srv->puid : -1,
3327 es->ev_id, pn, port,
3328 es->buf_ofs, es->buf_out,
3329 global.tune.bufsize - es->buf_out - es->buf_len,
3330 es->buf_len, es->buf_wrap, es->buf_err);
3331
3332 if (es->show)
3333 es->show(&trash, es);
3334
3335 chunk_appendf(&trash, " \n");
3336
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003337 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003338 goto cant_send_unlock;
3339
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003340 ctx->ptr = 0;
3341 ctx->ev_id = es->ev_id;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003342 }
3343
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003344 if (ctx->ev_id != es->ev_id) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003345 /* the snapshot changed while we were dumping it */
3346 chunk_appendf(&trash,
3347 " WARNING! update detected on this snapshot, dump interrupted. Please re-check!\n");
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003348 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003349 goto cant_send_unlock;
3350
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003351 goto next;
3352 }
3353
3354 /* OK, ptr >= 0, so we have to dump the current line */
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003355 while (ctx->ptr < es->buf_len && ctx->ptr < global.tune.bufsize) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003356 int newptr;
3357 int newline;
3358
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003359 newline = ctx->bol;
3360 newptr = dump_text_line(&trash, es->buf, global.tune.bufsize, es->buf_len, &newline, ctx->ptr);
Christopher Faulet7b3d38a2023-05-05 11:28:45 +02003361 if (newptr == ctx->ptr) {
3362 sc_need_room(sc, 0);
Willy Tarreau36b27362018-09-07 19:55:44 +02003363 goto cant_send_unlock;
Christopher Faulet7b3d38a2023-05-05 11:28:45 +02003364 }
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003365
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003366 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003367 goto cant_send_unlock;
3368
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003369 ctx->ptr = newptr;
3370 ctx->bol = newline;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003371 };
3372 next:
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003373 HA_RWLOCK_RDUNLOCK(PROXY_LOCK, &ctx->px->lock);
3374 ctx->bol = 0;
3375 ctx->ptr = -1;
3376 ctx->flag ^= 1;
3377 if (!(ctx->flag & 1))
3378 ctx->px = ctx->px->next;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003379 }
3380
3381 /* dump complete */
3382 return 1;
Willy Tarreau36b27362018-09-07 19:55:44 +02003383
3384 cant_send_unlock:
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003385 HA_RWLOCK_RDUNLOCK(PROXY_LOCK, &ctx->px->lock);
Willy Tarreau36b27362018-09-07 19:55:44 +02003386 cant_send:
Willy Tarreau36b27362018-09-07 19:55:44 +02003387 return 0;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003388}
3389
William Lallemanda6c5f332016-11-19 02:25:36 +01003390/* register cli keywords */
3391static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003392 { { "disable", "frontend", NULL }, "disable frontend <frontend> : temporarily disable specific frontend", cli_parse_disable_frontend, NULL, NULL },
3393 { { "enable", "frontend", NULL }, "enable frontend <frontend> : re-enable specific frontend", cli_parse_enable_frontend, NULL, NULL },
3394 { { "set", "maxconn", "frontend", NULL }, "set maxconn frontend <frontend> <value> : change a frontend's maxconn setting", cli_parse_set_maxconn_frontend, NULL },
3395 { { "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 },
3396 { { "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 },
3397 { { "show", "backend", NULL }, "show backend : list backends in the current running config", NULL, cli_io_handler_show_backend },
3398 { { "shutdown", "frontend", NULL }, "shutdown frontend <frontend> : stop a specific frontend", cli_parse_shutdown_frontend, NULL, NULL },
3399 { { "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 },
3400 { { "enable", "dynamic-cookie", "backend", NULL }, "enable dynamic-cookie backend <bk> : enable dynamic cookies on a specific backend", cli_parse_enable_dyncookie_backend, NULL },
3401 { { "disable", "dynamic-cookie", "backend", NULL }, "disable dynamic-cookie backend <bk> : disable dynamic cookies on a specific backend", cli_parse_disable_dyncookie_backend, NULL },
3402 { { "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 +01003403 {{},}
3404}};
3405
Willy Tarreau0108d902018-11-25 19:14:37 +01003406INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
Willy Tarreaubaaee002006-06-26 02:48:02 +02003407
3408/*
3409 * Local variables:
3410 * c-indent-level: 8
3411 * c-basic-offset: 8
3412 * End:
3413 */