blob: a15acc13b4bbd26301c785945bd24825948899aa [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * Proxy variables and functions.
3 *
Willy Tarreau3a7d2072009-03-05 23:48:25 +01004 * Copyright 2000-2009 Willy Tarreau <w@1wt.eu>
Willy Tarreaubaaee002006-06-26 02:48:02 +02005 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreaubaaee002006-06-26 02:48:02 +020013#include <unistd.h>
Willy Tarreauc8f24f82007-11-30 18:38:35 +010014#include <string.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020015#include <sys/types.h>
16#include <sys/socket.h>
17#include <sys/stat.h>
18
Willy Tarreaub2551052020-06-09 09:07:15 +020019#include <import/eb32tree.h>
20#include <import/ebistree.h>
21
Amaury Denoyelle27fefa12021-03-24 16:13:20 +010022#include <haproxy/acl.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020023#include <haproxy/api.h>
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +020024#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020025#include <haproxy/capture-t.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020026#include <haproxy/cfgparse.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020027#include <haproxy/cli.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020028#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/fd.h>
Willy Tarreauc7babd82020-06-04 21:29:29 +020030#include <haproxy/filters.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020031#include <haproxy/global.h>
Willy Tarreauc2b1ff02020-06-04 21:21:03 +020032#include <haproxy/http_ana.h>
Willy Tarreau76838932021-02-12 08:49:47 +010033#include <haproxy/http_htx.h>
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +010034#include <haproxy/http_ext.h>
Aurelien DARRAGON7abc9222023-05-11 10:30:27 +020035#include <haproxy/http_rules.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020036#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020037#include <haproxy/log.h>
Willy Tarreau8efbdfb2020-06-04 11:29:21 +020038#include <haproxy/obj_type-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020039#include <haproxy/peers.h>
Willy Tarreaud0ef4392020-06-02 09:38:52 +020040#include <haproxy/pool.h>
Willy Tarreau626f3a72020-10-07 16:52:43 +020041#include <haproxy/protocol.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/proto_tcp.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020043#include <haproxy/proxy.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020044#include <haproxy/sc_strm.h>
Frédéric Lécaille748ece62022-05-21 23:58:40 +020045#include <haproxy/quic_tp.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020046#include <haproxy/server-t.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020047#include <haproxy/signal.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020048#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020049#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020050#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020051#include <haproxy/task.h>
Willy Tarreau76838932021-02-12 08:49:47 +010052#include <haproxy/tcpcheck.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020053#include <haproxy/time.h>
Willy Tarreaue6844832021-05-08 13:02:07 +020054#include <haproxy/tools.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020055
Willy Tarreaubaaee002006-06-26 02:48:02 +020056
Willy Tarreau918ff602011-07-25 16:33:49 +020057int listeners; /* # of proxy listeners, set by cfgparse */
Olivier Houchardfbc74e82017-11-24 16:54:05 +010058struct proxy *proxies_list = NULL; /* list of all existing proxies */
Willy Tarreau53fb4ae2009-10-04 23:04:08 +020059struct eb_root used_proxy_id = EB_ROOT; /* list of proxy IDs in use */
Willy Tarreauf79d9502014-03-15 07:22:35 +010060struct eb_root proxy_by_name = EB_ROOT; /* tree of proxies sorted by name */
Willy Tarreau0a0f6a72021-02-12 13:52:11 +010061struct eb_root defproxy_by_name = EB_ROOT; /* tree of default proxies sorted by name (dups possible) */
Willy Tarreau10479e42010-12-12 14:00:34 +010062unsigned int error_snapshot_id = 0; /* global ID assigned to each error then incremented */
Willy Tarreaubaaee002006-06-26 02:48:02 +020063
Willy Tarreau72a04232022-05-05 17:00:20 +020064/* CLI context used during "show servers {state|conn}" */
65struct show_srv_ctx {
66 struct proxy *px; /* current proxy to dump or NULL */
67 struct server *sv; /* current server to dump or NULL */
68 uint only_pxid; /* dump only this proxy ID when explicit */
69 int show_conn; /* non-zero = "conn" otherwise "state" */
Willy Tarreaud741e9c2022-05-05 19:26:18 +020070 enum {
71 SHOW_SRV_HEAD = 0,
72 SHOW_SRV_LIST,
73 } state;
Willy Tarreau72a04232022-05-05 17:00:20 +020074};
75
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010076/* proxy->options */
77const struct cfg_opt cfg_opts[] =
78{
79 { "abortonclose", PR_O_ABRT_CLOSE, PR_CAP_BE, 0, 0 },
80 { "allbackups", PR_O_USE_ALL_BK, PR_CAP_BE, 0, 0 },
81 { "checkcache", PR_O_CHK_CACHE, PR_CAP_BE, 0, PR_MODE_HTTP },
82 { "clitcpka", PR_O_TCP_CLI_KA, PR_CAP_FE, 0, 0 },
83 { "contstats", PR_O_CONTSTATS, PR_CAP_FE, 0, 0 },
84 { "dontlognull", PR_O_NULLNOLOG, PR_CAP_FE, 0, 0 },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010085 { "http-buffer-request", PR_O_WREQ_BODY, PR_CAP_FE | PR_CAP_BE, 0, PR_MODE_HTTP },
86 { "http-ignore-probes", PR_O_IGNORE_PRB, PR_CAP_FE, 0, PR_MODE_HTTP },
William Dauchya9dd9012022-01-05 22:53:24 +010087 { "idle-close-on-response", PR_O_IDLE_CLOSE_RESP, PR_CAP_FE, 0, PR_MODE_HTTP },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010088 { "prefer-last-server", PR_O_PREF_LAST, PR_CAP_BE, 0, PR_MODE_HTTP },
89 { "logasap", PR_O_LOGASAP, PR_CAP_FE, 0, 0 },
90 { "nolinger", PR_O_TCP_NOLING, PR_CAP_FE | PR_CAP_BE, 0, 0 },
91 { "persist", PR_O_PERSIST, PR_CAP_BE, 0, 0 },
92 { "srvtcpka", PR_O_TCP_SRV_KA, PR_CAP_BE, 0, 0 },
Willy Tarreaue5733232019-05-22 19:24:06 +020093#ifdef USE_TPROXY
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +010094 { "transparent", PR_O_TRANSP, PR_CAP_BE, 0, 0 },
95#else
96 { "transparent", 0, 0, 0, 0 },
97#endif
98
99 { NULL, 0, 0, 0, 0 }
100};
101
102/* proxy->options2 */
103const struct cfg_opt cfg_opts2[] =
104{
Willy Tarreaue5733232019-05-22 19:24:06 +0200105#ifdef USE_LINUX_SPLICE
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +0100106 { "splice-request", PR_O2_SPLIC_REQ, PR_CAP_FE|PR_CAP_BE, 0, 0 },
107 { "splice-response", PR_O2_SPLIC_RTR, PR_CAP_FE|PR_CAP_BE, 0, 0 },
108 { "splice-auto", PR_O2_SPLIC_AUT, PR_CAP_FE|PR_CAP_BE, 0, 0 },
109#else
110 { "splice-request", 0, 0, 0, 0 },
111 { "splice-response", 0, 0, 0, 0 },
112 { "splice-auto", 0, 0, 0, 0 },
113#endif
114 { "accept-invalid-http-request", PR_O2_REQBUG_OK, PR_CAP_FE, 0, PR_MODE_HTTP },
115 { "accept-invalid-http-response", PR_O2_RSPBUG_OK, PR_CAP_BE, 0, PR_MODE_HTTP },
116 { "dontlog-normal", PR_O2_NOLOGNORM, PR_CAP_FE, 0, 0 },
117 { "log-separate-errors", PR_O2_LOGERRORS, PR_CAP_FE, 0, 0 },
118 { "log-health-checks", PR_O2_LOGHCHKS, PR_CAP_BE, 0, 0 },
119 { "socket-stats", PR_O2_SOCKSTAT, PR_CAP_FE, 0, 0 },
120 { "tcp-smart-accept", PR_O2_SMARTACC, PR_CAP_FE, 0, 0 },
121 { "tcp-smart-connect", PR_O2_SMARTCON, PR_CAP_BE, 0, 0 },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +0100122 { "independent-streams", PR_O2_INDEPSTR, PR_CAP_FE|PR_CAP_BE, 0, 0 },
123 { "http-use-proxy-header", PR_O2_USE_PXHDR, PR_CAP_FE, 0, PR_MODE_HTTP },
124 { "http-pretend-keepalive", PR_O2_FAKE_KA, PR_CAP_BE, 0, PR_MODE_HTTP },
125 { "http-no-delay", PR_O2_NODELAY, PR_CAP_FE|PR_CAP_BE, 0, PR_MODE_HTTP },
Christopher Faulet98fbe952019-07-22 16:18:24 +0200126
Christopher Fauleta9e934b2022-09-06 10:09:40 +0200127 {"h1-case-adjust-bogus-client", PR_O2_H1_ADJ_BUGCLI, PR_CAP_FE, 0, 0 },
128 {"h1-case-adjust-bogus-server", PR_O2_H1_ADJ_BUGSRV, PR_CAP_BE, 0, 0 },
Christopher Faulet89aed322020-06-02 17:33:56 +0200129 {"disable-h2-upgrade", PR_O2_NO_H2_UPGRADE, PR_CAP_FE, 0, PR_MODE_HTTP },
Willy Tarreau3a1f5fd2018-11-11 15:40:36 +0100130 { NULL, 0, 0, 0 }
131};
132
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100133static void free_stick_rules(struct list *rules)
134{
135 struct sticking_rule *rule, *ruleb;
136
137 list_for_each_entry_safe(rule, ruleb, rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200138 LIST_DELETE(&rule->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100139 free_acl_cond(rule->cond);
140 release_sample_expr(rule->expr);
141 free(rule);
142 }
143}
144
145void free_proxy(struct proxy *p)
146{
Amaury Denoyellef5c1e122021-08-25 15:03:46 +0200147 struct server *s;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100148 struct cap_hdr *h,*h_next;
149 struct listener *l,*l_next;
150 struct bind_conf *bind_conf, *bind_back;
151 struct acl_cond *cond, *condb;
152 struct acl *acl, *aclb;
153 struct server_rule *srule, *sruleb;
154 struct switching_rule *rule, *ruleb;
155 struct redirect_rule *rdr, *rdrb;
156 struct logsrv *log, *logb;
157 struct logformat_node *lf, *lfb;
158 struct proxy_deinit_fct *pxdf;
159 struct server_deinit_fct *srvdf;
160
William Lallemandb0281a42021-08-20 10:16:37 +0200161 if (!p)
162 return;
163
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100164 free(p->conf.file);
165 free(p->id);
166 free(p->cookie_name);
167 free(p->cookie_domain);
168 free(p->cookie_attrs);
169 free(p->lbprm.arg_str);
Willy Tarreau7c9a0fe2022-04-25 10:25:34 +0200170 release_sample_expr(p->lbprm.expr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100171 free(p->server_state_file_name);
172 free(p->capture_name);
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +0100173 istfree(&p->monitor_uri);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100174 free(p->rdp_cookie_name);
175 free(p->invalid_rep);
176 free(p->invalid_req);
177#if defined(CONFIG_HAP_TRANSPARENT)
178 free(p->conn_src.bind_hdr_name);
179#endif
180 if (p->conf.logformat_string != default_http_log_format &&
181 p->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +0200182 p->conf.logformat_string != clf_http_log_format &&
William Lallemandbe6a8732022-12-22 15:37:01 +0100183 p->conf.logformat_string != default_https_log_format &&
184 p->conf.logformat_string != httpclient_log_format)
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100185 free(p->conf.logformat_string);
186
187 free(p->conf.lfs_file);
188 free(p->conf.uniqueid_format_string);
189 istfree(&p->header_unique_id);
190 free(p->conf.uif_file);
191 if ((p->lbprm.algo & BE_LB_LKUP) == BE_LB_LKUP_MAP)
192 free(p->lbprm.map.srv);
193
194 if (p->conf.logformat_sd_string != default_rfc5424_sd_log_format)
195 free(p->conf.logformat_sd_string);
196 free(p->conf.lfsd_file);
197
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +0200198 free(p->conf.error_logformat_string);
199 free(p->conf.elfs_file);
200
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100201 list_for_each_entry_safe(cond, condb, &p->mon_fail_cond, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200202 LIST_DELETE(&cond->list);
Aurelien DARRAGONc6100952023-05-11 12:29:51 +0200203 free_acl_cond(cond);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100204 }
205
206 EXTRA_COUNTERS_FREE(p->extra_counters_fe);
207 EXTRA_COUNTERS_FREE(p->extra_counters_be);
208
209 list_for_each_entry_safe(acl, aclb, &p->acl, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200210 LIST_DELETE(&acl->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100211 prune_acl(acl);
212 free(acl);
213 }
214
215 list_for_each_entry_safe(srule, sruleb, &p->server_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200216 LIST_DELETE(&srule->list);
Aurelien DARRAGONc6100952023-05-11 12:29:51 +0200217 free_acl_cond(srule->cond);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100218 list_for_each_entry_safe(lf, lfb, &srule->expr, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200219 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100220 release_sample_expr(lf->expr);
221 free(lf->arg);
222 free(lf);
223 }
224 free(srule->file);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100225 free(srule);
226 }
227
228 list_for_each_entry_safe(rule, ruleb, &p->switching_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200229 LIST_DELETE(&rule->list);
Aurelien DARRAGONc6100952023-05-11 12:29:51 +0200230 free_acl_cond(rule->cond);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100231 free(rule->file);
232 free(rule);
233 }
234
235 list_for_each_entry_safe(rdr, rdrb, &p->redirect_rules, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200236 LIST_DELETE(&rdr->list);
Aurelien DARRAGON7abc9222023-05-11 10:30:27 +0200237 http_free_redirect_rule(rdr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100238 }
239
240 list_for_each_entry_safe(log, logb, &p->logsrvs, list) {
Willy Tarreau211ea252022-03-17 19:47:33 +0100241 LIST_DEL_INIT(&log->list);
242 free_logsrv(log);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100243 }
244
245 list_for_each_entry_safe(lf, lfb, &p->logformat, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200246 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100247 release_sample_expr(lf->expr);
248 free(lf->arg);
249 free(lf);
250 }
251
252 list_for_each_entry_safe(lf, lfb, &p->logformat_sd, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200253 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100254 release_sample_expr(lf->expr);
255 free(lf->arg);
256 free(lf);
257 }
258
259 list_for_each_entry_safe(lf, lfb, &p->format_unique_id, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200260 LIST_DELETE(&lf->list);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100261 release_sample_expr(lf->expr);
262 free(lf->arg);
263 free(lf);
264 }
265
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +0200266 list_for_each_entry_safe(lf, lfb, &p->logformat_error, list) {
267 LIST_DELETE(&lf->list);
268 release_sample_expr(lf->expr);
269 free(lf->arg);
270 free(lf);
271 }
272
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100273 free_act_rules(&p->tcp_req.inspect_rules);
274 free_act_rules(&p->tcp_rep.inspect_rules);
275 free_act_rules(&p->tcp_req.l4_rules);
276 free_act_rules(&p->tcp_req.l5_rules);
277 free_act_rules(&p->http_req_rules);
278 free_act_rules(&p->http_res_rules);
279 free_act_rules(&p->http_after_res_rules);
280
281 free_stick_rules(&p->storersp_rules);
282 free_stick_rules(&p->sticking_rules);
283
284 h = p->req_cap;
285 while (h) {
Christopher Faulet57962282022-04-25 14:30:58 +0200286 if (p->defpx && h == p->defpx->req_cap)
287 break;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100288 h_next = h->next;
289 free(h->name);
290 pool_destroy(h->pool);
291 free(h);
292 h = h_next;
293 }/* end while(h) */
294
295 h = p->rsp_cap;
296 while (h) {
Christopher Faulet57962282022-04-25 14:30:58 +0200297 if (p->defpx && h == p->defpx->rsp_cap)
298 break;
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100299 h_next = h->next;
300 free(h->name);
301 pool_destroy(h->pool);
302 free(h);
303 h = h_next;
304 }/* end while(h) */
305
306 s = p->srv;
307 while (s) {
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100308 list_for_each_entry(srvdf, &server_deinit_list, list)
309 srvdf->fct(s);
Amaury Denoyellebc2ebfa2021-08-25 15:34:53 +0200310 s = srv_drop(s);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100311 }/* end while(s) */
312
Aurelien DARRAGON899b5472023-06-01 12:07:43 +0200313 /* also free default-server parameters since some of them might have
314 * been dynamically allocated (e.g.: config hints, cookies, ssl..)
315 */
316 srv_free_params(&p->defsrv);
317
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100318 list_for_each_entry_safe(l, l_next, &p->conf.listeners, by_fe) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200319 LIST_DELETE(&l->by_fe);
320 LIST_DELETE(&l->by_bind);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100321 free(l->name);
Amaury Denoyellef68b2cb2022-01-25 16:21:47 +0100322 free(l->per_thr);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100323 free(l->counters);
324
325 EXTRA_COUNTERS_FREE(l->extra_counters);
326 free(l);
327 }
328
329 /* Release unused SSL configs. */
330 list_for_each_entry_safe(bind_conf, bind_back, &p->conf.bind, by_fe) {
331 if (bind_conf->xprt->destroy_bind_conf)
332 bind_conf->xprt->destroy_bind_conf(bind_conf);
333 free(bind_conf->file);
334 free(bind_conf->arg);
Aurelien DARRAGON12d6b9a2023-06-01 10:58:44 +0200335 free(bind_conf->settings.interface);
Willy Tarreau2b718102021-04-21 07:32:39 +0200336 LIST_DELETE(&bind_conf->by_fe);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100337 free(bind_conf);
338 }
339
340 flt_deinit(p);
341
342 list_for_each_entry(pxdf, &proxy_deinit_list, list)
343 pxdf->fct(p);
344
345 free(p->desc);
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +0100346
347 http_ext_clean(p);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100348
349 task_destroy(p->task);
350
351 pool_destroy(p->req_cap_pool);
352 pool_destroy(p->rsp_cap_pool);
353 if (p->table)
354 pool_destroy(p->table->pool);
355
356 HA_RWLOCK_DESTROY(&p->lbprm.lock);
357 HA_RWLOCK_DESTROY(&p->lock);
Christopher Faulet57962282022-04-25 14:30:58 +0200358
359 proxy_unref_defaults(p);
Amaury Denoyelle27fefa12021-03-24 16:13:20 +0100360 ha_free(&p);
361}
362
Willy Tarreau977b8e42006-12-29 14:19:17 +0100363/*
Willy Tarreau816eb542007-11-04 07:04:43 +0100364 * This function returns a string containing a name describing capabilities to
365 * report comprehensible error messages. Specifically, it will return the words
Willy Tarreau80dc6fe2021-02-12 09:43:33 +0100366 * "frontend", "backend" when appropriate, "defaults" if it corresponds to a
367 * defaults section, or "proxy" for all other cases including the proxies
368 * declared in "listen" mode.
Willy Tarreau977b8e42006-12-29 14:19:17 +0100369 */
Willy Tarreau816eb542007-11-04 07:04:43 +0100370const char *proxy_cap_str(int cap)
Willy Tarreau977b8e42006-12-29 14:19:17 +0100371{
Willy Tarreau80dc6fe2021-02-12 09:43:33 +0100372 if (cap & PR_CAP_DEF)
373 return "defaults";
374
Willy Tarreau816eb542007-11-04 07:04:43 +0100375 if ((cap & PR_CAP_LISTEN) != PR_CAP_LISTEN) {
376 if (cap & PR_CAP_FE)
377 return "frontend";
378 else if (cap & PR_CAP_BE)
379 return "backend";
Willy Tarreau816eb542007-11-04 07:04:43 +0100380 }
381 return "proxy";
Willy Tarreau977b8e42006-12-29 14:19:17 +0100382}
383
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100384/*
385 * This function returns a string containing the mode of the proxy in a format
386 * suitable for error messages.
387 */
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100388const char *proxy_mode_str(int mode) {
389
390 if (mode == PR_MODE_TCP)
391 return "tcp";
392 else if (mode == PR_MODE_HTTP)
393 return "http";
William Lallemandcf62f7e2018-10-26 14:47:40 +0200394 else if (mode == PR_MODE_CLI)
395 return "cli";
William Lallemand06715af2022-03-08 11:50:59 +0100396 else if (mode == PR_MODE_SYSLOG)
397 return "syslog";
398 else if (mode == PR_MODE_PEERS)
399 return "peers";
Krzysztof Piotr Oledzki6eb730d2007-11-03 23:41:58 +0100400 else
401 return "unknown";
402}
403
Willy Tarreau31a3cea2021-03-15 11:11:55 +0100404/* try to find among known options the one that looks closest to <word> by
405 * counting transitions between letters, digits and other characters. Will
406 * return the best matching word if found, otherwise NULL. An optional array
407 * of extra words to compare may be passed in <extra>, but it must then be
408 * terminated by a NULL entry. If unused it may be NULL.
409 */
410const char *proxy_find_best_option(const char *word, const char **extra)
411{
412 uint8_t word_sig[1024];
413 uint8_t list_sig[1024];
414 const char *best_ptr = NULL;
415 int dist, best_dist = INT_MAX;
416 int index;
417
418 make_word_fingerprint(word_sig, word);
419
420 for (index = 0; cfg_opts[index].name; index++) {
421 make_word_fingerprint(list_sig, cfg_opts[index].name);
422 dist = word_fingerprint_distance(word_sig, list_sig);
423 if (dist < best_dist) {
424 best_dist = dist;
425 best_ptr = cfg_opts[index].name;
426 }
427 }
428
429 for (index = 0; cfg_opts2[index].name; index++) {
430 make_word_fingerprint(list_sig, cfg_opts2[index].name);
431 dist = word_fingerprint_distance(word_sig, list_sig);
432 if (dist < best_dist) {
433 best_dist = dist;
434 best_ptr = cfg_opts2[index].name;
435 }
436 }
437
438 while (extra && *extra) {
439 make_word_fingerprint(list_sig, *extra);
440 dist = word_fingerprint_distance(word_sig, list_sig);
441 if (dist < best_dist) {
442 best_dist = dist;
443 best_ptr = *extra;
444 }
445 extra++;
446 }
447
448 if (best_dist > 2 * strlen(word) || (best_ptr && best_dist > 2 * strlen(best_ptr)))
449 best_ptr = NULL;
450 return best_ptr;
451}
452
Willy Tarreauf3950172009-10-10 18:35:51 +0200453/*
454 * This function scans the list of backends and servers to retrieve the first
455 * backend and the first server with the given names, and sets them in both
456 * parameters. It returns zero if either is not found, or non-zero and sets
457 * the ones it did not found to NULL. If a NULL pointer is passed for the
458 * backend, only the pointer to the server will be updated.
459 */
460int get_backend_server(const char *bk_name, const char *sv_name,
461 struct proxy **bk, struct server **sv)
462{
463 struct proxy *p;
464 struct server *s;
Willy Tarreau7ecc4202014-03-15 07:57:11 +0100465 int sid;
Willy Tarreauf3950172009-10-10 18:35:51 +0200466
467 *sv = NULL;
468
Willy Tarreau050536d2012-10-04 08:47:34 +0200469 sid = -1;
Willy Tarreaucfeaa472009-10-10 22:33:08 +0200470 if (*sv_name == '#')
471 sid = atoi(sv_name + 1);
472
Willy Tarreau9e0bb102015-05-26 11:24:42 +0200473 p = proxy_be_by_name(bk_name);
Willy Tarreauf3950172009-10-10 18:35:51 +0200474 if (bk)
475 *bk = p;
476 if (!p)
477 return 0;
478
479 for (s = p->srv; s; s = s->next)
Willy Tarreau4055a102012-11-15 00:15:18 +0100480 if ((sid >= 0 && s->puid == sid) ||
481 (sid < 0 && strcmp(s->id, sv_name) == 0))
Willy Tarreauf3950172009-10-10 18:35:51 +0200482 break;
483 *sv = s;
484 if (!s)
485 return 0;
486 return 1;
487}
488
Willy Tarreaue219db72007-12-03 01:30:13 +0100489/* This function parses a "timeout" statement in a proxy section. It returns
490 * -1 if there is any error, 1 for a warning, otherwise zero. If it does not
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200491 * return zero, it will write an error or warning message into a preallocated
492 * buffer returned at <err>. The trailing is not be written. The function must
493 * be called with <args> pointing to the first command line word, with <proxy>
494 * pointing to the proxy being parsed, and <defpx> to the default proxy or NULL.
495 * As a special case for compatibility with older configs, it also accepts
496 * "{cli|srv|con}timeout" in args[0].
Willy Tarreaue219db72007-12-03 01:30:13 +0100497 */
Willy Tarreau9de1bbd2008-07-09 20:34:27 +0200498static int proxy_parse_timeout(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100499 const struct proxy *defpx, const char *file, int line,
Willy Tarreau28a47d62012-09-18 20:02:48 +0200500 char **err)
Willy Tarreaue219db72007-12-03 01:30:13 +0100501{
502 unsigned timeout;
503 int retval, cap;
504 const char *res, *name;
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200505 int *tv = NULL;
Willy Tarreau01825162021-03-09 09:53:46 +0100506 const int *td = NULL;
Willy Tarreaue219db72007-12-03 01:30:13 +0100507
508 retval = 0;
Willy Tarreau9de1bbd2008-07-09 20:34:27 +0200509
510 /* simply skip "timeout" but remain compatible with old form */
511 if (strcmp(args[0], "timeout") == 0)
512 args++;
513
Willy Tarreaue219db72007-12-03 01:30:13 +0100514 name = args[0];
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100515 if (strcmp(args[0], "client") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100516 name = "client";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100517 tv = &proxy->timeout.client;
518 td = &defpx->timeout.client;
Willy Tarreaue219db72007-12-03 01:30:13 +0100519 cap = PR_CAP_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100520 } else if (strcmp(args[0], "tarpit") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100521 tv = &proxy->timeout.tarpit;
522 td = &defpx->timeout.tarpit;
Willy Tarreau51c9bde2008-01-06 13:40:03 +0100523 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100524 } else if (strcmp(args[0], "http-keep-alive") == 0) {
Willy Tarreaub16a5742010-01-10 14:46:16 +0100525 tv = &proxy->timeout.httpka;
526 td = &defpx->timeout.httpka;
527 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100528 } else if (strcmp(args[0], "http-request") == 0) {
Willy Tarreau036fae02008-01-06 13:24:40 +0100529 tv = &proxy->timeout.httpreq;
530 td = &defpx->timeout.httpreq;
Willy Tarreaucd7afc02009-07-12 10:03:17 +0200531 cap = PR_CAP_FE | PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100532 } else if (strcmp(args[0], "server") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100533 name = "server";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100534 tv = &proxy->timeout.server;
535 td = &defpx->timeout.server;
Willy Tarreaue219db72007-12-03 01:30:13 +0100536 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100537 } else if (strcmp(args[0], "connect") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100538 name = "connect";
Willy Tarreaud7c30f92007-12-03 01:38:36 +0100539 tv = &proxy->timeout.connect;
540 td = &defpx->timeout.connect;
Willy Tarreaue219db72007-12-03 01:30:13 +0100541 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100542 } else if (strcmp(args[0], "check") == 0) {
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +0100543 tv = &proxy->timeout.check;
544 td = &defpx->timeout.check;
545 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100546 } else if (strcmp(args[0], "queue") == 0) {
Willy Tarreaue219db72007-12-03 01:30:13 +0100547 tv = &proxy->timeout.queue;
548 td = &defpx->timeout.queue;
549 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100550 } else if (strcmp(args[0], "tunnel") == 0) {
Willy Tarreauce887fd2012-05-12 12:50:00 +0200551 tv = &proxy->timeout.tunnel;
552 td = &defpx->timeout.tunnel;
553 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100554 } else if (strcmp(args[0], "client-fin") == 0) {
Willy Tarreau05cdd962014-05-10 14:30:07 +0200555 tv = &proxy->timeout.clientfin;
556 td = &defpx->timeout.clientfin;
557 cap = PR_CAP_FE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100558 } else if (strcmp(args[0], "server-fin") == 0) {
Willy Tarreau05cdd962014-05-10 14:30:07 +0200559 tv = &proxy->timeout.serverfin;
560 td = &defpx->timeout.serverfin;
561 cap = PR_CAP_BE;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100562 } else if (strcmp(args[0], "clitimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200563 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout client'.", args[0]);
564 return -1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100565 } else if (strcmp(args[0], "srvtimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200566 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout server'.", args[0]);
567 return -1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100568 } else if (strcmp(args[0], "contimeout") == 0) {
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +0200569 memprintf(err, "the '%s' directive is not supported anymore since HAProxy 2.1. Use 'timeout connect'.", args[0]);
570 return -1;
Willy Tarreaue219db72007-12-03 01:30:13 +0100571 } else {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200572 memprintf(err,
573 "'timeout' supports 'client', 'server', 'connect', 'check', "
Willy Tarreau05cdd962014-05-10 14:30:07 +0200574 "'queue', 'http-keep-alive', 'http-request', 'tunnel', 'tarpit', "
575 "'client-fin' and 'server-fin' (got '%s')",
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200576 args[0]);
Willy Tarreaue219db72007-12-03 01:30:13 +0100577 return -1;
578 }
579
580 if (*args[1] == 0) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200581 memprintf(err, "'timeout %s' expects an integer value (in milliseconds)", name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100582 return -1;
583 }
584
585 res = parse_time_err(args[1], &timeout, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +0200586 if (res == PARSE_TIME_OVER) {
587 memprintf(err, "timer overflow in argument '%s' to 'timeout %s' (maximum value is 2147483647 ms or ~24.8 days)",
588 args[1], name);
589 return -1;
590 }
591 else if (res == PARSE_TIME_UNDER) {
592 memprintf(err, "timer underflow in argument '%s' to 'timeout %s' (minimum non-null value is 1 ms)",
593 args[1], name);
594 return -1;
595 }
596 else if (res) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200597 memprintf(err, "unexpected character '%c' in 'timeout %s'", *res, name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100598 return -1;
599 }
600
601 if (!(proxy->cap & cap)) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200602 memprintf(err, "'timeout %s' will be ignored because %s '%s' has no %s capability",
603 name, proxy_type_str(proxy), proxy->id,
604 (cap & PR_CAP_BE) ? "backend" : "frontend");
Willy Tarreaue219db72007-12-03 01:30:13 +0100605 retval = 1;
606 }
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200607 else if (defpx && *tv != *td) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200608 memprintf(err, "overwriting 'timeout %s' which was already specified", name);
Willy Tarreaue219db72007-12-03 01:30:13 +0100609 retval = 1;
610 }
611
Willy Tarreaufac5b592014-05-22 08:24:46 +0200612 if (*args[2] != 0) {
613 memprintf(err, "'timeout %s' : unexpected extra argument '%s' after value '%s'.", name, args[2], args[1]);
614 retval = -1;
615 }
616
Willy Tarreau0c303ee2008-07-07 00:09:58 +0200617 *tv = MS_TO_TICKS(timeout);
Willy Tarreaue219db72007-12-03 01:30:13 +0100618 return retval;
619}
620
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100621/* This function parses a "rate-limit" statement in a proxy section. It returns
622 * -1 if there is any error, 1 for a warning, otherwise zero. If it does not
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200623 * return zero, it will write an error or warning message into a preallocated
624 * buffer returned at <err>. The function must be called with <args> pointing
625 * to the first command line word, with <proxy> pointing to the proxy being
626 * parsed, and <defpx> to the default proxy or NULL.
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100627 */
628static int proxy_parse_rate_limit(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100629 const struct proxy *defpx, const char *file, int line,
Willy Tarreau28a47d62012-09-18 20:02:48 +0200630 char **err)
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100631{
William Dauchybb9da0b2020-01-16 01:34:27 +0100632 int retval;
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200633 char *res;
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100634 unsigned int *tv = NULL;
Willy Tarreau01825162021-03-09 09:53:46 +0100635 const unsigned int *td = NULL;
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100636 unsigned int val;
637
638 retval = 0;
639
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200640 if (strcmp(args[1], "sessions") == 0) {
Willy Tarreau13a34bd2009-05-10 18:52:49 +0200641 tv = &proxy->fe_sps_lim;
642 td = &defpx->fe_sps_lim;
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200643 }
644 else {
645 memprintf(err, "'%s' only supports 'sessions' (got '%s')", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100646 return -1;
647 }
648
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200649 if (*args[2] == 0) {
650 memprintf(err, "'%s %s' expects expects an integer value (in sessions/second)", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100651 return -1;
652 }
653
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200654 val = strtoul(args[2], &res, 0);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100655 if (*res) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200656 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 +0100657 return -1;
658 }
659
William Dauchybb9da0b2020-01-16 01:34:27 +0100660 if (!(proxy->cap & PR_CAP_FE)) {
661 memprintf(err, "%s %s will be ignored because %s '%s' has no frontend capability",
662 args[0], args[1], proxy_type_str(proxy), proxy->id);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100663 retval = 1;
664 }
665 else if (defpx && *tv != *td) {
Willy Tarreau0a3dd742012-05-08 19:47:01 +0200666 memprintf(err, "overwriting %s %s which was already specified", args[0], args[1]);
Willy Tarreau3a7d2072009-03-05 23:48:25 +0100667 retval = 1;
668 }
669
670 *tv = val;
671 return retval;
672}
673
Willy Tarreauc35362a2014-04-25 13:58:37 +0200674/* This function parses a "max-keep-alive-queue" statement in a proxy section.
675 * It returns -1 if there is any error, 1 for a warning, otherwise zero. If it
676 * does not return zero, it will write an error or warning message into a
677 * preallocated buffer returned at <err>. The function must be called with
678 * <args> pointing to the first command line word, with <proxy> pointing to
679 * the proxy being parsed, and <defpx> to the default proxy or NULL.
680 */
681static int proxy_parse_max_ka_queue(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100682 const struct proxy *defpx, const char *file, int line,
Willy Tarreauc35362a2014-04-25 13:58:37 +0200683 char **err)
684{
685 int retval;
686 char *res;
687 unsigned int val;
688
689 retval = 0;
690
691 if (*args[1] == 0) {
692 memprintf(err, "'%s' expects expects an integer value (or -1 to disable)", args[0]);
693 return -1;
694 }
695
696 val = strtol(args[1], &res, 0);
697 if (*res) {
698 memprintf(err, "'%s' : unexpected character '%c' in integer value '%s'", args[0], *res, args[1]);
699 return -1;
700 }
701
702 if (!(proxy->cap & PR_CAP_BE)) {
703 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
704 args[0], proxy_type_str(proxy), proxy->id);
705 retval = 1;
706 }
707
708 /* we store <val+1> so that a user-facing value of -1 is stored as zero (default) */
709 proxy->max_ka_queue = val + 1;
710 return retval;
711}
712
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200713/* This function parses a "declare" statement in a proxy section. It returns -1
714 * if there is any error, 1 for warning, otherwise 0. If it does not return zero,
715 * it will write an error or warning message into a preallocated buffer returned
716 * at <err>. The function must be called with <args> pointing to the first command
717 * line word, with <proxy> pointing to the proxy being parsed, and <defpx> to the
718 * default proxy or NULL.
719 */
720static int proxy_parse_declare(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100721 const struct proxy *defpx, const char *file, int line,
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200722 char **err)
723{
724 /* Capture keyword wannot be declared in a default proxy. */
725 if (curpx == defpx) {
Joseph Herlant9edebb82018-11-15 11:50:44 -0800726 memprintf(err, "'%s' not available in default section", args[0]);
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200727 return -1;
728 }
729
Thayne McCombs8f0cc5c2021-01-07 21:35:52 -0700730 /* Capture keyword is only available in frontend. */
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200731 if (!(curpx->cap & PR_CAP_FE)) {
Joseph Herlant9edebb82018-11-15 11:50:44 -0800732 memprintf(err, "'%s' only available in frontend or listen section", args[0]);
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200733 return -1;
734 }
735
736 /* Check mandatory second keyword. */
737 if (!args[1] || !*args[1]) {
738 memprintf(err, "'%s' needs a second keyword that specify the type of declaration ('capture')", args[0]);
739 return -1;
740 }
741
Joseph Herlant59dd2952018-11-15 11:46:55 -0800742 /* Actually, declare is only available for declaring capture
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200743 * slot, but in the future it can declare maps or variables.
Joseph Herlant59dd2952018-11-15 11:46:55 -0800744 * So, this section permits to check and switch according with
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200745 * the second keyword.
746 */
747 if (strcmp(args[1], "capture") == 0) {
748 char *error = NULL;
749 long len;
750 struct cap_hdr *hdr;
751
752 /* Check the next keyword. */
753 if (!args[2] || !*args[2] ||
754 (strcmp(args[2], "response") != 0 &&
755 strcmp(args[2], "request") != 0)) {
756 memprintf(err, "'%s %s' requires a direction ('request' or 'response')", args[0], args[1]);
757 return -1;
758 }
759
760 /* Check the 'len' keyword. */
761 if (!args[3] || !*args[3] || strcmp(args[3], "len") != 0) {
762 memprintf(err, "'%s %s' requires a capture length ('len')", args[0], args[1]);
763 return -1;
764 }
765
766 /* Check the length value. */
767 if (!args[4] || !*args[4]) {
768 memprintf(err, "'%s %s': 'len' requires a numeric value that represents the "
769 "capture length",
770 args[0], args[1]);
771 return -1;
772 }
773
774 /* convert the length value. */
775 len = strtol(args[4], &error, 10);
776 if (*error != '\0') {
777 memprintf(err, "'%s %s': cannot parse the length '%s'.",
778 args[0], args[1], args[3]);
779 return -1;
780 }
781
782 /* check length. */
783 if (len <= 0) {
784 memprintf(err, "length must be > 0");
785 return -1;
786 }
787
788 /* register the capture. */
Vincent Bernat02779b62016-04-03 13:48:43 +0200789 hdr = calloc(1, sizeof(*hdr));
Remi Tricot-Le Breton55ba0d62021-05-12 18:04:46 +0200790 if (!hdr) {
791 memprintf(err, "proxy '%s': out of memory while registering a capture", curpx->id);
792 return -1;
793 }
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +0200794 hdr->name = NULL; /* not a header capture */
795 hdr->namelen = 0;
796 hdr->len = len;
797 hdr->pool = create_pool("caphdr", hdr->len + 1, MEM_F_SHARED);
798
799 if (strcmp(args[2], "request") == 0) {
800 hdr->next = curpx->req_cap;
801 hdr->index = curpx->nb_req_cap++;
802 curpx->req_cap = hdr;
803 }
804 if (strcmp(args[2], "response") == 0) {
805 hdr->next = curpx->rsp_cap;
806 hdr->index = curpx->nb_rsp_cap++;
807 curpx->rsp_cap = hdr;
808 }
809 return 0;
810 }
811 else {
812 memprintf(err, "unknown declaration type '%s' (supports 'capture')", args[1]);
813 return -1;
814 }
815}
816
Olivier Houcharda254a372019-04-05 15:30:12 +0200817/* This function parses a "retry-on" statement */
818static int
819proxy_parse_retry_on(char **args, int section, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +0100820 const struct proxy *defpx, const char *file, int line,
Olivier Houcharda254a372019-04-05 15:30:12 +0200821 char **err)
822{
823 int i;
824
825 if (!(*args[1])) {
826 memprintf(err, "'%s' needs at least one keyword to specify when to retry", args[0]);
827 return -1;
828 }
829 if (!(curpx->cap & PR_CAP_BE)) {
830 memprintf(err, "'%s' only available in backend or listen section", args[0]);
831 return -1;
832 }
833 curpx->retry_type = 0;
834 for (i = 1; *(args[i]); i++) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100835 if (strcmp(args[i], "conn-failure") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200836 curpx->retry_type |= PR_RE_CONN_FAILED;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100837 else if (strcmp(args[i], "empty-response") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200838 curpx->retry_type |= PR_RE_DISCONNECTED;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100839 else if (strcmp(args[i], "response-timeout") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200840 curpx->retry_type |= PR_RE_TIMEOUT;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100841 else if (strcmp(args[i], "401") == 0)
Julien Pivotto2de240a2020-11-12 11:14:05 +0100842 curpx->retry_type |= PR_RE_401;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100843 else if (strcmp(args[i], "403") == 0)
Julien Pivotto2de240a2020-11-12 11:14:05 +0100844 curpx->retry_type |= PR_RE_403;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100845 else if (strcmp(args[i], "404") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200846 curpx->retry_type |= PR_RE_404;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100847 else if (strcmp(args[i], "408") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200848 curpx->retry_type |= PR_RE_408;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100849 else if (strcmp(args[i], "425") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200850 curpx->retry_type |= PR_RE_425;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100851 else if (strcmp(args[i], "500") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200852 curpx->retry_type |= PR_RE_500;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100853 else if (strcmp(args[i], "501") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200854 curpx->retry_type |= PR_RE_501;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100855 else if (strcmp(args[i], "502") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200856 curpx->retry_type |= PR_RE_502;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100857 else if (strcmp(args[i], "503") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200858 curpx->retry_type |= PR_RE_503;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100859 else if (strcmp(args[i], "504") == 0)
Olivier Houcharda254a372019-04-05 15:30:12 +0200860 curpx->retry_type |= PR_RE_504;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100861 else if (strcmp(args[i], "0rtt-rejected") == 0)
Olivier Houchard865d8392019-05-03 22:46:27 +0200862 curpx->retry_type |= PR_RE_EARLY_ERROR;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100863 else if (strcmp(args[i], "junk-response") == 0)
Olivier Houcharde3249a92019-05-03 23:01:47 +0200864 curpx->retry_type |= PR_RE_JUNK_REQUEST;
Olivier Houchardddf0e032019-05-10 18:05:40 +0200865 else if (!(strcmp(args[i], "all-retryable-errors")))
866 curpx->retry_type |= PR_RE_CONN_FAILED | PR_RE_DISCONNECTED |
867 PR_RE_TIMEOUT | PR_RE_500 | PR_RE_502 |
868 PR_RE_503 | PR_RE_504 | PR_RE_EARLY_ERROR |
869 PR_RE_JUNK_REQUEST;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100870 else if (strcmp(args[i], "none") == 0) {
Olivier Houcharda254a372019-04-05 15:30:12 +0200871 if (i != 1 || *args[i + 1]) {
872 memprintf(err, "'%s' 'none' keyworld only usable alone", args[0]);
873 return -1;
874 }
875 } else {
876 memprintf(err, "'%s': unknown keyword '%s'", args[0], args[i]);
877 return -1;
878 }
879
880 }
881
882
883 return 0;
884}
885
Willy Tarreau52543212020-07-09 05:58:51 +0200886#ifdef TCP_KEEPCNT
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900887/* This function parses "{cli|srv}tcpka-cnt" statements */
888static int proxy_parse_tcpka_cnt(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100889 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900890 char **err)
891{
892 int retval;
893 char *res;
894 unsigned int tcpka_cnt;
895
896 retval = 0;
897
898 if (*args[1] == 0) {
899 memprintf(err, "'%s' expects an integer value", args[0]);
900 return -1;
901 }
902
903 tcpka_cnt = strtol(args[1], &res, 0);
904 if (*res) {
905 memprintf(err, "'%s' : unexpected character '%c' in integer value '%s'", args[0], *res, args[1]);
906 return -1;
907 }
908
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100909 if (strcmp(args[0], "clitcpka-cnt") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900910 if (!(proxy->cap & PR_CAP_FE)) {
911 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
912 args[0], proxy_type_str(proxy), proxy->id);
913 retval = 1;
914 }
915 proxy->clitcpka_cnt = tcpka_cnt;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100916 } else if (strcmp(args[0], "srvtcpka-cnt") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900917 if (!(proxy->cap & PR_CAP_BE)) {
918 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
919 args[0], proxy_type_str(proxy), proxy->id);
920 retval = 1;
921 }
922 proxy->srvtcpka_cnt = tcpka_cnt;
923 } else {
924 /* unreachable */
925 memprintf(err, "'%s': unknown keyword", args[0]);
926 return -1;
927 }
928
929 return retval;
930}
Willy Tarreau52543212020-07-09 05:58:51 +0200931#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900932
Willy Tarreau52543212020-07-09 05:58:51 +0200933#ifdef TCP_KEEPIDLE
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900934/* This function parses "{cli|srv}tcpka-idle" statements */
935static int proxy_parse_tcpka_idle(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100936 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900937 char **err)
938{
939 int retval;
940 const char *res;
941 unsigned int tcpka_idle;
942
943 retval = 0;
944
945 if (*args[1] == 0) {
946 memprintf(err, "'%s' expects an integer value", args[0]);
947 return -1;
948 }
949 res = parse_time_err(args[1], &tcpka_idle, TIME_UNIT_S);
950 if (res == PARSE_TIME_OVER) {
951 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
952 args[1], args[0]);
953 return -1;
954 }
955 else if (res == PARSE_TIME_UNDER) {
956 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
957 args[1], args[0]);
958 return -1;
959 }
960 else if (res) {
961 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
962 return -1;
963 }
964
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100965 if (strcmp(args[0], "clitcpka-idle") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900966 if (!(proxy->cap & PR_CAP_FE)) {
967 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
968 args[0], proxy_type_str(proxy), proxy->id);
969 retval = 1;
970 }
971 proxy->clitcpka_idle = tcpka_idle;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100972 } else if (strcmp(args[0], "srvtcpka-idle") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900973 if (!(proxy->cap & PR_CAP_BE)) {
974 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
975 args[0], proxy_type_str(proxy), proxy->id);
976 retval = 1;
977 }
978 proxy->srvtcpka_idle = tcpka_idle;
979 } else {
980 /* unreachable */
981 memprintf(err, "'%s': unknown keyword", args[0]);
982 return -1;
983 }
984
985 return retval;
986}
Willy Tarreau52543212020-07-09 05:58:51 +0200987#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900988
Willy Tarreau52543212020-07-09 05:58:51 +0200989#ifdef TCP_KEEPINTVL
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900990/* This function parses "{cli|srv}tcpka-intvl" statements */
991static int proxy_parse_tcpka_intvl(char **args, int section, struct proxy *proxy,
Willy Tarreau01825162021-03-09 09:53:46 +0100992 const struct proxy *defpx, const char *file, int line,
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +0900993 char **err)
994{
995 int retval;
996 const char *res;
997 unsigned int tcpka_intvl;
998
999 retval = 0;
1000
1001 if (*args[1] == 0) {
1002 memprintf(err, "'%s' expects an integer value", args[0]);
1003 return -1;
1004 }
1005 res = parse_time_err(args[1], &tcpka_intvl, TIME_UNIT_S);
1006 if (res == PARSE_TIME_OVER) {
1007 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
1008 args[1], args[0]);
1009 return -1;
1010 }
1011 else if (res == PARSE_TIME_UNDER) {
1012 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
1013 args[1], args[0]);
1014 return -1;
1015 }
1016 else if (res) {
1017 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
1018 return -1;
1019 }
1020
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001021 if (strcmp(args[0], "clitcpka-intvl") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001022 if (!(proxy->cap & PR_CAP_FE)) {
1023 memprintf(err, "%s will be ignored because %s '%s' has no frontend capability",
1024 args[0], proxy_type_str(proxy), proxy->id);
1025 retval = 1;
1026 }
1027 proxy->clitcpka_intvl = tcpka_intvl;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001028 } else if (strcmp(args[0], "srvtcpka-intvl") == 0) {
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001029 if (!(proxy->cap & PR_CAP_BE)) {
1030 memprintf(err, "%s will be ignored because %s '%s' has no backend capability",
1031 args[0], proxy_type_str(proxy), proxy->id);
1032 retval = 1;
1033 }
1034 proxy->srvtcpka_intvl = tcpka_intvl;
1035 } else {
1036 /* unreachable */
1037 memprintf(err, "'%s': unknown keyword", args[0]);
1038 return -1;
1039 }
1040
1041 return retval;
1042}
Willy Tarreau52543212020-07-09 05:58:51 +02001043#endif
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09001044
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001045/* This function inserts proxy <px> into the tree of known proxies (regular
1046 * ones or defaults depending on px->cap & PR_CAP_DEF). The proxy's name is
1047 * used as the storing key so it must already have been initialized.
Willy Tarreauf79d9502014-03-15 07:22:35 +01001048 */
1049void proxy_store_name(struct proxy *px)
1050{
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001051 struct eb_root *root = (px->cap & PR_CAP_DEF) ? &defproxy_by_name : &proxy_by_name;
1052
Willy Tarreauf79d9502014-03-15 07:22:35 +01001053 px->conf.by_name.key = px->id;
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001054 ebis_insert(root, &px->conf.by_name);
Willy Tarreauf79d9502014-03-15 07:22:35 +01001055}
1056
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001057/* Returns a pointer to the first proxy matching capabilities <cap> and id
1058 * <id>. NULL is returned if no match is found. If <table> is non-zero, it
1059 * only considers proxies having a table.
Willy Tarreaubc216c42011-08-02 11:25:54 +02001060 */
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001061struct proxy *proxy_find_by_id(int id, int cap, int table)
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001062{
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001063 struct eb32_node *n;
Willy Tarreaubc216c42011-08-02 11:25:54 +02001064
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001065 for (n = eb32_lookup(&used_proxy_id, id); n; n = eb32_next(n)) {
1066 struct proxy *px = container_of(n, struct proxy, conf.id);
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001067
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001068 if (px->uuid != id)
1069 break;
Alex Williams96532db2009-11-01 21:27:13 -05001070
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001071 if ((px->cap & cap) != cap)
1072 continue;
Alex Williams96532db2009-11-01 21:27:13 -05001073
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001074 if (table && (!px->table || !px->table->size))
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001075 continue;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001076
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001077 return px;
1078 }
1079 return NULL;
1080}
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001081
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001082/* Returns a pointer to the first proxy matching either name <name>, or id
1083 * <name> if <name> begins with a '#'. NULL is returned if no match is found.
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001084 * If <table> is non-zero, it only considers proxies having a table. The search
1085 * is made into the regular proxies, unless <cap> has PR_CAP_DEF set in which
1086 * case it's searched into the defproxy tree.
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001087 */
1088struct proxy *proxy_find_by_name(const char *name, int cap, int table)
1089{
1090 struct proxy *curproxy;
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001091
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001092 if (*name == '#' && !(cap & PR_CAP_DEF)) {
Willy Tarreau3c56a7d2015-05-26 15:25:32 +02001093 curproxy = proxy_find_by_id(atoi(name + 1), cap, table);
1094 if (curproxy)
Willy Tarreauc739aa82015-05-26 11:35:41 +02001095 return curproxy;
Alex Williams96532db2009-11-01 21:27:13 -05001096 }
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001097 else {
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001098 struct eb_root *root;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001099 struct ebpt_node *node;
1100
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001101 root = (cap & PR_CAP_DEF) ? &defproxy_by_name : &proxy_by_name;
1102 for (node = ebis_lookup(root, name); node; node = ebpt_next(node)) {
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001103 curproxy = container_of(node, struct proxy, conf.by_name);
Alex Williams96532db2009-11-01 21:27:13 -05001104
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001105 if (strcmp(curproxy->id, name) != 0)
1106 break;
1107
1108 if ((curproxy->cap & cap) != cap)
1109 continue;
1110
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01001111 if (table && (!curproxy->table || !curproxy->table->size))
Willy Tarreau9e0bb102015-05-26 11:24:42 +02001112 continue;
1113
Willy Tarreauc739aa82015-05-26 11:35:41 +02001114 return curproxy;
Willy Tarreaucfd837f2014-03-15 07:43:51 +01001115 }
1116 }
Willy Tarreauc739aa82015-05-26 11:35:41 +02001117 return NULL;
Alex Williams96532db2009-11-01 21:27:13 -05001118}
1119
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001120/* Finds the best match for a proxy with capabilities <cap>, name <name> and id
1121 * <id>. At most one of <id> or <name> may be different provided that <cap> is
1122 * valid. Either <id> or <name> may be left unspecified (0). The purpose is to
1123 * find a proxy based on some information from a previous configuration, across
1124 * reloads or during information exchange between peers.
1125 *
1126 * Names are looked up first if present, then IDs are compared if present. In
1127 * case of an inexact match whatever is forced in the configuration has
1128 * precedence in the following order :
1129 * - 1) forced ID (proves a renaming / change of proxy type)
1130 * - 2) proxy name+type (may indicate a move if ID differs)
1131 * - 3) automatic ID+type (may indicate a renaming)
1132 *
1133 * Depending on what is found, we can end up in the following situations :
1134 *
1135 * name id cap | possible causes
1136 * -------------+-----------------
1137 * -- -- -- | nothing found
1138 * -- -- ok | nothing found
1139 * -- ok -- | proxy deleted, ID points to next one
1140 * -- ok ok | proxy renamed, or deleted with ID pointing to next one
1141 * ok -- -- | proxy deleted, but other half with same name still here (before)
1142 * ok -- ok | proxy's ID changed (proxy moved in the config file)
1143 * ok ok -- | proxy deleted, but other half with same name still here (after)
1144 * ok ok ok | perfect match
1145 *
1146 * Upon return if <diff> is not NULL, it is zeroed then filled with up to 3 bits :
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001147 * - PR_FBM_MISMATCH_ID : proxy was found but ID differs
1148 * (and ID was not zero)
1149 * - PR_FBM_MISMATCH_NAME : proxy was found by ID but name differs
1150 * (and name was not NULL)
1151 * - PR_FBM_MISMATCH_PROXYTYPE : a proxy of different type was found with
1152 * the same name and/or id
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001153 *
1154 * Only a valid proxy is returned. If capabilities do not match, NULL is
1155 * returned. The caller can check <diff> to report detailed warnings / errors,
1156 * and decide whether or not to use what was found.
1157 */
1158struct proxy *proxy_find_best_match(int cap, const char *name, int id, int *diff)
1159{
1160 struct proxy *byname;
1161 struct proxy *byid;
1162
1163 if (!name && !id)
1164 return NULL;
1165
1166 if (diff)
1167 *diff = 0;
1168
1169 byname = byid = NULL;
1170
1171 if (name) {
1172 byname = proxy_find_by_name(name, cap, 0);
1173 if (byname && (!id || byname->uuid == id))
1174 return byname;
1175 }
1176
Joseph Herlant59dd2952018-11-15 11:46:55 -08001177 /* remaining possibilities :
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001178 * - name not set
1179 * - name set but not found
1180 * - name found, but ID doesn't match.
1181 */
1182 if (id) {
1183 byid = proxy_find_by_id(id, cap, 0);
1184 if (byid) {
1185 if (byname) {
1186 /* id+type found, name+type found, but not all 3.
1187 * ID wins only if forced, otherwise name wins.
1188 */
1189 if (byid->options & PR_O_FORCED_ID) {
1190 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001191 *diff |= PR_FBM_MISMATCH_NAME;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001192 return byid;
1193 }
1194 else {
1195 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001196 *diff |= PR_FBM_MISMATCH_ID;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001197 return byname;
1198 }
1199 }
1200
Joseph Herlant59dd2952018-11-15 11:46:55 -08001201 /* remaining possibilities :
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001202 * - name not set
1203 * - name set but not found
1204 */
1205 if (name && diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001206 *diff |= PR_FBM_MISMATCH_NAME;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001207 return byid;
1208 }
1209
1210 /* ID not found */
1211 if (byname) {
1212 if (diff)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001213 *diff |= PR_FBM_MISMATCH_ID;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001214 return byname;
1215 }
1216 }
1217
Joseph Herlant59dd2952018-11-15 11:46:55 -08001218 /* All remaining possibilities will lead to NULL. If we can report more
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001219 * detailed information to the caller about changed types and/or name,
1220 * we'll do it. For example, we could detect that "listen foo" was
1221 * split into "frontend foo_ft" and "backend foo_bk" if IDs are forced.
1222 * - name not set, ID not found
1223 * - name not found, ID not set
1224 * - name not found, ID not found
1225 */
1226 if (!diff)
1227 return NULL;
1228
1229 if (name) {
1230 byname = proxy_find_by_name(name, 0, 0);
1231 if (byname && (!id || byname->uuid == id))
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001232 *diff |= PR_FBM_MISMATCH_PROXYTYPE;
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001233 }
1234
1235 if (id) {
1236 byid = proxy_find_by_id(id, 0, 0);
1237 if (byid) {
1238 if (!name)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001239 *diff |= PR_FBM_MISMATCH_PROXYTYPE; /* only type changed */
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001240 else if (byid->options & PR_O_FORCED_ID)
Baptiste Assmann8a027cc2015-07-03 11:03:33 +02001241 *diff |= PR_FBM_MISMATCH_NAME | PR_FBM_MISMATCH_PROXYTYPE; /* name and type changed */
Willy Tarreaueb3e3482015-05-27 16:46:26 +02001242 /* otherwise it's a different proxy that was returned */
1243 }
1244 }
1245 return NULL;
1246}
1247
Willy Tarreaubaaee002006-06-26 02:48:02 +02001248/*
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001249 * This function finds a server with matching name within selected proxy.
1250 * It also checks if there are more matching servers with
1251 * requested name as this often leads into unexpected situations.
1252 */
1253
1254struct server *findserver(const struct proxy *px, const char *name) {
1255
1256 struct server *cursrv, *target = NULL;
1257
1258 if (!px)
1259 return NULL;
1260
1261 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001262 if (strcmp(cursrv->id, name) != 0)
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001263 continue;
1264
1265 if (!target) {
1266 target = cursrv;
1267 continue;
1268 }
1269
Christopher Faulet767a84b2017-11-24 16:50:31 +01001270 ha_alert("Refusing to use duplicated server '%s' found in proxy: %s!\n",
1271 name, px->id);
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01001272
1273 return NULL;
1274 }
1275
1276 return target;
1277}
1278
Aurelien DARRAGON4e5e2662023-02-22 09:55:05 +01001279/*
1280 * This function finds a server with matching "<puid> x <rid>" within
1281 * selected proxy <px>.
1282 * Using the combination of proxy-uid + revision id ensures that the function
1283 * will either return the server we're expecting or NULL if it has been removed
1284 * from the proxy.
1285 */
1286struct server *findserver_unique_id(const struct proxy *px, int puid, uint32_t rid) {
1287
1288 struct server *cursrv;
1289
1290 if (!px)
1291 return NULL;
1292
1293 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
1294 if (cursrv->puid == puid && cursrv->rid == rid)
1295 return cursrv;
1296 }
1297
1298 return NULL;
1299}
1300
1301/*
1302 * This function finds a server with matching "<name> x <rid>" within
1303 * selected proxy <px>.
1304 * Using the combination of name + revision id ensures that the function will
1305 * either return the server we're expecting or NULL if it has been removed
1306 * from the proxy.
1307 */
1308struct server *findserver_unique_name(const struct proxy *px, const char *name, uint32_t rid) {
1309
1310 struct server *cursrv;
1311
1312 if (!px)
1313 return NULL;
1314
1315 for (cursrv = px->srv; cursrv; cursrv = cursrv->next) {
1316 if (!strcmp(cursrv->id, name) && cursrv->rid == rid)
1317 return cursrv;
1318 }
1319
1320 return NULL;
1321}
1322
Willy Tarreauff01a212009-03-15 13:46:16 +01001323/* This function checks that the designated proxy has no http directives
1324 * enabled. It will output a warning if there are, and will fix some of them.
1325 * It returns the number of fatal errors encountered. This should be called
1326 * at the end of the configuration parsing if the proxy is not in http mode.
1327 * The <file> argument is used to construct the error message.
1328 */
Willy Tarreau915e1eb2009-06-22 15:48:36 +02001329int proxy_cfg_ensure_no_http(struct proxy *curproxy)
Willy Tarreauff01a212009-03-15 13:46:16 +01001330{
1331 if (curproxy->cookie_name != NULL) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001332 ha_warning("cookie will be ignored for %s '%s' (needs 'mode http').\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001333 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001334 }
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001335 if (isttest(curproxy->monitor_uri)) {
Amaury Denoyelle11124302021-06-04 18:22:08 +02001336 ha_warning("monitor-uri will be ignored for %s '%s' (needs 'mode http').\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001337 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001338 }
Willy Tarreauf3e49f92009-10-03 12:21:20 +02001339 if (curproxy->lbprm.algo & BE_LB_NEED_HTTP) {
Willy Tarreauff01a212009-03-15 13:46:16 +01001340 curproxy->lbprm.algo &= ~BE_LB_ALGO;
1341 curproxy->lbprm.algo |= BE_LB_ALGO_RR;
Amaury Denoyelle11124302021-06-04 18:22:08 +02001342 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 +01001343 proxy_type_str(curproxy), curproxy->id);
Willy Tarreauff01a212009-03-15 13:46:16 +01001344 }
Willy Tarreau17804162009-11-09 21:27:51 +01001345 if (curproxy->to_log & (LW_REQ | LW_RESP)) {
1346 curproxy->to_log &= ~(LW_REQ | LW_RESP);
Christopher Faulet767a84b2017-11-24 16:50:31 +01001347 ha_warning("parsing [%s:%d] : HTTP log/header format not usable with %s '%s' (needs 'mode http').\n",
1348 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1349 proxy_type_str(curproxy), curproxy->id);
Willy Tarreau17804162009-11-09 21:27:51 +01001350 }
Willy Tarreau62a61232013-04-12 18:13:46 +02001351 if (curproxy->conf.logformat_string == default_http_log_format ||
1352 curproxy->conf.logformat_string == clf_http_log_format) {
1353 /* Note: we don't change the directive's file:line number */
1354 curproxy->conf.logformat_string = default_tcp_log_format;
Christopher Faulet767a84b2017-11-24 16:50:31 +01001355 ha_warning("parsing [%s:%d] : 'option httplog' not usable with %s '%s' (needs 'mode http'). Falling back to 'option tcplog'.\n",
1356 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1357 proxy_type_str(curproxy), curproxy->id);
Willy Tarreau196729e2012-05-31 19:30:26 +02001358 }
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001359 else if (curproxy->conf.logformat_string == default_https_log_format) {
1360 /* Note: we don't change the directive's file:line number */
1361 curproxy->conf.logformat_string = default_tcp_log_format;
1362 ha_warning("parsing [%s:%d] : 'option httpslog' not usable with %s '%s' (needs 'mode http'). Falling back to 'option tcplog'.\n",
1363 curproxy->conf.lfs_file, curproxy->conf.lfs_line,
1364 proxy_type_str(curproxy), curproxy->id);
1365 }
Willy Tarreau196729e2012-05-31 19:30:26 +02001366
Willy Tarreauff01a212009-03-15 13:46:16 +01001367 return 0;
1368}
1369
Willy Tarreau237250c2011-07-29 01:49:03 +02001370/* Perform the most basic initialization of a proxy :
1371 * memset(), list_init(*), reset_timeouts(*).
Willy Tarreaub249e842011-09-07 18:41:08 +02001372 * Any new proxy or peer should be initialized via this function.
Willy Tarreau237250c2011-07-29 01:49:03 +02001373 */
1374void init_new_proxy(struct proxy *p)
1375{
1376 memset(p, 0, sizeof(struct proxy));
Willy Tarreau3fdb3662012-11-12 00:42:33 +01001377 p->obj_type = OBJ_TYPE_PROXY;
Willy Tarreaucdc83e02021-06-23 16:11:02 +02001378 queue_init(&p->queue, p, NULL);
Willy Tarreau237250c2011-07-29 01:49:03 +02001379 LIST_INIT(&p->acl);
1380 LIST_INIT(&p->http_req_rules);
Willy Tarreaue365c0b2013-06-11 16:06:12 +02001381 LIST_INIT(&p->http_res_rules);
Christopher Faulet6d0c3df2020-01-22 09:26:35 +01001382 LIST_INIT(&p->http_after_res_rules);
Willy Tarreau237250c2011-07-29 01:49:03 +02001383 LIST_INIT(&p->redirect_rules);
1384 LIST_INIT(&p->mon_fail_cond);
1385 LIST_INIT(&p->switching_rules);
Willy Tarreau4a5cade2012-04-05 21:09:48 +02001386 LIST_INIT(&p->server_rules);
Willy Tarreau237250c2011-07-29 01:49:03 +02001387 LIST_INIT(&p->persist_rules);
1388 LIST_INIT(&p->sticking_rules);
1389 LIST_INIT(&p->storersp_rules);
1390 LIST_INIT(&p->tcp_req.inspect_rules);
1391 LIST_INIT(&p->tcp_rep.inspect_rules);
1392 LIST_INIT(&p->tcp_req.l4_rules);
Willy Tarreau620408f2016-10-21 16:37:51 +02001393 LIST_INIT(&p->tcp_req.l5_rules);
Olivier Houchard859dc802019-08-08 15:47:21 +02001394 MT_LIST_INIT(&p->listener_queue);
William Lallemand0f99e342011-10-12 17:50:54 +02001395 LIST_INIT(&p->logsrvs);
William Lallemand723b73a2012-02-08 16:37:49 +01001396 LIST_INIT(&p->logformat);
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001397 LIST_INIT(&p->logformat_sd);
William Lallemanda73203e2012-03-12 12:48:57 +01001398 LIST_INIT(&p->format_unique_id);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001399 LIST_INIT(&p->logformat_error);
Willy Tarreau2a65ff02012-09-13 17:54:29 +02001400 LIST_INIT(&p->conf.bind);
Willy Tarreau4348fad2012-09-20 16:48:07 +02001401 LIST_INIT(&p->conf.listeners);
Christopher Faulet76edc0f2020-01-13 15:52:01 +01001402 LIST_INIT(&p->conf.errors);
Willy Tarreaua4312fa2013-04-02 16:34:32 +02001403 LIST_INIT(&p->conf.args.list);
Christopher Faulet443ea1a2016-02-04 13:40:26 +01001404 LIST_INIT(&p->filter_configs);
Christopher Faulet7a1e2e12020-04-02 18:05:11 +02001405 LIST_INIT(&p->tcpcheck_rules.preset_vars);
Willy Tarreau237250c2011-07-29 01:49:03 +02001406
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001407 p->defsrv.id = "default-server";
1408 p->conf.used_listener_id = EB_ROOT;
1409 p->conf.used_server_id = EB_ROOT;
1410 p->used_server_addr = EB_ROOT_UNIQUE;
1411
Willy Tarreau237250c2011-07-29 01:49:03 +02001412 /* Timeouts are defined as -1 */
1413 proxy_reset_timeouts(p);
1414 p->tcp_rep.inspect_delay = TICK_ETERNITY;
Willy Tarreau050536d2012-10-04 08:47:34 +02001415
1416 /* initial uuid is unassigned (-1) */
1417 p->uuid = -1;
Christopher Fauletff8abcd2017-06-02 15:33:24 +02001418
Olivier Houcharda254a372019-04-05 15:30:12 +02001419 /* Default to only allow L4 retries */
1420 p->retry_type = PR_RE_CONN_FAILED;
1421
Amaury Denoyelle7f8f6cb2020-11-10 14:24:31 +01001422 p->extra_counters_fe = NULL;
1423 p->extra_counters_be = NULL;
1424
Willy Tarreauac66d6b2020-10-20 17:24:27 +02001425 HA_RWLOCK_INIT(&p->lock);
Willy Tarreau237250c2011-07-29 01:49:03 +02001426}
1427
Willy Tarreau144289b2021-02-12 08:19:01 +01001428/* Preset default settings onto proxy <defproxy>. */
1429void proxy_preset_defaults(struct proxy *defproxy)
1430{
1431 defproxy->mode = PR_MODE_TCP;
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001432 defproxy->flags = 0;
William Lallemand6bb77b92021-07-28 15:48:16 +02001433 if (!(defproxy->cap & PR_CAP_INT)) {
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001434 defproxy->maxconn = cfg_maxpconn;
1435 defproxy->conn_retries = CONN_RETRIES;
1436 }
Willy Tarreau144289b2021-02-12 08:19:01 +01001437 defproxy->redispatch_after = 0;
1438 defproxy->options = PR_O_REUSE_SAFE;
William Lallemand6bb77b92021-07-28 15:48:16 +02001439 if (defproxy->cap & PR_CAP_INT)
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001440 defproxy->options2 |= PR_O2_INDEPSTR;
Willy Tarreau144289b2021-02-12 08:19:01 +01001441 defproxy->max_out_conns = MAX_SRV_LIST;
1442
1443 defproxy->defsrv.check.inter = DEF_CHKINTR;
1444 defproxy->defsrv.check.fastinter = 0;
1445 defproxy->defsrv.check.downinter = 0;
1446 defproxy->defsrv.agent.inter = DEF_CHKINTR;
1447 defproxy->defsrv.agent.fastinter = 0;
1448 defproxy->defsrv.agent.downinter = 0;
1449 defproxy->defsrv.check.rise = DEF_RISETIME;
1450 defproxy->defsrv.check.fall = DEF_FALLTIME;
1451 defproxy->defsrv.agent.rise = DEF_AGENT_RISETIME;
1452 defproxy->defsrv.agent.fall = DEF_AGENT_FALLTIME;
1453 defproxy->defsrv.check.port = 0;
1454 defproxy->defsrv.agent.port = 0;
1455 defproxy->defsrv.maxqueue = 0;
1456 defproxy->defsrv.minconn = 0;
1457 defproxy->defsrv.maxconn = 0;
1458 defproxy->defsrv.max_reuse = -1;
1459 defproxy->defsrv.max_idle_conns = -1;
1460 defproxy->defsrv.pool_purge_delay = 5000;
1461 defproxy->defsrv.slowstart = 0;
1462 defproxy->defsrv.onerror = DEF_HANA_ONERR;
1463 defproxy->defsrv.consecutive_errors_limit = DEF_HANA_ERRLIMIT;
1464 defproxy->defsrv.uweight = defproxy->defsrv.iweight = 1;
1465
1466 defproxy->email_alert.level = LOG_ALERT;
1467 defproxy->load_server_state_from_file = PR_SRV_STATE_FILE_UNSPEC;
1468#if defined(USE_QUIC)
1469 quic_transport_params_init(&defproxy->defsrv.quic_params, 0);
1470#endif
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001471
William Lallemand6bb77b92021-07-28 15:48:16 +02001472 if (defproxy->cap & PR_CAP_INT)
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001473 defproxy->timeout.connect = 5000;
Willy Tarreau144289b2021-02-12 08:19:01 +01001474}
1475
Willy Tarreaua3320a02021-02-12 10:38:49 +01001476/* Frees all dynamic settings allocated on a default proxy that's about to be
1477 * destroyed. This is a subset of the complete proxy deinit code, but these
1478 * should probably be merged ultimately. Note that most of the fields are not
1479 * even reset, so extreme care is required here, and calling
1480 * proxy_preset_defaults() afterwards would be safer.
1481 */
1482void proxy_free_defaults(struct proxy *defproxy)
1483{
Christopher Faulet6db9a972021-10-15 14:33:34 +02001484 struct acl *acl, *aclb;
Willy Tarreau211ea252022-03-17 19:47:33 +01001485 struct logsrv *log, *logb;
Christopher Faulet57962282022-04-25 14:30:58 +02001486 struct cap_hdr *h,*h_next;
Christopher Faulet6db9a972021-10-15 14:33:34 +02001487
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001488 ha_free(&defproxy->id);
1489 ha_free(&defproxy->conf.file);
1490 ha_free(&defproxy->check_command);
1491 ha_free(&defproxy->check_path);
1492 ha_free(&defproxy->cookie_name);
1493 ha_free(&defproxy->rdp_cookie_name);
1494 ha_free(&defproxy->dyncookie_key);
1495 ha_free(&defproxy->cookie_domain);
1496 ha_free(&defproxy->cookie_attrs);
1497 ha_free(&defproxy->lbprm.arg_str);
1498 ha_free(&defproxy->capture_name);
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001499 istfree(&defproxy->monitor_uri);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001500 ha_free(&defproxy->defbe.name);
1501 ha_free(&defproxy->conn_src.iface_name);
Tim Duesterhusb4b03772022-03-05 00:52:43 +01001502 istfree(&defproxy->server_id_hdr_name);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001503
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +01001504 http_ext_clean(defproxy);
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +01001505
Christopher Faulet6db9a972021-10-15 14:33:34 +02001506 list_for_each_entry_safe(acl, aclb, &defproxy->acl, list) {
1507 LIST_DELETE(&acl->list);
1508 prune_acl(acl);
1509 free(acl);
1510 }
1511
1512 free_act_rules(&defproxy->tcp_req.inspect_rules);
1513 free_act_rules(&defproxy->tcp_rep.inspect_rules);
1514 free_act_rules(&defproxy->tcp_req.l4_rules);
1515 free_act_rules(&defproxy->tcp_req.l5_rules);
1516 free_act_rules(&defproxy->http_req_rules);
1517 free_act_rules(&defproxy->http_res_rules);
1518 free_act_rules(&defproxy->http_after_res_rules);
1519
Christopher Faulet57962282022-04-25 14:30:58 +02001520 h = defproxy->req_cap;
1521 while (h) {
1522 h_next = h->next;
1523 free(h->name);
1524 pool_destroy(h->pool);
1525 free(h);
1526 h = h_next;
1527 }
1528
1529 h = defproxy->rsp_cap;
1530 while (h) {
1531 h_next = h->next;
1532 free(h->name);
1533 pool_destroy(h->pool);
1534 free(h);
1535 h = h_next;
1536 }
1537
Willy Tarreaua3320a02021-02-12 10:38:49 +01001538 if (defproxy->conf.logformat_string != default_http_log_format &&
1539 defproxy->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001540 defproxy->conf.logformat_string != clf_http_log_format &&
1541 defproxy->conf.logformat_string != default_https_log_format) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001542 ha_free(&defproxy->conf.logformat_string);
Willy Tarreau818ec782021-02-12 10:48:53 +01001543 }
Willy Tarreaua3320a02021-02-12 10:38:49 +01001544
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001545 if (defproxy->conf.logformat_sd_string != default_rfc5424_sd_log_format)
1546 ha_free(&defproxy->conf.logformat_sd_string);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001547
Willy Tarreau211ea252022-03-17 19:47:33 +01001548 list_for_each_entry_safe(log, logb, &defproxy->logsrvs, list) {
1549 LIST_DEL_INIT(&log->list);
1550 free_logsrv(log);
1551 }
1552
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001553 ha_free(&defproxy->conf.uniqueid_format_string);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001554 ha_free(&defproxy->conf.error_logformat_string);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001555 ha_free(&defproxy->conf.lfs_file);
1556 ha_free(&defproxy->conf.lfsd_file);
1557 ha_free(&defproxy->conf.uif_file);
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001558 ha_free(&defproxy->conf.elfs_file);
Willy Tarreaua3320a02021-02-12 10:38:49 +01001559 chunk_destroy(&defproxy->log_tag);
1560
1561 free_email_alert(defproxy);
1562 proxy_release_conf_errors(defproxy);
1563 deinit_proxy_tcpcheck(defproxy);
1564
1565 /* FIXME: we cannot free uri_auth because it might already be used by
1566 * another proxy (legacy code for stats URI ...). Refcount anyone ?
1567 */
1568}
1569
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001570/* delete a defproxy from the tree if still in it, frees its content and its
1571 * storage. Nothing is done if <px> is NULL or if it doesn't have PR_CAP_DEF
1572 * set, allowing to pass it the direct result of a lookup function.
1573 */
1574void proxy_destroy_defaults(struct proxy *px)
1575{
1576 if (!px)
1577 return;
1578 if (!(px->cap & PR_CAP_DEF))
1579 return;
Christopher Faulet27c8d202021-10-13 09:50:53 +02001580 BUG_ON(px->conf.refcount != 0);
Willy Tarreau0a0f6a72021-02-12 13:52:11 +01001581 ebpt_delete(&px->conf.by_name);
1582 proxy_free_defaults(px);
1583 free(px);
1584}
1585
Christopher Faulet27c8d202021-10-13 09:50:53 +02001586/* delete all unreferenced default proxies. A default proxy is unreferenced if
1587 * its refcount is equal to zero.
1588 */
1589void proxy_destroy_all_unref_defaults()
Willy Tarreaue90904d2021-02-12 14:08:31 +01001590{
1591 struct ebpt_node *n;
1592
Christopher Faulet27c8d202021-10-13 09:50:53 +02001593 n = ebpt_first(&defproxy_by_name);
1594 while (n) {
Willy Tarreaue90904d2021-02-12 14:08:31 +01001595 struct proxy *px = container_of(n, struct proxy, conf.by_name);
1596 BUG_ON(!(px->cap & PR_CAP_DEF));
Christopher Faulet27c8d202021-10-13 09:50:53 +02001597 n = ebpt_next(n);
1598 if (!px->conf.refcount)
1599 proxy_destroy_defaults(px);
Willy Tarreaue90904d2021-02-12 14:08:31 +01001600 }
1601}
1602
Christopher Faulet27c8d202021-10-13 09:50:53 +02001603/* Add a reference on the default proxy <defpx> for the proxy <px> Nothing is
1604 * done if <px> already references <defpx>. Otherwise, the default proxy
1605 * refcount is incremented by one. For now, this operation is not thread safe
1606 * and is perform during init stage only.
1607 */
1608void proxy_ref_defaults(struct proxy *px, struct proxy *defpx)
1609{
1610 if (px->defpx == defpx)
1611 return;
1612 BUG_ON(px->defpx != NULL);
1613 px->defpx = defpx;
1614 defpx->conf.refcount++;
1615}
1616
1617/* proxy <px> removes its reference on its default proxy. The default proxy
1618 * refcount is decremented by one. If it was the last reference, the
1619 * corresponding default proxy is destroyed. For now this operation is not
1620 * thread safe and is performed during deinit staged only.
1621*/
1622void proxy_unref_defaults(struct proxy *px)
1623{
1624 if (px->defpx == NULL)
1625 return;
1626 if (!--px->defpx->conf.refcount)
1627 proxy_destroy_defaults(px->defpx);
1628 px->defpx = NULL;
1629}
1630
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001631/* Allocates a new proxy <name> of type <cap>.
1632 * Returns the proxy instance on success. On error, NULL is returned.
Willy Tarreau76838932021-02-12 08:49:47 +01001633 */
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001634struct proxy *alloc_new_proxy(const char *name, unsigned int cap, char **errmsg)
Willy Tarreau76838932021-02-12 08:49:47 +01001635{
Willy Tarreau76838932021-02-12 08:49:47 +01001636 struct proxy *curproxy;
Willy Tarreau76838932021-02-12 08:49:47 +01001637
1638 if ((curproxy = calloc(1, sizeof(*curproxy))) == NULL) {
1639 memprintf(errmsg, "proxy '%s': out of memory", name);
1640 goto fail;
1641 }
1642
1643 init_new_proxy(curproxy);
Willy Tarreau69530f52023-04-28 09:16:15 +02001644 curproxy->last_change = ns_to_sec(now_ns);
Willy Tarreau76838932021-02-12 08:49:47 +01001645 curproxy->id = strdup(name);
1646 curproxy->cap = cap;
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001647
William Lallemand6bb77b92021-07-28 15:48:16 +02001648 if (!(cap & PR_CAP_INT))
Amaury Denoyelle6f26fae2021-03-24 10:49:34 +01001649 proxy_store_name(curproxy);
Willy Tarreau76838932021-02-12 08:49:47 +01001650
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001651 done:
1652 return curproxy;
1653
1654 fail:
1655 /* Note: in case of fatal error here, we WILL make valgrind unhappy,
1656 * but its not worth trying to unroll everything here just before
1657 * quitting.
1658 */
1659 free(curproxy);
1660 return NULL;
1661}
1662
1663/* Copy the proxy settings from <defproxy> to <curproxy>.
1664 * Returns 0 on success.
1665 * Returns 1 on error. <errmsg> will be allocated with an error description.
1666 */
1667static int proxy_defproxy_cpy(struct proxy *curproxy, const struct proxy *defproxy,
1668 char **errmsg)
1669{
1670 struct logsrv *tmplogsrv;
1671 char *tmpmsg = NULL;
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001672
1673 /* set default values from the specified default proxy */
Christopher Faulet6bb86532022-08-03 11:31:55 +02001674 srv_settings_cpy(&curproxy->defsrv, &defproxy->defsrv, 0);
Willy Tarreau76838932021-02-12 08:49:47 +01001675
Christopher Faulet56717802021-10-13 10:10:09 +02001676 curproxy->flags = (defproxy->flags & PR_FL_DISABLED); /* Only inherit from disabled flag */
Willy Tarreau76838932021-02-12 08:49:47 +01001677 curproxy->options = defproxy->options;
1678 curproxy->options2 = defproxy->options2;
1679 curproxy->no_options = defproxy->no_options;
1680 curproxy->no_options2 = defproxy->no_options2;
Willy Tarreau76838932021-02-12 08:49:47 +01001681 curproxy->retry_type = defproxy->retry_type;
Christopher Fauletee08d6c2021-10-13 15:40:15 +02001682 curproxy->tcp_req.inspect_delay = defproxy->tcp_req.inspect_delay;
1683 curproxy->tcp_rep.inspect_delay = defproxy->tcp_rep.inspect_delay;
Willy Tarreau76838932021-02-12 08:49:47 +01001684
Aurelien DARRAGONb2e2ec52023-01-09 11:09:03 +01001685 http_ext_clean(curproxy);
1686 http_ext_dup(defproxy, curproxy);
Willy Tarreau76838932021-02-12 08:49:47 +01001687
Tim Duesterhusb4b03772022-03-05 00:52:43 +01001688 if (isttest(defproxy->server_id_hdr_name))
1689 curproxy->server_id_hdr_name = istdup(defproxy->server_id_hdr_name);
Willy Tarreau76838932021-02-12 08:49:47 +01001690
1691 /* initialize error relocations */
1692 if (!proxy_dup_default_conf_errors(curproxy, defproxy, &tmpmsg)) {
1693 memprintf(errmsg, "proxy '%s' : %s", curproxy->id, tmpmsg);
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001694 free(tmpmsg);
1695 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001696 }
1697
1698 if (curproxy->cap & PR_CAP_FE) {
1699 curproxy->maxconn = defproxy->maxconn;
1700 curproxy->backlog = defproxy->backlog;
1701 curproxy->fe_sps_lim = defproxy->fe_sps_lim;
1702
1703 curproxy->to_log = defproxy->to_log & ~LW_COOKIE & ~LW_REQHDR & ~ LW_RSPHDR;
1704 curproxy->max_out_conns = defproxy->max_out_conns;
1705
1706 curproxy->clitcpka_cnt = defproxy->clitcpka_cnt;
1707 curproxy->clitcpka_idle = defproxy->clitcpka_idle;
1708 curproxy->clitcpka_intvl = defproxy->clitcpka_intvl;
1709 }
1710
1711 if (curproxy->cap & PR_CAP_BE) {
1712 curproxy->lbprm.algo = defproxy->lbprm.algo;
1713 curproxy->lbprm.hash_balance_factor = defproxy->lbprm.hash_balance_factor;
1714 curproxy->fullconn = defproxy->fullconn;
1715 curproxy->conn_retries = defproxy->conn_retries;
1716 curproxy->redispatch_after = defproxy->redispatch_after;
1717 curproxy->max_ka_queue = defproxy->max_ka_queue;
1718
1719 curproxy->tcpcheck_rules.flags = (defproxy->tcpcheck_rules.flags & ~TCPCHK_RULES_UNUSED_RS);
1720 curproxy->tcpcheck_rules.list = defproxy->tcpcheck_rules.list;
1721 if (!LIST_ISEMPTY(&defproxy->tcpcheck_rules.preset_vars)) {
1722 if (!dup_tcpcheck_vars(&curproxy->tcpcheck_rules.preset_vars,
1723 &defproxy->tcpcheck_rules.preset_vars)) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001724 memprintf(errmsg, "proxy '%s': failed to duplicate tcpcheck preset-vars", curproxy->id);
1725 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001726 }
1727 }
1728
1729 curproxy->ck_opts = defproxy->ck_opts;
Aurelien DARRAGONb2bb9252022-12-28 15:37:57 +01001730
Willy Tarreau76838932021-02-12 08:49:47 +01001731 if (defproxy->cookie_name)
1732 curproxy->cookie_name = strdup(defproxy->cookie_name);
1733 curproxy->cookie_len = defproxy->cookie_len;
1734
1735 if (defproxy->dyncookie_key)
1736 curproxy->dyncookie_key = strdup(defproxy->dyncookie_key);
1737 if (defproxy->cookie_domain)
1738 curproxy->cookie_domain = strdup(defproxy->cookie_domain);
1739
1740 if (defproxy->cookie_maxidle)
1741 curproxy->cookie_maxidle = defproxy->cookie_maxidle;
1742
1743 if (defproxy->cookie_maxlife)
1744 curproxy->cookie_maxlife = defproxy->cookie_maxlife;
1745
1746 if (defproxy->rdp_cookie_name)
1747 curproxy->rdp_cookie_name = strdup(defproxy->rdp_cookie_name);
1748 curproxy->rdp_cookie_len = defproxy->rdp_cookie_len;
1749
1750 if (defproxy->cookie_attrs)
1751 curproxy->cookie_attrs = strdup(defproxy->cookie_attrs);
1752
1753 if (defproxy->lbprm.arg_str)
1754 curproxy->lbprm.arg_str = strdup(defproxy->lbprm.arg_str);
1755 curproxy->lbprm.arg_len = defproxy->lbprm.arg_len;
1756 curproxy->lbprm.arg_opt1 = defproxy->lbprm.arg_opt1;
1757 curproxy->lbprm.arg_opt2 = defproxy->lbprm.arg_opt2;
1758 curproxy->lbprm.arg_opt3 = defproxy->lbprm.arg_opt3;
1759
1760 if (defproxy->conn_src.iface_name)
1761 curproxy->conn_src.iface_name = strdup(defproxy->conn_src.iface_name);
1762 curproxy->conn_src.iface_len = defproxy->conn_src.iface_len;
1763 curproxy->conn_src.opts = defproxy->conn_src.opts;
1764#if defined(CONFIG_HAP_TRANSPARENT)
1765 curproxy->conn_src.tproxy_addr = defproxy->conn_src.tproxy_addr;
1766#endif
1767 curproxy->load_server_state_from_file = defproxy->load_server_state_from_file;
1768
1769 curproxy->srvtcpka_cnt = defproxy->srvtcpka_cnt;
1770 curproxy->srvtcpka_idle = defproxy->srvtcpka_idle;
1771 curproxy->srvtcpka_intvl = defproxy->srvtcpka_intvl;
1772 }
1773
1774 if (curproxy->cap & PR_CAP_FE) {
1775 if (defproxy->capture_name)
1776 curproxy->capture_name = strdup(defproxy->capture_name);
1777 curproxy->capture_namelen = defproxy->capture_namelen;
1778 curproxy->capture_len = defproxy->capture_len;
Christopher Faulet57962282022-04-25 14:30:58 +02001779
1780 curproxy->nb_req_cap = defproxy->nb_req_cap;
1781 curproxy->req_cap = defproxy->req_cap;
1782
1783 curproxy->nb_rsp_cap = defproxy->nb_rsp_cap;
1784 curproxy->rsp_cap = defproxy->rsp_cap;
Willy Tarreau76838932021-02-12 08:49:47 +01001785 }
1786
1787 if (curproxy->cap & PR_CAP_FE) {
1788 curproxy->timeout.client = defproxy->timeout.client;
1789 curproxy->timeout.clientfin = defproxy->timeout.clientfin;
1790 curproxy->timeout.tarpit = defproxy->timeout.tarpit;
1791 curproxy->timeout.httpreq = defproxy->timeout.httpreq;
1792 curproxy->timeout.httpka = defproxy->timeout.httpka;
Tim Duesterhus4b1fcaa2022-03-05 00:52:40 +01001793 if (isttest(defproxy->monitor_uri))
1794 curproxy->monitor_uri = istdup(defproxy->monitor_uri);
Willy Tarreau76838932021-02-12 08:49:47 +01001795 if (defproxy->defbe.name)
1796 curproxy->defbe.name = strdup(defproxy->defbe.name);
1797
1798 /* get either a pointer to the logformat string or a copy of it */
1799 curproxy->conf.logformat_string = defproxy->conf.logformat_string;
1800 if (curproxy->conf.logformat_string &&
1801 curproxy->conf.logformat_string != default_http_log_format &&
1802 curproxy->conf.logformat_string != default_tcp_log_format &&
Remi Tricot-Le Breton98b930d2021-07-29 09:45:52 +02001803 curproxy->conf.logformat_string != clf_http_log_format &&
1804 curproxy->conf.logformat_string != default_https_log_format)
Willy Tarreau76838932021-02-12 08:49:47 +01001805 curproxy->conf.logformat_string = strdup(curproxy->conf.logformat_string);
1806
1807 if (defproxy->conf.lfs_file) {
1808 curproxy->conf.lfs_file = strdup(defproxy->conf.lfs_file);
1809 curproxy->conf.lfs_line = defproxy->conf.lfs_line;
1810 }
1811
1812 /* get either a pointer to the logformat string for RFC5424 structured-data or a copy of it */
1813 curproxy->conf.logformat_sd_string = defproxy->conf.logformat_sd_string;
1814 if (curproxy->conf.logformat_sd_string &&
1815 curproxy->conf.logformat_sd_string != default_rfc5424_sd_log_format)
1816 curproxy->conf.logformat_sd_string = strdup(curproxy->conf.logformat_sd_string);
1817
1818 if (defproxy->conf.lfsd_file) {
1819 curproxy->conf.lfsd_file = strdup(defproxy->conf.lfsd_file);
1820 curproxy->conf.lfsd_line = defproxy->conf.lfsd_line;
1821 }
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02001822
1823 curproxy->conf.error_logformat_string = defproxy->conf.error_logformat_string;
1824 if (curproxy->conf.error_logformat_string)
1825 curproxy->conf.error_logformat_string = strdup(curproxy->conf.error_logformat_string);
1826
1827 if (defproxy->conf.elfs_file) {
1828 curproxy->conf.elfs_file = strdup(defproxy->conf.elfs_file);
1829 curproxy->conf.elfs_line = defproxy->conf.elfs_line;
1830 }
Willy Tarreau76838932021-02-12 08:49:47 +01001831 }
1832
1833 if (curproxy->cap & PR_CAP_BE) {
1834 curproxy->timeout.connect = defproxy->timeout.connect;
1835 curproxy->timeout.server = defproxy->timeout.server;
1836 curproxy->timeout.serverfin = defproxy->timeout.serverfin;
1837 curproxy->timeout.check = defproxy->timeout.check;
1838 curproxy->timeout.queue = defproxy->timeout.queue;
1839 curproxy->timeout.tarpit = defproxy->timeout.tarpit;
1840 curproxy->timeout.httpreq = defproxy->timeout.httpreq;
1841 curproxy->timeout.httpka = defproxy->timeout.httpka;
1842 curproxy->timeout.tunnel = defproxy->timeout.tunnel;
1843 curproxy->conn_src.source_addr = defproxy->conn_src.source_addr;
1844 }
1845
1846 curproxy->mode = defproxy->mode;
1847 curproxy->uri_auth = defproxy->uri_auth; /* for stats */
1848
1849 /* copy default logsrvs to curproxy */
1850 list_for_each_entry(tmplogsrv, &defproxy->logsrvs, list) {
1851 struct logsrv *node = malloc(sizeof(*node));
1852
1853 if (!node) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001854 memprintf(errmsg, "proxy '%s': out of memory", curproxy->id);
1855 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001856 }
1857 memcpy(node, tmplogsrv, sizeof(struct logsrv));
1858 node->ref = tmplogsrv->ref;
1859 LIST_INIT(&node->list);
Willy Tarreau2b718102021-04-21 07:32:39 +02001860 LIST_APPEND(&curproxy->logsrvs, &node->list);
Willy Tarreau211ea252022-03-17 19:47:33 +01001861 node->ring_name = tmplogsrv->ring_name ? strdup(tmplogsrv->ring_name) : NULL;
1862 node->conf.file = strdup(tmplogsrv->conf.file);
1863 node->conf.line = tmplogsrv->conf.line;
Willy Tarreau76838932021-02-12 08:49:47 +01001864 }
1865
1866 curproxy->conf.uniqueid_format_string = defproxy->conf.uniqueid_format_string;
1867 if (curproxy->conf.uniqueid_format_string)
1868 curproxy->conf.uniqueid_format_string = strdup(curproxy->conf.uniqueid_format_string);
1869
1870 chunk_dup(&curproxy->log_tag, &defproxy->log_tag);
1871
1872 if (defproxy->conf.uif_file) {
1873 curproxy->conf.uif_file = strdup(defproxy->conf.uif_file);
1874 curproxy->conf.uif_line = defproxy->conf.uif_line;
1875 }
1876
1877 /* copy default header unique id */
1878 if (isttest(defproxy->header_unique_id)) {
1879 const struct ist copy = istdup(defproxy->header_unique_id);
1880
1881 if (!isttest(copy)) {
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001882 memprintf(errmsg, "proxy '%s': out of memory for unique-id-header", curproxy->id);
1883 return 1;
Willy Tarreau76838932021-02-12 08:49:47 +01001884 }
1885 curproxy->header_unique_id = copy;
1886 }
1887
1888 /* default compression options */
1889 if (defproxy->comp != NULL) {
1890 curproxy->comp = calloc(1, sizeof(*curproxy->comp));
Remi Tricot-Le Breton18a82ba2021-05-12 18:07:27 +02001891 if (!curproxy->comp) {
1892 memprintf(errmsg, "proxy '%s': out of memory for default compression options", curproxy->id);
1893 return 1;
1894 }
Olivier Houcharddb573e92023-04-05 17:32:36 +02001895 curproxy->comp->algos_res = defproxy->comp->algos_res;
1896 curproxy->comp->algo_req = defproxy->comp->algo_req;
1897 curproxy->comp->types_res = defproxy->comp->types_res;
1898 curproxy->comp->types_req = defproxy->comp->types_req;
Willy Tarreau862588a2023-05-10 16:39:00 +02001899 curproxy->comp->flags = defproxy->comp->flags;
Willy Tarreau76838932021-02-12 08:49:47 +01001900 }
1901
Willy Tarreau76838932021-02-12 08:49:47 +01001902 if (defproxy->check_path)
1903 curproxy->check_path = strdup(defproxy->check_path);
1904 if (defproxy->check_command)
1905 curproxy->check_command = strdup(defproxy->check_command);
1906
1907 if (defproxy->email_alert.mailers.name)
1908 curproxy->email_alert.mailers.name = strdup(defproxy->email_alert.mailers.name);
1909 if (defproxy->email_alert.from)
1910 curproxy->email_alert.from = strdup(defproxy->email_alert.from);
1911 if (defproxy->email_alert.to)
1912 curproxy->email_alert.to = strdup(defproxy->email_alert.to);
1913 if (defproxy->email_alert.myhostname)
1914 curproxy->email_alert.myhostname = strdup(defproxy->email_alert.myhostname);
1915 curproxy->email_alert.level = defproxy->email_alert.level;
1916 curproxy->email_alert.set = defproxy->email_alert.set;
Willy Tarreau3b06eae2021-02-12 09:15:16 +01001917
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001918 return 0;
1919}
1920
1921/* Allocates a new proxy <name> of type <cap> found at position <file:linenum>,
1922 * preset it from the defaults of <defproxy> and returns it. In case of error,
1923 * an alert is printed and NULL is returned.
1924 */
1925struct proxy *parse_new_proxy(const char *name, unsigned int cap,
1926 const char *file, int linenum,
1927 const struct proxy *defproxy)
1928{
1929 struct proxy *curproxy = NULL;
Willy Tarreau282b6a72022-02-24 16:37:19 +01001930 char *errmsg = NULL;
Amaury Denoyelle476b9ad2021-03-23 17:27:05 +01001931
1932 if (!(curproxy = alloc_new_proxy(name, cap, &errmsg))) {
1933 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
1934 free(errmsg);
1935 return NULL;
1936 }
1937
1938 if (defproxy) {
1939 if (proxy_defproxy_cpy(curproxy, defproxy, &errmsg)) {
1940 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
1941 free(errmsg);
1942
1943 ha_free(&curproxy);
1944 return NULL;
1945 }
1946 }
1947 else {
1948 proxy_preset_defaults(curproxy);
1949 }
1950
1951 curproxy->conf.args.file = curproxy->conf.file = strdup(file);
1952 curproxy->conf.args.line = curproxy->conf.line = linenum;
1953
Willy Tarreau76838932021-02-12 08:49:47 +01001954 return curproxy;
Willy Tarreau76838932021-02-12 08:49:47 +01001955}
1956
Aurelien DARRAGONd46f4372022-09-09 15:51:37 +02001957/* to be called under the proxy lock after pausing some listeners. This will
1958 * automatically update the p->flags flag
1959 */
1960void proxy_cond_pause(struct proxy *p)
1961{
1962 if (p->li_ready)
1963 return;
1964 p->flags |= PR_FL_PAUSED;
1965}
1966
1967/* to be called under the proxy lock after resuming some listeners. This will
1968 * automatically update the p->flags flag
1969 */
1970void proxy_cond_resume(struct proxy *p)
1971{
1972 if (!p->li_ready)
1973 return;
1974 p->flags &= ~PR_FL_PAUSED;
1975}
1976
Willy Tarreauacde1522020-10-07 16:31:39 +02001977/* to be called under the proxy lock after stopping some listeners. This will
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001978 * automatically update the p->flags flag after stopping the last one, and
Willy Tarreauacde1522020-10-07 16:31:39 +02001979 * will emit a log indicating the proxy's condition. The function is idempotent
1980 * so that it will not emit multiple logs; a proxy will be disabled only once.
1981 */
1982void proxy_cond_disable(struct proxy *p)
1983{
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001984 if (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauacde1522020-10-07 16:31:39 +02001985 return;
1986
1987 if (p->li_ready + p->li_paused > 0)
1988 return;
1989
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02001990 p->flags |= PR_FL_STOPPED;
Willy Tarreauacde1522020-10-07 16:31:39 +02001991
Willy Tarreauacde1522020-10-07 16:31:39 +02001992 /* Note: syslog proxies use their own loggers so while it's somewhat OK
1993 * to report them being stopped as a warning, we must not spam their log
1994 * servers which are in fact production servers. For other types (CLI,
1995 * peers, etc) we must not report them at all as they're not really on
1996 * the data plane but on the control plane.
1997 */
William Lallemand7f954692023-05-14 23:23:36 +02001998 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 +02001999 ha_warning("Proxy %s stopped (cumulated conns: FE: %lld, BE: %lld).\n",
2000 p->id, p->fe_counters.cum_conn, p->be_counters.cum_conn);
2001
William Lallemand7f954692023-05-14 23:23:36 +02002002 if ((p->mode == PR_MODE_TCP || p->mode == PR_MODE_HTTP) && !(p->cap & PR_CAP_INT))
Willy Tarreauacde1522020-10-07 16:31:39 +02002003 send_log(p, LOG_WARNING, "Proxy %s stopped (cumulated conns: FE: %lld, BE: %lld).\n",
2004 p->id, p->fe_counters.cum_conn, p->be_counters.cum_conn);
2005
Willy Tarreauacde1522020-10-07 16:31:39 +02002006 if (p->table && p->table->size && p->table->sync_task)
2007 task_wakeup(p->table->sync_task, TASK_WOKEN_MSG);
2008
2009 if (p->task)
2010 task_wakeup(p->task, TASK_WOKEN_MSG);
2011}
2012
Krzysztof Piotr Oledzkic8b16fc2008-02-18 01:26:35 +01002013/*
Willy Tarreau918ff602011-07-25 16:33:49 +02002014 * This is the proxy management task. It enables proxies when there are enough
Willy Tarreau87b09662015-04-03 00:22:06 +02002015 * free streams, or stops them when the table is full. It is designed to be
Willy Tarreau918ff602011-07-25 16:33:49 +02002016 * called as a task which is woken up upon stopping or when rate limiting must
2017 * be enforced.
Willy Tarreaubaaee002006-06-26 02:48:02 +02002018 */
Willy Tarreau144f84a2021-03-02 16:09:26 +01002019struct task *manage_proxy(struct task *t, void *context, unsigned int state)
Willy Tarreaubaaee002006-06-26 02:48:02 +02002020{
Olivier Houchard9f6af332018-05-25 14:04:04 +02002021 struct proxy *p = context;
Willy Tarreau918ff602011-07-25 16:33:49 +02002022 int next = TICK_ETERNITY;
Willy Tarreau79584222009-03-06 09:18:27 +01002023 unsigned int wait;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002024
Willy Tarreau918ff602011-07-25 16:33:49 +02002025 /* We should periodically try to enable listeners waiting for a
2026 * global resource here.
2027 */
Willy Tarreaubaaee002006-06-26 02:48:02 +02002028
Willy Tarreau3a925c12013-09-04 17:54:01 +02002029 /* If the proxy holds a stick table, we need to purge all unused
2030 * entries. These are all the ones in the table with ref_cnt == 0
2031 * and all the ones in the pool used to allocate new entries. Any
Willy Tarreau87b09662015-04-03 00:22:06 +02002032 * entry attached to an existing stream waiting for a store will
Willy Tarreau3a925c12013-09-04 17:54:01 +02002033 * be in neither list. Any entry being dumped will have ref_cnt > 0.
2034 * However we protect tables that are being synced to peers.
2035 */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002036 if (unlikely(stopping && (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) && p->table && p->table->current)) {
Emeric Brun2cc201f2021-04-23 12:21:26 +02002037
2038 if (!p->table->refcnt) {
2039 /* !table->refcnt means there
2040 * is no more pending full resync
2041 * to push to a new process and
2042 * we are free to flush the table.
2043 */
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002044 int budget;
2045 int cleaned_up;
2046
2047 /* We purposely enforce a budget limitation since we don't want
2048 * to spend too much time purging old entries
2049 *
2050 * This is known to cause the watchdog to occasionnaly trigger if
2051 * the table is huge and all entries become available for purge
2052 * at the same time
2053 *
2054 * Moreover, we must also anticipate the pool_gc() call which
2055 * will also be much slower if there is too much work at once
2056 */
2057 budget = MIN(p->table->current, (1 << 15)); /* max: 32K */
2058 cleaned_up = stktable_trash_oldest(p->table, budget);
2059 if (cleaned_up) {
2060 /* immediately release freed memory since we are stopping */
Aurelien DARRAGON6e1fe252023-03-28 15:14:48 +02002061 pool_gc(NULL);
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002062 if (cleaned_up > (budget / 2)) {
2063 /* most of the budget was used to purge entries,
2064 * it is very likely that there are still trashable
2065 * entries in the table, reschedule a new cleanup
2066 * attempt ASAP
2067 */
2068 t->expire = TICK_ETERNITY;
2069 task_wakeup(t, TASK_WOKEN_RES);
2070 return t;
2071 }
2072 }
Willy Tarreau3a925c12013-09-04 17:54:01 +02002073 }
Frédéric Lécaille1b8e68e2019-03-14 07:07:41 +01002074 if (p->table->current) {
Aurelien DARRAGON7f01f0a2023-03-29 16:18:50 +02002075 /* some entries still remain but are not yet available
2076 * for cleanup, let's recheck in one second
2077 */
Willy Tarreau3a925c12013-09-04 17:54:01 +02002078 next = tick_first(next, tick_add(now_ms, 1000));
2079 }
2080 }
2081
Willy Tarreau918ff602011-07-25 16:33:49 +02002082 /* the rest below is just for frontends */
2083 if (!(p->cap & PR_CAP_FE))
2084 goto out;
Willy Tarreauf3f8c702011-07-25 07:37:28 +02002085
Willy Tarreau918ff602011-07-25 16:33:49 +02002086 /* check the various reasons we may find to block the frontend */
Willy Tarreau6b3bf732020-09-24 07:35:46 +02002087 if (unlikely(p->feconn >= p->maxconn))
Willy Tarreau918ff602011-07-25 16:33:49 +02002088 goto out;
Willy Tarreau3a7d2072009-03-05 23:48:25 +01002089
Willy Tarreau918ff602011-07-25 16:33:49 +02002090 if (p->fe_sps_lim &&
2091 (wait = next_event_delay(&p->fe_sess_per_sec, p->fe_sps_lim, 0))) {
2092 /* we're blocking because a limit was reached on the number of
2093 * requests/s on the frontend. We want to re-check ASAP, which
2094 * means in 1 ms before estimated expiration date, because the
2095 * timer will have settled down.
2096 */
2097 next = tick_first(next, tick_add(now_ms, wait));
2098 goto out;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002099 }
Willy Tarreau918ff602011-07-25 16:33:49 +02002100
2101 /* The proxy is not limited so we can re-enable any waiting listener */
Willy Tarreau241797a2019-12-10 14:10:52 +01002102 dequeue_proxy_listeners(p);
Willy Tarreau918ff602011-07-25 16:33:49 +02002103 out:
2104 t->expire = next;
2105 task_queue(t);
2106 return t;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002107}
2108
2109
Willy Tarreau10080712021-09-07 10:49:45 +02002110static int proxy_parse_grace(char **args, int section_type, struct proxy *curpx,
2111 const struct proxy *defpx, const char *file, int line,
2112 char **err)
2113{
2114 const char *res;
2115
2116 if (!*args[1]) {
2117 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2118 return -1;
2119 }
2120 res = parse_time_err(args[1], &global.grace_delay, TIME_UNIT_MS);
2121 if (res == PARSE_TIME_OVER) {
2122 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2123 args[1], args[0]);
2124 return -1;
2125 }
2126 else if (res == PARSE_TIME_UNDER) {
2127 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2128 args[1], args[0]);
2129 return -1;
2130 }
2131 else if (res) {
2132 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2133 return -1;
2134 }
2135 return 0;
2136}
2137
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002138static int proxy_parse_hard_stop_after(char **args, int section_type, struct proxy *curpx,
Willy Tarreau01825162021-03-09 09:53:46 +01002139 const struct proxy *defpx, const char *file, int line,
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002140 char **err)
2141{
2142 const char *res;
2143
2144 if (!*args[1]) {
2145 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2146 return -1;
2147 }
2148 res = parse_time_err(args[1], &global.hard_stop_after, TIME_UNIT_MS);
Willy Tarreau9faebe32019-06-07 19:00:37 +02002149 if (res == PARSE_TIME_OVER) {
2150 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2151 args[1], args[0]);
2152 return -1;
2153 }
2154 else if (res == PARSE_TIME_UNDER) {
2155 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2156 args[1], args[0]);
2157 return -1;
2158 }
2159 else if (res) {
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002160 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2161 return -1;
2162 }
2163 return 0;
2164}
2165
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002166static int proxy_parse_close_spread_time(char **args, int section_type, struct proxy *curpx,
2167 const struct proxy *defpx, const char *file, int line,
2168 char **err)
2169{
2170 const char *res;
2171
2172 if (!*args[1]) {
2173 memprintf(err, "'%s' expects <time> as argument.\n", args[0]);
2174 return -1;
2175 }
Remi Tricot-Le Breton4d7fdc62022-04-26 15:17:18 +02002176
2177 /* If close-spread-time is set to "infinite", disable the active connection
2178 * closing during soft-stop.
2179 */
2180 if (strcmp(args[1], "infinite") == 0) {
2181 global.tune.options |= GTUNE_DISABLE_ACTIVE_CLOSE;
2182 global.close_spread_time = TICK_ETERNITY;
2183 return 0;
2184 }
2185
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002186 res = parse_time_err(args[1], &global.close_spread_time, TIME_UNIT_MS);
2187 if (res == PARSE_TIME_OVER) {
2188 memprintf(err, "timer overflow in argument '%s' to '%s' (maximum value is 2147483647 ms or ~24.8 days)",
2189 args[1], args[0]);
2190 return -1;
2191 }
2192 else if (res == PARSE_TIME_UNDER) {
2193 memprintf(err, "timer underflow in argument '%s' to '%s' (minimum non-null value is 1 ms)",
2194 args[1], args[0]);
2195 return -1;
2196 }
2197 else if (res) {
2198 memprintf(err, "unexpected character '%c' in argument to <%s>.\n", *res, args[0]);
2199 return -1;
2200 }
Remi Tricot-Le Breton4d7fdc62022-04-26 15:17:18 +02002201 global.tune.options &= ~GTUNE_DISABLE_ACTIVE_CLOSE;
2202
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002203 return 0;
2204}
2205
Willy Tarreau144f84a2021-03-02 16:09:26 +01002206struct task *hard_stop(struct task *t, void *context, unsigned int state)
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002207{
2208 struct proxy *p;
2209 struct stream *s;
Willy Tarreau0d038252021-02-24 11:13:59 +01002210 int thr;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002211
2212 if (killed) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002213 ha_warning("Some tasks resisted to hard-stop, exiting now.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002214 send_log(NULL, LOG_WARNING, "Some tasks resisted to hard-stop, exiting now.\n");
Willy Tarreau7067b3a2019-06-02 11:11:29 +02002215 killed = 2;
Willy Tarreau0d038252021-02-24 11:13:59 +01002216 for (thr = 0; thr < global.nbthread; thr++)
Willy Tarreaub2f38c12023-01-19 19:14:18 +01002217 if (_HA_ATOMIC_LOAD(&ha_thread_info[thr].tg->threads_enabled) & ha_thread_info[thr].ltid_bit)
Willy Tarreau0d038252021-02-24 11:13:59 +01002218 wake_thread(thr);
Willy Tarreau7067b3a2019-06-02 11:11:29 +02002219 t->expire = TICK_ETERNITY;
2220 return t;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002221 }
2222
Christopher Faulet767a84b2017-11-24 16:50:31 +01002223 ha_warning("soft-stop running for too long, performing a hard-stop.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002224 send_log(NULL, LOG_WARNING, "soft-stop running for too long, performing a hard-stop.\n");
Olivier Houchardfbc74e82017-11-24 16:54:05 +01002225 p = proxies_list;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002226 while (p) {
2227 if ((p->cap & PR_CAP_FE) && (p->feconn > 0)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002228 ha_warning("Proxy %s hard-stopped (%d remaining conns will be closed).\n",
2229 p->id, p->feconn);
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002230 send_log(p, LOG_WARNING, "Proxy %s hard-stopped (%d remaining conns will be closed).\n",
2231 p->id, p->feconn);
2232 }
2233 p = p->next;
2234 }
Willy Tarreau92b887e2021-02-24 11:08:56 +01002235
2236 thread_isolate();
Willy Tarreaua698eb62021-02-24 10:37:01 +01002237
2238 for (thr = 0; thr < global.nbthread; thr++) {
Willy Tarreaub4e34762021-09-30 19:02:18 +02002239 list_for_each_entry(s, &ha_thread_ctx[thr].streams, list) {
Willy Tarreaua698eb62021-02-24 10:37:01 +01002240 stream_shutdown(s, SF_ERR_KILLED);
2241 }
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002242 }
Willy Tarreaua698eb62021-02-24 10:37:01 +01002243
Willy Tarreau92b887e2021-02-24 11:08:56 +01002244 thread_release();
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002245
2246 killed = 1;
2247 t->expire = tick_add(now_ms, MS_TO_TICKS(1000));
2248 return t;
2249}
2250
Willy Tarreau10080712021-09-07 10:49:45 +02002251/* perform the soft-stop right now (i.e. unbind listeners) */
2252static void do_soft_stop_now()
Willy Tarreaubaaee002006-06-26 02:48:02 +02002253{
Christopher Faulet48678e42023-03-14 14:33:11 +01002254 struct proxy *p;
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002255 struct task *task;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002256
William Dauchy3894d972019-12-28 15:36:02 +01002257 /* disable busy polling to avoid cpu eating for the new process */
2258 global.tune.options &= ~GTUNE_BUSY_POLLING;
Willy Tarreau10080712021-09-07 10:49:45 +02002259
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002260 if (tick_isset(global.close_spread_time)) {
2261 global.close_spread_end = tick_add(now_ms, global.close_spread_time);
2262 }
2263
Willy Tarreau10080712021-09-07 10:49:45 +02002264 /* schedule a hard-stop after a delay if needed */
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002265 if (tick_isset(global.hard_stop_after)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +02002266 task = task_new_anywhere();
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002267 if (task) {
2268 task->process = hard_stop;
2269 task_schedule(task, tick_add(now_ms, global.hard_stop_after));
2270 }
2271 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002272 ha_alert("out of memory trying to allocate the hard-stop task.\n");
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002273 }
2274 }
Willy Tarreau626f3a72020-10-07 16:52:43 +02002275
Willy Tarreau1b927eb2022-07-15 19:15:02 +02002276 /* we isolate so that we have a chance of stopping listeners in other groups */
2277 thread_isolate();
2278
Willy Tarreaueb778242021-06-11 16:27:10 +02002279 /* stop all stoppable listeners */
Willy Tarreau626f3a72020-10-07 16:52:43 +02002280 protocol_stop_now();
2281
Willy Tarreau1b927eb2022-07-15 19:15:02 +02002282 thread_release();
2283
Christopher Faulet48678e42023-03-14 14:33:11 +01002284 /* Loop on proxies to stop backends */
2285 p = proxies_list;
2286 while (p) {
2287 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2288 proxy_cond_disable(p);
2289 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
2290 p = p->next;
2291 }
2292
Willy Tarreaud0807c32010-08-27 18:26:11 +02002293 /* signal zero is used to broadcast the "stopping" event */
2294 signal_handler(0);
Willy Tarreaubaaee002006-06-26 02:48:02 +02002295}
2296
Willy Tarreau10080712021-09-07 10:49:45 +02002297/* triggered by a soft-stop delayed with `grace` */
2298static struct task *grace_expired(struct task *t, void *context, unsigned int state)
2299{
2300 ha_notice("Grace period expired, proceeding with soft-stop now.\n");
2301 send_log(NULL, LOG_NOTICE, "Grace period expired, proceeding with soft-stop now.\n");
2302 do_soft_stop_now();
2303 task_destroy(t);
2304 return NULL;
2305}
2306
2307/*
2308 * this function disables health-check servers so that the process will quickly be ignored
2309 * by load balancers.
2310 */
2311void soft_stop(void)
2312{
2313 struct task *task;
2314
2315 stopping = 1;
2316
2317 if (tick_isset(global.grace_delay)) {
Willy Tarreaubeeabf52021-10-01 18:23:30 +02002318 task = task_new_anywhere();
Willy Tarreau10080712021-09-07 10:49:45 +02002319 if (task) {
2320 ha_notice("Scheduling a soft-stop in %u ms.\n", global.grace_delay);
2321 send_log(NULL, LOG_WARNING, "Scheduling a soft-stop in %u ms.\n", global.grace_delay);
2322 task->process = grace_expired;
2323 task_schedule(task, tick_add(now_ms, global.grace_delay));
2324 return;
2325 }
2326 else {
2327 ha_alert("out of memory trying to allocate the stop-stop task, stopping now.\n");
2328 }
2329 }
2330
2331 /* no grace (or failure to enforce it): stop now */
2332 do_soft_stop_now();
2333}
2334
Willy Tarreaubaaee002006-06-26 02:48:02 +02002335
Willy Tarreaube58c382011-07-24 18:28:10 +02002336/* Temporarily disables listening on all of the proxy's listeners. Upon
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002337 * success, the proxy enters the PR_PAUSED state. The function returns 0
Willy Tarreauce8fe252011-09-07 19:14:57 +02002338 * if it fails, or non-zero on success.
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002339 * The function takes the proxy's lock so it's safe to
2340 * call from multiple places.
Willy Tarreaubaaee002006-06-26 02:48:02 +02002341 */
Willy Tarreauce8fe252011-09-07 19:14:57 +02002342int pause_proxy(struct proxy *p)
Willy Tarreaubaaee002006-06-26 02:48:02 +02002343{
2344 struct listener *l;
Willy Tarreauce8fe252011-09-07 19:14:57 +02002345
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002346 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2347
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002348 if (!(p->cap & PR_CAP_FE) || (p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !p->li_ready)
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002349 goto end;
Willy Tarreauce8fe252011-09-07 19:14:57 +02002350
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002351 list_for_each_entry(l, &p->conf.listeners, by_fe)
Aurelien DARRAGONd3ffba42023-02-13 17:45:08 +01002352 suspend_listener(l, 1, 0);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002353
Willy Tarreaua17c91b2020-09-24 07:44:34 +02002354 if (p->li_ready) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002355 ha_warning("%s %s failed to enter pause mode.\n", proxy_cap_str(p->cap), p->id);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002356 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 +02002357 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002358 return 0;
2359 }
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002360end:
2361 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauce8fe252011-09-07 19:14:57 +02002362 return 1;
Willy Tarreauda250db2008-10-12 12:07:48 +02002363}
2364
Willy Tarreauda250db2008-10-12 12:07:48 +02002365/*
2366 * This function completely stops a proxy and releases its listeners. It has
2367 * to be called when going down in order to release the ports so that another
2368 * process may bind to them. It must also be called on disabled proxies at the
William Lallemandc59f9882018-11-16 16:57:21 +01002369 * end of start-up. If all listeners are closed, the proxy is set to the
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002370 * PR_STOPPED state.
2371 * The function takes the proxy's lock so it's safe to
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002372 * call from multiple places.
Willy Tarreauda250db2008-10-12 12:07:48 +02002373 */
2374void stop_proxy(struct proxy *p)
2375{
2376 struct listener *l;
2377
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002378 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002379
Willy Tarreau322b9b92020-10-07 16:20:34 +02002380 list_for_each_entry(l, &p->conf.listeners, by_fe)
Aurelien DARRAGON4059e092023-02-06 17:06:03 +01002381 stop_listener(l, 1, 0, 0);
Willy Tarreau3de3cd42019-07-24 17:42:44 +02002382
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002383 if (!(p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) && !p->li_ready) {
Willy Tarreauba296872020-10-16 15:10:11 +02002384 /* might be just a backend */
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002385 p->flags |= PR_FL_STOPPED;
Willy Tarreauba296872020-10-16 15:10:11 +02002386 }
2387
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002388 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreaubaaee002006-06-26 02:48:02 +02002389}
2390
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002391/* This function resumes listening on the specified proxy. It scans all of its
2392 * listeners and tries to enable them all. If any of them fails, the proxy is
2393 * put back to the paused state. It returns 1 upon success, or zero if an error
2394 * is encountered.
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002395 * The function takes the proxy's lock so it's safe to
2396 * call from multiple places.
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002397 */
2398int resume_proxy(struct proxy *p)
2399{
2400 struct listener *l;
2401 int fail;
2402
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002403 HA_RWLOCK_WRLOCK(PROXY_LOCK, &p->lock);
2404
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002405 if ((p->flags & (PR_FL_DISABLED|PR_FL_STOPPED)) || !p->li_paused)
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002406 goto end;
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002407
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002408 fail = 0;
Willy Tarreau4348fad2012-09-20 16:48:07 +02002409 list_for_each_entry(l, &p->conf.listeners, by_fe) {
Aurelien DARRAGON4059e092023-02-06 17:06:03 +01002410 if (!resume_listener(l, 1, 0)) {
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002411 int port;
2412
Willy Tarreau37159062020-08-27 07:48:42 +02002413 port = get_host_port(&l->rx.addr);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002414 if (port) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002415 ha_warning("Port %d busy while trying to enable %s %s.\n",
2416 port, proxy_cap_str(p->cap), p->id);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002417 send_log(p, LOG_WARNING, "Port %d busy while trying to enable %s %s.\n",
2418 port, proxy_cap_str(p->cap), p->id);
2419 }
2420 else {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002421 ha_warning("Bind on socket %d busy while trying to enable %s %s.\n",
2422 l->luid, proxy_cap_str(p->cap), p->id);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002423 send_log(p, LOG_WARNING, "Bind on socket %d busy while trying to enable %s %s.\n",
2424 l->luid, proxy_cap_str(p->cap), p->id);
2425 }
2426
2427 /* Another port might have been enabled. Let's stop everything. */
2428 fail = 1;
2429 break;
2430 }
2431 }
2432
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002433 if (fail) {
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002434 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
2435 /* pause_proxy will take PROXY_LOCK */
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002436 pause_proxy(p);
2437 return 0;
2438 }
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02002439end:
2440 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &p->lock);
Willy Tarreauc03ebbf2011-09-07 21:33:14 +02002441 return 1;
2442}
2443
Willy Tarreau87b09662015-04-03 00:22:06 +02002444/* Set current stream's backend to <be>. Nothing is done if the
2445 * stream already had a backend assigned, which is indicated by
Willy Tarreaue7dff022015-04-03 01:14:29 +02002446 * s->flags & SF_BE_ASSIGNED.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002447 * All flags, stats and counters which need be updated are updated.
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002448 * Returns 1 if done, 0 in case of internal error, eg: lack of resource.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002449 */
Willy Tarreau87b09662015-04-03 00:22:06 +02002450int stream_set_backend(struct stream *s, struct proxy *be)
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002451{
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002452 unsigned int req_ana;
2453
Willy Tarreaue7dff022015-04-03 01:14:29 +02002454 if (s->flags & SF_BE_ASSIGNED)
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002455 return 1;
Christopher Faulet41179042016-06-21 11:54:52 +02002456
2457 if (flt_set_stream_backend(s, be) < 0)
2458 return 0;
2459
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002460 s->be = be;
Christopher Fauletff8abcd2017-06-02 15:33:24 +02002461 HA_ATOMIC_UPDATE_MAX(&be->be_counters.conn_max,
Willy Tarreau1db42732021-04-06 11:44:07 +02002462 HA_ATOMIC_ADD_FETCH(&be->beconn, 1));
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002463 proxy_inc_be_ctr(be);
2464
Willy Tarreau87b09662015-04-03 00:22:06 +02002465 /* assign new parameters to the stream from the new backend */
Willy Tarreaucb041662022-05-17 19:44:42 +02002466 s->scb->flags &= ~SC_FL_INDEP_STR;
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02002467 if (be->options2 & PR_O2_INDEPSTR)
Willy Tarreaucb041662022-05-17 19:44:42 +02002468 s->scb->flags |= SC_FL_INDEP_STR;
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02002469
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002470 /* We want to enable the backend-specific analysers except those which
2471 * were already run as part of the frontend/listener. Note that it would
2472 * be more reliable to store the list of analysers that have been run,
2473 * but what we do here is OK for now.
2474 */
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002475 req_ana = be->be_req_ana;
2476 if (!(strm_fe(s)->options & PR_O_WREQ_BODY) && be->options & PR_O_WREQ_BODY) {
2477 /* The backend request to parse a request body while it was not
2478 * performed on the frontend, so add the corresponding analyser
2479 */
2480 req_ana |= AN_REQ_HTTP_BODY;
2481 }
2482 if (IS_HTX_STRM(s) && strm_fe(s)->mode != PR_MODE_HTTP) {
2483 /* The stream was already upgraded to HTTP, so remove analysers
2484 * set during the upgrade
2485 */
2486 req_ana &= ~(AN_REQ_WAIT_HTTP|AN_REQ_HTTP_PROCESS_FE);
2487 }
Willy Tarreau7866e8e2023-01-12 18:39:42 +01002488 s->req.analysers |= req_ana & ~(strm_li(s) ? strm_li(s)->bind_conf->analysers : 0);
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002489
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002490 if (!IS_HTX_STRM(s) && be->mode == PR_MODE_HTTP) {
Christopher Fauletbbe68542019-04-08 10:53:51 +02002491 /* If we chain a TCP frontend to an HTX backend, we must upgrade
2492 * the client mux */
Christopher Fauletae863c62021-03-15 12:03:44 +01002493 if (!stream_set_http_mode(s, NULL))
Christopher Fauleteec7f8a2019-12-20 15:59:20 +01002494 return 0;
Christopher Faulet6c1fd982021-03-15 10:42:02 +01002495 }
2496 else if (IS_HTX_STRM(s) && be->mode != PR_MODE_HTTP) {
2497 /* If a TCP backend is assgiend to an HTX stream, return an
2498 * error. It may happens for a new stream on a previously
2499 * upgraded connections. */
2500 if (!(s->flags & SF_ERR_MASK))
2501 s->flags |= SF_ERR_INTERNAL;
2502 return 0;
2503 }
2504 else {
2505 /* If the target backend requires HTTP processing, we have to allocate
2506 * the HTTP transaction if we did not have one.
2507 */
2508 if (unlikely(!s->txn && be->http_needed && !http_create_txn(s)))
2509 return 0;
Willy Tarreaueee5b512015-04-03 23:46:31 +02002510 }
2511
2512 s->flags |= SF_BE_ASSIGNED;
Willy Tarreau96e31212011-05-30 18:10:30 +02002513 if (be->options2 & PR_O2_NODELAY) {
Christopher Faulet68ef2182023-03-17 15:38:18 +01002514 s->scf->flags |= SC_FL_SND_NEVERWAIT;
2515 s->scb->flags |= SC_FL_SND_NEVERWAIT;
Willy Tarreau96e31212011-05-30 18:10:30 +02002516 }
2517
Willy Tarreaubedb9ba2009-07-12 08:27:39 +02002518 return 1;
Willy Tarreau1d0dfb12009-07-07 15:10:31 +02002519}
2520
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002521/* Capture a bad request or response and archive it in the proxy's structure.
2522 * It is relatively protocol-agnostic so it requires that a number of elements
2523 * are passed :
2524 * - <proxy> is the proxy where the error was detected and where the snapshot
2525 * needs to be stored
Joseph Herlant59dd2952018-11-15 11:46:55 -08002526 * - <is_back> indicates that the error happened when receiving the response
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002527 * - <other_end> is a pointer to the proxy on the other side when known
2528 * - <target> is the target of the connection, usually a server or a proxy
2529 * - <sess> is the session which experienced the error
2530 * - <ctx> may be NULL or should contain any info relevant to the protocol
2531 * - <buf> is the buffer containing the offending data
2532 * - <buf_ofs> is the position of this buffer's input data in the input
2533 * stream, starting at zero. It may be passed as zero if unknown.
2534 * - <buf_out> is the portion of <buf->data> which was already forwarded and
2535 * which precedes the buffer's input. The buffer's input starts at
2536 * buf->head + buf_out.
2537 * - <err_pos> is the pointer to the faulty byte in the buffer's input.
2538 * - <show> is the callback to use to display <ctx>. It may be NULL.
2539 */
2540void proxy_capture_error(struct proxy *proxy, int is_back,
2541 struct proxy *other_end, enum obj_type *target,
2542 const struct session *sess,
2543 const struct buffer *buf, long buf_ofs,
2544 unsigned int buf_out, unsigned int err_pos,
2545 const union error_snapshot_ctx *ctx,
2546 void (*show)(struct buffer *, const struct error_snapshot *))
2547{
2548 struct error_snapshot *es;
2549 unsigned int buf_len;
2550 int len1, len2;
Willy Tarreauc55015e2018-09-07 19:02:32 +02002551 unsigned int ev_id;
2552
Willy Tarreau18515722021-04-06 11:57:41 +02002553 ev_id = HA_ATOMIC_FETCH_ADD(&error_snapshot_id, 1);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002554
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002555 buf_len = b_data(buf) - buf_out;
2556
2557 es = malloc(sizeof(*es) + buf_len);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002558 if (!es)
2559 return;
2560
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002561 es->buf_len = buf_len;
2562 es->ev_id = ev_id;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002563
Christopher Faulet47a72102020-01-06 11:37:00 +01002564 len1 = b_size(buf) - b_peek_ofs(buf, buf_out);
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002565 if (len1 > buf_len)
2566 len1 = buf_len;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002567
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002568 if (len1) {
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002569 memcpy(es->buf, b_peek(buf, buf_out), len1);
Willy Tarreau4bc7d902018-09-07 20:07:17 +02002570 len2 = buf_len - len1;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002571 if (len2)
2572 memcpy(es->buf + len1, b_orig(buf), len2);
2573 }
2574
2575 es->buf_err = err_pos;
2576 es->when = date; // user-visible date
2577 es->srv = objt_server(target);
2578 es->oe = other_end;
Olivier Houchardbdb00c52020-03-12 15:30:17 +01002579 if (sess && objt_conn(sess->origin) && conn_get_src(__objt_conn(sess->origin)))
Willy Tarreau026efc72019-07-17 15:20:02 +02002580 es->src = *__objt_conn(sess->origin)->src;
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002581 else
2582 memset(&es->src, 0, sizeof(es->src));
2583
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002584 es->buf_wrap = b_wrap(buf) - b_peek(buf, buf_out);
2585 es->buf_out = buf_out;
2586 es->buf_ofs = buf_ofs;
2587
2588 /* be sure to indicate the offset of the first IN byte */
2589 if (es->buf_ofs >= es->buf_len)
2590 es->buf_ofs -= es->buf_len;
2591 else
2592 es->buf_ofs = 0;
2593
2594 /* protocol-specific part now */
2595 if (ctx)
2596 es->ctx = *ctx;
2597 else
2598 memset(&es->ctx, 0, sizeof(es->ctx));
2599 es->show = show;
Willy Tarreauc55015e2018-09-07 19:02:32 +02002600
2601 /* note: we still lock since we have to be certain that nobody is
2602 * dumping the output while we free.
2603 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002604 HA_RWLOCK_WRLOCK(PROXY_LOCK, &proxy->lock);
Willy Tarreauc55015e2018-09-07 19:02:32 +02002605 if (is_back) {
2606 es = HA_ATOMIC_XCHG(&proxy->invalid_rep, es);
2607 } else {
2608 es = HA_ATOMIC_XCHG(&proxy->invalid_req, es);
2609 }
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002610 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &proxy->lock);
Willy Tarreauda9f2582022-09-17 11:07:19 +02002611 ha_free(&es);
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002612}
2613
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002614/* Configure all proxies which lack a maxconn setting to use the global one by
2615 * default. This avoids the common mistake consisting in setting maxconn only
2616 * in the global section and discovering the hard way that it doesn't propagate
2617 * through the frontends. These values are also propagated through the various
Ilya Shipitsin47d17182020-06-21 21:42:57 +05002618 * targeted backends, whose fullconn is finally calculated if not yet set.
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002619 */
2620void proxy_adjust_all_maxconn()
2621{
2622 struct proxy *curproxy;
2623 struct switching_rule *swrule1, *swrule2;
2624
2625 for (curproxy = proxies_list; curproxy; curproxy = curproxy->next) {
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002626 if (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002627 continue;
2628
2629 if (!(curproxy->cap & PR_CAP_FE))
2630 continue;
2631
2632 if (!curproxy->maxconn)
2633 curproxy->maxconn = global.maxconn;
2634
2635 /* update the target backend's fullconn count : default_backend */
2636 if (curproxy->defbe.be)
2637 curproxy->defbe.be->tot_fe_maxconn += curproxy->maxconn;
2638 else if ((curproxy->cap & PR_CAP_LISTEN) == PR_CAP_LISTEN)
2639 curproxy->tot_fe_maxconn += curproxy->maxconn;
2640
2641 list_for_each_entry(swrule1, &curproxy->switching_rules, list) {
2642 /* For each target of switching rules, we update their
2643 * tot_fe_maxconn, except if a previous rule points to
2644 * the same backend or to the default backend.
2645 */
2646 if (swrule1->be.backend != curproxy->defbe.be) {
Frédéric Lécaille2365fb02019-03-07 15:02:52 +01002647 /* note: swrule1->be.backend isn't a backend if the rule
2648 * is dynamic, it's an expression instead, so it must not
2649 * be dereferenced as a backend before being certain it is.
2650 */
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002651 list_for_each_entry(swrule2, &curproxy->switching_rules, list) {
2652 if (swrule2 == swrule1) {
Frédéric Lécaille2365fb02019-03-07 15:02:52 +01002653 if (!swrule1->dynamic)
2654 swrule1->be.backend->tot_fe_maxconn += curproxy->maxconn;
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002655 break;
2656 }
2657 else if (!swrule2->dynamic && swrule2->be.backend == swrule1->be.backend) {
2658 /* there are multiple refs of this backend */
2659 break;
2660 }
2661 }
2662 }
2663 }
2664 }
2665
2666 /* automatically compute fullconn if not set. We must not do it in the
2667 * loop above because cross-references are not yet fully resolved.
2668 */
2669 for (curproxy = proxies_list; curproxy; curproxy = curproxy->next) {
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02002670 if (curproxy->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreauc8d5b952019-02-27 17:25:52 +01002671 continue;
2672
2673 /* If <fullconn> is not set, let's set it to 10% of the sum of
2674 * the possible incoming frontend's maxconns.
2675 */
2676 if (!curproxy->fullconn && (curproxy->cap & PR_CAP_BE)) {
2677 /* we have the sum of the maxconns in <total>. We only
2678 * keep 10% of that sum to set the default fullconn, with
2679 * a hard minimum of 1 (to avoid a divide by zero).
2680 */
2681 curproxy->fullconn = (curproxy->tot_fe_maxconn + 9) / 10;
2682 if (!curproxy->fullconn)
2683 curproxy->fullconn = 1;
2684 }
2685 }
2686}
2687
Willy Tarreau75fb65a2018-09-07 17:43:26 +02002688/* Config keywords below */
2689
Willy Tarreaudc13c112013-06-21 23:16:39 +02002690static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau10080712021-09-07 10:49:45 +02002691 { CFG_GLOBAL, "grace", proxy_parse_grace },
Cyril Bonté203ec5a2017-03-23 22:44:13 +01002692 { CFG_GLOBAL, "hard-stop-after", proxy_parse_hard_stop_after },
Remi Tricot-Le Bretonb5d968d2022-04-08 18:04:18 +02002693 { CFG_GLOBAL, "close-spread-time", proxy_parse_close_spread_time },
Willy Tarreau9de1bbd2008-07-09 20:34:27 +02002694 { CFG_LISTEN, "timeout", proxy_parse_timeout },
Tim Duesterhus86e6b6e2019-05-14 20:57:59 +02002695 { CFG_LISTEN, "clitimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
2696 { CFG_LISTEN, "contimeout", proxy_parse_timeout }, /* This keyword actually fails to parse, this line remains for better error messages. */
2697 { 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 +01002698 { CFG_LISTEN, "rate-limit", proxy_parse_rate_limit },
Willy Tarreauc35362a2014-04-25 13:58:37 +02002699 { CFG_LISTEN, "max-keep-alive-queue", proxy_parse_max_ka_queue },
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +02002700 { CFG_LISTEN, "declare", proxy_parse_declare },
Olivier Houcharda254a372019-04-05 15:30:12 +02002701 { CFG_LISTEN, "retry-on", proxy_parse_retry_on },
Willy Tarreau52543212020-07-09 05:58:51 +02002702#ifdef TCP_KEEPCNT
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002703 { CFG_LISTEN, "clitcpka-cnt", proxy_parse_tcpka_cnt },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002704 { CFG_LISTEN, "srvtcpka-cnt", proxy_parse_tcpka_cnt },
Willy Tarreau52543212020-07-09 05:58:51 +02002705#endif
2706#ifdef TCP_KEEPIDLE
2707 { CFG_LISTEN, "clitcpka-idle", proxy_parse_tcpka_idle },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002708 { CFG_LISTEN, "srvtcpka-idle", proxy_parse_tcpka_idle },
Willy Tarreau52543212020-07-09 05:58:51 +02002709#endif
2710#ifdef TCP_KEEPINTVL
2711 { CFG_LISTEN, "clitcpka-intvl", proxy_parse_tcpka_intvl },
MIZUTA Takeshib24bc0d2020-07-09 11:13:20 +09002712 { CFG_LISTEN, "srvtcpka-intvl", proxy_parse_tcpka_intvl },
Willy Tarreau52543212020-07-09 05:58:51 +02002713#endif
Willy Tarreau9de1bbd2008-07-09 20:34:27 +02002714 { 0, NULL, NULL },
2715}};
2716
Willy Tarreau0108d902018-11-25 19:14:37 +01002717INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2718
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002719/* Expects to find a frontend named <arg> and returns it, otherwise displays various
2720 * adequate error messages and returns NULL. This function is designed to be used by
2721 * functions requiring a frontend on the CLI.
2722 */
2723struct proxy *cli_find_frontend(struct appctx *appctx, const char *arg)
2724{
2725 struct proxy *px;
2726
2727 if (!*arg) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002728 cli_err(appctx, "A frontend name is expected.\n");
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002729 return NULL;
2730 }
2731
2732 px = proxy_fe_by_name(arg);
2733 if (!px) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002734 cli_err(appctx, "No such frontend.\n");
Willy Tarreau960f2cb2016-11-24 12:02:29 +01002735 return NULL;
2736 }
2737 return px;
2738}
2739
Olivier Houchard614f8d72017-03-14 20:08:46 +01002740/* Expects to find a backend named <arg> and returns it, otherwise displays various
2741 * adequate error messages and returns NULL. This function is designed to be used by
2742 * functions requiring a frontend on the CLI.
2743 */
2744struct proxy *cli_find_backend(struct appctx *appctx, const char *arg)
2745{
2746 struct proxy *px;
2747
2748 if (!*arg) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002749 cli_err(appctx, "A backend name is expected.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01002750 return NULL;
2751 }
2752
2753 px = proxy_be_by_name(arg);
2754 if (!px) {
Willy Tarreau9d008692019-08-09 11:21:01 +02002755 cli_err(appctx, "No such backend.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01002756 return NULL;
2757 }
2758 return px;
2759}
2760
2761
Willy Tarreau69f591e2020-07-01 07:00:59 +02002762/* parse a "show servers [state|conn]" CLI line, returns 0 if it wants to start
2763 * the dump or 1 if it stops immediately. If an argument is specified, it will
Willy Tarreau72a04232022-05-05 17:00:20 +02002764 * reserve a show_srv_ctx context and set the proxy pointer into ->px, its ID
2765 * into ->only_pxid, and ->show_conn to 0 for "state", or 1 for "conn".
William Lallemanda6c5f332016-11-19 02:25:36 +01002766 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002767static int cli_parse_show_servers(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemanda6c5f332016-11-19 02:25:36 +01002768{
Willy Tarreau72a04232022-05-05 17:00:20 +02002769 struct show_srv_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002770 struct proxy *px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002771
Willy Tarreau72a04232022-05-05 17:00:20 +02002772 ctx->show_conn = *args[2] == 'c'; // "conn" vs "state"
Willy Tarreau69f591e2020-07-01 07:00:59 +02002773
William Lallemanda6c5f332016-11-19 02:25:36 +01002774 /* check if a backend name has been provided */
2775 if (*args[3]) {
2776 /* read server state from local file */
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002777 px = proxy_be_by_name(args[3]);
William Lallemanda6c5f332016-11-19 02:25:36 +01002778
Willy Tarreau9d008692019-08-09 11:21:01 +02002779 if (!px)
2780 return cli_err(appctx, "Can't find backend.\n");
2781
Willy Tarreau72a04232022-05-05 17:00:20 +02002782 ctx->px = px;
2783 ctx->only_pxid = px->uuid;
William Lallemanda6c5f332016-11-19 02:25:36 +01002784 }
2785 return 0;
2786}
2787
William Dauchyd1a7b852021-02-11 22:51:26 +01002788/* helper to dump server addr */
2789static void dump_server_addr(const struct sockaddr_storage *addr, char *addr_str)
2790{
2791 addr_str[0] = '\0';
2792 switch (addr->ss_family) {
2793 case AF_INET:
2794 case AF_INET6:
2795 addr_to_str(addr, addr_str, INET6_ADDRSTRLEN + 1);
2796 break;
2797 default:
2798 memcpy(addr_str, "-\0", 2);
2799 break;
2800 }
2801}
2802
Willy Tarreau6ff81432020-07-01 07:02:42 +02002803/* dumps server state information for all the servers found in backend cli.p0.
William Lallemanda6c5f332016-11-19 02:25:36 +01002804 * These information are all the parameters which may change during HAProxy runtime.
Willy Tarreau72a04232022-05-05 17:00:20 +02002805 * By default, we only export to the last known server state file format. These
2806 * information can be used at next startup to recover same level of server
2807 * state. It takes its context from show_srv_ctx, with the proxy pointer from
2808 * ->px, the proxy's id ->only_pxid, the server's pointer from ->sv, and the
2809 * choice of what to dump from ->show_conn.
William Lallemanda6c5f332016-11-19 02:25:36 +01002810 */
Willy Tarreau475e4632022-05-27 10:26:46 +02002811static int dump_servers_state(struct stconn *sc)
William Lallemanda6c5f332016-11-19 02:25:36 +01002812{
Willy Tarreau475e4632022-05-27 10:26:46 +02002813 struct appctx *appctx = __sc_appctx(sc);
Willy Tarreau72a04232022-05-05 17:00:20 +02002814 struct show_srv_ctx *ctx = appctx->svcctx;
2815 struct proxy *px = ctx->px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002816 struct server *srv;
2817 char srv_addr[INET6_ADDRSTRLEN + 1];
William Dauchyd1a7b852021-02-11 22:51:26 +01002818 char srv_agent_addr[INET6_ADDRSTRLEN + 1];
2819 char srv_check_addr[INET6_ADDRSTRLEN + 1];
William Lallemanda6c5f332016-11-19 02:25:36 +01002820 time_t srv_time_since_last_change;
2821 int bk_f_forced_id, srv_f_forced_id;
Baptiste Assmann6d0f38f2018-07-02 17:00:54 +02002822 char *srvrecord;
William Lallemanda6c5f332016-11-19 02:25:36 +01002823
Willy Tarreau72a04232022-05-05 17:00:20 +02002824 if (!ctx->sv)
2825 ctx->sv = px->srv;
William Lallemanda6c5f332016-11-19 02:25:36 +01002826
Willy Tarreau72a04232022-05-05 17:00:20 +02002827 for (; ctx->sv != NULL; ctx->sv = srv->next) {
2828 srv = ctx->sv;
William Lallemanda6c5f332016-11-19 02:25:36 +01002829
William Dauchyd1a7b852021-02-11 22:51:26 +01002830 dump_server_addr(&srv->addr, srv_addr);
2831 dump_server_addr(&srv->check.addr, srv_check_addr);
2832 dump_server_addr(&srv->agent.addr, srv_agent_addr);
2833
Willy Tarreau69530f52023-04-28 09:16:15 +02002834 srv_time_since_last_change = ns_to_sec(now_ns) - srv->last_change;
Willy Tarreau3c92f2a2016-12-16 18:23:39 +01002835 bk_f_forced_id = px->options & PR_O_FORCED_ID ? 1 : 0;
William Lallemanda6c5f332016-11-19 02:25:36 +01002836 srv_f_forced_id = srv->flags & SRV_F_FORCED_ID ? 1 : 0;
2837
Baptiste Assmann6d0f38f2018-07-02 17:00:54 +02002838 srvrecord = NULL;
2839 if (srv->srvrq && srv->srvrq->name)
2840 srvrecord = srv->srvrq->name;
2841
Willy Tarreau72a04232022-05-05 17:00:20 +02002842 if (ctx->show_conn == 0) {
Willy Tarreau69f591e2020-07-01 07:00:59 +02002843 /* show servers state */
2844 chunk_printf(&trash,
2845 "%d %s "
2846 "%d %s %s "
2847 "%d %d %d %d %ld "
2848 "%d %d %d %d %d "
William Dauchyf6370442020-11-14 19:25:33 +01002849 "%d %d %s %u "
William Dauchyd1a7b852021-02-11 22:51:26 +01002850 "%s %d %d "
2851 "%s %s %d"
Willy Tarreau69f591e2020-07-01 07:00:59 +02002852 "\n",
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002853 px->uuid, HA_ANON_CLI(px->id),
Erwan Le Goas9ac3ccb2022-09-29 10:27:33 +02002854 srv->puid, HA_ANON_CLI(srv->id),
2855 hash_ipanon(appctx->cli_anon_key, srv_addr, 0),
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002856 srv->cur_state, srv->cur_admin, srv->uweight, srv->iweight,
2857 (long int)srv_time_since_last_change,
2858 srv->check.status, srv->check.result, srv->check.health,
Willy Tarreau99521ab2022-10-12 21:40:31 +02002859 srv->check.state & 0x0F, srv->agent.state & 0x1F,
Erwan Le Goas1caa5352022-09-29 10:28:44 +02002860 bk_f_forced_id, srv_f_forced_id,
2861 srv->hostname ? HA_ANON_CLI(srv->hostname) : "-", srv->svc_port,
William Dauchyd1a7b852021-02-11 22:51:26 +01002862 srvrecord ? srvrecord : "-", srv->use_ssl, srv->check.port,
2863 srv_check_addr, srv_agent_addr, srv->agent.port);
Willy Tarreau69f591e2020-07-01 07:00:59 +02002864 } else {
2865 /* show servers conn */
2866 int thr;
2867
2868 chunk_printf(&trash,
2869 "%s/%s %d/%d %s %u - %u %u %u %u %u %u %d %u",
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002870 HA_ANON_CLI(px->id), HA_ANON_CLI(srv->id),
Erwan Le Goas9ac3ccb2022-09-29 10:27:33 +02002871 px->uuid, srv->puid, hash_ipanon(appctx->cli_anon_key, srv_addr, 0),
Erwan Le Goasacfdf762022-09-14 17:48:55 +02002872 srv->svc_port, srv->pool_purge_delay,
Willy Tarreau69f591e2020-07-01 07:00:59 +02002873 srv->curr_used_conns, srv->max_used_conns, srv->est_need_conns,
2874 srv->curr_idle_nb, srv->curr_safe_nb, (int)srv->max_idle_conns, srv->curr_idle_conns);
2875
Willy Tarreau42abe682020-07-02 15:19:57 +02002876 for (thr = 0; thr < global.nbthread && srv->curr_idle_thr; thr++)
Willy Tarreau69f591e2020-07-01 07:00:59 +02002877 chunk_appendf(&trash, " %u", srv->curr_idle_thr[thr]);
2878
2879 chunk_appendf(&trash, "\n");
2880 }
2881
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002882 if (applet_putchk(appctx, &trash) == -1) {
William Lallemanda6c5f332016-11-19 02:25:36 +01002883 return 0;
2884 }
2885 }
2886 return 1;
2887}
2888
2889/* Parses backend list or simply use backend name provided by the user to return
Willy Tarreau72a04232022-05-05 17:00:20 +02002890 * states of servers to stdout. It takes its context from show_srv_ctx and dumps
2891 * proxy ->px and stops if ->only_pxid is non-null.
William Lallemanda6c5f332016-11-19 02:25:36 +01002892 */
2893static int cli_io_handler_servers_state(struct appctx *appctx)
2894{
Willy Tarreau72a04232022-05-05 17:00:20 +02002895 struct show_srv_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02002896 struct stconn *sc = appctx_sc(appctx);
William Lallemanda6c5f332016-11-19 02:25:36 +01002897 struct proxy *curproxy;
2898
Willy Tarreaud741e9c2022-05-05 19:26:18 +02002899 if (ctx->state == SHOW_SRV_HEAD) {
Willy Tarreau72a04232022-05-05 17:00:20 +02002900 if (ctx->show_conn == 0)
Willy Tarreau69f591e2020-07-01 07:00:59 +02002901 chunk_printf(&trash, "%d\n# %s\n", SRV_STATE_FILE_VERSION, SRV_STATE_FILE_FIELD_NAMES);
2902 else
2903 chunk_printf(&trash,
2904 "# 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",
2905 global.nbthread);
2906
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002907 if (applet_putchk(appctx, &trash) == -1)
William Lallemanda6c5f332016-11-19 02:25:36 +01002908 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002909
Willy Tarreaud741e9c2022-05-05 19:26:18 +02002910 ctx->state = SHOW_SRV_LIST;
2911
2912 if (!ctx->px)
2913 ctx->px = proxies_list;
William Lallemanda6c5f332016-11-19 02:25:36 +01002914 }
2915
Willy Tarreau72a04232022-05-05 17:00:20 +02002916 for (; ctx->px != NULL; ctx->px = curproxy->next) {
2917 curproxy = ctx->px;
William Lallemanda6c5f332016-11-19 02:25:36 +01002918 /* servers are only in backends */
William Lallemanda39e6262021-08-25 18:15:31 +02002919 if ((curproxy->cap & PR_CAP_BE) && !(curproxy->cap & PR_CAP_INT)) {
Willy Tarreau475e4632022-05-27 10:26:46 +02002920 if (!dump_servers_state(sc))
William Lallemanda6c5f332016-11-19 02:25:36 +01002921 return 0;
William Lallemanda6c5f332016-11-19 02:25:36 +01002922 }
2923 /* only the selected proxy is dumped */
Willy Tarreau72a04232022-05-05 17:00:20 +02002924 if (ctx->only_pxid)
William Lallemanda6c5f332016-11-19 02:25:36 +01002925 break;
2926 }
2927
2928 return 1;
2929}
2930
Willy Tarreau608ea592016-12-16 18:01:15 +01002931/* Parses backend list and simply report backend names. It keeps the proxy
Willy Tarreauacf6a442022-05-05 17:05:38 +02002932 * pointer in svcctx since there's nothing else to store there.
Willy Tarreau608ea592016-12-16 18:01:15 +01002933 */
William Lallemand933efcd2016-11-22 12:34:16 +01002934static int cli_io_handler_show_backend(struct appctx *appctx)
2935{
William Lallemand933efcd2016-11-22 12:34:16 +01002936 struct proxy *curproxy;
2937
2938 chunk_reset(&trash);
2939
Willy Tarreauacf6a442022-05-05 17:05:38 +02002940 if (!appctx->svcctx) {
William Lallemand933efcd2016-11-22 12:34:16 +01002941 chunk_printf(&trash, "# name\n");
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002942 if (applet_putchk(appctx, &trash) == -1)
William Lallemand933efcd2016-11-22 12:34:16 +01002943 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002944
Willy Tarreauacf6a442022-05-05 17:05:38 +02002945 appctx->svcctx = proxies_list;
William Lallemand933efcd2016-11-22 12:34:16 +01002946 }
2947
Willy Tarreauacf6a442022-05-05 17:05:38 +02002948 for (; appctx->svcctx != NULL; appctx->svcctx = curproxy->next) {
2949 curproxy = appctx->svcctx;
William Lallemand933efcd2016-11-22 12:34:16 +01002950
Willy Tarreau4f9f1572022-05-05 17:10:03 +02002951 /* looking for non-internal backends only */
2952 if ((curproxy->cap & (PR_CAP_BE|PR_CAP_INT)) != PR_CAP_BE)
William Lallemand933efcd2016-11-22 12:34:16 +01002953 continue;
2954
William Lallemand933efcd2016-11-22 12:34:16 +01002955 chunk_appendf(&trash, "%s\n", curproxy->id);
Willy Tarreaud0a06d52022-05-18 15:07:19 +02002956 if (applet_putchk(appctx, &trash) == -1)
William Lallemand933efcd2016-11-22 12:34:16 +01002957 return 0;
William Lallemand933efcd2016-11-22 12:34:16 +01002958 }
2959
2960 return 1;
2961}
William Lallemanda6c5f332016-11-19 02:25:36 +01002962
Willy Tarreaua275a372018-08-21 14:50:44 +02002963/* Parses the "enable dynamic-cookies backend" directive, it always returns 1.
2964 *
2965 * Grabs the proxy lock and each server's lock.
2966 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002967static int cli_parse_enable_dyncookie_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01002968{
2969 struct proxy *px;
2970 struct server *s;
2971
2972 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
2973 return 1;
2974
2975 px = cli_find_backend(appctx, args[3]);
2976 if (!px)
2977 return 1;
2978
Willy Tarreau5e83d992019-07-30 11:59:34 +02002979 /* Note: this lock is to make sure this doesn't change while another
2980 * thread is in srv_set_dyncookie().
2981 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002982 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002983 px->ck_opts |= PR_CK_DYNAMIC;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02002984 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002985
Willy Tarreaua275a372018-08-21 14:50:44 +02002986 for (s = px->srv; s != NULL; s = s->next) {
2987 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01002988 srv_set_dyncookie(s);
Willy Tarreaua275a372018-08-21 14:50:44 +02002989 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
2990 }
2991
Olivier Houchard614f8d72017-03-14 20:08:46 +01002992 return 1;
2993}
2994
Willy Tarreaua275a372018-08-21 14:50:44 +02002995/* Parses the "disable dynamic-cookies backend" directive, it always returns 1.
2996 *
2997 * Grabs the proxy lock and each server's lock.
2998 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002999static int cli_parse_disable_dyncookie_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01003000{
3001 struct proxy *px;
3002 struct server *s;
3003
3004 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3005 return 1;
3006
3007 px = cli_find_backend(appctx, args[3]);
3008 if (!px)
3009 return 1;
3010
Willy Tarreau5e83d992019-07-30 11:59:34 +02003011 /* Note: this lock is to make sure this doesn't change while another
3012 * thread is in srv_set_dyncookie().
3013 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003014 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003015 px->ck_opts &= ~PR_CK_DYNAMIC;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003016 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003017
3018 for (s = px->srv; s != NULL; s = s->next) {
Willy Tarreaua275a372018-08-21 14:50:44 +02003019 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003020 if (!(s->flags & SRV_F_COOKIESET))
3021 ha_free(&s->cookie);
Willy Tarreaua275a372018-08-21 14:50:44 +02003022 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003023 }
3024
3025 return 1;
3026}
3027
Willy Tarreaua275a372018-08-21 14:50:44 +02003028/* Parses the "set dynamic-cookie-key backend" directive, it always returns 1.
3029 *
3030 * Grabs the proxy lock and each server's lock.
3031 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003032static int cli_parse_set_dyncookie_key_backend(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchard614f8d72017-03-14 20:08:46 +01003033{
3034 struct proxy *px;
3035 struct server *s;
3036 char *newkey;
3037
3038 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3039 return 1;
3040
3041 px = cli_find_backend(appctx, args[3]);
3042 if (!px)
3043 return 1;
3044
Willy Tarreau9d008692019-08-09 11:21:01 +02003045 if (!*args[4])
3046 return cli_err(appctx, "String value expected.\n");
Olivier Houchard614f8d72017-03-14 20:08:46 +01003047
3048 newkey = strdup(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02003049 if (!newkey)
3050 return cli_err(appctx, "Failed to allocate memory.\n");
Willy Tarreaua275a372018-08-21 14:50:44 +02003051
Willy Tarreau5e83d992019-07-30 11:59:34 +02003052 /* Note: this lock is to make sure this doesn't change while another
3053 * thread is in srv_set_dyncookie().
3054 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003055 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003056 free(px->dyncookie_key);
3057 px->dyncookie_key = newkey;
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003058 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003059
Willy Tarreaua275a372018-08-21 14:50:44 +02003060 for (s = px->srv; s != NULL; s = s->next) {
3061 HA_SPIN_LOCK(SERVER_LOCK, &s->lock);
Olivier Houchard614f8d72017-03-14 20:08:46 +01003062 srv_set_dyncookie(s);
Willy Tarreaua275a372018-08-21 14:50:44 +02003063 HA_SPIN_UNLOCK(SERVER_LOCK, &s->lock);
3064 }
3065
Olivier Houchard614f8d72017-03-14 20:08:46 +01003066 return 1;
3067}
3068
Willy Tarreaua275a372018-08-21 14:50:44 +02003069/* Parses the "set maxconn frontend" directive, it always returns 1.
3070 *
3071 * Grabs the proxy lock.
3072 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003073static int cli_parse_set_maxconn_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003074{
3075 struct proxy *px;
3076 struct listener *l;
3077 int v;
3078
3079 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3080 return 1;
3081
3082 px = cli_find_frontend(appctx, args[3]);
3083 if (!px)
3084 return 1;
3085
Willy Tarreau9d008692019-08-09 11:21:01 +02003086 if (!*args[4])
3087 return cli_err(appctx, "Integer value expected.\n");
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003088
3089 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02003090 if (v < 0)
3091 return cli_err(appctx, "Value out of range.\n");
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003092
3093 /* OK, the value is fine, so we assign it to the proxy and to all of
3094 * its listeners. The blocked ones will be dequeued.
3095 */
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003096 HA_RWLOCK_WRLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaua275a372018-08-21 14:50:44 +02003097
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003098 px->maxconn = v;
3099 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003100 if (l->state == LI_FULL)
Aurelien DARRAGONf5d98932023-02-06 17:19:58 +01003101 relax_listener(l, 1, 0);
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003102 }
3103
Willy Tarreau241797a2019-12-10 14:10:52 +01003104 if (px->maxconn > px->feconn)
3105 dequeue_proxy_listeners(px);
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003106
Willy Tarreauac66d6b2020-10-20 17:24:27 +02003107 HA_RWLOCK_WRUNLOCK(PROXY_LOCK, &px->lock);
Willy Tarreaua275a372018-08-21 14:50:44 +02003108
Willy Tarreauc429a1f2016-11-23 16:22:04 +01003109 return 1;
3110}
3111
Willy Tarreaua275a372018-08-21 14:50:44 +02003112/* Parses the "shutdown frontend" directive, it always returns 1.
3113 *
3114 * Grabs the proxy lock.
3115 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003116static int cli_parse_shutdown_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003117{
3118 struct proxy *px;
3119
3120 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3121 return 1;
3122
3123 px = cli_find_frontend(appctx, args[2]);
3124 if (!px)
3125 return 1;
3126
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003127 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003128 return cli_msg(appctx, LOG_NOTICE, "Frontend was already shut down.\n");
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003129
Willy Tarreau5212d7f2016-11-24 11:13:06 +01003130 stop_proxy(px);
3131 return 1;
3132}
3133
Willy Tarreaua275a372018-08-21 14:50:44 +02003134/* Parses the "disable frontend" directive, it always returns 1.
3135 *
3136 * Grabs the proxy lock.
3137 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003138static int cli_parse_disable_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau15b9e682016-11-24 11:55:28 +01003139{
3140 struct proxy *px;
Willy Tarreaua275a372018-08-21 14:50:44 +02003141 int ret;
Willy Tarreau15b9e682016-11-24 11:55:28 +01003142
3143 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3144 return 1;
3145
3146 px = cli_find_frontend(appctx, args[2]);
3147 if (!px)
3148 return 1;
3149
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003150 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003151 return cli_msg(appctx, LOG_NOTICE, "Frontend was previously shut down, cannot disable.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003152
Willy Tarreauf18d9682020-09-24 08:04:27 +02003153 if (!px->li_ready)
3154 return cli_msg(appctx, LOG_NOTICE, "All sockets are already disabled.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003155
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02003156 /* pause_proxy will take PROXY_LOCK */
Willy Tarreaua275a372018-08-21 14:50:44 +02003157 ret = pause_proxy(px);
Willy Tarreaua275a372018-08-21 14:50:44 +02003158
Willy Tarreau9d008692019-08-09 11:21:01 +02003159 if (!ret)
3160 return cli_err(appctx, "Failed to pause frontend, check logs for precise cause.\n");
3161
Willy Tarreau15b9e682016-11-24 11:55:28 +01003162 return 1;
3163}
3164
Willy Tarreaua275a372018-08-21 14:50:44 +02003165/* Parses the "enable frontend" directive, it always returns 1.
3166 *
3167 * Grabs the proxy lock.
3168 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02003169static int cli_parse_enable_frontend(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau15b9e682016-11-24 11:55:28 +01003170{
3171 struct proxy *px;
Willy Tarreaua275a372018-08-21 14:50:44 +02003172 int ret;
Willy Tarreau15b9e682016-11-24 11:55:28 +01003173
3174 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
3175 return 1;
3176
3177 px = cli_find_frontend(appctx, args[2]);
3178 if (!px)
3179 return 1;
3180
Christopher Fauletdfd10ab2021-10-06 14:24:19 +02003181 if (px->flags & (PR_FL_DISABLED|PR_FL_STOPPED))
Willy Tarreau9d008692019-08-09 11:21:01 +02003182 return cli_err(appctx, "Frontend was previously shut down, cannot enable.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003183
Willy Tarreauf18d9682020-09-24 08:04:27 +02003184 if (px->li_ready == px->li_all)
3185 return cli_msg(appctx, LOG_NOTICE, "All sockets are already enabled.\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003186
Aurelien DARRAGON7d000772022-09-08 14:35:35 +02003187 /* resume_proxy will take PROXY_LOCK */
Willy Tarreaua275a372018-08-21 14:50:44 +02003188 ret = resume_proxy(px);
Willy Tarreaua275a372018-08-21 14:50:44 +02003189
Willy Tarreau9d008692019-08-09 11:21:01 +02003190 if (!ret)
3191 return cli_err(appctx, "Failed to resume frontend, check logs for precise cause (port conflict?).\n");
Willy Tarreau15b9e682016-11-24 11:55:28 +01003192 return 1;
3193}
3194
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003195/* appctx context used during "show errors" */
3196struct show_errors_ctx {
3197 struct proxy *px; /* current proxy being dumped, NULL = not started yet. */
3198 unsigned int flag; /* bit0: buffer being dumped, 0 = req, 1 = resp ; bit1=skip req ; bit2=skip resp. */
3199 unsigned int ev_id; /* event ID of error being dumped */
3200 int iid; /* if >= 0, ID of the proxy to filter on */
3201 int ptr; /* <0: headers, >=0 : text pointer to restart from */
3202 int bol; /* pointer to beginning of current line */
3203};
3204
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003205/* "show errors" handler for the CLI. Returns 0 if wants to continue, 1 to stop
3206 * now.
3207 */
3208static int cli_parse_show_errors(char **args, char *payload, struct appctx *appctx, void *private)
3209{
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003210 struct show_errors_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
3211
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003212 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
3213 return 1;
3214
3215 if (*args[2]) {
3216 struct proxy *px;
3217
3218 px = proxy_find_by_name(args[2], 0, 0);
3219 if (px)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003220 ctx->iid = px->uuid;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003221 else
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003222 ctx->iid = atoi(args[2]);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003223
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003224 if (!ctx->iid)
Willy Tarreau9d008692019-08-09 11:21:01 +02003225 return cli_err(appctx, "No such proxy.\n");
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003226 }
3227 else
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003228 ctx->iid = -1; // dump all proxies
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003229
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003230 ctx->flag = 0;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003231 if (strcmp(args[3], "request") == 0)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003232 ctx->flag |= 4; // ignore response
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003233 else if (strcmp(args[3], "response") == 0)
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003234 ctx->flag |= 2; // ignore request
3235 ctx->px = NULL;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003236 return 0;
3237}
3238
Willy Tarreau4596fe22022-05-17 19:07:51 +02003239/* This function dumps all captured errors onto the stream connector's
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003240 * read buffer. It returns 0 if the output buffer is full and it needs
3241 * to be called again, otherwise non-zero.
3242 */
3243static int cli_io_handler_show_errors(struct appctx *appctx)
3244{
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003245 struct show_errors_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02003246 struct stconn *sc = appctx_sc(appctx);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003247 extern const char *monthname[12];
3248
Christopher Faulet87633c32023-04-03 18:32:50 +02003249 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02003250 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003251 return 1;
3252
3253 chunk_reset(&trash);
3254
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003255 if (!ctx->px) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003256 /* the function had not been called yet, let's prepare the
3257 * buffer for a response.
3258 */
3259 struct tm tm;
3260
3261 get_localtime(date.tv_sec, &tm);
3262 chunk_appendf(&trash, "Total events captured on [%02d/%s/%04d:%02d:%02d:%02d.%03d] : %u\n",
3263 tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3264 tm.tm_hour, tm.tm_min, tm.tm_sec, (int)(date.tv_usec/1000),
3265 error_snapshot_id);
3266
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003267 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003268 goto cant_send;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003269
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003270 ctx->px = proxies_list;
3271 ctx->bol = 0;
3272 ctx->ptr = -1;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003273 }
3274
3275 /* we have two inner loops here, one for the proxy, the other one for
3276 * the buffer.
3277 */
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003278 while (ctx->px) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003279 struct error_snapshot *es;
3280
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003281 HA_RWLOCK_RDLOCK(PROXY_LOCK, &ctx->px->lock);
Willy Tarreau36b27362018-09-07 19:55:44 +02003282
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003283 if ((ctx->flag & 1) == 0) {
3284 es = ctx->px->invalid_req;
3285 if (ctx->flag & 2) // skip req
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003286 goto next;
3287 }
3288 else {
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003289 es = ctx->px->invalid_rep;
3290 if (ctx->flag & 4) // skip resp
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003291 goto next;
3292 }
3293
Willy Tarreauc55015e2018-09-07 19:02:32 +02003294 if (!es)
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003295 goto next;
3296
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003297 if (ctx->iid >= 0 &&
3298 ctx->px->uuid != ctx->iid &&
3299 (!es->oe || es->oe->uuid != ctx->iid))
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003300 goto next;
3301
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003302 if (ctx->ptr < 0) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003303 /* just print headers now */
3304
3305 char pn[INET6_ADDRSTRLEN];
3306 struct tm tm;
3307 int port;
3308
3309 get_localtime(es->when.tv_sec, &tm);
3310 chunk_appendf(&trash, " \n[%02d/%s/%04d:%02d:%02d:%02d.%03d]",
3311 tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3312 tm.tm_hour, tm.tm_min, tm.tm_sec, (int)(es->when.tv_usec/1000));
3313
3314 switch (addr_to_str(&es->src, pn, sizeof(pn))) {
3315 case AF_INET:
3316 case AF_INET6:
3317 port = get_host_port(&es->src);
3318 break;
3319 default:
3320 port = 0;
3321 }
3322
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003323 switch (ctx->flag & 1) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003324 case 0:
3325 chunk_appendf(&trash,
3326 " frontend %s (#%d): invalid request\n"
3327 " backend %s (#%d)",
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003328 ctx->px->id, ctx->px->uuid,
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003329 (es->oe && es->oe->cap & PR_CAP_BE) ? es->oe->id : "<NONE>",
3330 (es->oe && es->oe->cap & PR_CAP_BE) ? es->oe->uuid : -1);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003331 break;
3332 case 1:
3333 chunk_appendf(&trash,
3334 " backend %s (#%d): invalid response\n"
3335 " frontend %s (#%d)",
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003336 ctx->px->id, ctx->px->uuid,
Olivier Houchardbdb00c52020-03-12 15:30:17 +01003337 es->oe ? es->oe->id : "<NONE>" , es->oe ? es->oe->uuid : -1);
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003338 break;
3339 }
3340
3341 chunk_appendf(&trash,
3342 ", server %s (#%d), event #%u, src %s:%d\n"
3343 " buffer starts at %llu (including %u out), %u free,\n"
3344 " len %u, wraps at %u, error at position %u\n",
3345 es->srv ? es->srv->id : "<NONE>",
3346 es->srv ? es->srv->puid : -1,
3347 es->ev_id, pn, port,
3348 es->buf_ofs, es->buf_out,
3349 global.tune.bufsize - es->buf_out - es->buf_len,
3350 es->buf_len, es->buf_wrap, es->buf_err);
3351
3352 if (es->show)
3353 es->show(&trash, es);
3354
3355 chunk_appendf(&trash, " \n");
3356
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003357 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003358 goto cant_send_unlock;
3359
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003360 ctx->ptr = 0;
3361 ctx->ev_id = es->ev_id;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003362 }
3363
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003364 if (ctx->ev_id != es->ev_id) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003365 /* the snapshot changed while we were dumping it */
3366 chunk_appendf(&trash,
3367 " WARNING! update detected on this snapshot, dump interrupted. Please re-check!\n");
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003368 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003369 goto cant_send_unlock;
3370
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003371 goto next;
3372 }
3373
3374 /* OK, ptr >= 0, so we have to dump the current line */
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003375 while (ctx->ptr < es->buf_len && ctx->ptr < global.tune.bufsize) {
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003376 int newptr;
3377 int newline;
3378
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003379 newline = ctx->bol;
3380 newptr = dump_text_line(&trash, es->buf, global.tune.bufsize, es->buf_len, &newline, ctx->ptr);
Christopher Faulet7b3d38a2023-05-05 11:28:45 +02003381 if (newptr == ctx->ptr) {
3382 sc_need_room(sc, 0);
Willy Tarreau36b27362018-09-07 19:55:44 +02003383 goto cant_send_unlock;
Christopher Faulet7b3d38a2023-05-05 11:28:45 +02003384 }
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003385
Willy Tarreaud0a06d52022-05-18 15:07:19 +02003386 if (applet_putchk(appctx, &trash) == -1)
Willy Tarreau36b27362018-09-07 19:55:44 +02003387 goto cant_send_unlock;
3388
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003389 ctx->ptr = newptr;
3390 ctx->bol = newline;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003391 };
3392 next:
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003393 HA_RWLOCK_RDUNLOCK(PROXY_LOCK, &ctx->px->lock);
3394 ctx->bol = 0;
3395 ctx->ptr = -1;
3396 ctx->flag ^= 1;
3397 if (!(ctx->flag & 1))
3398 ctx->px = ctx->px->next;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003399 }
3400
3401 /* dump complete */
3402 return 1;
Willy Tarreau36b27362018-09-07 19:55:44 +02003403
3404 cant_send_unlock:
Willy Tarreau0fd8f0e2022-05-03 11:24:24 +02003405 HA_RWLOCK_RDUNLOCK(PROXY_LOCK, &ctx->px->lock);
Willy Tarreau36b27362018-09-07 19:55:44 +02003406 cant_send:
Willy Tarreau36b27362018-09-07 19:55:44 +02003407 return 0;
Willy Tarreauddb68ac2018-09-07 18:34:24 +02003408}
3409
William Lallemanda6c5f332016-11-19 02:25:36 +01003410/* register cli keywords */
3411static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003412 { { "disable", "frontend", NULL }, "disable frontend <frontend> : temporarily disable specific frontend", cli_parse_disable_frontend, NULL, NULL },
3413 { { "enable", "frontend", NULL }, "enable frontend <frontend> : re-enable specific frontend", cli_parse_enable_frontend, NULL, NULL },
3414 { { "set", "maxconn", "frontend", NULL }, "set maxconn frontend <frontend> <value> : change a frontend's maxconn setting", cli_parse_set_maxconn_frontend, NULL },
3415 { { "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 },
3416 { { "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 },
3417 { { "show", "backend", NULL }, "show backend : list backends in the current running config", NULL, cli_io_handler_show_backend },
3418 { { "shutdown", "frontend", NULL }, "shutdown frontend <frontend> : stop a specific frontend", cli_parse_shutdown_frontend, NULL, NULL },
3419 { { "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 },
3420 { { "enable", "dynamic-cookie", "backend", NULL }, "enable dynamic-cookie backend <bk> : enable dynamic cookies on a specific backend", cli_parse_enable_dyncookie_backend, NULL },
3421 { { "disable", "dynamic-cookie", "backend", NULL }, "disable dynamic-cookie backend <bk> : disable dynamic cookies on a specific backend", cli_parse_disable_dyncookie_backend, NULL },
3422 { { "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 +01003423 {{},}
3424}};
3425
Willy Tarreau0108d902018-11-25 19:14:37 +01003426INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
Willy Tarreaubaaee002006-06-26 02:48:02 +02003427
3428/*
3429 * Local variables:
3430 * c-indent-level: 8
3431 * c-basic-offset: 8
3432 * End:
3433 */