blob: 2460e53ff16a633b22cf4c39a1cc78286c3eabf5 [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
Eric Salama2af5bc42021-03-16 15:12:17 +010092struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +020093
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 Fournierb2239a72020-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
267 if (!strcmp(args[1], "socket")) {
268 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 }
338 else if (!strcmp(args[1], "timeout")) {
339 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 }
369 else if (!strcmp(args[1], "maxconn")) {
370 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 }
385 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
386 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);
Willy Tarreaubfca7372021-05-04 16:27:45 +0200707 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100708 break;
709 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100710 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200711 char *str;
712
713 /* use a trash chunk to store received data */
714 if (!appctx->chunk) {
715 appctx->chunk = alloc_trash_chunk();
716 if (!appctx->chunk) {
717 appctx->st0 = CLI_ST_END;
718 continue;
719 }
720 }
721
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200722 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200723
William Lallemand74c24fb2016-11-21 17:18:36 +0100724 /* ensure we have some output room left in the event we
725 * would want to return some info right after parsing.
726 */
727 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100728 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100729 break;
730 }
731
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200732 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200733 reql = co_getline(si_oc(si), str,
734 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100735 if (reql <= 0) { /* closed or EOL not found */
736 if (reql == 0)
737 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100738 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100739 continue;
740 }
741
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
743 /* seek for a possible unescaped semi-colon. If we find
744 * one, we replace it with an LF and skip only this part.
745 */
746 for (len = 0; len < reql; len++) {
747 if (str[len] == '\\') {
748 len++;
749 continue;
750 }
751 if (str[len] == ';') {
752 str[len] = '\n';
753 reql = len + 1;
754 break;
755 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100756 }
757 }
758
759 /* now it is time to check that we have a full line,
760 * remove the trailing \n and possibly \r, then cut the
761 * line.
762 */
763 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200764 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100765 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100766 continue;
767 }
768
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200769 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100770 len--;
771
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200772 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200773 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200774
775 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200776 appctx->chunk->area[appctx->chunk->data] = '\n';
777 appctx->chunk->area[appctx->chunk->data + 1] = 0;
778 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200779 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100780
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100781 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200782
783 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
784 /* empty line */
785 if (!len) {
786 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200787 appctx->chunk->data -= 2;
788 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200789
790 if (!cli_parse_request(appctx))
791 cli_gen_usage_msg(appctx);
792
793 chunk_reset(appctx->chunk);
794 /* NB: cli_sock_parse_request() may have put
795 * another CLI_ST_O_* into appctx->st0.
796 */
797
798 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100799 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100800 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200801 else {
802 /*
803 * Look for the "payload start" pattern at the end of a line
804 * Its location is not remembered here, this is just to switch
805 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100806 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200807 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200808 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200809 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200810 /* no payload, the command is complete: parse the request */
811 if (!cli_parse_request(appctx))
812 cli_gen_usage_msg(appctx);
813
814 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200815 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100816 }
817
818 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200819 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100820 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
821 }
822 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200823 const char *msg;
824 int sev;
825
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100827 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100828 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200829 case CLI_ST_PRINT: /* print const message in msg */
830 case CLI_ST_PRINT_ERR: /* print const error in msg */
831 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
832 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
833 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
834 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
835 LOG_ERR : appctx->ctx.cli.severity;
836 msg = appctx->ctx.cli.msg;
837 }
838 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
839 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
840 LOG_ERR : appctx->ctx.cli.severity;
841 msg = appctx->ctx.cli.err;
842 if (!msg) {
843 sev = LOG_ERR;
844 msg = "Out of memory.\n";
845 }
846 }
847 else {
848 sev = LOG_ERR;
849 msg = "Internal error.\n";
850 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200851
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200852 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
853 if (appctx->st0 == CLI_ST_PRINT_FREE ||
854 appctx->st0 == CLI_ST_PRINT_DYN) {
855 free(appctx->ctx.cli.err);
856 appctx->ctx.cli.err = NULL;
857 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100858 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100859 }
860 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100861 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100862 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200863
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100864 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100865 if (appctx->io_handler)
866 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100867 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100868 if (appctx->io_release) {
869 appctx->io_release(appctx);
870 appctx->io_release = NULL;
871 }
872 }
873 break;
874 default: /* abnormal state */
875 si->flags |= SI_FL_ERR;
876 break;
877 }
878
879 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100880 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200881 const char *prompt = "";
882
883 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
884 /*
885 * when entering a payload with interactive mode, change the prompt
886 * to emphasize that more data can still be sent
887 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200888 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200889 prompt = "+ ";
890 else
891 prompt = "\n> ";
892 }
893 else {
William Lallemandad032882019-07-01 10:56:15 +0200894 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200895 prompt = "\n";
896 }
897
898 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100899 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100900 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100901 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100902 }
903
904 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100905 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100906 break;
907
908 /* Now we close the output if one of the writers did so,
909 * or if we're not in interactive mode and the request
910 * buffer is empty. This still allows pipelined requests
911 * to be sent in non-interactive mode.
912 */
William Lallemand3de09d52018-12-11 16:10:56 +0100913 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
914 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100915 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100916 continue;
917 }
918
919 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100920 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200921 /* reactivate the \n at the end of the response for the next command */
922 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100923 }
924 }
925
926 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
927 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
928 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
929 /* Other side has closed, let's abort if we have no more processing to do
930 * and nothing more to consume. This is comparable to a broken pipe, so
931 * we forward the close to the request side so that it flows upstream to
932 * the client.
933 */
934 si_shutw(si);
935 }
936
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100937 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100938 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
939 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
940 /* We have no more processing to do, and nothing more to send, and
941 * the client side has closed. So we'll forward this state downstream
942 * on the response buffer.
943 */
944 si_shutr(si);
945 res->flags |= CF_READ_NULL;
946 }
947
948 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200949 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 +0100950 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200951 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 +0100952}
953
William Lallemand74c24fb2016-11-21 17:18:36 +0100954/* This is called when the stream interface is closed. For instance, upon an
955 * external abort, we won't call the i/o handler anymore so we may need to
956 * remove back references to the stream currently being dumped.
957 */
958static void cli_release_handler(struct appctx *appctx)
959{
Willy Tarreaubfca7372021-05-04 16:27:45 +0200960 free_trash_chunk(appctx->chunk);
961 appctx->chunk = NULL;
962
William Lallemand74c24fb2016-11-21 17:18:36 +0100963 if (appctx->io_release) {
964 appctx->io_release(appctx);
965 appctx->io_release = NULL;
966 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200967 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100968 free(appctx->ctx.cli.err);
969 appctx->ctx.cli.err = NULL;
970 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100971}
972
973/* This function dumps all environmnent variables to the buffer. It returns 0
974 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100975 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
976 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100977 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100978static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100979{
Willy Tarreau0a739292016-11-22 20:21:23 +0100980 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100981 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100982
983 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
984 return 1;
985
986 chunk_reset(&trash);
987
988 /* we have two inner loops here, one for the proxy, the other one for
989 * the buffer.
990 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100991 while (*var) {
992 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100993
Willy Tarreau06d80a92017-10-19 14:32:15 +0200994 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100995 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100996 return 0;
997 }
998 if (appctx->st2 == STAT_ST_END)
999 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001000 var++;
1001 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001002 }
1003
1004 /* dump complete */
1005 return 1;
1006}
1007
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001008/* This function dumps all file descriptors states (or the requested one) to
1009 * the buffer. It returns 0 if the output buffer is full and it needs to be
1010 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1011 * It uses cli.i0 as the fd number to restart from.
1012 */
1013static int cli_io_handler_show_fd(struct appctx *appctx)
1014{
1015 struct stream_interface *si = appctx->owner;
1016 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001017 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001018
1019 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001020 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001021
1022 chunk_reset(&trash);
1023
Willy Tarreauca1b1572018-12-18 15:45:11 +01001024 /* isolate the threads once per round. We're limited to a buffer worth
1025 * of output anyway, it cannot last very long.
1026 */
1027 thread_isolate();
1028
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001029 /* we have two inner loops here, one for the proxy, the other one for
1030 * the buffer.
1031 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001032 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001033 struct fdtab fdt;
Willy Tarreau7f4973e2021-01-20 14:13:46 +01001034 const struct listener *li = NULL;
1035 const struct server *sv = NULL;
1036 const struct proxy *px = NULL;
1037 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001038 const struct mux_ops *mux = NULL;
Willy Tarreau48733842021-01-20 14:40:04 +01001039 const struct xprt_ops *xprt = NULL;
Willy Tarreau7f4973e2021-01-20 14:13:46 +01001040 const void *ctx = NULL;
Willy Tarreau48733842021-01-20 14:40:04 +01001041 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001042 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001043 int is_back = 0;
Willy Tarreau6cb467e2021-01-21 08:26:06 +01001044 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001045
1046 fdt = fdtab[fd];
1047
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001048 /* When DEBUG_FD is set, we also report closed FDs that have a
1049 * non-null event count to detect stuck ones.
1050 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001051 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001052#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001053 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001054#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001055 goto skip; // closed
1056 }
1057 else if (fdt.iocb == conn_fd_handler) {
Willy Tarreau7f4973e2021-01-20 14:13:46 +01001058 conn = (const struct connection *)fdt.owner;
1059 conn_flags = conn->flags;
1060 mux = conn->mux;
1061 ctx = conn->ctx;
Willy Tarreau48733842021-01-20 14:40:04 +01001062 xprt = conn->xprt;
1063 xprt_ctx = conn->xprt_ctx;
Willy Tarreau7f4973e2021-01-20 14:13:46 +01001064 li = objt_listener(conn->target);
1065 sv = objt_server(conn->target);
1066 px = objt_proxy(conn->target);
1067 is_back = conn_is_back(conn);
Willy Tarreau9e177142021-01-21 09:07:29 +01001068 if (atleast2(fdt.thread_mask))
1069 suspicious = 1;
1070 if (conn->handle.fd != fd)
1071 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001072 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001073 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001074 li = fdt.owner;
1075
Willy Tarreau9e177142021-01-21 09:07:29 +01001076 if (!fdt.thread_mask)
1077 suspicious = 1;
1078
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001079 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001080 " %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 +02001081 fd,
1082 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001083 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1084 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001085 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1086 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1087 fdt.ev,
1088 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1089 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1090 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1091 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1092 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001093 fdt.linger_risk ? 'L' : 'l',
1094 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001095 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001096 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001097 fdt.iocb);
1098 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001099
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001100 if (!fdt.owner) {
1101 chunk_appendf(&trash, ")");
1102 }
1103 else if (fdt.iocb == conn_fd_handler) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001104 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau9e177142021-01-21 09:07:29 +01001105
1106 if (conn->handle.fd != fd) {
1107 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1108 suspicious = 1;
Willy Tarreau21129142021-02-05 10:54:52 +01001109 } else {
1110 struct sockaddr_storage sa;
1111 socklen_t salen;
1112
1113 salen = sizeof(sa);
1114 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1115 if (sa.ss_family == AF_INET)
1116 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1117 else if (sa.ss_family == AF_INET6)
1118 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1119 else if (sa.ss_family == AF_UNIX)
1120 chunk_appendf(&trash, " fam=unix");
1121 }
1122
1123 salen = sizeof(sa);
1124 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1125 if (sa.ss_family == AF_INET)
1126 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1127 else if (sa.ss_family == AF_INET6)
1128 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1129 }
Willy Tarreau9e177142021-01-21 09:07:29 +01001130 }
1131
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001132 if (px)
1133 chunk_appendf(&trash, " px=%s", px->id);
1134 else if (sv)
1135 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1136 else if (li)
1137 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001138
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001139 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001140 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreau9e177142021-01-21 09:07:29 +01001141 if (!ctx)
1142 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001143 if (mux->show_fd)
Willy Tarreau6cb467e2021-01-21 08:26:06 +01001144 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001145 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001146 else
1147 chunk_appendf(&trash, " nomux");
Willy Tarreau48733842021-01-20 14:40:04 +01001148
1149 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreaue0150e72021-01-20 15:30:56 +01001150 if (xprt) {
1151 if (xprt_ctx || xprt->show_fd)
1152 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1153 if (xprt->show_fd)
Willy Tarreau6cb467e2021-01-21 08:26:06 +01001154 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreaue0150e72021-01-20 15:30:56 +01001155 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001156 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001157 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreau21129142021-02-05 10:54:52 +01001158 struct sockaddr_storage sa;
1159 socklen_t salen;
1160
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001161 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001162 listener_state_str(li),
1163 li->bind_conf->frontend->id);
Willy Tarreau21129142021-02-05 10:54:52 +01001164
1165 salen = sizeof(sa);
1166 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1167 if (sa.ss_family == AF_INET)
1168 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1169 else if (sa.ss_family == AF_INET6)
1170 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1171 else if (sa.ss_family == AF_UNIX)
1172 chunk_appendf(&trash, " fam=unix");
1173 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001174 }
Willy Tarreau7f4973e2021-01-20 14:13:46 +01001175 else
1176 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001177
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001178#ifdef DEBUG_FD
1179 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreau9e177142021-01-21 09:07:29 +01001180 if (fdtab[fd].event_count >= 1000000)
1181 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001182#endif
Willy Tarreau6cb467e2021-01-21 08:26:06 +01001183 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001184
Willy Tarreau06d80a92017-10-19 14:32:15 +02001185 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001186 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001187 appctx->ctx.cli.i0 = fd;
1188 ret = 0;
1189 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001190 }
1191 skip:
1192 if (appctx->st2 == STAT_ST_END)
1193 break;
1194
1195 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001196 }
1197
Willy Tarreauca1b1572018-12-18 15:45:11 +01001198 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001199 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001200
1201 thread_release();
1202 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001203}
1204
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001205/* This function dumps some activity counters used by developers and support to
1206 * rule out some hypothesis during bug reports. It returns 0 if the output
1207 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1208 * everything at once in the buffer and is not designed to do it in multiple
1209 * passes.
1210 */
1211static int cli_io_handler_show_activity(struct appctx *appctx)
1212{
1213 struct stream_interface *si = appctx->owner;
1214 int thr;
1215
1216 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1217 return 1;
1218
1219 chunk_reset(&trash);
1220
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001221#undef SHOW_TOT
1222#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001223 do { \
1224 unsigned int _v[MAX_THREADS]; \
1225 unsigned int _tot; \
1226 const unsigned int _nbt = global.nbthread; \
1227 for (_tot = t = 0; t < _nbt; t++) \
1228 _tot += _v[t] = (x); \
1229 if (_nbt == 1) { \
1230 chunk_appendf(&trash, " %u\n", _tot); \
1231 break; \
1232 } \
1233 chunk_appendf(&trash, " %u [", _tot); \
1234 for (t = 0; t < _nbt; t++) \
1235 chunk_appendf(&trash, " %u", _v[t]); \
1236 chunk_appendf(&trash, " ]\n"); \
1237 } while (0)
1238
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001239#undef SHOW_AVG
1240#define SHOW_AVG(t, x) \
1241 do { \
1242 unsigned int _v[MAX_THREADS]; \
1243 unsigned int _tot; \
1244 const unsigned int _nbt = global.nbthread; \
1245 for (_tot = t = 0; t < _nbt; t++) \
1246 _tot += _v[t] = (x); \
1247 if (_nbt == 1) { \
1248 chunk_appendf(&trash, " %u\n", _tot); \
1249 break; \
1250 } \
1251 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1252 for (t = 0; t < _nbt; t++) \
1253 chunk_appendf(&trash, " %u", _v[t]); \
1254 chunk_appendf(&trash, " ]\n"); \
1255 } while (0)
1256
Willy Tarreaua0211b82019-05-28 15:09:08 +02001257 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1258 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001259 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1260 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1261 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1262 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001263 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001264 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1265 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001266 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001267 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001268 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1269 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1270 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001271 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001272 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001273 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1274 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001275 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1276 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1277 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1278 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1279 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1280 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1281 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001282#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001283 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 +02001284 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001285#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001286
Willy Tarreaud6a78502019-05-27 07:03:38 +02001287#if defined(DEBUG_DEV)
1288 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001289 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1290 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1291 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001292#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001293
1294 if (ci_putchk(si_ic(si), &trash) == -1) {
1295 chunk_reset(&trash);
1296 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001297 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001298 }
1299
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001300#undef SHOW_AVG
1301#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001302 /* dump complete */
1303 return 1;
1304}
1305
William Lallemandeceddf72016-12-15 18:06:44 +01001306/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001307 * CLI IO handler for `show cli sockets`.
1308 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001309 */
1310static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1311{
1312 struct bind_conf *bind_conf;
1313 struct stream_interface *si = appctx->owner;
1314
1315 chunk_reset(&trash);
1316
1317 switch (appctx->st2) {
1318 case STAT_ST_INIT:
1319 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001320 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001321 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001322 return 0;
1323 }
William Lallemandeceddf72016-12-15 18:06:44 +01001324 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001325 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001326
1327 case STAT_ST_LIST:
1328 if (global.stats_fe) {
1329 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1330 struct listener *l;
1331
1332 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001333 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001334 * if the current node is the first of the list
1335 */
1336
Willy Tarreau3af9d832016-12-16 12:58:09 +01001337 if (appctx->ctx.cli.p0 &&
1338 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001339 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001340 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001341 continue;
1342 }
1343
1344 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1345
1346 char addr[46];
1347 char port[6];
1348
Willy Tarreau37159062020-08-27 07:48:42 +02001349 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001350 const struct sockaddr_un *un;
1351
Willy Tarreau37159062020-08-27 07:48:42 +02001352 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001353 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001354 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001355 } else {
1356 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1357 }
Willy Tarreau37159062020-08-27 07:48:42 +02001358 } else if (l->rx.addr.ss_family == AF_INET) {
1359 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1360 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001361 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001362 } else if (l->rx.addr.ss_family == AF_INET6) {
1363 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1364 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001365 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001366 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1367 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001368 } else
William Lallemand26314342018-10-26 14:47:41 +02001369 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001370
William Lallemand07a62f72017-05-24 00:57:40 +02001371 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001372 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001373 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1374 chunk_appendf(&trash, "operator ");
1375 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1376 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001377 else
1378 chunk_appendf(&trash, " ");
1379
Willy Tarreaue26993c2020-09-03 07:18:55 +02001380 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001381 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001382 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1383 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001384 chunk_appendf(&trash, "%d,", pos+1);
1385 }
1386 }
1387 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001388 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001389
1390 } else {
1391 chunk_appendf(&trash, "all\n");
1392 }
1393
Willy Tarreau06d80a92017-10-19 14:32:15 +02001394 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001395 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001396 return 0;
1397 }
1398 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001399 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001400 }
1401 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001402 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001403 default:
1404 appctx->st2 = STAT_ST_FIN;
1405 return 1;
1406 }
1407}
1408
1409
Willy Tarreau0a739292016-11-22 20:21:23 +01001410/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001411 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1412 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001413 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001414static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001415{
1416 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001417 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001418
1419 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1420 return 1;
1421
Willy Tarreauf6710f82016-12-16 17:45:44 +01001422 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001423
1424 if (*args[2]) {
1425 int len = strlen(args[2]);
1426
Willy Tarreauf6710f82016-12-16 17:45:44 +01001427 for (; *var; var++) {
1428 if (strncmp(*var, args[2], len) == 0 &&
1429 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001430 break;
1431 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001432 if (!*var)
1433 return cli_err(appctx, "Variable not found\n");
1434
Willy Tarreau0a739292016-11-22 20:21:23 +01001435 appctx->st2 = STAT_ST_END;
1436 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001437 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001438 return 0;
1439}
1440
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001441/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1442 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1443 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1444 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001445static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001446{
1447 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1448 return 1;
1449
1450 appctx->ctx.cli.i0 = 0;
1451
1452 if (*args[2]) {
1453 appctx->ctx.cli.i0 = atoi(args[2]);
1454 appctx->st2 = STAT_ST_END;
1455 }
1456 return 0;
1457}
1458
Willy Tarreau599852e2016-11-22 20:33:32 +01001459/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001460static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001461{
1462 struct stream_interface *si = appctx->owner;
1463 struct stream *s = si_strm(si);
1464
1465 if (strcmp(args[2], "cli") == 0) {
1466 unsigned timeout;
1467 const char *res;
1468
Willy Tarreau9d008692019-08-09 11:21:01 +02001469 if (!*args[3])
1470 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001471
1472 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001473 if (res || timeout < 1)
1474 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001475
1476 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1477 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1478 return 1;
1479 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001480
1481 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001482}
1483
Willy Tarreau2af99412016-11-23 11:10:59 +01001484/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001485static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001486{
1487 int v;
1488
1489 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1490 return 1;
1491
Willy Tarreau9d008692019-08-09 11:21:01 +02001492 if (!*args[3])
1493 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001494
1495 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001496 if (v > global.hardmaxconn)
1497 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001498
1499 /* check for unlimited values */
1500 if (v <= 0)
1501 v = global.hardmaxconn;
1502
1503 global.maxconn = v;
1504
1505 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001506 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001507
1508 return 1;
1509}
1510
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001511static int set_severity_output(int *target, char *argument)
1512{
1513 if (!strcmp(argument, "none")) {
1514 *target = CLI_SEVERITY_NONE;
1515 return 1;
1516 }
1517 else if (!strcmp(argument, "number")) {
1518 *target = CLI_SEVERITY_NUMBER;
1519 return 1;
1520 }
1521 else if (!strcmp(argument, "string")) {
1522 *target = CLI_SEVERITY_STRING;
1523 return 1;
1524 }
1525 return 0;
1526}
1527
1528/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001529static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001530{
1531 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1532 return 0;
1533
Willy Tarreau9d008692019-08-09 11:21:01 +02001534 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001535}
William Lallemandeceddf72016-12-15 18:06:44 +01001536
William Lallemand67a234f2018-12-13 09:05:45 +01001537
1538/* show the level of the current CLI session */
1539static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1540{
William Lallemand67a234f2018-12-13 09:05:45 +01001541 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001542 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001543 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001544 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001545 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001546 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001547 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001548 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001549}
1550
1551/* parse and set the CLI level dynamically */
1552static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1553{
William Lallemandad032882019-07-01 10:56:15 +02001554 /* this will ask the applet to not output a \n after the command */
1555 if (!strcmp(args[1], "-"))
1556 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1557
William Lallemand67a234f2018-12-13 09:05:45 +01001558 if (!strcmp(args[0], "operator")) {
1559 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1560 return 1;
1561 }
1562 appctx->cli_level &= ~ACCESS_LVL_MASK;
1563 appctx->cli_level |= ACCESS_LVL_OPER;
1564
1565 } else if (!strcmp(args[0], "user")) {
1566 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1567 return 1;
1568 }
1569 appctx->cli_level &= ~ACCESS_LVL_MASK;
1570 appctx->cli_level |= ACCESS_LVL_USER;
1571 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001572 appctx->cli_level &= ~ACCESS_EXPERT;
1573 return 1;
1574}
1575
1576
1577/* parse and set the CLI expert-mode dynamically */
1578static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1579{
1580 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1581 return 1;
1582
1583 if (!*args[1])
1584 return (appctx->cli_level & ACCESS_EXPERT)
1585 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1586 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1587
1588 appctx->cli_level &= ~ACCESS_EXPERT;
1589 if (strcmp(args[1], "on") == 0)
1590 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001591 return 1;
1592}
1593
William Lallemanda57b7e32018-12-14 21:11:31 +01001594
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001595int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001596{
1597 return 0;
1598}
1599
Willy Tarreau45c742b2016-11-24 14:51:17 +01001600/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001601static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001602{
1603 int v;
1604 int *res;
1605 int mul = 1;
1606
1607 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1608 return 1;
1609
1610 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1611 res = &global.cps_lim;
1612 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1613 res = &global.sps_lim;
1614#ifdef USE_OPENSSL
1615 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1616 res = &global.ssl_lim;
1617#endif
1618 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1619 res = &global.comp_rate_lim;
1620 mul = 1024;
1621 }
1622 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001623 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001624 "'set rate-limit' only supports :\n"
1625 " - 'connections global' to set the per-process maximum connection rate\n"
1626 " - 'sessions global' to set the per-process maximum session rate\n"
1627#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001628 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001629#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001630 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001631 }
1632
Willy Tarreau9d008692019-08-09 11:21:01 +02001633 if (!*args[4])
1634 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001635
1636 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001637 if (v < 0)
1638 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001639
1640 *res = v * mul;
1641
1642 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001643 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001644
1645 return 1;
1646}
1647
William Lallemandf6975e92017-05-26 17:42:10 +02001648/* parse the "expose-fd" argument on the bind lines */
1649static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1650{
1651 if (!*args[cur_arg + 1]) {
1652 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1653 return ERR_ALERT | ERR_FATAL;
1654 }
1655 if (!strcmp(args[cur_arg+1], "listeners")) {
1656 conf->level |= ACCESS_FD_LISTENERS;
1657 } else {
1658 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1659 args[cur_arg], args[cur_arg+1]);
1660 return ERR_ALERT | ERR_FATAL;
1661 }
1662
1663 return 0;
1664}
1665
William Lallemand74c24fb2016-11-21 17:18:36 +01001666/* parse the "level" argument on the bind lines */
1667static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1668{
1669 if (!*args[cur_arg + 1]) {
1670 memprintf(err, "'%s' : missing level", args[cur_arg]);
1671 return ERR_ALERT | ERR_FATAL;
1672 }
1673
William Lallemand07a62f72017-05-24 00:57:40 +02001674 if (!strcmp(args[cur_arg+1], "user")) {
1675 conf->level &= ~ACCESS_LVL_MASK;
1676 conf->level |= ACCESS_LVL_USER;
1677 } else if (!strcmp(args[cur_arg+1], "operator")) {
1678 conf->level &= ~ACCESS_LVL_MASK;
1679 conf->level |= ACCESS_LVL_OPER;
1680 } else if (!strcmp(args[cur_arg+1], "admin")) {
1681 conf->level &= ~ACCESS_LVL_MASK;
1682 conf->level |= ACCESS_LVL_ADMIN;
1683 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001684 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1685 args[cur_arg], args[cur_arg+1]);
1686 return ERR_ALERT | ERR_FATAL;
1687 }
1688
1689 return 0;
1690}
1691
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001692static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1693{
1694 if (!*args[cur_arg + 1]) {
1695 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1696 return ERR_ALERT | ERR_FATAL;
1697 }
1698
1699 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1700 return 0;
1701 else {
1702 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1703 args[cur_arg], args[cur_arg+1]);
1704 return ERR_ALERT | ERR_FATAL;
1705 }
1706}
1707
Olivier Houchardf886e342017-04-05 22:24:59 +02001708/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001709static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001710{
1711 char *cmsgbuf = NULL;
1712 unsigned char *tmpbuf = NULL;
1713 struct cmsghdr *cmsg;
1714 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001715 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001716 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001717 struct msghdr msghdr;
1718 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001719 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001720 const char *ns_name, *if_name;
1721 unsigned char ns_nlen, if_nlen;
1722 int nb_queued;
1723 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001724 int *tmpfd;
1725 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001726 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001727 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001728 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001729 int ret;
1730
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001731 if (!remote) {
1732 ha_warning("Only works on real connections\n");
1733 goto out;
1734 }
1735
1736 fd = remote->handle.fd;
1737
Olivier Houchardf886e342017-04-05 22:24:59 +02001738 /* Temporary set the FD in blocking mode, that will make our life easier */
1739 old_fcntl = fcntl(fd, F_GETFL);
1740 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001741 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001742 goto out;
1743 }
1744 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1745 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001746 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001747 goto out;
1748 }
1749 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001750 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001751 goto out;
1752 }
Olivier Houchard54740872017-04-06 14:45:14 +02001753 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001754 iov.iov_base = &tot_fd_nb;
1755 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001756 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001757 goto out;
1758 memset(&msghdr, 0, sizeof(msghdr));
1759 /*
1760 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001761 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001762 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001763 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
1764 tot_fd_nb += fdtab[cur_fd].exported;
William Lallemand5fd3b282020-01-16 15:32:08 +01001765
Olivier Houchardf886e342017-04-05 22:24:59 +02001766 if (tot_fd_nb == 0)
1767 goto out;
1768
1769 /* First send the total number of file descriptors, so that the
1770 * receiving end knows what to expect.
1771 */
1772 msghdr.msg_iov = &iov;
1773 msghdr.msg_iovlen = 1;
1774 ret = sendmsg(fd, &msghdr, 0);
1775 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001776 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001777 goto out;
1778 }
1779
1780 /* Now send the fds */
1781 msghdr.msg_control = cmsgbuf;
1782 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1783 cmsg = CMSG_FIRSTHDR(&msghdr);
1784 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1785 cmsg->cmsg_level = SOL_SOCKET;
1786 cmsg->cmsg_type = SCM_RIGHTS;
1787 tmpfd = (int *)CMSG_DATA(cmsg);
1788
Olivier Houchardf886e342017-04-05 22:24:59 +02001789 /* For each socket, e message is sent, containing the following :
1790 * Size of the namespace name (or 0 if none), as an unsigned char.
1791 * The namespace name, if any
1792 * Size of the interface name (or 0 if none), as an unsigned char
1793 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001794 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001795 */
1796 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001797 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001798 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001799 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001800 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001801 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001802 goto out;
1803 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001804
1805 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001806 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001807 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
1808 if (!(fdtab[cur_fd].exported))
1809 continue;
1810
1811 ns_name = if_name = "";
1812 ns_nlen = if_nlen = 0;
1813
1814 /* for now we can only retrieve namespaces and interfaces from
1815 * pure listeners.
1816 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001817 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001818 const struct listener *l = fdtab[cur_fd].owner;
1819
Willy Tarreau818a92e2020-09-03 07:50:19 +02001820 if (l->rx.settings->interface) {
1821 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001822 if_nlen = strlen(if_name);
1823 }
1824
1825#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001826 if (l->rx.settings->netns) {
1827 ns_name = l->rx.settings->netns->node.key;
1828 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001829 }
1830#endif
1831 }
1832
1833 /* put the FD into the CMSG_DATA */
1834 tmpfd[nb_queued++] = cur_fd;
1835
1836 /* first block is <ns_name_len> <ns_name> */
1837 tmpbuf[curoff++] = ns_nlen;
1838 if (ns_nlen)
1839 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1840 curoff += ns_nlen;
1841
1842 /* second block is <if_name_len> <if_name> */
1843 tmpbuf[curoff++] = if_nlen;
1844 if (if_nlen)
1845 memcpy(tmpbuf + curoff, if_name, if_nlen);
1846 curoff += if_nlen;
1847
1848 /* we used to send the listener options here before 2.3 */
1849 memset(tmpbuf + curoff, 0, sizeof(int));
1850 curoff += sizeof(int);
1851
1852 /* there's a limit to how many FDs may be sent at once */
1853 if (nb_queued == MAX_SEND_FD) {
1854 iov.iov_len = curoff;
1855 if (sendmsg(fd, &msghdr, 0) != curoff) {
1856 ha_warning("Failed to transfer sockets\n");
1857 return -1;
1858 }
1859
1860 /* Wait for an ack */
1861 do {
1862 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
1863 } while (ret == -1 && errno == EINTR);
1864
1865 if (ret <= 0) {
1866 ha_warning("Unexpected error while transferring sockets\n");
1867 return -1;
1868 }
1869 curoff = 0;
1870 nb_queued = 0;
1871 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001872 }
1873
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001874 /* flush pending stuff */
1875 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02001876 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001877 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
1878 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02001879 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001880 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001881 goto out;
1882 }
1883 }
1884
1885out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001886 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001887 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001888 goto out;
1889 }
1890 appctx->st0 = CLI_ST_END;
1891 free(cmsgbuf);
1892 free(tmpbuf);
1893 return 1;
1894}
1895
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001896static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1897{
1898 if (*args[0] == 'h')
1899 /* help */
1900 cli_gen_usage_msg(appctx);
1901 else if (*args[0] == 'p')
1902 /* prompt */
1903 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1904 else if (*args[0] == 'q')
1905 /* quit */
1906 appctx->st0 = CLI_ST_END;
1907
1908 return 1;
1909}
Olivier Houchardf886e342017-04-05 22:24:59 +02001910
William Lallemand2f4ce202018-10-26 14:47:47 +02001911void pcli_write_prompt(struct stream *s)
1912{
1913 struct buffer *msg = get_trash_chunk();
1914 struct channel *oc = si_oc(&s->si[0]);
1915
William Lallemanddc12c2e2018-12-13 09:05:46 +01001916 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001917 return;
1918
William Lallemanddc12c2e2018-12-13 09:05:46 +01001919 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001920 chunk_appendf(msg, "+ ");
1921 } else {
1922 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001923 chunk_appendf(msg, "master%s> ",
1924 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001925 else
1926 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1927 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001928 co_inject(oc, msg->area, msg->data);
1929}
1930
William Lallemand291810d2018-10-26 14:47:38 +02001931
William Lallemandcf62f7e2018-10-26 14:47:40 +02001932/* The pcli_* functions are used for the CLI proxy in the master */
1933
William Lallemanddeeaa592018-10-26 14:47:48 +02001934void pcli_reply_and_close(struct stream *s, const char *msg)
1935{
1936 struct buffer *buf = get_trash_chunk();
1937
1938 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001939 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001940}
1941
William Lallemand291810d2018-10-26 14:47:38 +02001942static enum obj_type *pcli_pid_to_server(int proc_pid)
1943{
1944 struct mworker_proc *child;
1945
William Lallemand99e0bb92020-11-05 10:28:53 +01001946 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01001947 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01001948 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01001949
William Lallemand291810d2018-10-26 14:47:38 +02001950 list_for_each_entry(child, &proc_list, list) {
1951 if (child->pid == proc_pid){
1952 return &child->srv->obj_type;
1953 }
1954 }
1955 return NULL;
1956}
1957
1958/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1959 * Return:
1960 * 0: master
1961 * > 0: pid of a worker
1962 * < 0: didn't find a worker
1963 */
1964static int pcli_prefix_to_pid(const char *prefix)
1965{
1966 int proc_pid;
1967 struct mworker_proc *child;
1968 char *errtol = NULL;
1969
1970 if (*prefix != '@') /* not a prefix, should not happen */
1971 return -1;
1972
1973 prefix++;
1974 if (!*prefix) /* sent @ alone, return the master */
1975 return 0;
1976
1977 if (strcmp("master", prefix) == 0) {
1978 return 0;
1979 } else if (*prefix == '!') {
1980 prefix++;
1981 if (!*prefix)
1982 return -1;
1983
1984 proc_pid = strtol(prefix, &errtol, 10);
1985 if (*errtol != '\0')
1986 return -1;
1987 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001988 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001989 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001990 if (child->pid == proc_pid){
1991 return child->pid;
1992 }
1993 }
1994 } else {
1995 struct mworker_proc *chosen = NULL;
1996 /* this is a relative pid */
1997
1998 proc_pid = strtol(prefix, &errtol, 10);
1999 if (*errtol != '\0')
2000 return -1;
2001
2002 if (proc_pid == 0) /* return the master */
2003 return 0;
2004
2005 /* chose the right process, the current one is the one with the
2006 least number of reloads */
2007 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002008 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002009 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002010 if (child->relative_pid == proc_pid){
2011 if (child->reloads == 0)
2012 return child->pid;
2013 else if (chosen == NULL || child->reloads < chosen->reloads)
2014 chosen = child;
2015 }
2016 }
2017 if (chosen)
2018 return chosen->pid;
2019 }
2020 return -1;
2021}
2022
William Lallemandbddd33a2018-12-11 16:10:53 +01002023/* Return::
2024 * >= 0 : number of words to escape
2025 * = -1 : error
2026 */
2027
2028int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2029{
2030 if (argl < 1)
2031 return 0;
2032
2033 /* there is a prefix */
2034 if (args[0][0] == '@') {
2035 int target_pid = pcli_prefix_to_pid(args[0]);
2036
2037 if (target_pid == -1) {
2038 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2039 return -1;
2040 }
2041
2042 /* if the prefix is alone, define a default target */
2043 if (argl == 1)
2044 s->pcli_next_pid = target_pid;
2045 else
2046 *next_pid = target_pid;
2047 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01002048 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002049 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002050 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002051
2052 } else if (!strcmp("quit", args[0])) {
2053 channel_shutr_now(&s->req);
2054 channel_shutw_now(&s->res);
2055 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01002056 } else if (!strcmp(args[0], "operator")) {
2057 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2058 memprintf(errmsg, "Permission denied!\n");
2059 return -1;
2060 }
2061 s->pcli_flags &= ~ACCESS_LVL_MASK;
2062 s->pcli_flags |= ACCESS_LVL_OPER;
2063 return argl;
2064
2065 } else if (!strcmp(args[0], "user")) {
2066 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2067 memprintf(errmsg, "Permission denied!\n");
2068 return -1;
2069 }
2070 s->pcli_flags &= ~ACCESS_LVL_MASK;
2071 s->pcli_flags |= ACCESS_LVL_USER;
2072 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002073 }
2074
2075 return 0;
2076}
2077
2078/*
2079 * Parse the CLI request:
2080 * - It does basically the same as the cli_io_handler, but as a proxy
2081 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002082 *
2083 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002084 * - the number of characters to forward or
2085 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002086 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002087int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002088{
William Lallemandbddd33a2018-12-11 16:10:53 +01002089 char *str = (char *)ci_head(req);
2090 char *end = (char *)ci_stop(req);
2091 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2092 int argl; /* number of args */
2093 char *p;
2094 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002095 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002096 int wtrim = 0; /* number of words to trim */
2097 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002098 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002099 int i = 0;
2100
2101 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002102
William Lallemanddc12c2e2018-12-13 09:05:46 +01002103 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002104
2105 /* Looks for the end of one command */
2106 while (p+reql < end) {
2107 /* handle escaping */
2108 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002109 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002110 continue;
2111 }
2112 if (p[reql] == ';' || p[reql] == '\n') {
2113 /* found the end of the command */
2114 p[reql] = '\n';
2115 reql++;
2116 break;
2117 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002118 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002119 }
William Lallemandebf61802018-12-11 16:10:57 +01002120 } else {
2121 while (p+reql < end) {
2122 if (p[reql] == '\n') {
2123 /* found the end of the line */
2124 reql++;
2125 break;
2126 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002127 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002128 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002129 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002130
William Lallemandbddd33a2018-12-11 16:10:53 +01002131 /* set end to first byte after the end of the command */
2132 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002133
William Lallemandbddd33a2018-12-11 16:10:53 +01002134 /* there is no end to this command, need more to parse ! */
2135 if (*(end-1) != '\n') {
2136 return -1;
2137 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002138
William Lallemand3301f3e2018-12-13 09:05:48 +01002139 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2140 if (reql == 1) /* last line of the payload */
2141 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002142 return reql;
2143 }
2144
William Lallemandbddd33a2018-12-11 16:10:53 +01002145 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002146
William Lallemandbddd33a2018-12-11 16:10:53 +01002147 /* splits the command in words */
2148 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002149 /* skip leading spaces/tabs */
2150 p += strspn(p, " \t");
2151 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002152 break;
2153
William Lallemandbddd33a2018-12-11 16:10:53 +01002154 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002155 while (1) {
2156 p += strcspn(p, " \t\\");
2157 /* escaped chars using backlashes (\) */
2158 if (*p == '\\') {
2159 if (!*++p)
2160 break;
2161 if (!*++p)
2162 break;
2163 } else {
2164 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002165 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002166 }
William Lallemandfe249c32020-06-18 18:03:57 +02002167 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002168 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002169 }
2170
William Lallemandbddd33a2018-12-11 16:10:53 +01002171 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002172
William Lallemandbddd33a2018-12-11 16:10:53 +01002173 for (; i < MAX_STATS_ARGS + 1; i++)
2174 args[i] = NULL;
2175
2176 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2177
2178 /* End of words are ending by \0, we need to replace the \0s by spaces
21791 before forwarding them */
2180 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002181 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002182 if (*p == '\0')
2183 *p = ' ';
2184 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002185 }
2186
William Lallemand3301f3e2018-12-13 09:05:48 +01002187 payload = strstr(str, PAYLOAD_PATTERN);
2188 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2189 /* if the payload pattern is at the end */
2190 s->pcli_flags |= PCLI_F_PAYLOAD;
2191 ret = reql;
2192 }
2193
William Lallemandbddd33a2018-12-11 16:10:53 +01002194 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002195
William Lallemandbddd33a2018-12-11 16:10:53 +01002196 if (wtrim > 0) {
2197 trim = &args[wtrim][0];
2198 if (trim == NULL) /* if this was the last word in the table */
2199 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002200
William Lallemandbddd33a2018-12-11 16:10:53 +01002201 b_del(&req->buf, trim - str);
2202
William Lallemandb7ea1412018-12-13 09:05:47 +01002203 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002204 } else if (wtrim < 0) {
2205 /* parsing error */
2206 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002207 } else {
2208 /* the whole string */
2209 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002210 }
2211
William Lallemandb7ea1412018-12-13 09:05:47 +01002212 if (ret > 1) {
2213 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2214 goto end;
2215 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002216 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2217 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002218 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002219 ci_insert_line2(req, 0, "user -", strlen("user -"));
2220 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002221 }
2222 }
2223end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002224
William Lallemandb7ea1412018-12-13 09:05:47 +01002225 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002226}
2227
2228int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2229{
William Lallemandbddd33a2018-12-11 16:10:53 +01002230 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002231 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002232 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002233
William Lallemandb7ea1412018-12-13 09:05:47 +01002234 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2235 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2236
William Lallemandcf62f7e2018-10-26 14:47:40 +02002237read_again:
2238 /* if the channel is closed for read, we won't receive any more data
2239 from the client, but we don't want to forward this close to the
2240 server */
2241 channel_dont_close(req);
2242
2243 /* We don't know yet to which server we will connect */
2244 channel_dont_connect(req);
2245
2246
2247 /* we are not waiting for a response, there is no more request and we
2248 * receive a close from the client, we can leave */
2249 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2250 channel_shutw_now(&s->res);
2251 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2252 return 1;
2253 }
2254
2255 req->flags |= CF_READ_DONTWAIT;
2256
2257 /* need more data */
2258 if (!ci_data(req))
2259 return 0;
2260
2261 /* If there is data available for analysis, log the end of the idle time. */
2262 if (c_data(req) && s->logs.t_idle == -1)
2263 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2264
William Lallemandbddd33a2018-12-11 16:10:53 +01002265 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002266 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002267 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002268 /* enough data */
2269
William Lallemandcf62f7e2018-10-26 14:47:40 +02002270 /* forward only 1 command */
2271 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002272
William Lallemanddc12c2e2018-12-13 09:05:46 +01002273 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002274 /* we send only 1 command per request, and we write close after it */
2275 channel_shutw_now(req);
2276 } else {
2277 pcli_write_prompt(s);
2278 }
2279
2280 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002281
2282 /* remove the XFER_DATA analysers, which forwards all
2283 * the data, we don't want to forward the next requests
2284 * We need to add CF_FLT_ANALYZE to abort the forward too.
2285 */
2286 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2287 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2288 s->res.analysers |= AN_RES_WAIT_CLI;
2289
William Lallemandebf61802018-12-11 16:10:57 +01002290 if (!(s->flags & SF_ASSIGNED)) {
2291 if (next_pid > -1)
2292 target_pid = next_pid;
2293 else
2294 target_pid = s->pcli_next_pid;
2295 /* we can connect now */
2296 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002297
William Lallemandebf61802018-12-11 16:10:57 +01002298 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2299 channel_auto_connect(req);
2300 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002301
2302 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002303 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002304 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002305 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002306 } else if (to_forward == -1 && errmsg) {
2307 /* there was an error during the parsing */
2308 pcli_reply_and_close(s, errmsg);
2309 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002310 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2311 /* buffer is full and we didn't catch the end of a command */
2312 goto send_help;
2313 }
2314
2315 return 0;
2316
2317send_help:
2318 b_reset(&req->buf);
2319 b_putblk(&req->buf, "help\n", 5);
2320 goto read_again;
2321}
2322
2323int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2324{
2325 struct proxy *fe = strm_fe(s);
2326 struct proxy *be = s->be;
2327
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002328 if (rep->flags & CF_READ_ERROR) {
2329 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2330 s->res.analysers &= ~AN_RES_WAIT_CLI;
2331 return 0;
2332 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002333 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2334 rep->flags |= CF_NEVER_WAIT;
2335
2336 /* don't forward the close */
2337 channel_dont_close(&s->res);
2338 channel_dont_close(&s->req);
2339
William Lallemanddc12c2e2018-12-13 09:05:46 +01002340 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002341 s->req.analysers |= AN_REQ_WAIT_CLI;
2342 s->res.analysers &= ~AN_RES_WAIT_CLI;
2343 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2344 return 0;
2345 }
2346
William Lallemandcf62f7e2018-10-26 14:47:40 +02002347 /* forward the data */
2348 if (ci_data(rep)) {
2349 c_adv(rep, ci_data(rep));
2350 return 0;
2351 }
2352
2353 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2354 /* stream cleanup */
2355
William Lallemand2f4ce202018-10-26 14:47:47 +02002356 pcli_write_prompt(s);
2357
William Lallemandcf62f7e2018-10-26 14:47:40 +02002358 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2359 si_shutr(&s->si[1]);
2360 si_shutw(&s->si[1]);
2361
2362 /*
2363 * starting from there this the same code as
2364 * http_end_txn_clean_session().
2365 *
2366 * It allows to do frontend keepalive while reconnecting to a
2367 * new server for each request.
2368 */
2369
2370 if (s->flags & SF_BE_ASSIGNED) {
2371 HA_ATOMIC_SUB(&be->beconn, 1);
2372 if (unlikely(s->srv_conn))
2373 sess_change_server(s, NULL);
2374 }
2375
2376 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2377 stream_process_counters(s);
2378
2379 /* don't count other requests' data */
2380 s->logs.bytes_in -= ci_data(&s->req);
2381 s->logs.bytes_out -= ci_data(&s->res);
2382
2383 /* we may need to know the position in the queue */
2384 pendconn_free(s);
2385
2386 /* let's do a final log if we need it */
2387 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2388 !(s->flags & SF_MONITOR) &&
2389 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2390 s->do_log(s);
2391 }
2392
2393 /* stop tracking content-based counters */
2394 stream_stop_content_counters(s);
2395 stream_update_time_stats(s);
2396
2397 s->logs.accept_date = date; /* user-visible date for logging */
2398 s->logs.tv_accept = now; /* corrected date for internal use */
2399 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2400 s->logs.t_idle = -1;
2401 tv_zero(&s->logs.tv_request);
2402 s->logs.t_queue = -1;
2403 s->logs.t_connect = -1;
2404 s->logs.t_data = -1;
2405 s->logs.t_close = 0;
2406 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2407 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2408
2409 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2410 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2411
2412 stream_del_srv_conn(s);
2413 if (objt_server(s->target)) {
2414 if (s->flags & SF_CURR_SESS) {
2415 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002416 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002417 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002418 if (may_dequeue_tasks(__objt_server(s->target), be))
2419 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002420 }
2421
2422 s->target = NULL;
2423
2424 /* only release our endpoint if we don't intend to reuse the
2425 * connection.
2426 */
2427 if (!si_conn_ready(&s->si[1])) {
2428 si_release_endpoint(&s->si[1]);
2429 s->srv_conn = NULL;
2430 }
2431
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002432 sockaddr_free(&s->target_addr);
2433
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2435 s->si[1].err_type = SI_ET_NONE;
2436 s->si[1].conn_retries = 0; /* used for logging too */
2437 s->si[1].exp = TICK_ETERNITY;
2438 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 +02002439 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 +02002440 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 +02002441 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2442 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2443 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2444 /* reinitialise the current rule list pointer to NULL. We are sure that
2445 * any rulelist match the NULL pointer.
2446 */
2447 s->current_rule_list = NULL;
2448
2449 s->be = strm_fe(s);
2450 s->logs.logwait = strm_fe(s)->to_log;
2451 s->logs.level = 0;
2452 stream_del_srv_conn(s);
2453 s->target = NULL;
2454 /* re-init store persistence */
2455 s->store_count = 0;
2456 s->uniq_id = global.req_count++;
2457
2458 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2459
2460 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2461
2462 s->req.analysers |= AN_REQ_WAIT_CLI;
2463 s->res.analysers &= ~AN_RES_WAIT_CLI;
2464
2465 /* We must trim any excess data from the response buffer, because we
2466 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002467 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002468 * we want those data to come along with next response. A typical
2469 * example of such data would be from a buggy server responding to
2470 * a HEAD with some data, or sending more than the advertised
2471 * content-length.
2472 */
2473 if (unlikely(ci_data(&s->res)))
2474 b_set_data(&s->res.buf, co_data(&s->res));
2475
2476 /* Now we can realign the response buffer */
2477 c_realign_if_empty(&s->res);
2478
2479 s->req.rto = strm_fe(s)->timeout.client;
2480 s->req.wto = TICK_ETERNITY;
2481
2482 s->res.rto = TICK_ETERNITY;
2483 s->res.wto = strm_fe(s)->timeout.client;
2484
2485 s->req.rex = TICK_ETERNITY;
2486 s->req.wex = TICK_ETERNITY;
2487 s->req.analyse_exp = TICK_ETERNITY;
2488 s->res.rex = TICK_ETERNITY;
2489 s->res.wex = TICK_ETERNITY;
2490 s->res.analyse_exp = TICK_ETERNITY;
2491 s->si[1].hcto = TICK_ETERNITY;
2492
2493 /* we're removing the analysers, we MUST re-enable events detection.
2494 * We don't enable close on the response channel since it's either
2495 * already closed, or in keep-alive with an idle connection handler.
2496 */
2497 channel_auto_read(&s->req);
2498 channel_auto_close(&s->req);
2499 channel_auto_read(&s->res);
2500
2501
2502 return 1;
2503 }
2504 return 0;
2505}
2506
William Lallemand8a022572018-10-26 14:47:35 +02002507/*
2508 * The mworker functions are used to initialize the CLI in the master process
2509 */
2510
William Lallemand309dc9a2018-10-26 14:47:45 +02002511 /*
2512 * Stop the mworker proxy
2513 */
2514void mworker_cli_proxy_stop()
2515{
William Lallemand550db6d2018-11-06 17:37:12 +01002516 if (mworker_proxy)
2517 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002518}
2519
William Lallemand8a022572018-10-26 14:47:35 +02002520/*
2521 * Create the mworker CLI proxy
2522 */
2523int mworker_cli_proxy_create()
2524{
2525 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002526 char *msg = NULL;
2527 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002528
2529 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2530 if (!mworker_proxy)
2531 return -1;
2532
2533 init_new_proxy(mworker_proxy);
2534 mworker_proxy->next = proxies_list;
2535 proxies_list = mworker_proxy;
2536 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002537 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002538 mworker_proxy->last_change = now.tv_sec;
2539 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2540 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2541 mworker_proxy->timeout.client = 0; /* no timeout */
2542 mworker_proxy->conf.file = strdup("MASTER");
2543 mworker_proxy->conf.line = 0;
2544 mworker_proxy->accept = frontend_accept;
2545 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2546
2547 /* Does not init the default target the CLI applet, but must be done in
2548 * the request parsing code */
2549 mworker_proxy->default_target = NULL;
2550
2551 /* the check_config_validity() will get an ID for the proxy */
2552 mworker_proxy->uuid = -1;
2553
2554 proxy_store_name(mworker_proxy);
2555
2556 /* create all servers using the mworker_proc list */
2557 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002558 struct server *newsrv = NULL;
2559 struct sockaddr_storage *sk;
2560 int port1, port2, port;
2561 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002562
William Lallemanda31b09e2020-01-14 15:25:02 +01002563 /* only the workers support the master CLI */
2564 if (!(child->options & PROC_O_TYPE_WORKER))
2565 continue;
2566
William Lallemand8a022572018-10-26 14:47:35 +02002567 newsrv = new_server(mworker_proxy);
2568 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002569 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002570
2571 /* we don't know the new pid yet */
2572 if (child->pid == -1)
2573 memprintf(&msg, "cur-%d", child->relative_pid);
2574 else
2575 memprintf(&msg, "old-%d", child->pid);
2576
2577 newsrv->next = mworker_proxy->srv;
2578 mworker_proxy->srv = newsrv;
2579 newsrv->conf.file = strdup(msg);
2580 newsrv->id = strdup(msg);
2581 newsrv->conf.line = 0;
2582
2583 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002584 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002585 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002586 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002587 }
2588 free(msg);
2589 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002590
Willy Tarreau5fc93282020-09-16 18:25:03 +02002591 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002592 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002593 }
2594
2595 /* no port specified */
2596 newsrv->flags |= SRV_F_MAPPORTS;
2597 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002598 /* don't let the server participate to load balancing */
2599 newsrv->iweight = 0;
2600 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002601 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002602
2603 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002604 }
2605 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002606
2607error:
2608 ha_alert("%s\n", errmsg);
2609
2610 list_for_each_entry(child, &proc_list, list) {
2611 free((char *)child->srv->conf.file); /* cast because of const char * */
2612 free(child->srv->id);
2613 free(child->srv);
2614 child->srv = NULL;
2615 }
2616 free(mworker_proxy->id);
2617 free(mworker_proxy->conf.file);
2618 free(mworker_proxy);
2619 mworker_proxy = NULL;
2620 free(errmsg);
2621 free(msg);
2622
2623 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002624}
Olivier Houchardf886e342017-04-05 22:24:59 +02002625
William Lallemandce83b4a2018-10-26 14:47:30 +02002626/*
William Lallemande7361152018-10-26 14:47:36 +02002627 * Create a new listener for the master CLI proxy
2628 */
2629int mworker_cli_proxy_new_listener(char *line)
2630{
2631 struct bind_conf *bind_conf;
2632 struct listener *l;
2633 char *err = NULL;
2634 char *args[MAX_LINE_ARGS + 1];
2635 int arg;
2636 int cur_arg;
2637
William Lallemand2e945c82019-11-25 09:58:37 +01002638 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002639 args[0] = line;
2640
2641 /* args is a bind configuration with spaces replaced by commas */
2642 while (*line && arg < MAX_LINE_ARGS) {
2643
2644 if (*line == ',') {
2645 *line++ = '\0';
2646 while (*line == ',')
2647 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002648 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002649 }
2650 line++;
2651 }
2652
William Lallemand2e945c82019-11-25 09:58:37 +01002653 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002654
2655 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002656 if (!bind_conf)
2657 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002658
2659 bind_conf->level &= ~ACCESS_LVL_MASK;
2660 bind_conf->level |= ACCESS_LVL_ADMIN;
2661
2662 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2663 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002664 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002665 }
2666
2667 cur_arg = 1;
2668
2669 while (*args[cur_arg]) {
2670 static int bind_dumped;
2671 struct bind_kw *kw;
2672
2673 kw = bind_find_kw(args[cur_arg]);
2674 if (kw) {
2675 if (!kw->parse) {
2676 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2677 args[0], args[1], args[cur_arg]);
2678 goto err;
2679 }
2680
2681 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2682 if (err)
2683 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2684 else
2685 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2686 args[0], args[1], args[cur_arg]);
2687 goto err;
2688 }
2689
2690 cur_arg += 1 + kw->skip;
2691 continue;
2692 }
2693
2694 if (!bind_dumped) {
2695 bind_dump_kws(&err);
2696 indent_msg(&err, 4);
2697 bind_dumped = 1;
2698 }
2699
2700 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2701 args[0], args[1], args[cur_arg],
2702 err ? " Registered keywords :" : "", err ? err : "");
2703 goto err;
2704 }
2705
2706
2707 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002708 l->accept = session_accept_fd;
2709 l->default_target = mworker_proxy->default_target;
2710 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002711 l->options |= LI_O_UNLIMITED;
2712 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002713 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002714 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002715 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002716 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002717
2718 return 0;
2719
2720err:
2721 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002722 free(err);
2723 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002724 return -1;
2725
2726}
2727
2728/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002729 * Create a new CLI socket using a socketpair for a worker process
2730 * <mworker_proc> is the process structure, and <proc> is the process number
2731 */
2732int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2733{
2734 struct bind_conf *bind_conf;
2735 struct listener *l;
2736 char *path = NULL;
2737 char *err = NULL;
2738
2739 /* master pipe to ensure the master is still alive */
2740 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2741 ha_alert("Cannot create worker socketpair.\n");
2742 return -1;
2743 }
2744
2745 /* XXX: we might want to use a separate frontend at some point */
2746 if (!global.stats_fe) {
2747 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2748 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002749 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002750 }
2751 }
2752
2753 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002754 if (!bind_conf)
2755 goto error;
2756
William Lallemandce83b4a2018-10-26 14:47:30 +02002757 bind_conf->level &= ~ACCESS_LVL_MASK;
2758 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2759
Willy Tarreaue26993c2020-09-03 07:18:55 +02002760 bind_conf->settings.bind_proc = 1UL << proc;
William Lallemandce83b4a2018-10-26 14:47:30 +02002761 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2762
2763 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2764 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002765 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002766 }
2767
2768 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002769 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002770 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002771 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002772 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002773 free(path);
2774 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002775
2776 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002777 l->accept = session_accept_fd;
2778 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002779 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau455585e2020-10-09 18:25:14 +02002780 HA_ATOMIC_ADD(&unstoppable_jobs, 1);
William Lallemandce83b4a2018-10-26 14:47:30 +02002781 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002782 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002783 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002784 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002785 }
2786
2787 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002788
2789error:
2790 close(mworker_proc->ipc_fd[0]);
2791 close(mworker_proc->ipc_fd[1]);
2792 free(err);
2793
2794 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002795}
2796
William Lallemand74c24fb2016-11-21 17:18:36 +01002797static struct applet cli_applet = {
2798 .obj_type = OBJ_TYPE_APPLET,
2799 .name = "<CLI>", /* used for logging */
2800 .fct = cli_io_handler,
2801 .release = cli_release_handler,
2802};
2803
William Lallemand99e0bb92020-11-05 10:28:53 +01002804/* master CLI */
2805static struct applet mcli_applet = {
2806 .obj_type = OBJ_TYPE_APPLET,
2807 .name = "<MCLI>", /* used for logging */
2808 .fct = cli_io_handler,
2809 .release = cli_release_handler,
2810};
2811
Willy Tarreau0a739292016-11-22 20:21:23 +01002812/* register cli keywords */
2813static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002814 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2815 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2816 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002817 { { "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 +01002818 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002819 { { "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 +01002820 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002821 { { "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 +02002822 { { "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 +01002823 { { "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 +02002824 { { "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 +01002825 { { "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 +01002826 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2827 { { "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 +02002828 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002829 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002830 {{},}
2831}};
2832
Willy Tarreau0108d902018-11-25 19:14:37 +01002833INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2834
William Lallemand74c24fb2016-11-21 17:18:36 +01002835static struct cfg_kw_list cfg_kws = {ILH, {
2836 { CFG_GLOBAL, "stats", stats_parse_global },
2837 { 0, NULL, NULL },
2838}};
2839
Willy Tarreau0108d902018-11-25 19:14:37 +01002840INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2841
William Lallemand74c24fb2016-11-21 17:18:36 +01002842static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002843 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2844 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002845 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002846 { NULL, NULL, 0 },
2847}};
2848
Willy Tarreau0108d902018-11-25 19:14:37 +01002849INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002850
2851/*
2852 * Local variables:
2853 * c-indent-level: 8
2854 * c-basic-offset: 8
2855 * End:
2856 */