blob: c527e906d2ff96888171bc5bbb155c96b2502b2e [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
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/applet-t.h>
32#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020038#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020039#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020042#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020043#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020044#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020045#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020046#include <haproxy/log.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020054#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020055#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020056#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020057#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020058#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020059#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020060#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020061#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020062#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020063#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020064#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010065
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020066#define PAYLOAD_PATTERN "<<"
67
William Lallemand74c24fb2016-11-21 17:18:36 +010068static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010069static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010070
71static const char stats_sock_usage_msg[] =
72 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010073 " help : this message\n"
74 " prompt : toggle interactive mode with prompt\n"
75 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010076 "";
77
78static const char stats_permission_denied_msg[] =
79 "Permission denied\n"
80 "";
81
82
Christopher Faulet1bc04c72017-10-29 20:14:08 +010083static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010084
85/* List head of cli keywords */
86static struct cli_kw_list cli_keywords = {
87 .list = LIST_HEAD_INIT(cli_keywords.list)
88};
89
90extern const char *stat_status_codes[];
91
William Lallemand8a022572018-10-26 14:47:35 +020092static struct proxy *mworker_proxy; /* CLI proxy of the master */
93
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020094static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +010095{
96 struct cli_kw_list *kw_list;
97 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020098 struct buffer *tmp = get_trash_chunk();
99 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100100
101 free(dynamic_usage_msg);
102 dynamic_usage_msg = NULL;
103
104 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200105 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100106
107 chunk_reset(tmp);
108 chunk_strcat(tmp, stats_sock_usage_msg);
109 list_for_each_entry(kw_list, &cli_keywords.list, list) {
110 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200111 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200112
113 /* in a worker or normal process, don't display master only commands */
William Lallemand99e0bb92020-11-05 10:28:53 +0100114 if (appctx->applet == &cli_applet && (kw->level & ACCESS_MASTER_ONLY))
William Lallemand14721be2018-10-26 14:47:37 +0200115 goto next_kw;
116
117 /* in master don't displays if we don't have the master bits */
William Lallemand99e0bb92020-11-05 10:28:53 +0100118 if (appctx->applet == &mcli_applet && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
William Lallemand14721be2018-10-26 14:47:37 +0200119 goto next_kw;
120
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200121 /* only show expert commands in expert mode */
122 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
123 goto next_kw;
124
William Lallemand0154edc2018-05-15 11:50:04 +0200125 if (kw->usage)
126 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200127
128next_kw:
129
William Lallemand74c24fb2016-11-21 17:18:36 +0100130 kw++;
131 }
132 }
133 chunk_init(&out, NULL, 0);
134 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200135 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200136
137end:
138 if (dynamic_usage_msg) {
139 appctx->ctx.cli.severity = LOG_INFO;
140 appctx->ctx.cli.msg = dynamic_usage_msg;
141 }
142 else {
143 appctx->ctx.cli.severity = LOG_INFO;
144 appctx->ctx.cli.msg = stats_sock_usage_msg;
145 }
146 appctx->st0 = CLI_ST_PRINT;
147
William Lallemand74c24fb2016-11-21 17:18:36 +0100148 return dynamic_usage_msg;
149}
150
151struct cli_kw* cli_find_kw(char **args)
152{
153 struct cli_kw_list *kw_list;
154 struct cli_kw *kw;/* current cli_kw */
155 char **tmp_args;
156 const char **tmp_str_kw;
157 int found = 0;
158
159 if (LIST_ISEMPTY(&cli_keywords.list))
160 return NULL;
161
162 list_for_each_entry(kw_list, &cli_keywords.list, list) {
163 kw = &kw_list->kw[0];
164 while (*kw->str_kw) {
165 tmp_args = args;
166 tmp_str_kw = kw->str_kw;
167 while (*tmp_str_kw) {
168 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
169 found = 1;
170 } else {
171 found = 0;
172 break;
173 }
174 tmp_args++;
175 tmp_str_kw++;
176 }
177 if (found)
178 return (kw);
179 kw++;
180 }
181 }
182 return NULL;
183}
184
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100185struct cli_kw* cli_find_kw_exact(char **args)
186{
187 struct cli_kw_list *kw_list;
188 int found = 0;
189 int i;
190 int j;
191
192 if (LIST_ISEMPTY(&cli_keywords.list))
193 return NULL;
194
195 list_for_each_entry(kw_list, &cli_keywords.list, list) {
196 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
197 found = 1;
198 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
199 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
200 break;
201 }
202 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
203 found = 0;
204 break;
205 }
206 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
207 found = 0;
208 break;
209 }
210 }
211 if (found)
212 return &kw_list->kw[i];
213 }
214 }
215 return NULL;
216}
217
William Lallemand74c24fb2016-11-21 17:18:36 +0100218void cli_register_kw(struct cli_kw_list *kw_list)
219{
220 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
221}
222
223
224/* allocate a new stats frontend named <name>, and return it
225 * (or NULL in case of lack of memory).
226 */
227static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
228{
229 struct proxy *fe;
230
231 fe = calloc(1, sizeof(*fe));
232 if (!fe)
233 return NULL;
234
235 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100236 fe->next = proxies_list;
237 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100238 fe->last_change = now.tv_sec;
239 fe->id = strdup("GLOBAL");
240 fe->cap = PR_CAP_FE;
241 fe->maxconn = 10; /* default to 10 concurrent connections */
242 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
243 fe->conf.file = strdup(file);
244 fe->conf.line = line;
245 fe->accept = frontend_accept;
246 fe->default_target = &cli_applet.obj_type;
247
248 /* the stats frontend is the only one able to assign ID #0 */
249 fe->conf.id.key = fe->uuid = 0;
250 eb32_insert(&used_proxy_id, &fe->conf.id);
251 return fe;
252}
253
254/* This function parses a "stats" statement in the "global" section. It returns
255 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
256 * error message into the <err> buffer which will be preallocated. The trailing
257 * '\n' must not be written. The function must be called with <args> pointing to
258 * the first word after "stats".
259 */
260static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
261 struct proxy *defpx, const char *file, int line,
262 char **err)
263{
264 struct bind_conf *bind_conf;
265 struct listener *l;
266
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100267 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100268 int cur_arg;
269
270 if (*args[2] == 0) {
271 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
272 return -1;
273 }
274
275 if (!global.stats_fe) {
276 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
277 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
278 return -1;
279 }
280 }
281
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100282 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200283 bind_conf->level &= ~ACCESS_LVL_MASK;
284 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100285
286 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
287 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
288 file, line, args[0], args[1], err && *err ? *err : "error");
289 return -1;
290 }
291
292 cur_arg = 3;
293 while (*args[cur_arg]) {
294 static int bind_dumped;
295 struct bind_kw *kw;
296
297 kw = bind_find_kw(args[cur_arg]);
298 if (kw) {
299 if (!kw->parse) {
300 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
301 args[0], args[1], args[cur_arg]);
302 return -1;
303 }
304
305 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
306 if (err && *err)
307 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
308 else
309 memprintf(err, "'%s %s' : error encountered while processing '%s'",
310 args[0], args[1], args[cur_arg]);
311 return -1;
312 }
313
314 cur_arg += 1 + kw->skip;
315 continue;
316 }
317
318 if (!bind_dumped) {
319 bind_dump_kws(err);
320 indent_msg(err, 4);
321 bind_dumped = 1;
322 }
323
324 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
325 args[0], args[1], args[cur_arg],
326 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
327 return -1;
328 }
329
330 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100331 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100332 l->default_target = global.stats_fe->default_target;
333 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
334 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100335 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100336 }
337 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100338 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100339 unsigned timeout;
340 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
341
Willy Tarreau9faebe32019-06-07 19:00:37 +0200342 if (res == PARSE_TIME_OVER) {
343 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
344 args[2], args[0], args[1]);
345 return -1;
346 }
347 else if (res == PARSE_TIME_UNDER) {
348 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
349 args[2], args[0], args[1]);
350 return -1;
351 }
352 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100353 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
354 return -1;
355 }
356
357 if (!timeout) {
358 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
359 return -1;
360 }
361 if (!global.stats_fe) {
362 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
363 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
364 return -1;
365 }
366 }
367 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
368 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100369 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100370 int maxconn = atol(args[2]);
371
372 if (maxconn <= 0) {
373 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
374 return -1;
375 }
376
377 if (!global.stats_fe) {
378 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
379 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
380 return -1;
381 }
382 }
383 global.stats_fe->maxconn = maxconn;
384 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100385 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100386 int cur_arg = 2;
387 unsigned long set = 0;
388
389 if (!global.stats_fe) {
390 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
391 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
392 return -1;
393 }
394 }
395
396 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100397 if (strcmp(args[cur_arg], "all") == 0) {
398 set = 0;
399 break;
400 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100401 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100402 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100403 return -1;
404 }
405 cur_arg++;
406 }
407 global.stats_fe->bind_proc = set;
408 }
409 else {
410 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
411 return -1;
412 }
413 return 0;
414}
415
William Lallemand33d29e22019-04-01 11:30:06 +0200416/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200417 * This function exports the bound addresses of a <frontend> in the environment
418 * variable <varname>. Those addresses are separated by semicolons and prefixed
419 * with their type (abns@, unix@, sockpair@ etc)
420 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200421 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200422int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200423{
424 struct buffer *trash = get_trash_chunk();
425 struct bind_conf *bind_conf;
426
William Lallemand9a37fd02019-04-12 16:09:24 +0200427 if (frontend) {
428 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200429 struct listener *l;
430
431 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
432 char addr[46];
433 char port[6];
434
William Lallemand620072b2019-04-12 16:09:25 +0200435 /* separate listener by semicolons */
436 if (trash->data)
437 chunk_appendf(trash, ";");
438
Willy Tarreau37159062020-08-27 07:48:42 +0200439 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200440 const struct sockaddr_un *un;
441
Willy Tarreau37159062020-08-27 07:48:42 +0200442 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200443 if (un->sun_path[0] == '\0') {
444 chunk_appendf(trash, "abns@%s", un->sun_path+1);
445 } else {
446 chunk_appendf(trash, "unix@%s", un->sun_path);
447 }
Willy Tarreau37159062020-08-27 07:48:42 +0200448 } else if (l->rx.addr.ss_family == AF_INET) {
449 addr_to_str(&l->rx.addr, addr, sizeof(addr));
450 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200451 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200452 } else if (l->rx.addr.ss_family == AF_INET6) {
453 addr_to_str(&l->rx.addr, addr, sizeof(addr));
454 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200455 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200456 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
457 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200458 }
William Lallemand33d29e22019-04-01 11:30:06 +0200459 }
460 }
461 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200462 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200463 return -1;
464 }
465
466 return 0;
467}
468
William Lallemand9a37fd02019-04-12 16:09:24 +0200469int cli_socket_setenv()
470{
471 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
472 return -1;
473 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
474 return -1;
475
476 return 0;
477}
478
William Lallemand33d29e22019-04-01 11:30:06 +0200479REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
480
Willy Tarreaude57a572016-11-23 17:01:39 +0100481/* Verifies that the CLI at least has a level at least as high as <level>
482 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
483 * failure, an error message is prepared and the appctx's state is adjusted
484 * to print it so that a return 1 is enough to abort any processing.
485 */
486int cli_has_level(struct appctx *appctx, int level)
487{
Willy Tarreaude57a572016-11-23 17:01:39 +0100488
William Lallemandf630d012018-12-13 09:05:44 +0100489 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau9d008692019-08-09 11:21:01 +0200490 cli_err(appctx, stats_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100491 return 0;
492 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100493 return 1;
494}
495
William Lallemandb7ea1412018-12-13 09:05:47 +0100496/* same as cli_has_level but for the CLI proxy and without error message */
497int pcli_has_level(struct stream *s, int level)
498{
499 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
500 return 0;
501 }
502 return 1;
503}
504
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200505/* Returns severity_output for the current session if set, or default for the socket */
506static int cli_get_severity_output(struct appctx *appctx)
507{
508 if (appctx->cli_severity_output)
509 return appctx->cli_severity_output;
510 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
511}
William Lallemand74c24fb2016-11-21 17:18:36 +0100512
Willy Tarreau41908562016-11-24 16:23:38 +0100513/* Processes the CLI interpreter on the stats socket. This function is called
514 * from the CLI's IO handler running in an appctx context. The function returns 1
515 * if the request was understood, otherwise zero. It is called with appctx->st0
516 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
517 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
518 * have its own I/O handler called again. Most of the time, parsers will only
519 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100520 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
521 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100522 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200523static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100524{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200525 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
526 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100527 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100528
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200529 appctx->st2 = 0;
530 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100531
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200532 p = appctx->chunk->area;
533 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100534
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200535 /*
536 * Get the payload start if there is one.
537 * For the sake of simplicity, the payload pattern is looked up
538 * everywhere from the start of the input but it can only be found
539 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
540 *
541 * The input string was zero terminated so it is safe to use
542 * the str*() functions throughout the parsing
543 */
544 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
545 payload = strstr(p, PAYLOAD_PATTERN);
546 end = payload;
547 /* skip the pattern */
548 payload += strlen(PAYLOAD_PATTERN);
549 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100550
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200551 /*
552 * Get pointers on words.
553 * One extra slot is reserved to store a pointer on a null byte.
554 */
555 while (i < MAX_STATS_ARGS && p < end) {
556 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100557
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200558 /* skip leading spaces/tabs */
559 p += strspn(p, " \t");
560 if (!*p)
561 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100562
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200563 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200564 while (1) {
565 p += strcspn(p, " \t\\");
566 /* escaped chars using backlashes (\) */
567 if (*p == '\\') {
568 if (!*++p)
569 break;
570 if (!*++p)
571 break;
572 } else {
573 break;
574 }
575 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200576 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100577
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200578 /* unescape backslashes (\) */
579 for (j = 0, k = 0; args[i][k]; k++) {
580 if (args[i][k] == '\\') {
581 if (args[i][k + 1] == '\\')
582 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100583 else
584 continue;
585 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200586 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 j++;
588 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200589 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100590
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200591 i++;
592 }
593 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200594 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200595 for (; i < MAX_STATS_ARGS + 1; i++)
596 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100597
598 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100599 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100600 return 0;
601
William Lallemand14721be2018-10-26 14:47:37 +0200602 /* in a worker or normal process, don't display master only commands */
William Lallemand99e0bb92020-11-05 10:28:53 +0100603 if (appctx->applet == &cli_applet && (kw->level & ACCESS_MASTER_ONLY))
William Lallemand14721be2018-10-26 14:47:37 +0200604 return 0;
605
606 /* in master don't displays if we don't have the master bits */
William Lallemand99e0bb92020-11-05 10:28:53 +0100607 if (appctx->applet == &mcli_applet && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
William Lallemand14721be2018-10-26 14:47:37 +0200608 return 0;
609
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200610 /* only accept expert commands in expert mode */
611 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
612 return 0;
613
Willy Tarreau41908562016-11-24 16:23:38 +0100614 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200615 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200616
617 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
618 goto fail;
619
620 /* kw->parse could set its own io_handler or io_release handler */
621 if (!appctx->io_handler)
622 goto fail;
623
624 appctx->st0 = CLI_ST_CALLBACK;
625 return 1;
626fail:
627 appctx->io_handler = NULL;
628 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100629 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100630}
631
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200632/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
633static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
634{
Willy Tarreau83061a82018-07-13 11:56:34 +0200635 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200636
637 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200638 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200639
640 tmp = get_trash_chunk();
641 chunk_reset(tmp);
642
643 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100644 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200645 chunk_printf(tmp, "[%d]: ", severity);
646 }
647 else {
648 switch (severity_output) {
649 case CLI_SEVERITY_NUMBER:
650 chunk_printf(tmp, "[%d]: ", severity);
651 break;
652 case CLI_SEVERITY_STRING:
653 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
654 break;
655 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100656 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200657 }
658 }
659 chunk_appendf(tmp, "%s", msg);
660
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200661 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200662}
663
William Lallemand74c24fb2016-11-21 17:18:36 +0100664/* This I/O handler runs as an applet embedded in a stream interface. It is
665 * used to processes I/O from/to the stats unix socket. The system relies on a
666 * state machine handling requests and various responses. We read a request,
667 * then we process it and send the response, and we possibly display a prompt.
668 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100669 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100670 * or not.
671 */
672static void cli_io_handler(struct appctx *appctx)
673{
674 struct stream_interface *si = appctx->owner;
675 struct channel *req = si_oc(si);
676 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200677 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100678 int reql;
679 int len;
680
681 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
682 goto out;
683
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800684 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200685 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100686 /* buf.size==0 means we failed to get a buffer and were
687 * already subscribed to a wait list to get a buffer.
688 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100689 goto out;
690 }
691
William Lallemand74c24fb2016-11-21 17:18:36 +0100692 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100693 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100694 /* Stats output not initialized yet */
695 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200696 /* reset severity to default at init */
697 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100698 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100699 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100700 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100701 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100702 /* Let's close for real now. We just close the request
703 * side, the conditions below will complete if needed.
704 */
705 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200706 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100707 break;
708 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100709 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200710 char *str;
711
712 /* use a trash chunk to store received data */
713 if (!appctx->chunk) {
714 appctx->chunk = alloc_trash_chunk();
715 if (!appctx->chunk) {
716 appctx->st0 = CLI_ST_END;
717 continue;
718 }
719 }
720
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200721 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200722
William Lallemand74c24fb2016-11-21 17:18:36 +0100723 /* ensure we have some output room left in the event we
724 * would want to return some info right after parsing.
725 */
726 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100727 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100728 break;
729 }
730
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200731 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200732 reql = co_getline(si_oc(si), str,
733 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100734 if (reql <= 0) { /* closed or EOL not found */
735 if (reql == 0)
736 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100737 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100738 continue;
739 }
740
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
742 /* seek for a possible unescaped semi-colon. If we find
743 * one, we replace it with an LF and skip only this part.
744 */
745 for (len = 0; len < reql; len++) {
746 if (str[len] == '\\') {
747 len++;
748 continue;
749 }
750 if (str[len] == ';') {
751 str[len] = '\n';
752 reql = len + 1;
753 break;
754 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100755 }
756 }
757
758 /* now it is time to check that we have a full line,
759 * remove the trailing \n and possibly \r, then cut the
760 * line.
761 */
762 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200763 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100764 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100765 continue;
766 }
767
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200768 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100769 len--;
770
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200771 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200772 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200773
774 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200775 appctx->chunk->area[appctx->chunk->data] = '\n';
776 appctx->chunk->area[appctx->chunk->data + 1] = 0;
777 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200778 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100779
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100780 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200781
782 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
783 /* empty line */
784 if (!len) {
785 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200786 appctx->chunk->data -= 2;
787 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200788
789 if (!cli_parse_request(appctx))
790 cli_gen_usage_msg(appctx);
791
792 chunk_reset(appctx->chunk);
793 /* NB: cli_sock_parse_request() may have put
794 * another CLI_ST_O_* into appctx->st0.
795 */
796
797 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100798 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100799 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200800 else {
801 /*
802 * Look for the "payload start" pattern at the end of a line
803 * Its location is not remembered here, this is just to switch
804 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100805 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100806 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200807 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200808 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200809 /* no payload, the command is complete: parse the request */
810 if (!cli_parse_request(appctx))
811 cli_gen_usage_msg(appctx);
812
813 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200814 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100815 }
816
817 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200818 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100819 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
820 }
821 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200822 const char *msg;
823 int sev;
824
William Lallemand74c24fb2016-11-21 17:18:36 +0100825 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100826 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100827 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200828 case CLI_ST_PRINT: /* print const message in msg */
829 case CLI_ST_PRINT_ERR: /* print const error in msg */
830 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
831 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
832 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
833 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
834 LOG_ERR : appctx->ctx.cli.severity;
835 msg = appctx->ctx.cli.msg;
836 }
837 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
838 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
839 LOG_ERR : appctx->ctx.cli.severity;
840 msg = appctx->ctx.cli.err;
841 if (!msg) {
842 sev = LOG_ERR;
843 msg = "Out of memory.\n";
844 }
845 }
846 else {
847 sev = LOG_ERR;
848 msg = "Internal error.\n";
849 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200850
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200851 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
852 if (appctx->st0 == CLI_ST_PRINT_FREE ||
853 appctx->st0 == CLI_ST_PRINT_DYN) {
854 free(appctx->ctx.cli.err);
855 appctx->ctx.cli.err = NULL;
856 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100857 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100858 }
859 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100860 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100861 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200862
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100863 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100864 if (appctx->io_handler)
865 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100866 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100867 if (appctx->io_release) {
868 appctx->io_release(appctx);
869 appctx->io_release = NULL;
870 }
871 }
872 break;
873 default: /* abnormal state */
874 si->flags |= SI_FL_ERR;
875 break;
876 }
877
878 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100879 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200880 const char *prompt = "";
881
882 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
883 /*
884 * when entering a payload with interactive mode, change the prompt
885 * to emphasize that more data can still be sent
886 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200887 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200888 prompt = "+ ";
889 else
890 prompt = "\n> ";
891 }
892 else {
William Lallemandad032882019-07-01 10:56:15 +0200893 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200894 prompt = "\n";
895 }
896
897 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100898 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100899 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100900 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100901 }
902
903 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100904 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100905 break;
906
907 /* Now we close the output if one of the writers did so,
908 * or if we're not in interactive mode and the request
909 * buffer is empty. This still allows pipelined requests
910 * to be sent in non-interactive mode.
911 */
William Lallemand3de09d52018-12-11 16:10:56 +0100912 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
913 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100914 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100915 continue;
916 }
917
918 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100919 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200920 /* reactivate the \n at the end of the response for the next command */
921 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100922 }
923 }
924
925 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
926 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
927 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
928 /* Other side has closed, let's abort if we have no more processing to do
929 * and nothing more to consume. This is comparable to a broken pipe, so
930 * we forward the close to the request side so that it flows upstream to
931 * the client.
932 */
933 si_shutw(si);
934 }
935
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100936 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100937 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
938 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
939 /* We have no more processing to do, and nothing more to send, and
940 * the client side has closed. So we'll forward this state downstream
941 * on the response buffer.
942 */
943 si_shutr(si);
944 res->flags |= CF_READ_NULL;
945 }
946
947 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200948 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 +0100949 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200950 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 +0100951}
952
William Lallemand74c24fb2016-11-21 17:18:36 +0100953/* This is called when the stream interface is closed. For instance, upon an
954 * external abort, we won't call the i/o handler anymore so we may need to
955 * remove back references to the stream currently being dumped.
956 */
957static void cli_release_handler(struct appctx *appctx)
958{
959 if (appctx->io_release) {
960 appctx->io_release(appctx);
961 appctx->io_release = NULL;
962 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200963 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100964 free(appctx->ctx.cli.err);
965 appctx->ctx.cli.err = NULL;
966 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100967}
968
969/* This function dumps all environmnent variables to the buffer. It returns 0
970 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100971 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
972 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100973 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100974static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100975{
Willy Tarreau0a739292016-11-22 20:21:23 +0100976 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100977 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100978
979 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
980 return 1;
981
982 chunk_reset(&trash);
983
984 /* we have two inner loops here, one for the proxy, the other one for
985 * the buffer.
986 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100987 while (*var) {
988 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100989
Willy Tarreau06d80a92017-10-19 14:32:15 +0200990 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100991 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100992 return 0;
993 }
994 if (appctx->st2 == STAT_ST_END)
995 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100996 var++;
997 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100998 }
999
1000 /* dump complete */
1001 return 1;
1002}
1003
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001004/* This function dumps all file descriptors states (or the requested one) to
1005 * the buffer. It returns 0 if the output buffer is full and it needs to be
1006 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1007 * It uses cli.i0 as the fd number to restart from.
1008 */
1009static int cli_io_handler_show_fd(struct appctx *appctx)
1010{
1011 struct stream_interface *si = appctx->owner;
1012 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001013 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001014
1015 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001016 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001017
1018 chunk_reset(&trash);
1019
Willy Tarreauca1b1572018-12-18 15:45:11 +01001020 /* isolate the threads once per round. We're limited to a buffer worth
1021 * of output anyway, it cannot last very long.
1022 */
1023 thread_isolate();
1024
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001025 /* we have two inner loops here, one for the proxy, the other one for
1026 * the buffer.
1027 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001028 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001029 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +02001030 struct listener *li = NULL;
1031 struct server *sv = NULL;
1032 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001033 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001034 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001035 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001036 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001037
1038 fdt = fdtab[fd];
1039
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001040 /* When DEBUG_FD is set, we also report closed FDs that have a
1041 * non-null event count to detect stuck ones.
1042 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001043 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001044#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001045 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001046#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001047 goto skip; // closed
1048 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001049 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001050 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001051 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001052 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001053 li = objt_listener(((struct connection *)fdt.owner)->target);
1054 sv = objt_server(((struct connection *)fdt.owner)->target);
1055 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001056 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001057 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001058 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001059 li = fdt.owner;
1060
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001061 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001062 " %5d : st=0x%02x(R:%c%c W:%c%c) ev=0x%02x(%c%c%c%c%c) [%c%c] tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001063 fd,
1064 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001065 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1066 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001067 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1068 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1069 fdt.ev,
1070 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1071 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1072 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1073 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1074 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001075 fdt.linger_risk ? 'L' : 'l',
1076 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001077 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001078 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001079 fdt.iocb);
1080 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001081
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001082 if (!fdt.owner) {
1083 chunk_appendf(&trash, ")");
1084 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001085 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001086 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001087 if (px)
1088 chunk_appendf(&trash, " px=%s", px->id);
1089 else if (sv)
1090 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1091 else if (li)
1092 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001093
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001094 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001095 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001096 if (mux->show_fd)
1097 mux->show_fd(&trash, fdt.owner);
1098 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001099 else
1100 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001101 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001102 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001103 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001104 listener_state_str(li),
1105 li->bind_conf->frontend->id);
1106 }
1107
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001108#ifdef DEBUG_FD
1109 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
1110#endif
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001111 chunk_appendf(&trash, ")\n");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001112
Willy Tarreau06d80a92017-10-19 14:32:15 +02001113 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001114 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001115 appctx->ctx.cli.i0 = fd;
1116 ret = 0;
1117 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001118 }
1119 skip:
1120 if (appctx->st2 == STAT_ST_END)
1121 break;
1122
1123 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001124 }
1125
Willy Tarreauca1b1572018-12-18 15:45:11 +01001126 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001127 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001128
1129 thread_release();
1130 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001131}
1132
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001133/* This function dumps some activity counters used by developers and support to
1134 * rule out some hypothesis during bug reports. It returns 0 if the output
1135 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1136 * everything at once in the buffer and is not designed to do it in multiple
1137 * passes.
1138 */
1139static int cli_io_handler_show_activity(struct appctx *appctx)
1140{
1141 struct stream_interface *si = appctx->owner;
1142 int thr;
1143
1144 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1145 return 1;
1146
1147 chunk_reset(&trash);
1148
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001149#undef SHOW_TOT
1150#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001151 do { \
1152 unsigned int _v[MAX_THREADS]; \
1153 unsigned int _tot; \
1154 const unsigned int _nbt = global.nbthread; \
1155 for (_tot = t = 0; t < _nbt; t++) \
1156 _tot += _v[t] = (x); \
1157 if (_nbt == 1) { \
1158 chunk_appendf(&trash, " %u\n", _tot); \
1159 break; \
1160 } \
1161 chunk_appendf(&trash, " %u [", _tot); \
1162 for (t = 0; t < _nbt; t++) \
1163 chunk_appendf(&trash, " %u", _v[t]); \
1164 chunk_appendf(&trash, " ]\n"); \
1165 } while (0)
1166
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001167#undef SHOW_AVG
1168#define SHOW_AVG(t, x) \
1169 do { \
1170 unsigned int _v[MAX_THREADS]; \
1171 unsigned int _tot; \
1172 const unsigned int _nbt = global.nbthread; \
1173 for (_tot = t = 0; t < _nbt; t++) \
1174 _tot += _v[t] = (x); \
1175 if (_nbt == 1) { \
1176 chunk_appendf(&trash, " %u\n", _tot); \
1177 break; \
1178 } \
1179 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1180 for (t = 0; t < _nbt; t++) \
1181 chunk_appendf(&trash, " %u", _v[t]); \
1182 chunk_appendf(&trash, " ]\n"); \
1183 } while (0)
1184
Willy Tarreaua0211b82019-05-28 15:09:08 +02001185 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1186 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001187 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1188 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1189 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1190 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001191 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001192 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1193 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001194 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001195 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001196 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1197 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1198 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001199 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001200 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001201 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1202 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001203 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1204 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1205 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1206 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1207 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1208 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1209 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001210#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001211 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 Tarreaub1591322020-06-29 14:17:59 +02001212 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001213#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001214
Willy Tarreaud6a78502019-05-27 07:03:38 +02001215#if defined(DEBUG_DEV)
1216 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001217 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1218 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1219 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001220#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001221
1222 if (ci_putchk(si_ic(si), &trash) == -1) {
1223 chunk_reset(&trash);
1224 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001225 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001226 }
1227
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001228#undef SHOW_AVG
1229#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001230 /* dump complete */
1231 return 1;
1232}
1233
William Lallemandeceddf72016-12-15 18:06:44 +01001234/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001235 * CLI IO handler for `show cli sockets`.
1236 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001237 */
1238static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1239{
1240 struct bind_conf *bind_conf;
1241 struct stream_interface *si = appctx->owner;
1242
1243 chunk_reset(&trash);
1244
1245 switch (appctx->st2) {
1246 case STAT_ST_INIT:
1247 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001248 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001249 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001250 return 0;
1251 }
William Lallemandeceddf72016-12-15 18:06:44 +01001252 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001253 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001254
1255 case STAT_ST_LIST:
1256 if (global.stats_fe) {
1257 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1258 struct listener *l;
1259
1260 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001261 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001262 * if the current node is the first of the list
1263 */
1264
Willy Tarreau3af9d832016-12-16 12:58:09 +01001265 if (appctx->ctx.cli.p0 &&
1266 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001267 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001268 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001269 continue;
1270 }
1271
1272 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1273
1274 char addr[46];
1275 char port[6];
1276
Willy Tarreau37159062020-08-27 07:48:42 +02001277 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001278 const struct sockaddr_un *un;
1279
Willy Tarreau37159062020-08-27 07:48:42 +02001280 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001281 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001282 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001283 } else {
1284 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1285 }
Willy Tarreau37159062020-08-27 07:48:42 +02001286 } else if (l->rx.addr.ss_family == AF_INET) {
1287 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1288 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001289 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001290 } else if (l->rx.addr.ss_family == AF_INET6) {
1291 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1292 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001293 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001294 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1295 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001296 } else
William Lallemand26314342018-10-26 14:47:41 +02001297 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001298
William Lallemand07a62f72017-05-24 00:57:40 +02001299 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001300 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001301 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1302 chunk_appendf(&trash, "operator ");
1303 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1304 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001305 else
1306 chunk_appendf(&trash, " ");
1307
Willy Tarreaue26993c2020-09-03 07:18:55 +02001308 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001309 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001310 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1311 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001312 chunk_appendf(&trash, "%d,", pos+1);
1313 }
1314 }
1315 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001316 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001317
1318 } else {
1319 chunk_appendf(&trash, "all\n");
1320 }
1321
Willy Tarreau06d80a92017-10-19 14:32:15 +02001322 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001323 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001324 return 0;
1325 }
1326 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001327 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001328 }
1329 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001330 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001331 default:
1332 appctx->st2 = STAT_ST_FIN;
1333 return 1;
1334 }
1335}
1336
1337
Willy Tarreau0a739292016-11-22 20:21:23 +01001338/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001339 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1340 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001341 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001342static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001343{
1344 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001345 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001346
1347 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1348 return 1;
1349
Willy Tarreauf6710f82016-12-16 17:45:44 +01001350 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001351
1352 if (*args[2]) {
1353 int len = strlen(args[2]);
1354
Willy Tarreauf6710f82016-12-16 17:45:44 +01001355 for (; *var; var++) {
1356 if (strncmp(*var, args[2], len) == 0 &&
1357 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001358 break;
1359 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001360 if (!*var)
1361 return cli_err(appctx, "Variable not found\n");
1362
Willy Tarreau0a739292016-11-22 20:21:23 +01001363 appctx->st2 = STAT_ST_END;
1364 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001365 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001366 return 0;
1367}
1368
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001369/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1370 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1371 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1372 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001373static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001374{
1375 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1376 return 1;
1377
1378 appctx->ctx.cli.i0 = 0;
1379
1380 if (*args[2]) {
1381 appctx->ctx.cli.i0 = atoi(args[2]);
1382 appctx->st2 = STAT_ST_END;
1383 }
1384 return 0;
1385}
1386
Willy Tarreau599852e2016-11-22 20:33:32 +01001387/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001388static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001389{
1390 struct stream_interface *si = appctx->owner;
1391 struct stream *s = si_strm(si);
1392
1393 if (strcmp(args[2], "cli") == 0) {
1394 unsigned timeout;
1395 const char *res;
1396
Willy Tarreau9d008692019-08-09 11:21:01 +02001397 if (!*args[3])
1398 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001399
1400 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001401 if (res || timeout < 1)
1402 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001403
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 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001408
1409 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001410}
1411
Willy Tarreau2af99412016-11-23 11:10:59 +01001412/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001413static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001414{
1415 int v;
1416
1417 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1418 return 1;
1419
Willy Tarreau9d008692019-08-09 11:21:01 +02001420 if (!*args[3])
1421 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001422
1423 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001424 if (v > global.hardmaxconn)
1425 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001426
1427 /* check for unlimited values */
1428 if (v <= 0)
1429 v = global.hardmaxconn;
1430
1431 global.maxconn = v;
1432
1433 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001434 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001435
1436 return 1;
1437}
1438
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001439static int set_severity_output(int *target, char *argument)
1440{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001441 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001442 *target = CLI_SEVERITY_NONE;
1443 return 1;
1444 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001445 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001446 *target = CLI_SEVERITY_NUMBER;
1447 return 1;
1448 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001449 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001450 *target = CLI_SEVERITY_STRING;
1451 return 1;
1452 }
1453 return 0;
1454}
1455
1456/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001457static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001458{
1459 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1460 return 0;
1461
Willy Tarreau9d008692019-08-09 11:21:01 +02001462 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001463}
William Lallemandeceddf72016-12-15 18:06:44 +01001464
William Lallemand67a234f2018-12-13 09:05:45 +01001465
1466/* show the level of the current CLI session */
1467static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1468{
William Lallemand67a234f2018-12-13 09:05:45 +01001469 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001470 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001471 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001472 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001473 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001474 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001475 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001476 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001477}
1478
1479/* parse and set the CLI level dynamically */
1480static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1481{
William Lallemandad032882019-07-01 10:56:15 +02001482 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001483 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001484 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1485
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001486 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001487 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1488 return 1;
1489 }
1490 appctx->cli_level &= ~ACCESS_LVL_MASK;
1491 appctx->cli_level |= ACCESS_LVL_OPER;
1492
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001493 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001494 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1495 return 1;
1496 }
1497 appctx->cli_level &= ~ACCESS_LVL_MASK;
1498 appctx->cli_level |= ACCESS_LVL_USER;
1499 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001500 appctx->cli_level &= ~ACCESS_EXPERT;
1501 return 1;
1502}
1503
1504
1505/* parse and set the CLI expert-mode dynamically */
1506static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1507{
1508 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1509 return 1;
1510
1511 if (!*args[1])
1512 return (appctx->cli_level & ACCESS_EXPERT)
1513 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1514 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1515
1516 appctx->cli_level &= ~ACCESS_EXPERT;
1517 if (strcmp(args[1], "on") == 0)
1518 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001519 return 1;
1520}
1521
William Lallemanda57b7e32018-12-14 21:11:31 +01001522
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001523int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001524{
1525 return 0;
1526}
1527
Willy Tarreau45c742b2016-11-24 14:51:17 +01001528/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001529static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001530{
1531 int v;
1532 int *res;
1533 int mul = 1;
1534
1535 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1536 return 1;
1537
1538 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1539 res = &global.cps_lim;
1540 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1541 res = &global.sps_lim;
1542#ifdef USE_OPENSSL
1543 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1544 res = &global.ssl_lim;
1545#endif
1546 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1547 res = &global.comp_rate_lim;
1548 mul = 1024;
1549 }
1550 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001551 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001552 "'set rate-limit' only supports :\n"
1553 " - 'connections global' to set the per-process maximum connection rate\n"
1554 " - 'sessions global' to set the per-process maximum session rate\n"
1555#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001556 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001557#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001558 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001559 }
1560
Willy Tarreau9d008692019-08-09 11:21:01 +02001561 if (!*args[4])
1562 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001563
1564 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001565 if (v < 0)
1566 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001567
1568 *res = v * mul;
1569
1570 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001571 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001572
1573 return 1;
1574}
1575
William Lallemandf6975e92017-05-26 17:42:10 +02001576/* parse the "expose-fd" argument on the bind lines */
1577static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1578{
1579 if (!*args[cur_arg + 1]) {
1580 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1581 return ERR_ALERT | ERR_FATAL;
1582 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001583 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001584 conf->level |= ACCESS_FD_LISTENERS;
1585 } else {
1586 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1587 args[cur_arg], args[cur_arg+1]);
1588 return ERR_ALERT | ERR_FATAL;
1589 }
1590
1591 return 0;
1592}
1593
William Lallemand74c24fb2016-11-21 17:18:36 +01001594/* parse the "level" argument on the bind lines */
1595static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1596{
1597 if (!*args[cur_arg + 1]) {
1598 memprintf(err, "'%s' : missing level", args[cur_arg]);
1599 return ERR_ALERT | ERR_FATAL;
1600 }
1601
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001602 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001603 conf->level &= ~ACCESS_LVL_MASK;
1604 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001605 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001606 conf->level &= ~ACCESS_LVL_MASK;
1607 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001608 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001609 conf->level &= ~ACCESS_LVL_MASK;
1610 conf->level |= ACCESS_LVL_ADMIN;
1611 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001612 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1613 args[cur_arg], args[cur_arg+1]);
1614 return ERR_ALERT | ERR_FATAL;
1615 }
1616
1617 return 0;
1618}
1619
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001620static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1621{
1622 if (!*args[cur_arg + 1]) {
1623 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1624 return ERR_ALERT | ERR_FATAL;
1625 }
1626
1627 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1628 return 0;
1629 else {
1630 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1631 args[cur_arg], args[cur_arg+1]);
1632 return ERR_ALERT | ERR_FATAL;
1633 }
1634}
1635
Olivier Houchardf886e342017-04-05 22:24:59 +02001636/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001637static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001638{
1639 char *cmsgbuf = NULL;
1640 unsigned char *tmpbuf = NULL;
1641 struct cmsghdr *cmsg;
1642 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001643 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001644 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001645 struct msghdr msghdr;
1646 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001647 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001648 const char *ns_name, *if_name;
1649 unsigned char ns_nlen, if_nlen;
1650 int nb_queued;
1651 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001652 int *tmpfd;
1653 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001654 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001655 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001656 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001657 int ret;
1658
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001659 if (!remote) {
1660 ha_warning("Only works on real connections\n");
1661 goto out;
1662 }
1663
1664 fd = remote->handle.fd;
1665
Olivier Houchardf886e342017-04-05 22:24:59 +02001666 /* Temporary set the FD in blocking mode, that will make our life easier */
1667 old_fcntl = fcntl(fd, F_GETFL);
1668 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001669 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001670 goto out;
1671 }
1672 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1673 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001674 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001675 goto out;
1676 }
1677 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001678 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001679 goto out;
1680 }
Olivier Houchard54740872017-04-06 14:45:14 +02001681 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001682 iov.iov_base = &tot_fd_nb;
1683 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001684 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001685 goto out;
1686 memset(&msghdr, 0, sizeof(msghdr));
1687 /*
1688 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001689 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001690 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001691 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
1692 tot_fd_nb += fdtab[cur_fd].exported;
William Lallemand5fd3b282020-01-16 15:32:08 +01001693
Olivier Houchardf886e342017-04-05 22:24:59 +02001694 if (tot_fd_nb == 0)
1695 goto out;
1696
1697 /* First send the total number of file descriptors, so that the
1698 * receiving end knows what to expect.
1699 */
1700 msghdr.msg_iov = &iov;
1701 msghdr.msg_iovlen = 1;
1702 ret = sendmsg(fd, &msghdr, 0);
1703 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001704 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001705 goto out;
1706 }
1707
1708 /* Now send the fds */
1709 msghdr.msg_control = cmsgbuf;
1710 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1711 cmsg = CMSG_FIRSTHDR(&msghdr);
1712 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1713 cmsg->cmsg_level = SOL_SOCKET;
1714 cmsg->cmsg_type = SCM_RIGHTS;
1715 tmpfd = (int *)CMSG_DATA(cmsg);
1716
Olivier Houchardf886e342017-04-05 22:24:59 +02001717 /* For each socket, e message is sent, containing the following :
1718 * Size of the namespace name (or 0 if none), as an unsigned char.
1719 * The namespace name, if any
1720 * Size of the interface name (or 0 if none), as an unsigned char
1721 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001722 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001723 */
1724 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001725 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001726 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001727 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001728 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001729 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001730 goto out;
1731 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001732
1733 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001734 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001735 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
1736 if (!(fdtab[cur_fd].exported))
1737 continue;
1738
1739 ns_name = if_name = "";
1740 ns_nlen = if_nlen = 0;
1741
1742 /* for now we can only retrieve namespaces and interfaces from
1743 * pure listeners.
1744 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001745 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001746 const struct listener *l = fdtab[cur_fd].owner;
1747
Willy Tarreau818a92e2020-09-03 07:50:19 +02001748 if (l->rx.settings->interface) {
1749 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001750 if_nlen = strlen(if_name);
1751 }
1752
1753#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001754 if (l->rx.settings->netns) {
1755 ns_name = l->rx.settings->netns->node.key;
1756 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001757 }
1758#endif
1759 }
1760
1761 /* put the FD into the CMSG_DATA */
1762 tmpfd[nb_queued++] = cur_fd;
1763
1764 /* first block is <ns_name_len> <ns_name> */
1765 tmpbuf[curoff++] = ns_nlen;
1766 if (ns_nlen)
1767 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1768 curoff += ns_nlen;
1769
1770 /* second block is <if_name_len> <if_name> */
1771 tmpbuf[curoff++] = if_nlen;
1772 if (if_nlen)
1773 memcpy(tmpbuf + curoff, if_name, if_nlen);
1774 curoff += if_nlen;
1775
1776 /* we used to send the listener options here before 2.3 */
1777 memset(tmpbuf + curoff, 0, sizeof(int));
1778 curoff += sizeof(int);
1779
1780 /* there's a limit to how many FDs may be sent at once */
1781 if (nb_queued == MAX_SEND_FD) {
1782 iov.iov_len = curoff;
1783 if (sendmsg(fd, &msghdr, 0) != curoff) {
1784 ha_warning("Failed to transfer sockets\n");
1785 return -1;
1786 }
1787
1788 /* Wait for an ack */
1789 do {
1790 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
1791 } while (ret == -1 && errno == EINTR);
1792
1793 if (ret <= 0) {
1794 ha_warning("Unexpected error while transferring sockets\n");
1795 return -1;
1796 }
1797 curoff = 0;
1798 nb_queued = 0;
1799 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001800 }
1801
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001802 /* flush pending stuff */
1803 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02001804 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001805 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
1806 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02001807 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001808 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001809 goto out;
1810 }
1811 }
1812
1813out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001814 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001815 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001816 goto out;
1817 }
1818 appctx->st0 = CLI_ST_END;
1819 free(cmsgbuf);
1820 free(tmpbuf);
1821 return 1;
1822}
1823
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001824static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1825{
1826 if (*args[0] == 'h')
1827 /* help */
1828 cli_gen_usage_msg(appctx);
1829 else if (*args[0] == 'p')
1830 /* prompt */
1831 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1832 else if (*args[0] == 'q')
1833 /* quit */
1834 appctx->st0 = CLI_ST_END;
1835
1836 return 1;
1837}
Olivier Houchardf886e342017-04-05 22:24:59 +02001838
William Lallemand2f4ce202018-10-26 14:47:47 +02001839void pcli_write_prompt(struct stream *s)
1840{
1841 struct buffer *msg = get_trash_chunk();
1842 struct channel *oc = si_oc(&s->si[0]);
1843
William Lallemanddc12c2e2018-12-13 09:05:46 +01001844 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001845 return;
1846
William Lallemanddc12c2e2018-12-13 09:05:46 +01001847 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001848 chunk_appendf(msg, "+ ");
1849 } else {
1850 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001851 chunk_appendf(msg, "master%s> ",
1852 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001853 else
1854 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1855 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001856 co_inject(oc, msg->area, msg->data);
1857}
1858
William Lallemand291810d2018-10-26 14:47:38 +02001859
William Lallemandcf62f7e2018-10-26 14:47:40 +02001860/* The pcli_* functions are used for the CLI proxy in the master */
1861
William Lallemanddeeaa592018-10-26 14:47:48 +02001862void pcli_reply_and_close(struct stream *s, const char *msg)
1863{
1864 struct buffer *buf = get_trash_chunk();
1865
1866 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001867 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001868}
1869
William Lallemand291810d2018-10-26 14:47:38 +02001870static enum obj_type *pcli_pid_to_server(int proc_pid)
1871{
1872 struct mworker_proc *child;
1873
William Lallemand99e0bb92020-11-05 10:28:53 +01001874 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01001875 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01001876 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01001877
William Lallemand291810d2018-10-26 14:47:38 +02001878 list_for_each_entry(child, &proc_list, list) {
1879 if (child->pid == proc_pid){
1880 return &child->srv->obj_type;
1881 }
1882 }
1883 return NULL;
1884}
1885
1886/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1887 * Return:
1888 * 0: master
1889 * > 0: pid of a worker
1890 * < 0: didn't find a worker
1891 */
1892static int pcli_prefix_to_pid(const char *prefix)
1893{
1894 int proc_pid;
1895 struct mworker_proc *child;
1896 char *errtol = NULL;
1897
1898 if (*prefix != '@') /* not a prefix, should not happen */
1899 return -1;
1900
1901 prefix++;
1902 if (!*prefix) /* sent @ alone, return the master */
1903 return 0;
1904
1905 if (strcmp("master", prefix) == 0) {
1906 return 0;
1907 } else if (*prefix == '!') {
1908 prefix++;
1909 if (!*prefix)
1910 return -1;
1911
1912 proc_pid = strtol(prefix, &errtol, 10);
1913 if (*errtol != '\0')
1914 return -1;
1915 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001916 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001917 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001918 if (child->pid == proc_pid){
1919 return child->pid;
1920 }
1921 }
1922 } else {
1923 struct mworker_proc *chosen = NULL;
1924 /* this is a relative pid */
1925
1926 proc_pid = strtol(prefix, &errtol, 10);
1927 if (*errtol != '\0')
1928 return -1;
1929
1930 if (proc_pid == 0) /* return the master */
1931 return 0;
1932
1933 /* chose the right process, the current one is the one with the
1934 least number of reloads */
1935 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001936 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001937 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001938 if (child->relative_pid == proc_pid){
1939 if (child->reloads == 0)
1940 return child->pid;
1941 else if (chosen == NULL || child->reloads < chosen->reloads)
1942 chosen = child;
1943 }
1944 }
1945 if (chosen)
1946 return chosen->pid;
1947 }
1948 return -1;
1949}
1950
William Lallemandbddd33a2018-12-11 16:10:53 +01001951/* Return::
1952 * >= 0 : number of words to escape
1953 * = -1 : error
1954 */
1955
1956int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1957{
1958 if (argl < 1)
1959 return 0;
1960
1961 /* there is a prefix */
1962 if (args[0][0] == '@') {
1963 int target_pid = pcli_prefix_to_pid(args[0]);
1964
1965 if (target_pid == -1) {
1966 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1967 return -1;
1968 }
1969
1970 /* if the prefix is alone, define a default target */
1971 if (argl == 1)
1972 s->pcli_next_pid = target_pid;
1973 else
1974 *next_pid = target_pid;
1975 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001976 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001977 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001978 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001979
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001980 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01001981 channel_shutr_now(&s->req);
1982 channel_shutw_now(&s->res);
1983 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001984 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01001985 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1986 memprintf(errmsg, "Permission denied!\n");
1987 return -1;
1988 }
1989 s->pcli_flags &= ~ACCESS_LVL_MASK;
1990 s->pcli_flags |= ACCESS_LVL_OPER;
1991 return argl;
1992
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001993 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01001994 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1995 memprintf(errmsg, "Permission denied!\n");
1996 return -1;
1997 }
1998 s->pcli_flags &= ~ACCESS_LVL_MASK;
1999 s->pcli_flags |= ACCESS_LVL_USER;
2000 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002001 }
2002
2003 return 0;
2004}
2005
2006/*
2007 * Parse the CLI request:
2008 * - It does basically the same as the cli_io_handler, but as a proxy
2009 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002010 *
2011 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002012 * - the number of characters to forward or
2013 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002014 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002015int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002016{
William Lallemandbddd33a2018-12-11 16:10:53 +01002017 char *str = (char *)ci_head(req);
2018 char *end = (char *)ci_stop(req);
2019 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2020 int argl; /* number of args */
2021 char *p;
2022 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002023 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002024 int wtrim = 0; /* number of words to trim */
2025 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002026 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002027 int i = 0;
2028
2029 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002030
William Lallemanddc12c2e2018-12-13 09:05:46 +01002031 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002032
2033 /* Looks for the end of one command */
2034 while (p+reql < end) {
2035 /* handle escaping */
2036 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002037 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002038 continue;
2039 }
2040 if (p[reql] == ';' || p[reql] == '\n') {
2041 /* found the end of the command */
2042 p[reql] = '\n';
2043 reql++;
2044 break;
2045 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002046 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002047 }
William Lallemandebf61802018-12-11 16:10:57 +01002048 } else {
2049 while (p+reql < end) {
2050 if (p[reql] == '\n') {
2051 /* found the end of the line */
2052 reql++;
2053 break;
2054 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002055 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002056 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002057 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002058
William Lallemandbddd33a2018-12-11 16:10:53 +01002059 /* set end to first byte after the end of the command */
2060 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002061
William Lallemandbddd33a2018-12-11 16:10:53 +01002062 /* there is no end to this command, need more to parse ! */
2063 if (*(end-1) != '\n') {
2064 return -1;
2065 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002066
William Lallemand3301f3e2018-12-13 09:05:48 +01002067 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2068 if (reql == 1) /* last line of the payload */
2069 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002070 return reql;
2071 }
2072
William Lallemandbddd33a2018-12-11 16:10:53 +01002073 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002074
William Lallemandbddd33a2018-12-11 16:10:53 +01002075 /* splits the command in words */
2076 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002077 /* skip leading spaces/tabs */
2078 p += strspn(p, " \t");
2079 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002080 break;
2081
William Lallemandbddd33a2018-12-11 16:10:53 +01002082 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002083 while (1) {
2084 p += strcspn(p, " \t\\");
2085 /* escaped chars using backlashes (\) */
2086 if (*p == '\\') {
2087 if (!*++p)
2088 break;
2089 if (!*++p)
2090 break;
2091 } else {
2092 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002093 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002094 }
William Lallemandfe249c32020-06-18 18:03:57 +02002095 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002096 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002097 }
2098
William Lallemandbddd33a2018-12-11 16:10:53 +01002099 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002100
William Lallemandbddd33a2018-12-11 16:10:53 +01002101 for (; i < MAX_STATS_ARGS + 1; i++)
2102 args[i] = NULL;
2103
2104 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2105
2106 /* End of words are ending by \0, we need to replace the \0s by spaces
21071 before forwarding them */
2108 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002109 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002110 if (*p == '\0')
2111 *p = ' ';
2112 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002113 }
2114
William Lallemand3301f3e2018-12-13 09:05:48 +01002115 payload = strstr(str, PAYLOAD_PATTERN);
2116 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2117 /* if the payload pattern is at the end */
2118 s->pcli_flags |= PCLI_F_PAYLOAD;
2119 ret = reql;
2120 }
2121
William Lallemandbddd33a2018-12-11 16:10:53 +01002122 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002123
William Lallemandbddd33a2018-12-11 16:10:53 +01002124 if (wtrim > 0) {
2125 trim = &args[wtrim][0];
2126 if (trim == NULL) /* if this was the last word in the table */
2127 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002128
William Lallemandbddd33a2018-12-11 16:10:53 +01002129 b_del(&req->buf, trim - str);
2130
William Lallemandb7ea1412018-12-13 09:05:47 +01002131 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002132 } else if (wtrim < 0) {
2133 /* parsing error */
2134 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002135 } else {
2136 /* the whole string */
2137 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002138 }
2139
William Lallemandb7ea1412018-12-13 09:05:47 +01002140 if (ret > 1) {
2141 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2142 goto end;
2143 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002144 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2145 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002146 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002147 ci_insert_line2(req, 0, "user -", strlen("user -"));
2148 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002149 }
2150 }
2151end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002152
William Lallemandb7ea1412018-12-13 09:05:47 +01002153 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002154}
2155
2156int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2157{
William Lallemandbddd33a2018-12-11 16:10:53 +01002158 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002159 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002160 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002161
William Lallemandb7ea1412018-12-13 09:05:47 +01002162 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2163 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2164
William Lallemandcf62f7e2018-10-26 14:47:40 +02002165read_again:
2166 /* if the channel is closed for read, we won't receive any more data
2167 from the client, but we don't want to forward this close to the
2168 server */
2169 channel_dont_close(req);
2170
2171 /* We don't know yet to which server we will connect */
2172 channel_dont_connect(req);
2173
2174
2175 /* we are not waiting for a response, there is no more request and we
2176 * receive a close from the client, we can leave */
2177 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2178 channel_shutw_now(&s->res);
2179 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2180 return 1;
2181 }
2182
2183 req->flags |= CF_READ_DONTWAIT;
2184
2185 /* need more data */
2186 if (!ci_data(req))
2187 return 0;
2188
2189 /* If there is data available for analysis, log the end of the idle time. */
2190 if (c_data(req) && s->logs.t_idle == -1)
2191 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2192
William Lallemandbddd33a2018-12-11 16:10:53 +01002193 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002194 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002195 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002196 /* enough data */
2197
William Lallemandcf62f7e2018-10-26 14:47:40 +02002198 /* forward only 1 command */
2199 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002200
William Lallemanddc12c2e2018-12-13 09:05:46 +01002201 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002202 /* we send only 1 command per request, and we write close after it */
2203 channel_shutw_now(req);
2204 } else {
2205 pcli_write_prompt(s);
2206 }
2207
2208 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002209
2210 /* remove the XFER_DATA analysers, which forwards all
2211 * the data, we don't want to forward the next requests
2212 * We need to add CF_FLT_ANALYZE to abort the forward too.
2213 */
2214 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2215 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2216 s->res.analysers |= AN_RES_WAIT_CLI;
2217
William Lallemandebf61802018-12-11 16:10:57 +01002218 if (!(s->flags & SF_ASSIGNED)) {
2219 if (next_pid > -1)
2220 target_pid = next_pid;
2221 else
2222 target_pid = s->pcli_next_pid;
2223 /* we can connect now */
2224 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002225
William Lallemandebf61802018-12-11 16:10:57 +01002226 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2227 channel_auto_connect(req);
2228 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002229
2230 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002231 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002232 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002233 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002234 } else if (to_forward == -1 && errmsg) {
2235 /* there was an error during the parsing */
2236 pcli_reply_and_close(s, errmsg);
2237 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002238 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2239 /* buffer is full and we didn't catch the end of a command */
2240 goto send_help;
2241 }
2242
2243 return 0;
2244
2245send_help:
2246 b_reset(&req->buf);
2247 b_putblk(&req->buf, "help\n", 5);
2248 goto read_again;
2249}
2250
2251int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2252{
2253 struct proxy *fe = strm_fe(s);
2254 struct proxy *be = s->be;
2255
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002256 if (rep->flags & CF_READ_ERROR) {
2257 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2258 s->res.analysers &= ~AN_RES_WAIT_CLI;
2259 return 0;
2260 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002261 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2262 rep->flags |= CF_NEVER_WAIT;
2263
2264 /* don't forward the close */
2265 channel_dont_close(&s->res);
2266 channel_dont_close(&s->req);
2267
William Lallemanddc12c2e2018-12-13 09:05:46 +01002268 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002269 s->req.analysers |= AN_REQ_WAIT_CLI;
2270 s->res.analysers &= ~AN_RES_WAIT_CLI;
2271 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2272 return 0;
2273 }
2274
William Lallemandcf62f7e2018-10-26 14:47:40 +02002275 /* forward the data */
2276 if (ci_data(rep)) {
2277 c_adv(rep, ci_data(rep));
2278 return 0;
2279 }
2280
2281 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2282 /* stream cleanup */
2283
William Lallemand2f4ce202018-10-26 14:47:47 +02002284 pcli_write_prompt(s);
2285
William Lallemandcf62f7e2018-10-26 14:47:40 +02002286 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2287 si_shutr(&s->si[1]);
2288 si_shutw(&s->si[1]);
2289
2290 /*
2291 * starting from there this the same code as
2292 * http_end_txn_clean_session().
2293 *
2294 * It allows to do frontend keepalive while reconnecting to a
2295 * new server for each request.
2296 */
2297
2298 if (s->flags & SF_BE_ASSIGNED) {
2299 HA_ATOMIC_SUB(&be->beconn, 1);
2300 if (unlikely(s->srv_conn))
2301 sess_change_server(s, NULL);
2302 }
2303
2304 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2305 stream_process_counters(s);
2306
2307 /* don't count other requests' data */
2308 s->logs.bytes_in -= ci_data(&s->req);
2309 s->logs.bytes_out -= ci_data(&s->res);
2310
2311 /* we may need to know the position in the queue */
2312 pendconn_free(s);
2313
2314 /* let's do a final log if we need it */
2315 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2316 !(s->flags & SF_MONITOR) &&
2317 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2318 s->do_log(s);
2319 }
2320
2321 /* stop tracking content-based counters */
2322 stream_stop_content_counters(s);
2323 stream_update_time_stats(s);
2324
2325 s->logs.accept_date = date; /* user-visible date for logging */
2326 s->logs.tv_accept = now; /* corrected date for internal use */
2327 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2328 s->logs.t_idle = -1;
2329 tv_zero(&s->logs.tv_request);
2330 s->logs.t_queue = -1;
2331 s->logs.t_connect = -1;
2332 s->logs.t_data = -1;
2333 s->logs.t_close = 0;
2334 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2335 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2336
2337 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2338 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2339
2340 stream_del_srv_conn(s);
2341 if (objt_server(s->target)) {
2342 if (s->flags & SF_CURR_SESS) {
2343 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002344 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002345 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002346 if (may_dequeue_tasks(__objt_server(s->target), be))
2347 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002348 }
2349
2350 s->target = NULL;
2351
2352 /* only release our endpoint if we don't intend to reuse the
2353 * connection.
2354 */
2355 if (!si_conn_ready(&s->si[1])) {
2356 si_release_endpoint(&s->si[1]);
2357 s->srv_conn = NULL;
2358 }
2359
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002360 sockaddr_free(&s->target_addr);
2361
William Lallemandcf62f7e2018-10-26 14:47:40 +02002362 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2363 s->si[1].err_type = SI_ET_NONE;
2364 s->si[1].conn_retries = 0; /* used for logging too */
2365 s->si[1].exp = TICK_ETERNITY;
2366 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet22dc2482019-07-16 14:43:08 +02002367 s->req.flags &= ~(CF_SHUTW|CF_SHUTW_NOW|CF_AUTO_CONNECT|CF_WRITE_ERROR|CF_STREAMER|CF_STREAMER_FAST|CF_NEVER_WAIT|CF_WROTE_DATA);
William Lallemand19338012019-06-25 18:00:19 +02002368 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 +02002369 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2370 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2371 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2372 /* reinitialise the current rule list pointer to NULL. We are sure that
2373 * any rulelist match the NULL pointer.
2374 */
2375 s->current_rule_list = NULL;
2376
2377 s->be = strm_fe(s);
2378 s->logs.logwait = strm_fe(s)->to_log;
2379 s->logs.level = 0;
2380 stream_del_srv_conn(s);
2381 s->target = NULL;
2382 /* re-init store persistence */
2383 s->store_count = 0;
2384 s->uniq_id = global.req_count++;
2385
2386 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2387
2388 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2389
2390 s->req.analysers |= AN_REQ_WAIT_CLI;
2391 s->res.analysers &= ~AN_RES_WAIT_CLI;
2392
2393 /* We must trim any excess data from the response buffer, because we
2394 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002395 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002396 * we want those data to come along with next response. A typical
2397 * example of such data would be from a buggy server responding to
2398 * a HEAD with some data, or sending more than the advertised
2399 * content-length.
2400 */
2401 if (unlikely(ci_data(&s->res)))
2402 b_set_data(&s->res.buf, co_data(&s->res));
2403
2404 /* Now we can realign the response buffer */
2405 c_realign_if_empty(&s->res);
2406
2407 s->req.rto = strm_fe(s)->timeout.client;
2408 s->req.wto = TICK_ETERNITY;
2409
2410 s->res.rto = TICK_ETERNITY;
2411 s->res.wto = strm_fe(s)->timeout.client;
2412
2413 s->req.rex = TICK_ETERNITY;
2414 s->req.wex = TICK_ETERNITY;
2415 s->req.analyse_exp = TICK_ETERNITY;
2416 s->res.rex = TICK_ETERNITY;
2417 s->res.wex = TICK_ETERNITY;
2418 s->res.analyse_exp = TICK_ETERNITY;
2419 s->si[1].hcto = TICK_ETERNITY;
2420
2421 /* we're removing the analysers, we MUST re-enable events detection.
2422 * We don't enable close on the response channel since it's either
2423 * already closed, or in keep-alive with an idle connection handler.
2424 */
2425 channel_auto_read(&s->req);
2426 channel_auto_close(&s->req);
2427 channel_auto_read(&s->res);
2428
2429
2430 return 1;
2431 }
2432 return 0;
2433}
2434
William Lallemand8a022572018-10-26 14:47:35 +02002435/*
2436 * The mworker functions are used to initialize the CLI in the master process
2437 */
2438
William Lallemand309dc9a2018-10-26 14:47:45 +02002439 /*
2440 * Stop the mworker proxy
2441 */
2442void mworker_cli_proxy_stop()
2443{
William Lallemand550db6d2018-11-06 17:37:12 +01002444 if (mworker_proxy)
2445 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002446}
2447
William Lallemand8a022572018-10-26 14:47:35 +02002448/*
2449 * Create the mworker CLI proxy
2450 */
2451int mworker_cli_proxy_create()
2452{
2453 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002454 char *msg = NULL;
2455 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002456
2457 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2458 if (!mworker_proxy)
2459 return -1;
2460
2461 init_new_proxy(mworker_proxy);
2462 mworker_proxy->next = proxies_list;
2463 proxies_list = mworker_proxy;
2464 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002465 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002466 mworker_proxy->last_change = now.tv_sec;
2467 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2468 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2469 mworker_proxy->timeout.client = 0; /* no timeout */
2470 mworker_proxy->conf.file = strdup("MASTER");
2471 mworker_proxy->conf.line = 0;
2472 mworker_proxy->accept = frontend_accept;
2473 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2474
2475 /* Does not init the default target the CLI applet, but must be done in
2476 * the request parsing code */
2477 mworker_proxy->default_target = NULL;
2478
2479 /* the check_config_validity() will get an ID for the proxy */
2480 mworker_proxy->uuid = -1;
2481
2482 proxy_store_name(mworker_proxy);
2483
2484 /* create all servers using the mworker_proc list */
2485 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002486 struct server *newsrv = NULL;
2487 struct sockaddr_storage *sk;
2488 int port1, port2, port;
2489 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002490
William Lallemanda31b09e2020-01-14 15:25:02 +01002491 /* only the workers support the master CLI */
2492 if (!(child->options & PROC_O_TYPE_WORKER))
2493 continue;
2494
William Lallemand8a022572018-10-26 14:47:35 +02002495 newsrv = new_server(mworker_proxy);
2496 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002497 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002498
2499 /* we don't know the new pid yet */
2500 if (child->pid == -1)
2501 memprintf(&msg, "cur-%d", child->relative_pid);
2502 else
2503 memprintf(&msg, "old-%d", child->pid);
2504
2505 newsrv->next = mworker_proxy->srv;
2506 mworker_proxy->srv = newsrv;
2507 newsrv->conf.file = strdup(msg);
2508 newsrv->id = strdup(msg);
2509 newsrv->conf.line = 0;
2510
2511 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002512 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002513 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002514 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002515 }
2516 free(msg);
2517 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002518
Willy Tarreau5fc93282020-09-16 18:25:03 +02002519 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002520 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002521 }
2522
2523 /* no port specified */
2524 newsrv->flags |= SRV_F_MAPPORTS;
2525 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002526 /* don't let the server participate to load balancing */
2527 newsrv->iweight = 0;
2528 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002529 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002530
2531 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002532 }
2533 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002534
2535error:
2536 ha_alert("%s\n", errmsg);
2537
2538 list_for_each_entry(child, &proc_list, list) {
2539 free((char *)child->srv->conf.file); /* cast because of const char * */
2540 free(child->srv->id);
2541 free(child->srv);
2542 child->srv = NULL;
2543 }
2544 free(mworker_proxy->id);
2545 free(mworker_proxy->conf.file);
2546 free(mworker_proxy);
2547 mworker_proxy = NULL;
2548 free(errmsg);
2549 free(msg);
2550
2551 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002552}
Olivier Houchardf886e342017-04-05 22:24:59 +02002553
William Lallemandce83b4a2018-10-26 14:47:30 +02002554/*
William Lallemande7361152018-10-26 14:47:36 +02002555 * Create a new listener for the master CLI proxy
2556 */
2557int mworker_cli_proxy_new_listener(char *line)
2558{
2559 struct bind_conf *bind_conf;
2560 struct listener *l;
2561 char *err = NULL;
2562 char *args[MAX_LINE_ARGS + 1];
2563 int arg;
2564 int cur_arg;
2565
William Lallemand2e945c82019-11-25 09:58:37 +01002566 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002567 args[0] = line;
2568
2569 /* args is a bind configuration with spaces replaced by commas */
2570 while (*line && arg < MAX_LINE_ARGS) {
2571
2572 if (*line == ',') {
2573 *line++ = '\0';
2574 while (*line == ',')
2575 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002576 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002577 }
2578 line++;
2579 }
2580
William Lallemand2e945c82019-11-25 09:58:37 +01002581 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002582
2583 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002584 if (!bind_conf)
2585 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002586
2587 bind_conf->level &= ~ACCESS_LVL_MASK;
2588 bind_conf->level |= ACCESS_LVL_ADMIN;
2589
2590 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2591 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002592 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002593 }
2594
2595 cur_arg = 1;
2596
2597 while (*args[cur_arg]) {
2598 static int bind_dumped;
2599 struct bind_kw *kw;
2600
2601 kw = bind_find_kw(args[cur_arg]);
2602 if (kw) {
2603 if (!kw->parse) {
2604 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2605 args[0], args[1], args[cur_arg]);
2606 goto err;
2607 }
2608
2609 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2610 if (err)
2611 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2612 else
2613 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2614 args[0], args[1], args[cur_arg]);
2615 goto err;
2616 }
2617
2618 cur_arg += 1 + kw->skip;
2619 continue;
2620 }
2621
2622 if (!bind_dumped) {
2623 bind_dump_kws(&err);
2624 indent_msg(&err, 4);
2625 bind_dumped = 1;
2626 }
2627
2628 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2629 args[0], args[1], args[cur_arg],
2630 err ? " Registered keywords :" : "", err ? err : "");
2631 goto err;
2632 }
2633
2634
2635 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002636 l->accept = session_accept_fd;
2637 l->default_target = mworker_proxy->default_target;
2638 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002639 l->options |= LI_O_UNLIMITED;
2640 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002641 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002642 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002643 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002644 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002645
2646 return 0;
2647
2648err:
2649 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002650 free(err);
2651 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002652 return -1;
2653
2654}
2655
2656/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002657 * Create a new CLI socket using a socketpair for a worker process
2658 * <mworker_proc> is the process structure, and <proc> is the process number
2659 */
2660int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2661{
2662 struct bind_conf *bind_conf;
2663 struct listener *l;
2664 char *path = NULL;
2665 char *err = NULL;
2666
2667 /* master pipe to ensure the master is still alive */
2668 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2669 ha_alert("Cannot create worker socketpair.\n");
2670 return -1;
2671 }
2672
2673 /* XXX: we might want to use a separate frontend at some point */
2674 if (!global.stats_fe) {
2675 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2676 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002677 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002678 }
2679 }
2680
2681 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002682 if (!bind_conf)
2683 goto error;
2684
William Lallemandce83b4a2018-10-26 14:47:30 +02002685 bind_conf->level &= ~ACCESS_LVL_MASK;
2686 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2687
Willy Tarreaue26993c2020-09-03 07:18:55 +02002688 bind_conf->settings.bind_proc = 1UL << proc;
William Lallemandce83b4a2018-10-26 14:47:30 +02002689 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2690
2691 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2692 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002693 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002694 }
2695
2696 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002697 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002698 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002699 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002700 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002701 free(path);
2702 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002703
2704 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002705 l->accept = session_accept_fd;
2706 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002707 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau455585e2020-10-09 18:25:14 +02002708 HA_ATOMIC_ADD(&unstoppable_jobs, 1);
William Lallemandce83b4a2018-10-26 14:47:30 +02002709 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002710 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002711 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002712 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002713 }
2714
2715 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002716
2717error:
2718 close(mworker_proc->ipc_fd[0]);
2719 close(mworker_proc->ipc_fd[1]);
2720 free(err);
2721
2722 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002723}
2724
William Lallemand74c24fb2016-11-21 17:18:36 +01002725static struct applet cli_applet = {
2726 .obj_type = OBJ_TYPE_APPLET,
2727 .name = "<CLI>", /* used for logging */
2728 .fct = cli_io_handler,
2729 .release = cli_release_handler,
2730};
2731
William Lallemand99e0bb92020-11-05 10:28:53 +01002732/* master CLI */
2733static struct applet mcli_applet = {
2734 .obj_type = OBJ_TYPE_APPLET,
2735 .name = "<MCLI>", /* used for logging */
2736 .fct = cli_io_handler,
2737 .release = cli_release_handler,
2738};
2739
Willy Tarreau0a739292016-11-22 20:21:23 +01002740/* register cli keywords */
2741static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002742 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2743 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2744 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002745 { { "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 +01002746 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002747 { { "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 +01002748 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002749 { { "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 +02002750 { { "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 +01002751 { { "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 +02002752 { { "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 +01002753 { { "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 +01002754 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2755 { { "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 +02002756 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002757 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002758 {{},}
2759}};
2760
Willy Tarreau0108d902018-11-25 19:14:37 +01002761INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2762
William Lallemand74c24fb2016-11-21 17:18:36 +01002763static struct cfg_kw_list cfg_kws = {ILH, {
2764 { CFG_GLOBAL, "stats", stats_parse_global },
2765 { 0, NULL, NULL },
2766}};
2767
Willy Tarreau0108d902018-11-25 19:14:37 +01002768INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2769
William Lallemand74c24fb2016-11-21 17:18:36 +01002770static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002771 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2772 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002773 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002774 { NULL, NULL, 0 },
2775}};
2776
Willy Tarreau0108d902018-11-25 19:14:37 +01002777INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002778
2779/*
2780 * Local variables:
2781 * c-indent-level: 8
2782 * c-basic-offset: 8
2783 * End:
2784 */