blob: 42e1dd4073dce2437bf7ef75f40baa601cdb1364 [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
William Lallemand74c24fb2016-11-21 17:18:36 +010029#include <common/cfgparse.h>
30#include <common/compat.h>
31#include <common/config.h>
32#include <common/debug.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010033#include <common/initcall.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010034#include <common/memory.h>
35#include <common/mini-clist.h>
36#include <common/standard.h>
37#include <common/ticks.h>
38#include <common/time.h>
39#include <common/uri_auth.h>
40#include <common/version.h>
41#include <common/base64.h>
42
43#include <types/applet.h>
William Lallemand9ed62032016-11-21 17:49:11 +010044#include <types/cli.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010045#include <types/global.h>
46#include <types/dns.h>
William Lallemand9ed62032016-11-21 17:49:11 +010047#include <types/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010048
Willy Tarreau609aad92018-11-22 08:31:09 +010049#include <proto/activity.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010050#include <proto/backend.h>
51#include <proto/channel.h>
52#include <proto/checks.h>
53#include <proto/compression.h>
William Lallemand9ed62032016-11-21 17:49:11 +010054#include <proto/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010055#include <proto/fd.h>
56#include <proto/freq_ctr.h>
57#include <proto/frontend.h>
58#include <proto/log.h>
59#include <proto/pattern.h>
60#include <proto/pipe.h>
William Lallemandce83b4a2018-10-26 14:47:30 +020061#include <proto/protocol.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010062#include <proto/listener.h>
63#include <proto/map.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010064#include <proto/proxy.h>
65#include <proto/sample.h>
66#include <proto/session.h>
67#include <proto/stream.h>
68#include <proto/server.h>
Willy Tarreauc125cef2019-05-10 09:58:43 +020069#include <proto/ssl_sock.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010070#include <proto/stream_interface.h>
71#include <proto/task.h>
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +020072#include <proto/proto_udp.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010073
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020074#define PAYLOAD_PATTERN "<<"
75
William Lallemand74c24fb2016-11-21 17:18:36 +010076static struct applet cli_applet;
77
78static const char stats_sock_usage_msg[] =
79 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010080 " help : this message\n"
81 " prompt : toggle interactive mode with prompt\n"
82 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010083 "";
84
85static const char stats_permission_denied_msg[] =
86 "Permission denied\n"
87 "";
88
89
Christopher Faulet1bc04c72017-10-29 20:14:08 +010090static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010091
92/* List head of cli keywords */
93static struct cli_kw_list cli_keywords = {
94 .list = LIST_HEAD_INIT(cli_keywords.list)
95};
96
97extern const char *stat_status_codes[];
98
Eric Salamae5d22322021-03-16 15:12:17 +010099struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +0200100
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200101static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100102{
103 struct cli_kw_list *kw_list;
104 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200105 struct buffer *tmp = get_trash_chunk();
106 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100107
108 free(dynamic_usage_msg);
109 dynamic_usage_msg = NULL;
110
111 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200112 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100113
114 chunk_reset(tmp);
115 chunk_strcat(tmp, stats_sock_usage_msg);
116 list_for_each_entry(kw_list, &cli_keywords.list, list) {
117 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200118 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200119
120 /* in a worker or normal process, don't display master only commands */
121 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
122 goto next_kw;
123
124 /* in master don't displays if we don't have the master bits */
125 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
126 goto next_kw;
127
William Lallemand0154edc2018-05-15 11:50:04 +0200128 if (kw->usage)
129 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200130
131next_kw:
132
William Lallemand74c24fb2016-11-21 17:18:36 +0100133 kw++;
134 }
135 }
136 chunk_init(&out, NULL, 0);
137 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200138 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200139
140end:
141 if (dynamic_usage_msg) {
142 appctx->ctx.cli.severity = LOG_INFO;
143 appctx->ctx.cli.msg = dynamic_usage_msg;
144 }
145 else {
146 appctx->ctx.cli.severity = LOG_INFO;
147 appctx->ctx.cli.msg = stats_sock_usage_msg;
148 }
149 appctx->st0 = CLI_ST_PRINT;
150
William Lallemand74c24fb2016-11-21 17:18:36 +0100151 return dynamic_usage_msg;
152}
153
154struct cli_kw* cli_find_kw(char **args)
155{
156 struct cli_kw_list *kw_list;
157 struct cli_kw *kw;/* current cli_kw */
158 char **tmp_args;
159 const char **tmp_str_kw;
160 int found = 0;
161
162 if (LIST_ISEMPTY(&cli_keywords.list))
163 return NULL;
164
165 list_for_each_entry(kw_list, &cli_keywords.list, list) {
166 kw = &kw_list->kw[0];
167 while (*kw->str_kw) {
168 tmp_args = args;
169 tmp_str_kw = kw->str_kw;
170 while (*tmp_str_kw) {
171 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
172 found = 1;
173 } else {
174 found = 0;
175 break;
176 }
177 tmp_args++;
178 tmp_str_kw++;
179 }
180 if (found)
181 return (kw);
182 kw++;
183 }
184 }
185 return NULL;
186}
187
Thierry Fournier5622e162020-11-28 20:10:08 +0100188struct cli_kw* cli_find_kw_exact(char **args)
189{
190 struct cli_kw_list *kw_list;
191 int found = 0;
192 int i;
193 int j;
194
195 if (LIST_ISEMPTY(&cli_keywords.list))
196 return NULL;
197
198 list_for_each_entry(kw_list, &cli_keywords.list, list) {
199 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
200 found = 1;
201 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
202 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
203 break;
204 }
205 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
206 found = 0;
207 break;
208 }
209 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
210 found = 0;
211 break;
212 }
213 }
214 if (found)
215 return &kw_list->kw[i];
216 }
217 }
218 return NULL;
219}
220
William Lallemand74c24fb2016-11-21 17:18:36 +0100221void cli_register_kw(struct cli_kw_list *kw_list)
222{
223 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
224}
225
226
227/* allocate a new stats frontend named <name>, and return it
228 * (or NULL in case of lack of memory).
229 */
230static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
231{
232 struct proxy *fe;
233
234 fe = calloc(1, sizeof(*fe));
235 if (!fe)
236 return NULL;
237
238 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100239 fe->next = proxies_list;
240 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100241 fe->last_change = now.tv_sec;
242 fe->id = strdup("GLOBAL");
243 fe->cap = PR_CAP_FE;
244 fe->maxconn = 10; /* default to 10 concurrent connections */
245 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
246 fe->conf.file = strdup(file);
247 fe->conf.line = line;
248 fe->accept = frontend_accept;
249 fe->default_target = &cli_applet.obj_type;
250
251 /* the stats frontend is the only one able to assign ID #0 */
252 fe->conf.id.key = fe->uuid = 0;
253 eb32_insert(&used_proxy_id, &fe->conf.id);
254 return fe;
255}
256
257/* This function parses a "stats" statement in the "global" section. It returns
258 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
259 * error message into the <err> buffer which will be preallocated. The trailing
260 * '\n' must not be written. The function must be called with <args> pointing to
261 * the first word after "stats".
262 */
263static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
264 struct proxy *defpx, const char *file, int line,
265 char **err)
266{
267 struct bind_conf *bind_conf;
268 struct listener *l;
269
270 if (!strcmp(args[1], "socket")) {
271 int cur_arg;
272
273 if (*args[2] == 0) {
274 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
275 return -1;
276 }
277
278 if (!global.stats_fe) {
279 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
280 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
281 return -1;
282 }
283 }
284
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100285 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200286 bind_conf->level &= ~ACCESS_LVL_MASK;
287 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100288
289 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
290 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
291 file, line, args[0], args[1], err && *err ? *err : "error");
292 return -1;
293 }
294
295 cur_arg = 3;
296 while (*args[cur_arg]) {
297 static int bind_dumped;
298 struct bind_kw *kw;
299
300 kw = bind_find_kw(args[cur_arg]);
301 if (kw) {
302 if (!kw->parse) {
303 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
304 args[0], args[1], args[cur_arg]);
305 return -1;
306 }
307
308 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
309 if (err && *err)
310 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
311 else
312 memprintf(err, "'%s %s' : error encountered while processing '%s'",
313 args[0], args[1], args[cur_arg]);
314 return -1;
315 }
316
317 cur_arg += 1 + kw->skip;
318 continue;
319 }
320
321 if (!bind_dumped) {
322 bind_dump_kws(err);
323 indent_msg(err, 4);
324 bind_dumped = 1;
325 }
326
327 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
328 args[0], args[1], args[cur_arg],
329 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
330 return -1;
331 }
332
333 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100334 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100335 l->default_target = global.stats_fe->default_target;
336 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
337 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100338 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100339 }
340 }
341 else if (!strcmp(args[1], "timeout")) {
342 unsigned timeout;
343 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
344
Willy Tarreau9faebe32019-06-07 19:00:37 +0200345 if (res == PARSE_TIME_OVER) {
346 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
347 args[2], args[0], args[1]);
348 return -1;
349 }
350 else if (res == PARSE_TIME_UNDER) {
351 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
352 args[2], args[0], args[1]);
353 return -1;
354 }
355 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100356 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
357 return -1;
358 }
359
360 if (!timeout) {
361 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
362 return -1;
363 }
364 if (!global.stats_fe) {
365 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
366 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
367 return -1;
368 }
369 }
370 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
371 }
372 else if (!strcmp(args[1], "maxconn")) {
373 int maxconn = atol(args[2]);
374
375 if (maxconn <= 0) {
376 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
377 return -1;
378 }
379
380 if (!global.stats_fe) {
381 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
382 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
383 return -1;
384 }
385 }
386 global.stats_fe->maxconn = maxconn;
387 }
388 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
389 int cur_arg = 2;
390 unsigned long set = 0;
391
392 if (!global.stats_fe) {
393 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
394 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
395 return -1;
396 }
397 }
398
399 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100400 if (strcmp(args[cur_arg], "all") == 0) {
401 set = 0;
402 break;
403 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100404 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100405 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100406 return -1;
407 }
408 cur_arg++;
409 }
410 global.stats_fe->bind_proc = set;
411 }
412 else {
413 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
414 return -1;
415 }
416 return 0;
417}
418
William Lallemand33d29e22019-04-01 11:30:06 +0200419/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200420 * This function exports the bound addresses of a <frontend> in the environment
421 * variable <varname>. Those addresses are separated by semicolons and prefixed
422 * with their type (abns@, unix@, sockpair@ etc)
423 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200424 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200425int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200426{
427 struct buffer *trash = get_trash_chunk();
428 struct bind_conf *bind_conf;
429
William Lallemand9a37fd02019-04-12 16:09:24 +0200430 if (frontend) {
431 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200432 struct listener *l;
433
434 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
435 char addr[46];
436 char port[6];
437
William Lallemand620072b2019-04-12 16:09:25 +0200438 /* separate listener by semicolons */
439 if (trash->data)
440 chunk_appendf(trash, ";");
441
William Lallemand33d29e22019-04-01 11:30:06 +0200442 if (l->addr.ss_family == AF_UNIX) {
443 const struct sockaddr_un *un;
444
445 un = (struct sockaddr_un *)&l->addr;
446 if (un->sun_path[0] == '\0') {
447 chunk_appendf(trash, "abns@%s", un->sun_path+1);
448 } else {
449 chunk_appendf(trash, "unix@%s", un->sun_path);
450 }
451 } else if (l->addr.ss_family == AF_INET) {
452 addr_to_str(&l->addr, addr, sizeof(addr));
453 port_to_str(&l->addr, port, sizeof(port));
454 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
455 } else if (l->addr.ss_family == AF_INET6) {
456 addr_to_str(&l->addr, addr, sizeof(addr));
457 port_to_str(&l->addr, port, sizeof(port));
458 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
459 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
460 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
461 }
William Lallemand33d29e22019-04-01 11:30:06 +0200462 }
463 }
464 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200465 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200466 return -1;
467 }
468
469 return 0;
470}
471
William Lallemand9a37fd02019-04-12 16:09:24 +0200472int cli_socket_setenv()
473{
474 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
475 return -1;
476 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
477 return -1;
478
479 return 0;
480}
481
William Lallemand33d29e22019-04-01 11:30:06 +0200482REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
483
Willy Tarreaude57a572016-11-23 17:01:39 +0100484/* Verifies that the CLI at least has a level at least as high as <level>
485 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
486 * failure, an error message is prepared and the appctx's state is adjusted
487 * to print it so that a return 1 is enough to abort any processing.
488 */
489int cli_has_level(struct appctx *appctx, int level)
490{
Willy Tarreaude57a572016-11-23 17:01:39 +0100491
William Lallemandf630d012018-12-13 09:05:44 +0100492 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200493 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100494 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100495 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100496 return 0;
497 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100498 return 1;
499}
500
William Lallemandb7ea1412018-12-13 09:05:47 +0100501/* same as cli_has_level but for the CLI proxy and without error message */
502int pcli_has_level(struct stream *s, int level)
503{
504 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
505 return 0;
506 }
507 return 1;
508}
509
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200510/* Returns severity_output for the current session if set, or default for the socket */
511static int cli_get_severity_output(struct appctx *appctx)
512{
513 if (appctx->cli_severity_output)
514 return appctx->cli_severity_output;
515 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
516}
William Lallemand74c24fb2016-11-21 17:18:36 +0100517
Willy Tarreau41908562016-11-24 16:23:38 +0100518/* Processes the CLI interpreter on the stats socket. This function is called
519 * from the CLI's IO handler running in an appctx context. The function returns 1
520 * if the request was understood, otherwise zero. It is called with appctx->st0
521 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
522 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
523 * have its own I/O handler called again. Most of the time, parsers will only
524 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100525 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
526 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100527 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200528static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100529{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200530 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
531 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100532 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100533
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200534 appctx->st2 = 0;
535 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100536
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200537 p = appctx->chunk->area;
538 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100539
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200540 /*
541 * Get the payload start if there is one.
542 * For the sake of simplicity, the payload pattern is looked up
543 * everywhere from the start of the input but it can only be found
544 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
545 *
546 * The input string was zero terminated so it is safe to use
547 * the str*() functions throughout the parsing
548 */
549 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
550 payload = strstr(p, PAYLOAD_PATTERN);
551 end = payload;
552 /* skip the pattern */
553 payload += strlen(PAYLOAD_PATTERN);
554 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100555
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200556 /*
557 * Get pointers on words.
558 * One extra slot is reserved to store a pointer on a null byte.
559 */
560 while (i < MAX_STATS_ARGS && p < end) {
561 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100562
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200563 /* skip leading spaces/tabs */
564 p += strspn(p, " \t");
565 if (!*p)
566 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100567
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200568 args[i] = p;
Yves Lafon7ed43aa2020-06-08 16:08:06 +0200569 while (1) {
570 p += strcspn(p, " \t\\");
571 /* escaped chars using backlashes (\) */
572 if (*p == '\\') {
573 if (!*++p)
574 break;
575 if (!*++p)
576 break;
577 } else {
578 break;
579 }
580 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200581 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100582
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200583 /* unescape backslashes (\) */
584 for (j = 0, k = 0; args[i][k]; k++) {
585 if (args[i][k] == '\\') {
586 if (args[i][k + 1] == '\\')
587 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100588 else
589 continue;
590 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200591 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100592 j++;
593 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200594 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100595
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200596 i++;
597 }
598 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200599 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200600 for (; i < MAX_STATS_ARGS + 1; i++)
601 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100602
603 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100604 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100605 return 0;
606
William Lallemand14721be2018-10-26 14:47:37 +0200607 /* in a worker or normal process, don't display master only commands */
608 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
609 return 0;
610
611 /* in master don't displays if we don't have the master bits */
612 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
613 return 0;
614
Willy Tarreau41908562016-11-24 16:23:38 +0100615 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200616 appctx->io_release = kw->io_release;
William Lallemandd4f20fa2019-10-25 21:10:14 +0200617
618 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
619 goto fail;
620
621 /* kw->parse could set its own io_handler or io_release handler */
622 if (!appctx->io_handler)
623 goto fail;
624
625 appctx->st0 = CLI_ST_CALLBACK;
626 return 1;
627fail:
628 appctx->io_handler = NULL;
629 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100630 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100631}
632
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200633/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
634static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
635{
Willy Tarreau83061a82018-07-13 11:56:34 +0200636 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200637
638 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200639 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200640
641 tmp = get_trash_chunk();
642 chunk_reset(tmp);
643
644 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100645 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200646 chunk_printf(tmp, "[%d]: ", severity);
647 }
648 else {
649 switch (severity_output) {
650 case CLI_SEVERITY_NUMBER:
651 chunk_printf(tmp, "[%d]: ", severity);
652 break;
653 case CLI_SEVERITY_STRING:
654 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
655 break;
656 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100657 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200658 }
659 }
660 chunk_appendf(tmp, "%s", msg);
661
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200662 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200663}
664
William Lallemand74c24fb2016-11-21 17:18:36 +0100665/* This I/O handler runs as an applet embedded in a stream interface. It is
666 * used to processes I/O from/to the stats unix socket. The system relies on a
667 * state machine handling requests and various responses. We read a request,
668 * then we process it and send the response, and we possibly display a prompt.
669 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100670 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100671 * or not.
672 */
673static void cli_io_handler(struct appctx *appctx)
674{
675 struct stream_interface *si = appctx->owner;
676 struct channel *req = si_oc(si);
677 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200678 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100679 int reql;
680 int len;
681
682 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
683 goto out;
684
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800685 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200686 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100687 /* buf.size==0 means we failed to get a buffer and were
688 * already subscribed to a wait list to get a buffer.
689 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100690 goto out;
691 }
692
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100694 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100695 /* Stats output not initialized yet */
696 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200697 /* reset severity to default at init */
698 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100699 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100700 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100701 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100702 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100703 /* Let's close for real now. We just close the request
704 * side, the conditions below will complete if needed.
705 */
706 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200707 free_trash_chunk(appctx->chunk);
Willy Tarreau6319cbf2021-05-04 16:27:45 +0200708 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100709 break;
710 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100711 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200712 char *str;
713
714 /* use a trash chunk to store received data */
715 if (!appctx->chunk) {
716 appctx->chunk = alloc_trash_chunk();
717 if (!appctx->chunk) {
718 appctx->st0 = CLI_ST_END;
719 continue;
720 }
721 }
722
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200723 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200724
William Lallemand74c24fb2016-11-21 17:18:36 +0100725 /* ensure we have some output room left in the event we
726 * would want to return some info right after parsing.
727 */
728 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100729 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100730 break;
731 }
732
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200733 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200734 reql = co_getline(si_oc(si), str,
735 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100736 if (reql <= 0) { /* closed or EOL not found */
737 if (reql == 0)
738 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100739 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100740 continue;
741 }
742
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
744 /* seek for a possible unescaped semi-colon. If we find
745 * one, we replace it with an LF and skip only this part.
746 */
747 for (len = 0; len < reql; len++) {
748 if (str[len] == '\\') {
749 len++;
750 continue;
751 }
752 if (str[len] == ';') {
753 str[len] = '\n';
754 reql = len + 1;
755 break;
756 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100757 }
758 }
759
760 /* now it is time to check that we have a full line,
761 * remove the trailing \n and possibly \r, then cut the
762 * line.
763 */
764 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200765 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100766 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100767 continue;
768 }
769
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200770 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100771 len--;
772
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200773 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200774 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200775
776 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200777 appctx->chunk->area[appctx->chunk->data] = '\n';
778 appctx->chunk->area[appctx->chunk->data + 1] = 0;
779 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200780 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100781
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100782 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200783
784 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
785 /* empty line */
786 if (!len) {
787 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200788 appctx->chunk->data -= 2;
789 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200790
791 if (!cli_parse_request(appctx))
792 cli_gen_usage_msg(appctx);
793
794 chunk_reset(appctx->chunk);
795 /* NB: cli_sock_parse_request() may have put
796 * another CLI_ST_O_* into appctx->st0.
797 */
798
799 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100800 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100801 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200802 else {
803 /*
804 * Look for the "payload start" pattern at the end of a line
805 * Its location is not remembered here, this is just to switch
806 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100807 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200808 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200809 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200810 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200811 /* no payload, the command is complete: parse the request */
812 if (!cli_parse_request(appctx))
813 cli_gen_usage_msg(appctx);
814
815 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200816 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100817 }
818
819 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200820 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100821 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
822 }
823 else { /* output functions */
824 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100825 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100827 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200828 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
829 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100830 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100831 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100832 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100833 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200834 case CLI_ST_PRINT_FREE: {
835 const char *msg = appctx->ctx.cli.err;
836
837 if (!msg)
838 msg = "Out of memory.\n";
839
840 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100841 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100842 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100843 }
844 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100845 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100846 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200847 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100848 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100849 if (appctx->io_handler)
850 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100851 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100852 if (appctx->io_release) {
853 appctx->io_release(appctx);
854 appctx->io_release = NULL;
855 }
856 }
857 break;
858 default: /* abnormal state */
859 si->flags |= SI_FL_ERR;
860 break;
861 }
862
863 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100864 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200865 const char *prompt = "";
866
867 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
868 /*
869 * when entering a payload with interactive mode, change the prompt
870 * to emphasize that more data can still be sent
871 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200872 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200873 prompt = "+ ";
874 else
875 prompt = "\n> ";
876 }
877 else {
William Lallemand1bd140e2019-07-01 10:56:15 +0200878 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200879 prompt = "\n";
880 }
881
882 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100883 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100884 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100885 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100886 }
887
888 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100889 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100890 break;
891
892 /* Now we close the output if one of the writers did so,
893 * or if we're not in interactive mode and the request
894 * buffer is empty. This still allows pipelined requests
895 * to be sent in non-interactive mode.
896 */
William Lallemand3de09d52018-12-11 16:10:56 +0100897 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
898 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100899 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100900 continue;
901 }
902
903 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100904 appctx->st0 = CLI_ST_GETREQ;
William Lallemand1bd140e2019-07-01 10:56:15 +0200905 /* reactivate the \n at the end of the response for the next command */
906 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100907 }
908 }
909
910 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
911 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
912 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
913 /* Other side has closed, let's abort if we have no more processing to do
914 * and nothing more to consume. This is comparable to a broken pipe, so
915 * we forward the close to the request side so that it flows upstream to
916 * the client.
917 */
918 si_shutw(si);
919 }
920
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100921 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100922 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
923 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
924 /* We have no more processing to do, and nothing more to send, and
925 * the client side has closed. So we'll forward this state downstream
926 * on the response buffer.
927 */
928 si_shutr(si);
929 res->flags |= CF_READ_NULL;
930 }
931
932 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200933 DPRINTF(stderr, "%s@%d: st=%d, rqf=%x, rpf=%x, rqh=%lu, rqs=%lu, rh=%lu, rs=%lu\n",
William Lallemand74c24fb2016-11-21 17:18:36 +0100934 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200935 si->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +0100936}
937
William Lallemand74c24fb2016-11-21 17:18:36 +0100938/* This is called when the stream interface is closed. For instance, upon an
939 * external abort, we won't call the i/o handler anymore so we may need to
940 * remove back references to the stream currently being dumped.
941 */
942static void cli_release_handler(struct appctx *appctx)
943{
Willy Tarreau6319cbf2021-05-04 16:27:45 +0200944 free_trash_chunk(appctx->chunk);
945 appctx->chunk = NULL;
946
William Lallemand74c24fb2016-11-21 17:18:36 +0100947 if (appctx->io_release) {
948 appctx->io_release(appctx);
949 appctx->io_release = NULL;
950 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100951 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100952 free(appctx->ctx.cli.err);
953 appctx->ctx.cli.err = NULL;
954 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100955}
956
957/* This function dumps all environmnent variables to the buffer. It returns 0
958 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100959 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
960 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100961 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100962static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100963{
Willy Tarreau0a739292016-11-22 20:21:23 +0100964 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100965 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100966
967 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
968 return 1;
969
970 chunk_reset(&trash);
971
972 /* we have two inner loops here, one for the proxy, the other one for
973 * the buffer.
974 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100975 while (*var) {
976 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100977
Willy Tarreau06d80a92017-10-19 14:32:15 +0200978 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100979 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100980 return 0;
981 }
982 if (appctx->st2 == STAT_ST_END)
983 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100984 var++;
985 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100986 }
987
988 /* dump complete */
989 return 1;
990}
991
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200992/* This function dumps all file descriptors states (or the requested one) to
993 * the buffer. It returns 0 if the output buffer is full and it needs to be
994 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
995 * It uses cli.i0 as the fd number to restart from.
996 */
997static int cli_io_handler_show_fd(struct appctx *appctx)
998{
999 struct stream_interface *si = appctx->owner;
1000 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001001 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001002
1003 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001004 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001005
1006 chunk_reset(&trash);
1007
Willy Tarreauca1b1572018-12-18 15:45:11 +01001008 /* isolate the threads once per round. We're limited to a buffer worth
1009 * of output anyway, it cannot last very long.
1010 */
1011 thread_isolate();
1012
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001013 /* we have two inner loops here, one for the proxy, the other one for
1014 * the buffer.
1015 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001016 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001017 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +02001018 struct listener *li = NULL;
1019 struct server *sv = NULL;
1020 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001021 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001022 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001023 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001024 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001025
1026 fdt = fdtab[fd];
1027
Willy Tarreauca1b1572018-12-18 15:45:11 +01001028 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +02001029 goto skip; // closed
1030
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001031 if (fdt.iocb == conn_fd_handler) {
1032 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001033 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001034 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001035 li = objt_listener(((struct connection *)fdt.owner)->target);
1036 sv = objt_server(((struct connection *)fdt.owner)->target);
1037 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001038 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001039 }
1040 else if (fdt.iocb == listener_accept)
1041 li = fdt.owner;
1042
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001043 chunk_printf(&trash,
Willy Tarreauc754b342018-03-30 15:00:15 +02001044 " %5d : st=0x%02x(R:%c%c%c W:%c%c%c) ev=0x%02x(%c%c%c%c%c) [%c%c] cnext=%d cprev=%d tmask=0x%lx umask=0x%lx owner=%p iocb=%p(%s)",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001045 fd,
1046 fdt.state,
1047 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
1048 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1049 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
1050 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
1051 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1052 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1053 fdt.ev,
1054 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1055 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1056 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1057 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1058 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001059 fdt.linger_risk ? 'L' : 'l',
1060 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001061 fdt.cache.next,
1062 fdt.cache.prev,
1063 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001064 fdt.owner,
1065 fdt.iocb,
1066 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
1067 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
1068 (fdt.iocb == listener_accept) ? "listener_accept" :
Olivier Houchard79321b92018-07-26 17:55:11 +02001069 (fdt.iocb == poller_pipe_io_handler) ? "poller_pipe_io_handler" :
William Lallemanddb6bdfb2018-11-20 17:36:51 +01001070 (fdt.iocb == mworker_accept_wrapper) ? "mworker_accept_wrapper" :
Emeric Brund0e095c2019-04-19 17:15:28 +02001071#ifdef USE_OPENSSL
Willy Tarreau5db847a2019-05-09 14:13:35 +02001072#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL) && !defined(OPENSSL_NO_ASYNC)
Emeric Brund0e095c2019-04-19 17:15:28 +02001073 (fdt.iocb == ssl_async_fd_free) ? "ssl_async_fd_free" :
1074 (fdt.iocb == ssl_async_fd_handler) ? "ssl_async_fd_handler" :
1075#endif
1076#endif
Willy Tarreauc754b342018-03-30 15:00:15 +02001077 "unknown");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001078
1079 if (fdt.iocb == conn_fd_handler) {
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001080 chunk_appendf(&trash, " back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001081 if (px)
1082 chunk_appendf(&trash, " px=%s", px->id);
1083 else if (sv)
1084 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1085 else if (li)
1086 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001087
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001088 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001089 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001090 if (mux->show_fd)
1091 mux->show_fd(&trash, fdt.owner);
1092 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001093 else
1094 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001095 }
1096 else if (fdt.iocb == listener_accept) {
1097 chunk_appendf(&trash, " l.st=%s fe=%s",
1098 listener_state_str(li),
1099 li->bind_conf->frontend->id);
1100 }
1101
1102 chunk_appendf(&trash, "\n");
1103
Willy Tarreau06d80a92017-10-19 14:32:15 +02001104 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001105 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001106 appctx->ctx.cli.i0 = fd;
1107 ret = 0;
1108 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001109 }
1110 skip:
1111 if (appctx->st2 == STAT_ST_END)
1112 break;
1113
1114 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001115 }
1116
Willy Tarreauca1b1572018-12-18 15:45:11 +01001117 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001118 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001119
1120 thread_release();
1121 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001122}
1123
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001124/* This function dumps some activity counters used by developers and support to
1125 * rule out some hypothesis during bug reports. It returns 0 if the output
1126 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1127 * everything at once in the buffer and is not designed to do it in multiple
1128 * passes.
1129 */
1130static int cli_io_handler_show_activity(struct appctx *appctx)
1131{
1132 struct stream_interface *si = appctx->owner;
1133 int thr;
1134
1135 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1136 return 1;
1137
1138 chunk_reset(&trash);
1139
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001140#undef SHOW_TOT
1141#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001142 do { \
1143 unsigned int _v[MAX_THREADS]; \
1144 unsigned int _tot; \
1145 const unsigned int _nbt = global.nbthread; \
1146 for (_tot = t = 0; t < _nbt; t++) \
1147 _tot += _v[t] = (x); \
1148 if (_nbt == 1) { \
1149 chunk_appendf(&trash, " %u\n", _tot); \
1150 break; \
1151 } \
1152 chunk_appendf(&trash, " %u [", _tot); \
1153 for (t = 0; t < _nbt; t++) \
1154 chunk_appendf(&trash, " %u", _v[t]); \
1155 chunk_appendf(&trash, " ]\n"); \
1156 } while (0)
1157
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001158#undef SHOW_AVG
1159#define SHOW_AVG(t, x) \
1160 do { \
1161 unsigned int _v[MAX_THREADS]; \
1162 unsigned int _tot; \
1163 const unsigned int _nbt = global.nbthread; \
1164 for (_tot = t = 0; t < _nbt; t++) \
1165 _tot += _v[t] = (x); \
1166 if (_nbt == 1) { \
1167 chunk_appendf(&trash, " %u\n", _tot); \
1168 break; \
1169 } \
1170 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1171 for (t = 0; t < _nbt; t++) \
1172 chunk_appendf(&trash, " %u", _v[t]); \
1173 chunk_appendf(&trash, " ]\n"); \
1174 } while (0)
1175
Willy Tarreaua0211b82019-05-28 15:09:08 +02001176 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1177 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001178 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
1179 chunk_appendf(&trash, "wake_cache:"); SHOW_TOT(thr, activity[thr].wake_cache);
1180 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1181 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
1182 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
1183 chunk_appendf(&trash, "poll_drop:"); SHOW_TOT(thr, activity[thr].poll_drop);
1184 chunk_appendf(&trash, "poll_dead:"); SHOW_TOT(thr, activity[thr].poll_dead);
1185 chunk_appendf(&trash, "poll_skip:"); SHOW_TOT(thr, activity[thr].poll_skip);
1186 chunk_appendf(&trash, "fd_lock:"); SHOW_TOT(thr, activity[thr].fd_lock);
1187 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
1188 chunk_appendf(&trash, "stream:"); SHOW_TOT(thr, activity[thr].stream);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001189 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1190 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001191 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1192 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
1193 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1194 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1195 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1196 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1197 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1198 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1199 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1200 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1201 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001202#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001203 chunk_appendf(&trash, "accq_ring:"); SHOW_TOT(thr, (accept_queue_rings[thr].tail - accept_queue_rings[thr].head + ACCEPT_QUEUE_SIZE) % ACCEPT_QUEUE_SIZE);
Willy Tarreaue6182842019-04-15 18:54:10 +02001204#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001205
Willy Tarreaud6a78502019-05-27 07:03:38 +02001206#if defined(DEBUG_DEV)
1207 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001208 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1209 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1210 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001211#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001212
1213 if (ci_putchk(si_ic(si), &trash) == -1) {
1214 chunk_reset(&trash);
1215 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001216 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001217 }
1218
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001219#undef SHOW_AVG
1220#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001221 /* dump complete */
1222 return 1;
1223}
1224
William Lallemandeceddf72016-12-15 18:06:44 +01001225/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001226 * CLI IO handler for `show cli sockets`.
1227 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001228 */
1229static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1230{
1231 struct bind_conf *bind_conf;
1232 struct stream_interface *si = appctx->owner;
1233
1234 chunk_reset(&trash);
1235
1236 switch (appctx->st2) {
1237 case STAT_ST_INIT:
1238 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001239 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001240 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001241 return 0;
1242 }
William Lallemandeceddf72016-12-15 18:06:44 +01001243 appctx->st2 = STAT_ST_LIST;
1244
1245 case STAT_ST_LIST:
1246 if (global.stats_fe) {
1247 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1248 struct listener *l;
1249
1250 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001251 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001252 * if the current node is the first of the list
1253 */
1254
Willy Tarreau3af9d832016-12-16 12:58:09 +01001255 if (appctx->ctx.cli.p0 &&
1256 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001257 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001258 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001259 continue;
1260 }
1261
1262 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1263
1264 char addr[46];
1265 char port[6];
1266
1267 if (l->addr.ss_family == AF_UNIX) {
1268 const struct sockaddr_un *un;
1269
1270 un = (struct sockaddr_un *)&l->addr;
William Lallemande58915f2019-04-01 11:30:05 +02001271 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001272 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001273 } else {
1274 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1275 }
William Lallemandeceddf72016-12-15 18:06:44 +01001276 } else if (l->addr.ss_family == AF_INET) {
1277 addr_to_str(&l->addr, addr, sizeof(addr));
1278 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001279 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001280 } else if (l->addr.ss_family == AF_INET6) {
1281 addr_to_str(&l->addr, addr, sizeof(addr));
1282 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001283 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001284 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1285 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001286 } else
William Lallemand26314342018-10-26 14:47:41 +02001287 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001288
William Lallemand07a62f72017-05-24 00:57:40 +02001289 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001290 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001291 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1292 chunk_appendf(&trash, "operator ");
1293 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1294 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001295 else
1296 chunk_appendf(&trash, " ");
1297
1298 if (bind_conf->bind_proc != 0) {
1299 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001300 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001301 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001302 chunk_appendf(&trash, "%d,", pos+1);
1303 }
1304 }
1305 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001306 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001307
1308 } else {
1309 chunk_appendf(&trash, "all\n");
1310 }
1311
Willy Tarreau06d80a92017-10-19 14:32:15 +02001312 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001313 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001314 return 0;
1315 }
1316 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001317 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001318 }
1319 }
1320 default:
1321 appctx->st2 = STAT_ST_FIN;
1322 return 1;
1323 }
1324}
1325
1326
Willy Tarreau0a739292016-11-22 20:21:23 +01001327/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001328 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1329 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001330 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001331static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001332{
1333 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001334 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001335
1336 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1337 return 1;
1338
Willy Tarreauf6710f82016-12-16 17:45:44 +01001339 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001340
1341 if (*args[2]) {
1342 int len = strlen(args[2]);
1343
Willy Tarreauf6710f82016-12-16 17:45:44 +01001344 for (; *var; var++) {
1345 if (strncmp(*var, args[2], len) == 0 &&
1346 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001347 break;
1348 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001349 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001350 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001351 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001352 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001353 return 1;
1354 }
1355 appctx->st2 = STAT_ST_END;
1356 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001357 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001358 return 0;
1359}
1360
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001361/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1362 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1363 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1364 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001365static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001366{
1367 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1368 return 1;
1369
1370 appctx->ctx.cli.i0 = 0;
1371
1372 if (*args[2]) {
1373 appctx->ctx.cli.i0 = atoi(args[2]);
1374 appctx->st2 = STAT_ST_END;
1375 }
1376 return 0;
1377}
1378
Willy Tarreau599852e2016-11-22 20:33:32 +01001379/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001380static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001381{
1382 struct stream_interface *si = appctx->owner;
1383 struct stream *s = si_strm(si);
1384
1385 if (strcmp(args[2], "cli") == 0) {
1386 unsigned timeout;
1387 const char *res;
1388
1389 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001390 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001391 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001392 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001393 return 1;
1394 }
1395
1396 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1397 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001398 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001399 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001400 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001401 return 1;
1402 }
1403
1404 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1405 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1406 return 1;
1407 }
1408 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001409 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001410 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001411 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001412 return 1;
1413 }
1414}
1415
Willy Tarreau2af99412016-11-23 11:10:59 +01001416/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001417static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001418{
1419 int v;
1420
1421 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1422 return 1;
1423
1424 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001425 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001426 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001427 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001428 return 1;
1429 }
1430
1431 v = atoi(args[3]);
1432 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001433 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001434 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001435 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001436 return 1;
1437 }
1438
1439 /* check for unlimited values */
1440 if (v <= 0)
1441 v = global.hardmaxconn;
1442
1443 global.maxconn = v;
1444
1445 /* Dequeues all of the listeners waiting for a resource */
1446 if (!LIST_ISEMPTY(&global_listener_queue))
1447 dequeue_all_listeners(&global_listener_queue);
1448
1449 return 1;
1450}
1451
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001452static int set_severity_output(int *target, char *argument)
1453{
1454 if (!strcmp(argument, "none")) {
1455 *target = CLI_SEVERITY_NONE;
1456 return 1;
1457 }
1458 else if (!strcmp(argument, "number")) {
1459 *target = CLI_SEVERITY_NUMBER;
1460 return 1;
1461 }
1462 else if (!strcmp(argument, "string")) {
1463 *target = CLI_SEVERITY_STRING;
1464 return 1;
1465 }
1466 return 0;
1467}
1468
1469/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001470static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001471{
1472 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1473 return 0;
1474
1475 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001476 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001477 appctx->st0 = CLI_ST_PRINT;
1478 return 1;
1479}
William Lallemandeceddf72016-12-15 18:06:44 +01001480
William Lallemand67a234f2018-12-13 09:05:45 +01001481
1482/* show the level of the current CLI session */
1483static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1484{
1485
1486 appctx->ctx.cli.severity = LOG_INFO;
1487 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1488 appctx->ctx.cli.msg = "admin\n";
1489 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1490 appctx->ctx.cli.msg = "operator\n";
1491 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1492 appctx->ctx.cli.msg = "user\n";
1493 else
1494 appctx->ctx.cli.msg = "unknown\n";
1495
1496 appctx->st0 = CLI_ST_PRINT;
1497 return 1;
1498
1499}
1500
1501/* parse and set the CLI level dynamically */
1502static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1503{
William Lallemand1bd140e2019-07-01 10:56:15 +02001504 /* this will ask the applet to not output a \n after the command */
1505 if (!strcmp(args[1], "-"))
1506 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1507
William Lallemand67a234f2018-12-13 09:05:45 +01001508 if (!strcmp(args[0], "operator")) {
1509 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1510 return 1;
1511 }
1512 appctx->cli_level &= ~ACCESS_LVL_MASK;
1513 appctx->cli_level |= ACCESS_LVL_OPER;
1514
1515 } else if (!strcmp(args[0], "user")) {
1516 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1517 return 1;
1518 }
1519 appctx->cli_level &= ~ACCESS_LVL_MASK;
1520 appctx->cli_level |= ACCESS_LVL_USER;
1521 }
1522 return 1;
1523}
1524
William Lallemanda57b7e32018-12-14 21:11:31 +01001525
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001526int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001527{
1528 return 0;
1529}
1530
Willy Tarreau45c742b2016-11-24 14:51:17 +01001531/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001532static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001533{
1534 int v;
1535 int *res;
1536 int mul = 1;
1537
1538 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1539 return 1;
1540
1541 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1542 res = &global.cps_lim;
1543 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1544 res = &global.sps_lim;
1545#ifdef USE_OPENSSL
1546 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1547 res = &global.ssl_lim;
1548#endif
1549 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1550 res = &global.comp_rate_lim;
1551 mul = 1024;
1552 }
1553 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001554 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001555 appctx->ctx.cli.msg =
1556 "'set rate-limit' only supports :\n"
1557 " - 'connections global' to set the per-process maximum connection rate\n"
1558 " - 'sessions global' to set the per-process maximum session rate\n"
1559#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001560 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001561#endif
1562 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001563 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001564 return 1;
1565 }
1566
1567 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001568 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001569 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001570 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001571 return 1;
1572 }
1573
1574 v = atoi(args[4]);
1575 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001576 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001577 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001578 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001579 return 1;
1580 }
1581
1582 *res = v * mul;
1583
1584 /* Dequeues all of the listeners waiting for a resource */
1585 if (!LIST_ISEMPTY(&global_listener_queue))
1586 dequeue_all_listeners(&global_listener_queue);
1587
1588 return 1;
1589}
1590
William Lallemandf6975e92017-05-26 17:42:10 +02001591/* parse the "expose-fd" argument on the bind lines */
1592static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1593{
1594 if (!*args[cur_arg + 1]) {
1595 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1596 return ERR_ALERT | ERR_FATAL;
1597 }
1598 if (!strcmp(args[cur_arg+1], "listeners")) {
1599 conf->level |= ACCESS_FD_LISTENERS;
1600 } else {
1601 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1602 args[cur_arg], args[cur_arg+1]);
1603 return ERR_ALERT | ERR_FATAL;
1604 }
1605
1606 return 0;
1607}
1608
William Lallemand74c24fb2016-11-21 17:18:36 +01001609/* parse the "level" argument on the bind lines */
1610static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1611{
1612 if (!*args[cur_arg + 1]) {
1613 memprintf(err, "'%s' : missing level", args[cur_arg]);
1614 return ERR_ALERT | ERR_FATAL;
1615 }
1616
William Lallemand07a62f72017-05-24 00:57:40 +02001617 if (!strcmp(args[cur_arg+1], "user")) {
1618 conf->level &= ~ACCESS_LVL_MASK;
1619 conf->level |= ACCESS_LVL_USER;
1620 } else if (!strcmp(args[cur_arg+1], "operator")) {
1621 conf->level &= ~ACCESS_LVL_MASK;
1622 conf->level |= ACCESS_LVL_OPER;
1623 } else if (!strcmp(args[cur_arg+1], "admin")) {
1624 conf->level &= ~ACCESS_LVL_MASK;
1625 conf->level |= ACCESS_LVL_ADMIN;
1626 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001627 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1628 args[cur_arg], args[cur_arg+1]);
1629 return ERR_ALERT | ERR_FATAL;
1630 }
1631
1632 return 0;
1633}
1634
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001635static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1636{
1637 if (!*args[cur_arg + 1]) {
1638 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1639 return ERR_ALERT | ERR_FATAL;
1640 }
1641
1642 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1643 return 0;
1644 else {
1645 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1646 args[cur_arg], args[cur_arg+1]);
1647 return ERR_ALERT | ERR_FATAL;
1648 }
1649}
1650
William Lallemand16dd1b32018-11-19 18:46:18 +01001651
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001652
Olivier Houchardf886e342017-04-05 22:24:59 +02001653/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001654static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001655{
1656 char *cmsgbuf = NULL;
1657 unsigned char *tmpbuf = NULL;
1658 struct cmsghdr *cmsg;
1659 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001660 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001661 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001662 struct msghdr msghdr;
1663 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001664 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001665 int *tmpfd;
1666 int tot_fd_nb = 0;
1667 struct proxy *px;
William Lallemand8dc8aec2020-01-16 15:32:08 +01001668 struct peers *prs;
Olivier Houchardf886e342017-04-05 22:24:59 +02001669 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001670 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001671 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001672 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001673 int ret;
1674
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001675 if (!remote) {
1676 ha_warning("Only works on real connections\n");
1677 goto out;
1678 }
1679
1680 fd = remote->handle.fd;
1681
Olivier Houchardf886e342017-04-05 22:24:59 +02001682 /* Temporary set the FD in blocking mode, that will make our life easier */
1683 old_fcntl = fcntl(fd, F_GETFL);
1684 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001685 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001686 goto out;
1687 }
1688 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1689 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001690 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001691 goto out;
1692 }
1693 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001694 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001695 goto out;
1696 }
Olivier Houchard54740872017-04-06 14:45:14 +02001697 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001698 iov.iov_base = &tot_fd_nb;
1699 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001700 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001701 goto out;
1702 memset(&msghdr, 0, sizeof(msghdr));
1703 /*
1704 * First, calculates the total number of FD, so that we can let
1705 * the caller know how much he should expects.
1706 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001707 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001708 while (px) {
1709 struct listener *l;
1710
1711 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001712 /* Only transfer IPv4/IPv6/UNIX sockets */
1713 if (l->state >= LI_ZOMBIE &&
1714 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001715 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001716 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001717 tot_fd_nb++;
1718 }
1719 px = px->next;
1720 }
William Lallemand8dc8aec2020-01-16 15:32:08 +01001721 prs = cfg_peers;
1722 while (prs) {
1723 if (prs->peers_fe) {
1724 struct listener *l;
1725
1726 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1727 /* Only transfer IPv4/IPv6/UNIX sockets */
1728 if (l->state >= LI_ZOMBIE &&
1729 (l->proto->sock_family == AF_INET ||
1730 l->proto->sock_family == AF_INET6 ||
1731 l->proto->sock_family == AF_UNIX))
1732 tot_fd_nb++;
1733 }
1734 }
1735 prs = prs->next;
1736 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001737 if (tot_fd_nb == 0)
1738 goto out;
1739
1740 /* First send the total number of file descriptors, so that the
1741 * receiving end knows what to expect.
1742 */
1743 msghdr.msg_iov = &iov;
1744 msghdr.msg_iovlen = 1;
1745 ret = sendmsg(fd, &msghdr, 0);
1746 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001747 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001748 goto out;
1749 }
1750
1751 /* Now send the fds */
1752 msghdr.msg_control = cmsgbuf;
1753 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1754 cmsg = CMSG_FIRSTHDR(&msghdr);
1755 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1756 cmsg->cmsg_level = SOL_SOCKET;
1757 cmsg->cmsg_type = SCM_RIGHTS;
1758 tmpfd = (int *)CMSG_DATA(cmsg);
1759
Olivier Houchardf886e342017-04-05 22:24:59 +02001760 /* For each socket, e message is sent, containing the following :
1761 * Size of the namespace name (or 0 if none), as an unsigned char.
1762 * The namespace name, if any
1763 * Size of the interface name (or 0 if none), as an unsigned char
1764 * The interface name, if any
1765 * Listener options, as an int.
1766 */
1767 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1768 * buffer big enough to store the socket informations.
1769 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001770 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001771 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001772 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001773 goto out;
1774 }
1775 iov.iov_base = tmpbuf;
William Lallemand8dc8aec2020-01-16 15:32:08 +01001776 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001777 while (px) {
1778 struct listener *l;
1779
1780 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1781 int ret;
1782 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001783 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001784 (l->proto->sock_family == AF_INET ||
1785 l->proto->sock_family == AF_INET6 ||
1786 l->proto->sock_family == AF_UNIX)) {
1787 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1788 if (!l->netns)
1789 tmpbuf[curoff++] = 0;
Willy Tarreaue5733232019-05-22 19:24:06 +02001790#ifdef USE_NS
Olivier Houchardf886e342017-04-05 22:24:59 +02001791 else {
1792 char *name = l->netns->node.key;
1793 unsigned char len = l->netns->name_len;
1794 tmpbuf[curoff++] = len;
1795 memcpy(tmpbuf + curoff, name, len);
1796 curoff += len;
1797 }
1798#endif
1799 if (l->interface) {
1800 unsigned char len = strlen(l->interface);
1801 tmpbuf[curoff++] = len;
1802 memcpy(tmpbuf + curoff, l->interface, len);
1803 curoff += len;
1804 } else
1805 tmpbuf[curoff++] = 0;
1806 memcpy(tmpbuf + curoff, &l->options,
1807 sizeof(l->options));
1808 curoff += sizeof(l->options);
1809
Olivier Houchardf886e342017-04-05 22:24:59 +02001810 i++;
1811 } else
1812 continue;
1813 if ((!(i % MAX_SEND_FD))) {
1814 iov.iov_len = curoff;
1815 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001816 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001817 goto out;
1818 }
1819 /* Wait for an ack */
1820 do {
1821 ret = recv(fd, &tot_fd_nb,
1822 sizeof(tot_fd_nb), 0);
1823 } while (ret == -1 && errno == EINTR);
1824 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001825 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001826 goto out;
1827 }
1828 curoff = 0;
1829 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001830 }
1831 px = px->next;
1832 }
William Lallemand8dc8aec2020-01-16 15:32:08 +01001833 /* should be done for peers too */
1834 prs = cfg_peers;
1835 while (prs) {
1836 if (prs->peers_fe) {
1837 struct listener *l;
1838
1839 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1840 int ret;
1841 /* Only transfer IPv4/IPv6 sockets */
1842 if (l->state >= LI_ZOMBIE &&
1843 (l->proto->sock_family == AF_INET ||
1844 l->proto->sock_family == AF_INET6 ||
1845 l->proto->sock_family == AF_UNIX)) {
1846 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1847 if (!l->netns)
1848 tmpbuf[curoff++] = 0;
1849#ifdef USE_NS
1850 else {
1851 char *name = l->netns->node.key;
1852 unsigned char len = l->netns->name_len;
1853 tmpbuf[curoff++] = len;
1854 memcpy(tmpbuf + curoff, name, len);
1855 curoff += len;
1856 }
1857#endif
1858 if (l->interface) {
1859 unsigned char len = strlen(l->interface);
1860 tmpbuf[curoff++] = len;
1861 memcpy(tmpbuf + curoff, l->interface, len);
1862 curoff += len;
1863 } else
1864 tmpbuf[curoff++] = 0;
1865 memcpy(tmpbuf + curoff, &l->options,
1866 sizeof(l->options));
1867 curoff += sizeof(l->options);
1868
1869 i++;
1870 } else
1871 continue;
1872 if ((!(i % MAX_SEND_FD))) {
1873 iov.iov_len = curoff;
1874 if (sendmsg(fd, &msghdr, 0) != curoff) {
1875 ha_warning("Failed to transfer sockets\n");
1876 goto out;
1877 }
1878 /* Wait for an ack */
1879 do {
1880 ret = recv(fd, &tot_fd_nb,
1881 sizeof(tot_fd_nb), 0);
1882 } while (ret == -1 && errno == EINTR);
1883 if (ret <= 0) {
1884 ha_warning("Unexpected error while transferring sockets\n");
1885 goto out;
1886 }
1887 curoff = 0;
1888 }
1889 }
1890 }
1891 prs = prs->next;
1892 }
1893
Olivier Houchardf886e342017-04-05 22:24:59 +02001894 if (i % MAX_SEND_FD) {
1895 iov.iov_len = curoff;
1896 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1897 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1898 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001899 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001900 goto out;
1901 }
1902 }
1903
1904out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001905 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001906 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001907 goto out;
1908 }
1909 appctx->st0 = CLI_ST_END;
1910 free(cmsgbuf);
1911 free(tmpbuf);
1912 return 1;
1913}
1914
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001915static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1916{
1917 if (*args[0] == 'h')
1918 /* help */
1919 cli_gen_usage_msg(appctx);
1920 else if (*args[0] == 'p')
1921 /* prompt */
1922 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1923 else if (*args[0] == 'q')
1924 /* quit */
1925 appctx->st0 = CLI_ST_END;
1926
1927 return 1;
1928}
Olivier Houchardf886e342017-04-05 22:24:59 +02001929
William Lallemand2f4ce202018-10-26 14:47:47 +02001930void pcli_write_prompt(struct stream *s)
1931{
1932 struct buffer *msg = get_trash_chunk();
1933 struct channel *oc = si_oc(&s->si[0]);
1934
William Lallemanddc12c2e2018-12-13 09:05:46 +01001935 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001936 return;
1937
William Lallemanddc12c2e2018-12-13 09:05:46 +01001938 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001939 chunk_appendf(msg, "+ ");
1940 } else {
1941 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001942 chunk_appendf(msg, "master%s> ",
1943 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001944 else
1945 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1946 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001947 co_inject(oc, msg->area, msg->data);
1948}
1949
William Lallemand291810d2018-10-26 14:47:38 +02001950
William Lallemandcf62f7e2018-10-26 14:47:40 +02001951/* The pcli_* functions are used for the CLI proxy in the master */
1952
William Lallemanddeeaa592018-10-26 14:47:48 +02001953void pcli_reply_and_close(struct stream *s, const char *msg)
1954{
1955 struct buffer *buf = get_trash_chunk();
1956
1957 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001958 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001959}
1960
William Lallemand291810d2018-10-26 14:47:38 +02001961static enum obj_type *pcli_pid_to_server(int proc_pid)
1962{
1963 struct mworker_proc *child;
1964
William Lallemandbddd33a2018-12-11 16:10:53 +01001965 /* return the CLI applet of the master */
1966 if (proc_pid == 0)
1967 return &cli_applet.obj_type;
1968
William Lallemand291810d2018-10-26 14:47:38 +02001969 list_for_each_entry(child, &proc_list, list) {
1970 if (child->pid == proc_pid){
1971 return &child->srv->obj_type;
1972 }
1973 }
1974 return NULL;
1975}
1976
1977/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1978 * Return:
1979 * 0: master
1980 * > 0: pid of a worker
1981 * < 0: didn't find a worker
1982 */
1983static int pcli_prefix_to_pid(const char *prefix)
1984{
1985 int proc_pid;
1986 struct mworker_proc *child;
1987 char *errtol = NULL;
1988
1989 if (*prefix != '@') /* not a prefix, should not happen */
1990 return -1;
1991
1992 prefix++;
1993 if (!*prefix) /* sent @ alone, return the master */
1994 return 0;
1995
1996 if (strcmp("master", prefix) == 0) {
1997 return 0;
1998 } else if (*prefix == '!') {
1999 prefix++;
2000 if (!*prefix)
2001 return -1;
2002
2003 proc_pid = strtol(prefix, &errtol, 10);
2004 if (*errtol != '\0')
2005 return -1;
2006 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002007 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002008 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002009 if (child->pid == proc_pid){
2010 return child->pid;
2011 }
2012 }
2013 } else {
2014 struct mworker_proc *chosen = NULL;
2015 /* this is a relative pid */
2016
2017 proc_pid = strtol(prefix, &errtol, 10);
2018 if (*errtol != '\0')
2019 return -1;
2020
2021 if (proc_pid == 0) /* return the master */
2022 return 0;
2023
2024 /* chose the right process, the current one is the one with the
2025 least number of reloads */
2026 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002027 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002028 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002029 if (child->relative_pid == proc_pid){
2030 if (child->reloads == 0)
2031 return child->pid;
2032 else if (chosen == NULL || child->reloads < chosen->reloads)
2033 chosen = child;
2034 }
2035 }
2036 if (chosen)
2037 return chosen->pid;
2038 }
2039 return -1;
2040}
2041
William Lallemandbddd33a2018-12-11 16:10:53 +01002042/* Return::
2043 * >= 0 : number of words to escape
2044 * = -1 : error
2045 */
2046
2047int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2048{
2049 if (argl < 1)
2050 return 0;
2051
2052 /* there is a prefix */
2053 if (args[0][0] == '@') {
2054 int target_pid = pcli_prefix_to_pid(args[0]);
2055
2056 if (target_pid == -1) {
2057 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2058 return -1;
2059 }
2060
2061 /* if the prefix is alone, define a default target */
2062 if (argl == 1)
2063 s->pcli_next_pid = target_pid;
2064 else
2065 *next_pid = target_pid;
2066 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01002067 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002068 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002069 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002070
2071 } else if (!strcmp("quit", args[0])) {
2072 channel_shutr_now(&s->req);
2073 channel_shutw_now(&s->res);
2074 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01002075 } else if (!strcmp(args[0], "operator")) {
2076 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2077 memprintf(errmsg, "Permission denied!\n");
2078 return -1;
2079 }
2080 s->pcli_flags &= ~ACCESS_LVL_MASK;
2081 s->pcli_flags |= ACCESS_LVL_OPER;
2082 return argl;
2083
2084 } else if (!strcmp(args[0], "user")) {
2085 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2086 memprintf(errmsg, "Permission denied!\n");
2087 return -1;
2088 }
2089 s->pcli_flags &= ~ACCESS_LVL_MASK;
2090 s->pcli_flags |= ACCESS_LVL_USER;
2091 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002092 }
2093
2094 return 0;
2095}
2096
2097/*
2098 * Parse the CLI request:
2099 * - It does basically the same as the cli_io_handler, but as a proxy
2100 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002101 *
2102 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002103 * - the number of characters to forward or
2104 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002105 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002106int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002107{
William Lallemandbddd33a2018-12-11 16:10:53 +01002108 char *str = (char *)ci_head(req);
2109 char *end = (char *)ci_stop(req);
2110 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2111 int argl; /* number of args */
2112 char *p;
2113 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002114 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002115 int wtrim = 0; /* number of words to trim */
2116 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002117 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002118 int i = 0;
2119
2120 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002121
William Lallemanddc12c2e2018-12-13 09:05:46 +01002122 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002123
2124 /* Looks for the end of one command */
2125 while (p+reql < end) {
2126 /* handle escaping */
2127 if (p[reql] == '\\') {
William Lallemandc3a2e352020-06-18 18:45:04 +02002128 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002129 continue;
2130 }
2131 if (p[reql] == ';' || p[reql] == '\n') {
2132 /* found the end of the command */
2133 p[reql] = '\n';
2134 reql++;
2135 break;
2136 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002137 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002138 }
William Lallemandebf61802018-12-11 16:10:57 +01002139 } else {
2140 while (p+reql < end) {
2141 if (p[reql] == '\n') {
2142 /* found the end of the line */
2143 reql++;
2144 break;
2145 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002146 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002147 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002148 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002149
William Lallemandbddd33a2018-12-11 16:10:53 +01002150 /* set end to first byte after the end of the command */
2151 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002152
William Lallemandbddd33a2018-12-11 16:10:53 +01002153 /* there is no end to this command, need more to parse ! */
2154 if (*(end-1) != '\n') {
2155 return -1;
2156 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002157
William Lallemand3301f3e2018-12-13 09:05:48 +01002158 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2159 if (reql == 1) /* last line of the payload */
2160 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002161 return reql;
2162 }
2163
William Lallemandbddd33a2018-12-11 16:10:53 +01002164 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002165
William Lallemandbddd33a2018-12-11 16:10:53 +01002166 /* splits the command in words */
2167 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002168 /* skip leading spaces/tabs */
2169 p += strspn(p, " \t");
2170 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002171 break;
2172
William Lallemandbddd33a2018-12-11 16:10:53 +01002173 args[i] = p;
William Lallemandda9a2d12020-06-18 18:03:57 +02002174 while (1) {
2175 p += strcspn(p, " \t\\");
2176 /* escaped chars using backlashes (\) */
2177 if (*p == '\\') {
2178 if (!*++p)
2179 break;
2180 if (!*++p)
2181 break;
2182 } else {
2183 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002184 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002185 }
William Lallemandda9a2d12020-06-18 18:03:57 +02002186 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002187 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002188 }
2189
William Lallemandbddd33a2018-12-11 16:10:53 +01002190 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002191
William Lallemandbddd33a2018-12-11 16:10:53 +01002192 for (; i < MAX_STATS_ARGS + 1; i++)
2193 args[i] = NULL;
2194
2195 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2196
2197 /* End of words are ending by \0, we need to replace the \0s by spaces
21981 before forwarding them */
2199 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002200 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002201 if (*p == '\0')
2202 *p = ' ';
2203 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002204 }
2205
William Lallemand3301f3e2018-12-13 09:05:48 +01002206 payload = strstr(str, PAYLOAD_PATTERN);
2207 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2208 /* if the payload pattern is at the end */
2209 s->pcli_flags |= PCLI_F_PAYLOAD;
2210 ret = reql;
2211 }
2212
William Lallemandbddd33a2018-12-11 16:10:53 +01002213 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002214
William Lallemandbddd33a2018-12-11 16:10:53 +01002215 if (wtrim > 0) {
2216 trim = &args[wtrim][0];
2217 if (trim == NULL) /* if this was the last word in the table */
2218 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002219
William Lallemandbddd33a2018-12-11 16:10:53 +01002220 b_del(&req->buf, trim - str);
2221
William Lallemandb7ea1412018-12-13 09:05:47 +01002222 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002223 } else if (wtrim < 0) {
2224 /* parsing error */
2225 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002226 } else {
2227 /* the whole string */
2228 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002229 }
2230
William Lallemandb7ea1412018-12-13 09:05:47 +01002231 if (ret > 1) {
2232 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2233 goto end;
2234 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemand1bd140e2019-07-01 10:56:15 +02002235 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2236 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002237 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemand1bd140e2019-07-01 10:56:15 +02002238 ci_insert_line2(req, 0, "user -", strlen("user -"));
2239 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002240 }
2241 }
2242end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002243
William Lallemandb7ea1412018-12-13 09:05:47 +01002244 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002245}
2246
2247int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2248{
William Lallemandbddd33a2018-12-11 16:10:53 +01002249 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002250 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002251 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002252
William Lallemandb7ea1412018-12-13 09:05:47 +01002253 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2254 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2255
William Lallemandcf62f7e2018-10-26 14:47:40 +02002256read_again:
2257 /* if the channel is closed for read, we won't receive any more data
2258 from the client, but we don't want to forward this close to the
2259 server */
2260 channel_dont_close(req);
2261
2262 /* We don't know yet to which server we will connect */
2263 channel_dont_connect(req);
2264
2265
2266 /* we are not waiting for a response, there is no more request and we
2267 * receive a close from the client, we can leave */
2268 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2269 channel_shutw_now(&s->res);
2270 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2271 return 1;
2272 }
2273
2274 req->flags |= CF_READ_DONTWAIT;
2275
2276 /* need more data */
2277 if (!ci_data(req))
2278 return 0;
2279
2280 /* If there is data available for analysis, log the end of the idle time. */
2281 if (c_data(req) && s->logs.t_idle == -1)
2282 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2283
William Lallemandbddd33a2018-12-11 16:10:53 +01002284 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002285 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002286 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002287 /* enough data */
2288
William Lallemandcf62f7e2018-10-26 14:47:40 +02002289 /* forward only 1 command */
2290 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002291
William Lallemanddc12c2e2018-12-13 09:05:46 +01002292 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002293 /* we send only 1 command per request, and we write close after it */
2294 channel_shutw_now(req);
2295 } else {
2296 pcli_write_prompt(s);
2297 }
2298
2299 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002300
2301 /* remove the XFER_DATA analysers, which forwards all
2302 * the data, we don't want to forward the next requests
2303 * We need to add CF_FLT_ANALYZE to abort the forward too.
2304 */
2305 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2306 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2307 s->res.analysers |= AN_RES_WAIT_CLI;
2308
William Lallemandebf61802018-12-11 16:10:57 +01002309 if (!(s->flags & SF_ASSIGNED)) {
2310 if (next_pid > -1)
2311 target_pid = next_pid;
2312 else
2313 target_pid = s->pcli_next_pid;
2314 /* we can connect now */
2315 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002316
William Lallemandebf61802018-12-11 16:10:57 +01002317 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2318 channel_auto_connect(req);
2319 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002320
2321 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002322 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002323 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002324 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002325 } else if (to_forward == -1 && errmsg) {
2326 /* there was an error during the parsing */
2327 pcli_reply_and_close(s, errmsg);
2328 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002329 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2330 /* buffer is full and we didn't catch the end of a command */
2331 goto send_help;
2332 }
2333
2334 return 0;
2335
2336send_help:
2337 b_reset(&req->buf);
2338 b_putblk(&req->buf, "help\n", 5);
2339 goto read_again;
2340}
2341
2342int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2343{
2344 struct proxy *fe = strm_fe(s);
2345 struct proxy *be = s->be;
2346
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002347 if (rep->flags & CF_READ_ERROR) {
2348 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2349 s->res.analysers &= ~AN_RES_WAIT_CLI;
2350 return 0;
2351 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002352 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2353 rep->flags |= CF_NEVER_WAIT;
2354
2355 /* don't forward the close */
2356 channel_dont_close(&s->res);
2357 channel_dont_close(&s->req);
2358
William Lallemanddc12c2e2018-12-13 09:05:46 +01002359 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002360 s->req.analysers |= AN_REQ_WAIT_CLI;
2361 s->res.analysers &= ~AN_RES_WAIT_CLI;
2362 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2363 return 0;
2364 }
2365
William Lallemandcf62f7e2018-10-26 14:47:40 +02002366 /* forward the data */
2367 if (ci_data(rep)) {
2368 c_adv(rep, ci_data(rep));
2369 return 0;
2370 }
2371
2372 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2373 /* stream cleanup */
2374
William Lallemand2f4ce202018-10-26 14:47:47 +02002375 pcli_write_prompt(s);
2376
William Lallemandcf62f7e2018-10-26 14:47:40 +02002377 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2378 si_shutr(&s->si[1]);
2379 si_shutw(&s->si[1]);
2380
2381 /*
2382 * starting from there this the same code as
2383 * http_end_txn_clean_session().
2384 *
2385 * It allows to do frontend keepalive while reconnecting to a
2386 * new server for each request.
2387 */
2388
2389 if (s->flags & SF_BE_ASSIGNED) {
2390 HA_ATOMIC_SUB(&be->beconn, 1);
2391 if (unlikely(s->srv_conn))
2392 sess_change_server(s, NULL);
2393 }
2394
2395 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2396 stream_process_counters(s);
2397
2398 /* don't count other requests' data */
2399 s->logs.bytes_in -= ci_data(&s->req);
2400 s->logs.bytes_out -= ci_data(&s->res);
2401
2402 /* we may need to know the position in the queue */
2403 pendconn_free(s);
2404
2405 /* let's do a final log if we need it */
2406 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2407 !(s->flags & SF_MONITOR) &&
2408 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2409 s->do_log(s);
2410 }
2411
2412 /* stop tracking content-based counters */
2413 stream_stop_content_counters(s);
2414 stream_update_time_stats(s);
2415
2416 s->logs.accept_date = date; /* user-visible date for logging */
2417 s->logs.tv_accept = now; /* corrected date for internal use */
2418 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2419 s->logs.t_idle = -1;
2420 tv_zero(&s->logs.tv_request);
2421 s->logs.t_queue = -1;
2422 s->logs.t_connect = -1;
2423 s->logs.t_data = -1;
2424 s->logs.t_close = 0;
2425 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2426 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2427
2428 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2429 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2430
2431 stream_del_srv_conn(s);
2432 if (objt_server(s->target)) {
2433 if (s->flags & SF_CURR_SESS) {
2434 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002435 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002436 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002437 if (may_dequeue_tasks(__objt_server(s->target), be))
Amaury Denoyelleb0fbda52021-06-18 11:11:36 +02002438 process_srv_queue(__objt_server(s->target), 0);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002439 }
2440
2441 s->target = NULL;
2442
2443 /* only release our endpoint if we don't intend to reuse the
2444 * connection.
2445 */
2446 if (!si_conn_ready(&s->si[1])) {
2447 si_release_endpoint(&s->si[1]);
2448 s->srv_conn = NULL;
2449 }
2450
2451 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2452 s->si[1].err_type = SI_ET_NONE;
2453 s->si[1].conn_retries = 0; /* used for logging too */
2454 s->si[1].exp = TICK_ETERNITY;
2455 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2456 s->req.flags &= ~(CF_SHUTW|CF_SHUTW_NOW|CF_AUTO_CONNECT|CF_WRITE_ERROR|CF_STREAMER|CF_STREAMER_FAST|CF_NEVER_WAIT|CF_WAKE_CONNECT|CF_WROTE_DATA);
William Lallemandd12fb062019-06-25 18:00:19 +02002457 s->res.flags &= ~(CF_SHUTR|CF_SHUTR_NOW|CF_READ_ATTACHED|CF_READ_ERROR|CF_READ_NOEXP|CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_PARTIAL|CF_NEVER_WAIT|CF_WROTE_DATA|CF_READ_NULL);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002458 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2459 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2460 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2461 /* reinitialise the current rule list pointer to NULL. We are sure that
2462 * any rulelist match the NULL pointer.
2463 */
2464 s->current_rule_list = NULL;
2465
2466 s->be = strm_fe(s);
2467 s->logs.logwait = strm_fe(s)->to_log;
2468 s->logs.level = 0;
2469 stream_del_srv_conn(s);
2470 s->target = NULL;
2471 /* re-init store persistence */
2472 s->store_count = 0;
2473 s->uniq_id = global.req_count++;
2474
2475 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2476
2477 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2478
2479 s->req.analysers |= AN_REQ_WAIT_CLI;
2480 s->res.analysers &= ~AN_RES_WAIT_CLI;
2481
2482 /* We must trim any excess data from the response buffer, because we
2483 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002484 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002485 * we want those data to come along with next response. A typical
2486 * example of such data would be from a buggy server responding to
2487 * a HEAD with some data, or sending more than the advertised
2488 * content-length.
2489 */
2490 if (unlikely(ci_data(&s->res)))
2491 b_set_data(&s->res.buf, co_data(&s->res));
2492
2493 /* Now we can realign the response buffer */
2494 c_realign_if_empty(&s->res);
2495
2496 s->req.rto = strm_fe(s)->timeout.client;
2497 s->req.wto = TICK_ETERNITY;
2498
2499 s->res.rto = TICK_ETERNITY;
2500 s->res.wto = strm_fe(s)->timeout.client;
2501
2502 s->req.rex = TICK_ETERNITY;
2503 s->req.wex = TICK_ETERNITY;
2504 s->req.analyse_exp = TICK_ETERNITY;
2505 s->res.rex = TICK_ETERNITY;
2506 s->res.wex = TICK_ETERNITY;
2507 s->res.analyse_exp = TICK_ETERNITY;
2508 s->si[1].hcto = TICK_ETERNITY;
2509
2510 /* we're removing the analysers, we MUST re-enable events detection.
2511 * We don't enable close on the response channel since it's either
2512 * already closed, or in keep-alive with an idle connection handler.
2513 */
2514 channel_auto_read(&s->req);
2515 channel_auto_close(&s->req);
2516 channel_auto_read(&s->res);
2517
2518
2519 return 1;
2520 }
2521 return 0;
2522}
2523
William Lallemand8a022572018-10-26 14:47:35 +02002524/*
2525 * The mworker functions are used to initialize the CLI in the master process
2526 */
2527
William Lallemand309dc9a2018-10-26 14:47:45 +02002528 /*
2529 * Stop the mworker proxy
2530 */
2531void mworker_cli_proxy_stop()
2532{
William Lallemand550db6d2018-11-06 17:37:12 +01002533 if (mworker_proxy)
2534 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002535}
2536
William Lallemand8a022572018-10-26 14:47:35 +02002537/*
2538 * Create the mworker CLI proxy
2539 */
2540int mworker_cli_proxy_create()
2541{
2542 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002543 char *msg = NULL;
2544 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002545
2546 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2547 if (!mworker_proxy)
2548 return -1;
2549
2550 init_new_proxy(mworker_proxy);
2551 mworker_proxy->next = proxies_list;
2552 proxies_list = mworker_proxy;
2553 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002554 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002555 mworker_proxy->state = PR_STNEW;
2556 mworker_proxy->last_change = now.tv_sec;
2557 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2558 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2559 mworker_proxy->timeout.client = 0; /* no timeout */
2560 mworker_proxy->conf.file = strdup("MASTER");
2561 mworker_proxy->conf.line = 0;
2562 mworker_proxy->accept = frontend_accept;
2563 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2564
2565 /* Does not init the default target the CLI applet, but must be done in
2566 * the request parsing code */
2567 mworker_proxy->default_target = NULL;
2568
2569 /* the check_config_validity() will get an ID for the proxy */
2570 mworker_proxy->uuid = -1;
2571
2572 proxy_store_name(mworker_proxy);
2573
2574 /* create all servers using the mworker_proc list */
2575 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002576 struct server *newsrv = NULL;
2577 struct sockaddr_storage *sk;
2578 int port1, port2, port;
2579 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002580
William Lallemandf0d9dd42020-01-14 15:25:02 +01002581 /* only the workers support the master CLI */
2582 if (!(child->options & PROC_O_TYPE_WORKER))
2583 continue;
2584
William Lallemand8a022572018-10-26 14:47:35 +02002585 newsrv = new_server(mworker_proxy);
2586 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002587 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002588
2589 /* we don't know the new pid yet */
2590 if (child->pid == -1)
2591 memprintf(&msg, "cur-%d", child->relative_pid);
2592 else
2593 memprintf(&msg, "old-%d", child->pid);
2594
2595 newsrv->next = mworker_proxy->srv;
2596 mworker_proxy->srv = newsrv;
2597 newsrv->conf.file = strdup(msg);
2598 newsrv->id = strdup(msg);
2599 newsrv->conf.line = 0;
2600
2601 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002602 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002603 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002604 }
2605 free(msg);
2606 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002607
2608 proto = protocol_by_family(sk->ss_family);
2609 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002610 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002611 }
2612
2613 /* no port specified */
2614 newsrv->flags |= SRV_F_MAPPORTS;
2615 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002616 /* don't let the server participate to load balancing */
2617 newsrv->iweight = 0;
2618 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002619 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002620
2621 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002622 }
2623 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002624
2625error:
2626 ha_alert("%s\n", errmsg);
2627
2628 list_for_each_entry(child, &proc_list, list) {
2629 free((char *)child->srv->conf.file); /* cast because of const char * */
2630 free(child->srv->id);
2631 free(child->srv);
2632 child->srv = NULL;
2633 }
2634 free(mworker_proxy->id);
2635 free(mworker_proxy->conf.file);
2636 free(mworker_proxy);
2637 mworker_proxy = NULL;
2638 free(errmsg);
2639 free(msg);
2640
2641 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002642}
Olivier Houchardf886e342017-04-05 22:24:59 +02002643
William Lallemandce83b4a2018-10-26 14:47:30 +02002644/*
William Lallemande7361152018-10-26 14:47:36 +02002645 * Create a new listener for the master CLI proxy
2646 */
2647int mworker_cli_proxy_new_listener(char *line)
2648{
2649 struct bind_conf *bind_conf;
2650 struct listener *l;
2651 char *err = NULL;
2652 char *args[MAX_LINE_ARGS + 1];
2653 int arg;
2654 int cur_arg;
2655
William Lallemandb4f87862019-11-25 09:58:37 +01002656 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002657 args[0] = line;
2658
2659 /* args is a bind configuration with spaces replaced by commas */
2660 while (*line && arg < MAX_LINE_ARGS) {
2661
2662 if (*line == ',') {
2663 *line++ = '\0';
2664 while (*line == ',')
2665 line++;
William Lallemandb4f87862019-11-25 09:58:37 +01002666 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002667 }
2668 line++;
2669 }
2670
William Lallemandb4f87862019-11-25 09:58:37 +01002671 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002672
2673 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002674 if (!bind_conf)
2675 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002676
2677 bind_conf->level &= ~ACCESS_LVL_MASK;
2678 bind_conf->level |= ACCESS_LVL_ADMIN;
2679
2680 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2681 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002682 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002683 }
2684
2685 cur_arg = 1;
2686
2687 while (*args[cur_arg]) {
2688 static int bind_dumped;
2689 struct bind_kw *kw;
2690
2691 kw = bind_find_kw(args[cur_arg]);
2692 if (kw) {
2693 if (!kw->parse) {
2694 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2695 args[0], args[1], args[cur_arg]);
2696 goto err;
2697 }
2698
2699 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2700 if (err)
2701 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2702 else
2703 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2704 args[0], args[1], args[cur_arg]);
2705 goto err;
2706 }
2707
2708 cur_arg += 1 + kw->skip;
2709 continue;
2710 }
2711
2712 if (!bind_dumped) {
2713 bind_dump_kws(&err);
2714 indent_msg(&err, 4);
2715 bind_dumped = 1;
2716 }
2717
2718 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2719 args[0], args[1], args[cur_arg],
2720 err ? " Registered keywords :" : "", err ? err : "");
2721 goto err;
2722 }
2723
2724
2725 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002726 l->accept = session_accept_fd;
2727 l->default_target = mworker_proxy->default_target;
2728 /* don't make the peers subject to global limits and don't close it in the master */
2729 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2730 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002731 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002732 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002733 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002734
2735 return 0;
2736
2737err:
2738 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002739 free(err);
2740 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002741 return -1;
2742
2743}
2744
2745/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002746 * Create a new CLI socket using a socketpair for a worker process
2747 * <mworker_proc> is the process structure, and <proc> is the process number
2748 */
2749int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2750{
2751 struct bind_conf *bind_conf;
2752 struct listener *l;
2753 char *path = NULL;
2754 char *err = NULL;
2755
2756 /* master pipe to ensure the master is still alive */
2757 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2758 ha_alert("Cannot create worker socketpair.\n");
2759 return -1;
2760 }
2761
2762 /* XXX: we might want to use a separate frontend at some point */
2763 if (!global.stats_fe) {
2764 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2765 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002766 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002767 }
2768 }
2769
2770 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002771 if (!bind_conf)
2772 goto error;
2773
William Lallemandce83b4a2018-10-26 14:47:30 +02002774 bind_conf->level &= ~ACCESS_LVL_MASK;
2775 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2776
2777 bind_conf->bind_proc = 1UL << proc;
2778 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2779
2780 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2781 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002782 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002783 }
2784
2785 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002786 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002787 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002788 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002789 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002790 free(path);
2791 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002792
2793 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002794 l->accept = session_accept_fd;
2795 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002796 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002797 /* it's a sockpair but we don't want to keep the fd in the master */
2798 l->options &= ~LI_O_INHERITED;
2799 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002800 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002801 }
2802
2803 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002804
2805error:
2806 close(mworker_proc->ipc_fd[0]);
2807 close(mworker_proc->ipc_fd[1]);
2808 free(err);
2809
2810 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002811}
2812
William Lallemand74c24fb2016-11-21 17:18:36 +01002813static struct applet cli_applet = {
2814 .obj_type = OBJ_TYPE_APPLET,
2815 .name = "<CLI>", /* used for logging */
2816 .fct = cli_io_handler,
2817 .release = cli_release_handler,
2818};
2819
Willy Tarreau0a739292016-11-22 20:21:23 +01002820/* register cli keywords */
2821static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002822 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2823 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2824 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002825 { { "set", "maxconn", "global", NULL }, "set maxconn global : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
Willy Tarreau45c742b2016-11-24 14:51:17 +01002826 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002827 { { "set", "severity-output", NULL }, "set severity-output [none|number|string] : set presence of severity level in feedback information", cli_parse_set_severity_output, NULL, NULL },
Willy Tarreau599852e2016-11-22 20:33:32 +01002828 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002829 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
William Lallemand35851fb2018-10-26 14:47:42 +02002830 { { "show", "cli", "sockets", NULL }, "show cli sockets : dump list of cli sockets", cli_parse_default, cli_io_handler_show_cli_sock, NULL, NULL, ACCESS_MASTER },
William Lallemand67a234f2018-12-13 09:05:45 +01002831 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02002832 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01002833 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemand67a234f2018-12-13 09:05:45 +01002834 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2835 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Olivier Houchardf886e342017-04-05 22:24:59 +02002836 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002837 {{},}
2838}};
2839
Willy Tarreau0108d902018-11-25 19:14:37 +01002840INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2841
William Lallemand74c24fb2016-11-21 17:18:36 +01002842static struct cfg_kw_list cfg_kws = {ILH, {
2843 { CFG_GLOBAL, "stats", stats_parse_global },
2844 { 0, NULL, NULL },
2845}};
2846
Willy Tarreau0108d902018-11-25 19:14:37 +01002847INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2848
William Lallemand74c24fb2016-11-21 17:18:36 +01002849static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002850 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2851 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002852 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002853 { NULL, NULL, 0 },
2854}};
2855
Willy Tarreau0108d902018-11-25 19:14:37 +01002856INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002857
2858/*
2859 * Local variables:
2860 * c-indent-level: 8
2861 * c-basic-offset: 8
2862 * End:
2863 */