blob: f48795a42b39c72e8e55d65da66079935e43b791 [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/applet-t.h>
32#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020038#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020039#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020042#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020043#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020044#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020045#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020046#include <haproxy/log.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020054#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020055#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020056#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020057#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020058#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020059#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020060#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020061#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020062#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020063#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020064#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010065
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020066#define PAYLOAD_PATTERN "<<"
67
William Lallemand74c24fb2016-11-21 17:18:36 +010068static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010069static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010070
71static const char stats_sock_usage_msg[] =
72 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010073 " help : this message\n"
74 " prompt : toggle interactive mode with prompt\n"
75 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010076 "";
77
78static const char stats_permission_denied_msg[] =
79 "Permission denied\n"
80 "";
81
82
Christopher Faulet1bc04c72017-10-29 20:14:08 +010083static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010084
85/* List head of cli keywords */
86static struct cli_kw_list cli_keywords = {
87 .list = LIST_HEAD_INIT(cli_keywords.list)
88};
89
90extern const char *stat_status_codes[];
91
William Lallemand8a022572018-10-26 14:47:35 +020092static struct proxy *mworker_proxy; /* CLI proxy of the master */
93
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020094static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +010095{
96 struct cli_kw_list *kw_list;
97 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020098 struct buffer *tmp = get_trash_chunk();
99 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100100
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100101 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100102
103 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200104 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100105
106 chunk_reset(tmp);
107 chunk_strcat(tmp, stats_sock_usage_msg);
108 list_for_each_entry(kw_list, &cli_keywords.list, list) {
109 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200110 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200111
112 /* in a worker or normal process, don't display master only commands */
William Lallemand99e0bb92020-11-05 10:28:53 +0100113 if (appctx->applet == &cli_applet && (kw->level & ACCESS_MASTER_ONLY))
William Lallemand14721be2018-10-26 14:47:37 +0200114 goto next_kw;
115
116 /* in master don't displays if we don't have the master bits */
William Lallemand99e0bb92020-11-05 10:28:53 +0100117 if (appctx->applet == &mcli_applet && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
William Lallemand14721be2018-10-26 14:47:37 +0200118 goto next_kw;
119
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200120 /* only show expert commands in expert mode */
121 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
122 goto next_kw;
123
William Lallemand0154edc2018-05-15 11:50:04 +0200124 if (kw->usage)
125 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200126
127next_kw:
128
William Lallemand74c24fb2016-11-21 17:18:36 +0100129 kw++;
130 }
131 }
132 chunk_init(&out, NULL, 0);
133 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200134 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200135
136end:
137 if (dynamic_usage_msg) {
138 appctx->ctx.cli.severity = LOG_INFO;
139 appctx->ctx.cli.msg = dynamic_usage_msg;
140 }
141 else {
142 appctx->ctx.cli.severity = LOG_INFO;
143 appctx->ctx.cli.msg = stats_sock_usage_msg;
144 }
145 appctx->st0 = CLI_ST_PRINT;
146
William Lallemand74c24fb2016-11-21 17:18:36 +0100147 return dynamic_usage_msg;
148}
149
150struct cli_kw* cli_find_kw(char **args)
151{
152 struct cli_kw_list *kw_list;
153 struct cli_kw *kw;/* current cli_kw */
154 char **tmp_args;
155 const char **tmp_str_kw;
156 int found = 0;
157
158 if (LIST_ISEMPTY(&cli_keywords.list))
159 return NULL;
160
161 list_for_each_entry(kw_list, &cli_keywords.list, list) {
162 kw = &kw_list->kw[0];
163 while (*kw->str_kw) {
164 tmp_args = args;
165 tmp_str_kw = kw->str_kw;
166 while (*tmp_str_kw) {
167 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
168 found = 1;
169 } else {
170 found = 0;
171 break;
172 }
173 tmp_args++;
174 tmp_str_kw++;
175 }
176 if (found)
177 return (kw);
178 kw++;
179 }
180 }
181 return NULL;
182}
183
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100184struct cli_kw* cli_find_kw_exact(char **args)
185{
186 struct cli_kw_list *kw_list;
187 int found = 0;
188 int i;
189 int j;
190
191 if (LIST_ISEMPTY(&cli_keywords.list))
192 return NULL;
193
194 list_for_each_entry(kw_list, &cli_keywords.list, list) {
195 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
196 found = 1;
197 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
198 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
199 break;
200 }
201 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
202 found = 0;
203 break;
204 }
205 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
206 found = 0;
207 break;
208 }
209 }
210 if (found)
211 return &kw_list->kw[i];
212 }
213 }
214 return NULL;
215}
216
William Lallemand74c24fb2016-11-21 17:18:36 +0100217void cli_register_kw(struct cli_kw_list *kw_list)
218{
219 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
220}
221
222
223/* allocate a new stats frontend named <name>, and return it
224 * (or NULL in case of lack of memory).
225 */
226static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
227{
228 struct proxy *fe;
229
230 fe = calloc(1, sizeof(*fe));
231 if (!fe)
232 return NULL;
233
234 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100235 fe->next = proxies_list;
236 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100237 fe->last_change = now.tv_sec;
238 fe->id = strdup("GLOBAL");
239 fe->cap = PR_CAP_FE;
240 fe->maxconn = 10; /* default to 10 concurrent connections */
241 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
242 fe->conf.file = strdup(file);
243 fe->conf.line = line;
244 fe->accept = frontend_accept;
245 fe->default_target = &cli_applet.obj_type;
246
247 /* the stats frontend is the only one able to assign ID #0 */
248 fe->conf.id.key = fe->uuid = 0;
249 eb32_insert(&used_proxy_id, &fe->conf.id);
250 return fe;
251}
252
253/* This function parses a "stats" statement in the "global" section. It returns
254 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
255 * error message into the <err> buffer which will be preallocated. The trailing
256 * '\n' must not be written. The function must be called with <args> pointing to
257 * the first word after "stats".
258 */
259static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
260 struct proxy *defpx, const char *file, int line,
261 char **err)
262{
263 struct bind_conf *bind_conf;
264 struct listener *l;
265
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100266 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100267 int cur_arg;
268
269 if (*args[2] == 0) {
270 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
271 return -1;
272 }
273
274 if (!global.stats_fe) {
275 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
276 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
277 return -1;
278 }
279 }
280
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100281 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200282 bind_conf->level &= ~ACCESS_LVL_MASK;
283 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100284
285 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
286 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
287 file, line, args[0], args[1], err && *err ? *err : "error");
288 return -1;
289 }
290
291 cur_arg = 3;
292 while (*args[cur_arg]) {
293 static int bind_dumped;
294 struct bind_kw *kw;
295
296 kw = bind_find_kw(args[cur_arg]);
297 if (kw) {
298 if (!kw->parse) {
299 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
300 args[0], args[1], args[cur_arg]);
301 return -1;
302 }
303
304 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
305 if (err && *err)
306 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
307 else
308 memprintf(err, "'%s %s' : error encountered while processing '%s'",
309 args[0], args[1], args[cur_arg]);
310 return -1;
311 }
312
313 cur_arg += 1 + kw->skip;
314 continue;
315 }
316
317 if (!bind_dumped) {
318 bind_dump_kws(err);
319 indent_msg(err, 4);
320 bind_dumped = 1;
321 }
322
323 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
324 args[0], args[1], args[cur_arg],
325 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
326 return -1;
327 }
328
329 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100330 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100331 l->default_target = global.stats_fe->default_target;
332 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
333 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100334 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100335 }
336 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100337 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100338 unsigned timeout;
339 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
340
Willy Tarreau9faebe32019-06-07 19:00:37 +0200341 if (res == PARSE_TIME_OVER) {
342 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
343 args[2], args[0], args[1]);
344 return -1;
345 }
346 else if (res == PARSE_TIME_UNDER) {
347 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
348 args[2], args[0], args[1]);
349 return -1;
350 }
351 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100352 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
353 return -1;
354 }
355
356 if (!timeout) {
357 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
358 return -1;
359 }
360 if (!global.stats_fe) {
361 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
362 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
363 return -1;
364 }
365 }
366 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
367 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100368 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100369 int maxconn = atol(args[2]);
370
371 if (maxconn <= 0) {
372 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
373 return -1;
374 }
375
376 if (!global.stats_fe) {
377 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
378 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
379 return -1;
380 }
381 }
382 global.stats_fe->maxconn = maxconn;
383 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100384 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100385 int cur_arg = 2;
386 unsigned long set = 0;
387
388 if (!global.stats_fe) {
389 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
390 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
391 return -1;
392 }
393 }
394
395 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100396 if (strcmp(args[cur_arg], "all") == 0) {
397 set = 0;
398 break;
399 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100400 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100401 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100402 return -1;
403 }
404 cur_arg++;
405 }
406 global.stats_fe->bind_proc = set;
407 }
408 else {
409 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
410 return -1;
411 }
412 return 0;
413}
414
William Lallemand33d29e22019-04-01 11:30:06 +0200415/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200416 * This function exports the bound addresses of a <frontend> in the environment
417 * variable <varname>. Those addresses are separated by semicolons and prefixed
418 * with their type (abns@, unix@, sockpair@ etc)
419 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200420 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200421int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200422{
423 struct buffer *trash = get_trash_chunk();
424 struct bind_conf *bind_conf;
425
William Lallemand9a37fd02019-04-12 16:09:24 +0200426 if (frontend) {
427 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200428 struct listener *l;
429
430 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
431 char addr[46];
432 char port[6];
433
William Lallemand620072b2019-04-12 16:09:25 +0200434 /* separate listener by semicolons */
435 if (trash->data)
436 chunk_appendf(trash, ";");
437
Willy Tarreau37159062020-08-27 07:48:42 +0200438 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200439 const struct sockaddr_un *un;
440
Willy Tarreau37159062020-08-27 07:48:42 +0200441 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200442 if (un->sun_path[0] == '\0') {
443 chunk_appendf(trash, "abns@%s", un->sun_path+1);
444 } else {
445 chunk_appendf(trash, "unix@%s", un->sun_path);
446 }
Willy Tarreau37159062020-08-27 07:48:42 +0200447 } else if (l->rx.addr.ss_family == AF_INET) {
448 addr_to_str(&l->rx.addr, addr, sizeof(addr));
449 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200450 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200451 } else if (l->rx.addr.ss_family == AF_INET6) {
452 addr_to_str(&l->rx.addr, addr, sizeof(addr));
453 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200454 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200455 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
456 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200457 }
William Lallemand33d29e22019-04-01 11:30:06 +0200458 }
459 }
460 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200461 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200462 return -1;
463 }
464
465 return 0;
466}
467
William Lallemand9a37fd02019-04-12 16:09:24 +0200468int cli_socket_setenv()
469{
470 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
471 return -1;
472 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
473 return -1;
474
475 return 0;
476}
477
William Lallemand33d29e22019-04-01 11:30:06 +0200478REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
479
Willy Tarreaude57a572016-11-23 17:01:39 +0100480/* Verifies that the CLI at least has a level at least as high as <level>
481 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
482 * failure, an error message is prepared and the appctx's state is adjusted
483 * to print it so that a return 1 is enough to abort any processing.
484 */
485int cli_has_level(struct appctx *appctx, int level)
486{
Willy Tarreaude57a572016-11-23 17:01:39 +0100487
William Lallemandf630d012018-12-13 09:05:44 +0100488 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau9d008692019-08-09 11:21:01 +0200489 cli_err(appctx, stats_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100490 return 0;
491 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100492 return 1;
493}
494
William Lallemandb7ea1412018-12-13 09:05:47 +0100495/* same as cli_has_level but for the CLI proxy and without error message */
496int pcli_has_level(struct stream *s, int level)
497{
498 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
499 return 0;
500 }
501 return 1;
502}
503
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200504/* Returns severity_output for the current session if set, or default for the socket */
505static int cli_get_severity_output(struct appctx *appctx)
506{
507 if (appctx->cli_severity_output)
508 return appctx->cli_severity_output;
509 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
510}
William Lallemand74c24fb2016-11-21 17:18:36 +0100511
Willy Tarreau41908562016-11-24 16:23:38 +0100512/* Processes the CLI interpreter on the stats socket. This function is called
513 * from the CLI's IO handler running in an appctx context. The function returns 1
514 * if the request was understood, otherwise zero. It is called with appctx->st0
515 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
516 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
517 * have its own I/O handler called again. Most of the time, parsers will only
518 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100519 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
520 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100521 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200522static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100523{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200524 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
525 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100526 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100527
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200528 appctx->st2 = 0;
529 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100530
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200531 p = appctx->chunk->area;
532 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100533
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200534 /*
535 * Get the payload start if there is one.
536 * For the sake of simplicity, the payload pattern is looked up
537 * everywhere from the start of the input but it can only be found
538 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
539 *
540 * The input string was zero terminated so it is safe to use
541 * the str*() functions throughout the parsing
542 */
543 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
544 payload = strstr(p, PAYLOAD_PATTERN);
545 end = payload;
546 /* skip the pattern */
547 payload += strlen(PAYLOAD_PATTERN);
548 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100549
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200550 /*
551 * Get pointers on words.
552 * One extra slot is reserved to store a pointer on a null byte.
553 */
554 while (i < MAX_STATS_ARGS && p < end) {
555 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100556
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200557 /* skip leading spaces/tabs */
558 p += strspn(p, " \t");
559 if (!*p)
560 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100561
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200562 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200563 while (1) {
564 p += strcspn(p, " \t\\");
565 /* escaped chars using backlashes (\) */
566 if (*p == '\\') {
567 if (!*++p)
568 break;
569 if (!*++p)
570 break;
571 } else {
572 break;
573 }
574 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200575 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100576
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200577 /* unescape backslashes (\) */
578 for (j = 0, k = 0; args[i][k]; k++) {
579 if (args[i][k] == '\\') {
580 if (args[i][k + 1] == '\\')
581 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100582 else
583 continue;
584 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200585 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100586 j++;
587 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200588 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100589
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200590 i++;
591 }
592 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200593 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200594 for (; i < MAX_STATS_ARGS + 1; i++)
595 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100596
597 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100598 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100599 return 0;
600
William Lallemand14721be2018-10-26 14:47:37 +0200601 /* in a worker or normal process, don't display master only commands */
William Lallemand99e0bb92020-11-05 10:28:53 +0100602 if (appctx->applet == &cli_applet && (kw->level & ACCESS_MASTER_ONLY))
William Lallemand14721be2018-10-26 14:47:37 +0200603 return 0;
604
605 /* in master don't displays if we don't have the master bits */
William Lallemand99e0bb92020-11-05 10:28:53 +0100606 if (appctx->applet == &mcli_applet && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
William Lallemand14721be2018-10-26 14:47:37 +0200607 return 0;
608
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200609 /* only accept expert commands in expert mode */
610 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
611 return 0;
612
Willy Tarreau41908562016-11-24 16:23:38 +0100613 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200614 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200615
616 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
617 goto fail;
618
619 /* kw->parse could set its own io_handler or io_release handler */
620 if (!appctx->io_handler)
621 goto fail;
622
623 appctx->st0 = CLI_ST_CALLBACK;
624 return 1;
625fail:
626 appctx->io_handler = NULL;
627 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100628 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100629}
630
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200631/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
632static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
633{
Willy Tarreau83061a82018-07-13 11:56:34 +0200634 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200635
636 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200637 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200638
639 tmp = get_trash_chunk();
640 chunk_reset(tmp);
641
642 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100643 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200644 chunk_printf(tmp, "[%d]: ", severity);
645 }
646 else {
647 switch (severity_output) {
648 case CLI_SEVERITY_NUMBER:
649 chunk_printf(tmp, "[%d]: ", severity);
650 break;
651 case CLI_SEVERITY_STRING:
652 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
653 break;
654 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100655 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200656 }
657 }
658 chunk_appendf(tmp, "%s", msg);
659
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200660 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200661}
662
William Lallemand74c24fb2016-11-21 17:18:36 +0100663/* This I/O handler runs as an applet embedded in a stream interface. It is
664 * used to processes I/O from/to the stats unix socket. The system relies on a
665 * state machine handling requests and various responses. We read a request,
666 * then we process it and send the response, and we possibly display a prompt.
667 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100668 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100669 * or not.
670 */
671static void cli_io_handler(struct appctx *appctx)
672{
673 struct stream_interface *si = appctx->owner;
674 struct channel *req = si_oc(si);
675 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200676 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100677 int reql;
678 int len;
679
680 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
681 goto out;
682
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800683 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200684 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100685 /* buf.size==0 means we failed to get a buffer and were
686 * already subscribed to a wait list to get a buffer.
687 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100688 goto out;
689 }
690
William Lallemand74c24fb2016-11-21 17:18:36 +0100691 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100692 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 /* Stats output not initialized yet */
694 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200695 /* reset severity to default at init */
696 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100697 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100698 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100699 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100700 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100701 /* Let's close for real now. We just close the request
702 * side, the conditions below will complete if needed.
703 */
704 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200705 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100706 break;
707 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100708 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200709 char *str;
710
711 /* use a trash chunk to store received data */
712 if (!appctx->chunk) {
713 appctx->chunk = alloc_trash_chunk();
714 if (!appctx->chunk) {
715 appctx->st0 = CLI_ST_END;
716 continue;
717 }
718 }
719
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200720 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200721
William Lallemand74c24fb2016-11-21 17:18:36 +0100722 /* ensure we have some output room left in the event we
723 * would want to return some info right after parsing.
724 */
725 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100726 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100727 break;
728 }
729
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200731 reql = co_getline(si_oc(si), str,
732 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100733 if (reql <= 0) { /* closed or EOL not found */
734 if (reql == 0)
735 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100736 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100737 continue;
738 }
739
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200740 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
741 /* seek for a possible unescaped semi-colon. If we find
742 * one, we replace it with an LF and skip only this part.
743 */
744 for (len = 0; len < reql; len++) {
745 if (str[len] == '\\') {
746 len++;
747 continue;
748 }
749 if (str[len] == ';') {
750 str[len] = '\n';
751 reql = len + 1;
752 break;
753 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100754 }
755 }
756
757 /* now it is time to check that we have a full line,
758 * remove the trailing \n and possibly \r, then cut the
759 * line.
760 */
761 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200762 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100763 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100764 continue;
765 }
766
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200767 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100768 len--;
769
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200770 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200771 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200772
773 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200774 appctx->chunk->area[appctx->chunk->data] = '\n';
775 appctx->chunk->area[appctx->chunk->data + 1] = 0;
776 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200777 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100778
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100779 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200780
781 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
782 /* empty line */
783 if (!len) {
784 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200785 appctx->chunk->data -= 2;
786 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200787
788 if (!cli_parse_request(appctx))
789 cli_gen_usage_msg(appctx);
790
791 chunk_reset(appctx->chunk);
792 /* NB: cli_sock_parse_request() may have put
793 * another CLI_ST_O_* into appctx->st0.
794 */
795
796 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100797 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100798 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200799 else {
800 /*
801 * Look for the "payload start" pattern at the end of a line
802 * Its location is not remembered here, this is just to switch
803 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100804 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100805 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200806 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200807 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200808 /* no payload, the command is complete: parse the request */
809 if (!cli_parse_request(appctx))
810 cli_gen_usage_msg(appctx);
811
812 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200813 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100814 }
815
816 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200817 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100818 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
819 }
820 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200821 const char *msg;
822 int sev;
823
William Lallemand74c24fb2016-11-21 17:18:36 +0100824 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100825 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200827 case CLI_ST_PRINT: /* print const message in msg */
828 case CLI_ST_PRINT_ERR: /* print const error in msg */
829 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
830 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
831 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
832 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
833 LOG_ERR : appctx->ctx.cli.severity;
834 msg = appctx->ctx.cli.msg;
835 }
836 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
837 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
838 LOG_ERR : appctx->ctx.cli.severity;
839 msg = appctx->ctx.cli.err;
840 if (!msg) {
841 sev = LOG_ERR;
842 msg = "Out of memory.\n";
843 }
844 }
845 else {
846 sev = LOG_ERR;
847 msg = "Internal error.\n";
848 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200849
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200850 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
851 if (appctx->st0 == CLI_ST_PRINT_FREE ||
852 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100853 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200854 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100855 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100856 }
857 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100858 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100859 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200860
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100861 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100862 if (appctx->io_handler)
863 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100864 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100865 if (appctx->io_release) {
866 appctx->io_release(appctx);
867 appctx->io_release = NULL;
868 }
869 }
870 break;
871 default: /* abnormal state */
872 si->flags |= SI_FL_ERR;
873 break;
874 }
875
876 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100877 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200878 const char *prompt = "";
879
880 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
881 /*
882 * when entering a payload with interactive mode, change the prompt
883 * to emphasize that more data can still be sent
884 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200885 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200886 prompt = "+ ";
887 else
888 prompt = "\n> ";
889 }
890 else {
William Lallemandad032882019-07-01 10:56:15 +0200891 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200892 prompt = "\n";
893 }
894
895 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100896 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100897 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100898 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100899 }
900
901 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100902 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 break;
904
905 /* Now we close the output if one of the writers did so,
906 * or if we're not in interactive mode and the request
907 * buffer is empty. This still allows pipelined requests
908 * to be sent in non-interactive mode.
909 */
William Lallemand3de09d52018-12-11 16:10:56 +0100910 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
911 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100912 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100913 continue;
914 }
915
916 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100917 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200918 /* reactivate the \n at the end of the response for the next command */
919 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100920 }
921 }
922
923 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
924 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
925 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
926 /* Other side has closed, let's abort if we have no more processing to do
927 * and nothing more to consume. This is comparable to a broken pipe, so
928 * we forward the close to the request side so that it flows upstream to
929 * the client.
930 */
931 si_shutw(si);
932 }
933
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100934 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100935 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
936 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
937 /* We have no more processing to do, and nothing more to send, and
938 * the client side has closed. So we'll forward this state downstream
939 * on the response buffer.
940 */
941 si_shutr(si);
942 res->flags |= CF_READ_NULL;
943 }
944
945 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200946 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 +0100947 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200948 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 +0100949}
950
William Lallemand74c24fb2016-11-21 17:18:36 +0100951/* This is called when the stream interface is closed. For instance, upon an
952 * external abort, we won't call the i/o handler anymore so we may need to
953 * remove back references to the stream currently being dumped.
954 */
955static void cli_release_handler(struct appctx *appctx)
956{
957 if (appctx->io_release) {
958 appctx->io_release(appctx);
959 appctx->io_release = NULL;
960 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200961 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100962 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100963 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100964}
965
966/* This function dumps all environmnent variables to the buffer. It returns 0
967 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100968 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
969 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100970 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100971static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100972{
Willy Tarreau0a739292016-11-22 20:21:23 +0100973 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100974 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100975
976 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
977 return 1;
978
979 chunk_reset(&trash);
980
981 /* we have two inner loops here, one for the proxy, the other one for
982 * the buffer.
983 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100984 while (*var) {
985 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100986
Willy Tarreau06d80a92017-10-19 14:32:15 +0200987 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100988 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100989 return 0;
990 }
991 if (appctx->st2 == STAT_ST_END)
992 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100993 var++;
994 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100995 }
996
997 /* dump complete */
998 return 1;
999}
1000
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001001/* This function dumps all file descriptors states (or the requested one) to
1002 * the buffer. It returns 0 if the output buffer is full and it needs to be
1003 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1004 * It uses cli.i0 as the fd number to restart from.
1005 */
1006static int cli_io_handler_show_fd(struct appctx *appctx)
1007{
1008 struct stream_interface *si = appctx->owner;
1009 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001010 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001011
1012 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001013 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001014
1015 chunk_reset(&trash);
1016
Willy Tarreauca1b1572018-12-18 15:45:11 +01001017 /* isolate the threads once per round. We're limited to a buffer worth
1018 * of output anyway, it cannot last very long.
1019 */
1020 thread_isolate();
1021
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001022 /* we have two inner loops here, one for the proxy, the other one for
1023 * the buffer.
1024 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001025 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001026 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001027 const struct listener *li = NULL;
1028 const struct server *sv = NULL;
1029 const struct proxy *px = NULL;
1030 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001031 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001032 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001033 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001034 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001035 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001036 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001037 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001038
1039 fdt = fdtab[fd];
1040
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001041 /* When DEBUG_FD is set, we also report closed FDs that have a
1042 * non-null event count to detect stuck ones.
1043 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001044 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001045#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001046 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001047#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001048 goto skip; // closed
1049 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001050 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001051 conn = (const struct connection *)fdt.owner;
1052 conn_flags = conn->flags;
1053 mux = conn->mux;
1054 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001055 xprt = conn->xprt;
1056 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001057 li = objt_listener(conn->target);
1058 sv = objt_server(conn->target);
1059 px = objt_proxy(conn->target);
1060 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001061 if (atleast2(fdt.thread_mask))
1062 suspicious = 1;
1063 if (conn->handle.fd != fd)
1064 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001065 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001066 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001067 li = fdt.owner;
1068
Willy Tarreaudacfde42021-01-21 09:07:29 +01001069 if (!fdt.thread_mask)
1070 suspicious = 1;
1071
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001072 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001073 " %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 +02001074 fd,
1075 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001076 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1077 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001078 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1079 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1080 fdt.ev,
1081 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1082 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1083 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1084 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1085 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001086 fdt.linger_risk ? 'L' : 'l',
1087 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001088 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001089 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001090 fdt.iocb);
1091 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001092
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001093 if (!fdt.owner) {
1094 chunk_appendf(&trash, ")");
1095 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001096 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001097 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001098
1099 if (conn->handle.fd != fd) {
1100 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1101 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001102 } else {
1103 struct sockaddr_storage sa;
1104 socklen_t salen;
1105
1106 salen = sizeof(sa);
1107 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1108 if (sa.ss_family == AF_INET)
1109 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1110 else if (sa.ss_family == AF_INET6)
1111 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1112 else if (sa.ss_family == AF_UNIX)
1113 chunk_appendf(&trash, " fam=unix");
1114 }
1115
1116 salen = sizeof(sa);
1117 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1118 if (sa.ss_family == AF_INET)
1119 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1120 else if (sa.ss_family == AF_INET6)
1121 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1122 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001123 }
1124
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001125 if (px)
1126 chunk_appendf(&trash, " px=%s", px->id);
1127 else if (sv)
1128 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1129 else if (li)
1130 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001131
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001132 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001133 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001134 if (!ctx)
1135 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001136 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001137 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001138 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001139 else
1140 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001141
1142 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001143 if (xprt) {
1144 if (xprt_ctx || xprt->show_fd)
1145 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1146 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001147 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001148 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001149 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001150 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001151 struct sockaddr_storage sa;
1152 socklen_t salen;
1153
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001154 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001155 listener_state_str(li),
1156 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001157
1158 salen = sizeof(sa);
1159 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1160 if (sa.ss_family == AF_INET)
1161 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1162 else if (sa.ss_family == AF_INET6)
1163 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1164 else if (sa.ss_family == AF_UNIX)
1165 chunk_appendf(&trash, " fam=unix");
1166 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001167 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001168 else
1169 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001170
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001171#ifdef DEBUG_FD
1172 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001173 if (fdtab[fd].event_count >= 1000000)
1174 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001175#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001176 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001177
Willy Tarreau06d80a92017-10-19 14:32:15 +02001178 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001179 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001180 appctx->ctx.cli.i0 = fd;
1181 ret = 0;
1182 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001183 }
1184 skip:
1185 if (appctx->st2 == STAT_ST_END)
1186 break;
1187
1188 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001189 }
1190
Willy Tarreauca1b1572018-12-18 15:45:11 +01001191 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001192 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001193
1194 thread_release();
1195 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001196}
1197
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001198/* This function dumps some activity counters used by developers and support to
1199 * rule out some hypothesis during bug reports. It returns 0 if the output
1200 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1201 * everything at once in the buffer and is not designed to do it in multiple
1202 * passes.
1203 */
1204static int cli_io_handler_show_activity(struct appctx *appctx)
1205{
1206 struct stream_interface *si = appctx->owner;
1207 int thr;
1208
1209 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1210 return 1;
1211
1212 chunk_reset(&trash);
1213
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001214#undef SHOW_TOT
1215#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001216 do { \
1217 unsigned int _v[MAX_THREADS]; \
1218 unsigned int _tot; \
1219 const unsigned int _nbt = global.nbthread; \
1220 for (_tot = t = 0; t < _nbt; t++) \
1221 _tot += _v[t] = (x); \
1222 if (_nbt == 1) { \
1223 chunk_appendf(&trash, " %u\n", _tot); \
1224 break; \
1225 } \
1226 chunk_appendf(&trash, " %u [", _tot); \
1227 for (t = 0; t < _nbt; t++) \
1228 chunk_appendf(&trash, " %u", _v[t]); \
1229 chunk_appendf(&trash, " ]\n"); \
1230 } while (0)
1231
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001232#undef SHOW_AVG
1233#define SHOW_AVG(t, x) \
1234 do { \
1235 unsigned int _v[MAX_THREADS]; \
1236 unsigned int _tot; \
1237 const unsigned int _nbt = global.nbthread; \
1238 for (_tot = t = 0; t < _nbt; t++) \
1239 _tot += _v[t] = (x); \
1240 if (_nbt == 1) { \
1241 chunk_appendf(&trash, " %u\n", _tot); \
1242 break; \
1243 } \
1244 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1245 for (t = 0; t < _nbt; t++) \
1246 chunk_appendf(&trash, " %u", _v[t]); \
1247 chunk_appendf(&trash, " ]\n"); \
1248 } while (0)
1249
Willy Tarreaua0211b82019-05-28 15:09:08 +02001250 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1251 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001252 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1253 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1254 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1255 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001256 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001257 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1258 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001259 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001260 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001261 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1262 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1263 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001264 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001265 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001266 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1267 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001268 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1269 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1270 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1271 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1272 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1273 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1274 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001275#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001276 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 +02001277 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001278#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001279
Willy Tarreaud6a78502019-05-27 07:03:38 +02001280#if defined(DEBUG_DEV)
1281 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001282 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1283 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1284 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001285#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001286
1287 if (ci_putchk(si_ic(si), &trash) == -1) {
1288 chunk_reset(&trash);
1289 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001290 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001291 }
1292
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001293#undef SHOW_AVG
1294#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001295 /* dump complete */
1296 return 1;
1297}
1298
William Lallemandeceddf72016-12-15 18:06:44 +01001299/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001300 * CLI IO handler for `show cli sockets`.
1301 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001302 */
1303static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1304{
1305 struct bind_conf *bind_conf;
1306 struct stream_interface *si = appctx->owner;
1307
1308 chunk_reset(&trash);
1309
1310 switch (appctx->st2) {
1311 case STAT_ST_INIT:
1312 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001313 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001314 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001315 return 0;
1316 }
William Lallemandeceddf72016-12-15 18:06:44 +01001317 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001318 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001319
1320 case STAT_ST_LIST:
1321 if (global.stats_fe) {
1322 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1323 struct listener *l;
1324
1325 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001326 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001327 * if the current node is the first of the list
1328 */
1329
Willy Tarreau3af9d832016-12-16 12:58:09 +01001330 if (appctx->ctx.cli.p0 &&
1331 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001332 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001333 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001334 continue;
1335 }
1336
1337 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1338
1339 char addr[46];
1340 char port[6];
1341
Willy Tarreau37159062020-08-27 07:48:42 +02001342 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001343 const struct sockaddr_un *un;
1344
Willy Tarreau37159062020-08-27 07:48:42 +02001345 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001346 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001347 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001348 } else {
1349 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1350 }
Willy Tarreau37159062020-08-27 07:48:42 +02001351 } else if (l->rx.addr.ss_family == AF_INET) {
1352 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1353 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001354 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001355 } else if (l->rx.addr.ss_family == AF_INET6) {
1356 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1357 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001358 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001359 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1360 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001361 } else
William Lallemand26314342018-10-26 14:47:41 +02001362 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001363
William Lallemand07a62f72017-05-24 00:57:40 +02001364 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001365 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001366 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1367 chunk_appendf(&trash, "operator ");
1368 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1369 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001370 else
1371 chunk_appendf(&trash, " ");
1372
Willy Tarreaue26993c2020-09-03 07:18:55 +02001373 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001374 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001375 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1376 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001377 chunk_appendf(&trash, "%d,", pos+1);
1378 }
1379 }
1380 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001381 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001382
1383 } else {
1384 chunk_appendf(&trash, "all\n");
1385 }
1386
Willy Tarreau06d80a92017-10-19 14:32:15 +02001387 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001388 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001389 return 0;
1390 }
1391 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001392 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001393 }
1394 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001395 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001396 default:
1397 appctx->st2 = STAT_ST_FIN;
1398 return 1;
1399 }
1400}
1401
1402
Willy Tarreau0a739292016-11-22 20:21:23 +01001403/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001404 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1405 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001406 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001407static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001408{
1409 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001410 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001411
1412 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1413 return 1;
1414
Willy Tarreauf6710f82016-12-16 17:45:44 +01001415 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001416
1417 if (*args[2]) {
1418 int len = strlen(args[2]);
1419
Willy Tarreauf6710f82016-12-16 17:45:44 +01001420 for (; *var; var++) {
1421 if (strncmp(*var, args[2], len) == 0 &&
1422 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001423 break;
1424 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001425 if (!*var)
1426 return cli_err(appctx, "Variable not found\n");
1427
Willy Tarreau0a739292016-11-22 20:21:23 +01001428 appctx->st2 = STAT_ST_END;
1429 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001430 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001431 return 0;
1432}
1433
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001434/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1435 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1436 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1437 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001438static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001439{
1440 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1441 return 1;
1442
1443 appctx->ctx.cli.i0 = 0;
1444
1445 if (*args[2]) {
1446 appctx->ctx.cli.i0 = atoi(args[2]);
1447 appctx->st2 = STAT_ST_END;
1448 }
1449 return 0;
1450}
1451
Willy Tarreau599852e2016-11-22 20:33:32 +01001452/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001453static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001454{
1455 struct stream_interface *si = appctx->owner;
1456 struct stream *s = si_strm(si);
1457
1458 if (strcmp(args[2], "cli") == 0) {
1459 unsigned timeout;
1460 const char *res;
1461
Willy Tarreau9d008692019-08-09 11:21:01 +02001462 if (!*args[3])
1463 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001464
1465 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001466 if (res || timeout < 1)
1467 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001468
1469 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1470 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1471 return 1;
1472 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001473
1474 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001475}
1476
Willy Tarreau2af99412016-11-23 11:10:59 +01001477/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001478static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001479{
1480 int v;
1481
1482 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1483 return 1;
1484
Willy Tarreau9d008692019-08-09 11:21:01 +02001485 if (!*args[3])
1486 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001487
1488 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001489 if (v > global.hardmaxconn)
1490 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001491
1492 /* check for unlimited values */
1493 if (v <= 0)
1494 v = global.hardmaxconn;
1495
1496 global.maxconn = v;
1497
1498 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001499 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001500
1501 return 1;
1502}
1503
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001504static int set_severity_output(int *target, char *argument)
1505{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001506 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001507 *target = CLI_SEVERITY_NONE;
1508 return 1;
1509 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001510 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001511 *target = CLI_SEVERITY_NUMBER;
1512 return 1;
1513 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001514 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001515 *target = CLI_SEVERITY_STRING;
1516 return 1;
1517 }
1518 return 0;
1519}
1520
1521/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001522static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001523{
1524 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1525 return 0;
1526
Willy Tarreau9d008692019-08-09 11:21:01 +02001527 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001528}
William Lallemandeceddf72016-12-15 18:06:44 +01001529
William Lallemand67a234f2018-12-13 09:05:45 +01001530
1531/* show the level of the current CLI session */
1532static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1533{
William Lallemand67a234f2018-12-13 09:05:45 +01001534 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001535 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001536 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001537 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001538 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001539 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001540 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001541 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001542}
1543
1544/* parse and set the CLI level dynamically */
1545static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1546{
William Lallemandad032882019-07-01 10:56:15 +02001547 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001548 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001549 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1550
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001551 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001552 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1553 return 1;
1554 }
1555 appctx->cli_level &= ~ACCESS_LVL_MASK;
1556 appctx->cli_level |= ACCESS_LVL_OPER;
1557
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001558 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001559 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1560 return 1;
1561 }
1562 appctx->cli_level &= ~ACCESS_LVL_MASK;
1563 appctx->cli_level |= ACCESS_LVL_USER;
1564 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001565 appctx->cli_level &= ~ACCESS_EXPERT;
1566 return 1;
1567}
1568
1569
1570/* parse and set the CLI expert-mode dynamically */
1571static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1572{
1573 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1574 return 1;
1575
1576 if (!*args[1])
1577 return (appctx->cli_level & ACCESS_EXPERT)
1578 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1579 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1580
1581 appctx->cli_level &= ~ACCESS_EXPERT;
1582 if (strcmp(args[1], "on") == 0)
1583 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001584 return 1;
1585}
1586
William Lallemanda57b7e32018-12-14 21:11:31 +01001587
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001588int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001589{
1590 return 0;
1591}
1592
Willy Tarreau45c742b2016-11-24 14:51:17 +01001593/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001594static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001595{
1596 int v;
1597 int *res;
1598 int mul = 1;
1599
1600 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1601 return 1;
1602
1603 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1604 res = &global.cps_lim;
1605 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1606 res = &global.sps_lim;
1607#ifdef USE_OPENSSL
1608 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1609 res = &global.ssl_lim;
1610#endif
1611 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1612 res = &global.comp_rate_lim;
1613 mul = 1024;
1614 }
1615 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001616 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001617 "'set rate-limit' only supports :\n"
1618 " - 'connections global' to set the per-process maximum connection rate\n"
1619 " - 'sessions global' to set the per-process maximum session rate\n"
1620#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001621 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001622#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001623 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001624 }
1625
Willy Tarreau9d008692019-08-09 11:21:01 +02001626 if (!*args[4])
1627 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001628
1629 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001630 if (v < 0)
1631 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001632
1633 *res = v * mul;
1634
1635 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001636 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001637
1638 return 1;
1639}
1640
William Lallemandf6975e92017-05-26 17:42:10 +02001641/* parse the "expose-fd" argument on the bind lines */
1642static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1643{
1644 if (!*args[cur_arg + 1]) {
1645 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1646 return ERR_ALERT | ERR_FATAL;
1647 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001648 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001649 conf->level |= ACCESS_FD_LISTENERS;
1650 } else {
1651 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1652 args[cur_arg], args[cur_arg+1]);
1653 return ERR_ALERT | ERR_FATAL;
1654 }
1655
1656 return 0;
1657}
1658
William Lallemand74c24fb2016-11-21 17:18:36 +01001659/* parse the "level" argument on the bind lines */
1660static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1661{
1662 if (!*args[cur_arg + 1]) {
1663 memprintf(err, "'%s' : missing level", args[cur_arg]);
1664 return ERR_ALERT | ERR_FATAL;
1665 }
1666
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001667 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001668 conf->level &= ~ACCESS_LVL_MASK;
1669 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001670 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001671 conf->level &= ~ACCESS_LVL_MASK;
1672 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001673 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001674 conf->level &= ~ACCESS_LVL_MASK;
1675 conf->level |= ACCESS_LVL_ADMIN;
1676 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001677 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1678 args[cur_arg], args[cur_arg+1]);
1679 return ERR_ALERT | ERR_FATAL;
1680 }
1681
1682 return 0;
1683}
1684
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001685static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1686{
1687 if (!*args[cur_arg + 1]) {
1688 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1689 return ERR_ALERT | ERR_FATAL;
1690 }
1691
1692 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1693 return 0;
1694 else {
1695 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1696 args[cur_arg], args[cur_arg+1]);
1697 return ERR_ALERT | ERR_FATAL;
1698 }
1699}
1700
Olivier Houchardf886e342017-04-05 22:24:59 +02001701/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001702static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001703{
1704 char *cmsgbuf = NULL;
1705 unsigned char *tmpbuf = NULL;
1706 struct cmsghdr *cmsg;
1707 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001708 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001709 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001710 struct msghdr msghdr;
1711 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001712 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001713 const char *ns_name, *if_name;
1714 unsigned char ns_nlen, if_nlen;
1715 int nb_queued;
1716 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001717 int *tmpfd;
1718 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001719 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001720 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001721 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001722 int ret;
1723
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001724 if (!remote) {
1725 ha_warning("Only works on real connections\n");
1726 goto out;
1727 }
1728
1729 fd = remote->handle.fd;
1730
Olivier Houchardf886e342017-04-05 22:24:59 +02001731 /* Temporary set the FD in blocking mode, that will make our life easier */
1732 old_fcntl = fcntl(fd, F_GETFL);
1733 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001734 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001735 goto out;
1736 }
1737 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1738 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001739 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001740 goto out;
1741 }
1742 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001743 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001744 goto out;
1745 }
Olivier Houchard54740872017-04-06 14:45:14 +02001746 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001747 iov.iov_base = &tot_fd_nb;
1748 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001749 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001750 goto out;
1751 memset(&msghdr, 0, sizeof(msghdr));
1752 /*
1753 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001754 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001755 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001756 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
1757 tot_fd_nb += fdtab[cur_fd].exported;
William Lallemand5fd3b282020-01-16 15:32:08 +01001758
Olivier Houchardf886e342017-04-05 22:24:59 +02001759 if (tot_fd_nb == 0)
1760 goto out;
1761
1762 /* First send the total number of file descriptors, so that the
1763 * receiving end knows what to expect.
1764 */
1765 msghdr.msg_iov = &iov;
1766 msghdr.msg_iovlen = 1;
1767 ret = sendmsg(fd, &msghdr, 0);
1768 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001769 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001770 goto out;
1771 }
1772
1773 /* Now send the fds */
1774 msghdr.msg_control = cmsgbuf;
1775 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1776 cmsg = CMSG_FIRSTHDR(&msghdr);
1777 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1778 cmsg->cmsg_level = SOL_SOCKET;
1779 cmsg->cmsg_type = SCM_RIGHTS;
1780 tmpfd = (int *)CMSG_DATA(cmsg);
1781
Olivier Houchardf886e342017-04-05 22:24:59 +02001782 /* For each socket, e message is sent, containing the following :
1783 * Size of the namespace name (or 0 if none), as an unsigned char.
1784 * The namespace name, if any
1785 * Size of the interface name (or 0 if none), as an unsigned char
1786 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001787 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001788 */
1789 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001790 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001791 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001792 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001793 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001794 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001795 goto out;
1796 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001797
1798 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001799 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001800 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
1801 if (!(fdtab[cur_fd].exported))
1802 continue;
1803
1804 ns_name = if_name = "";
1805 ns_nlen = if_nlen = 0;
1806
1807 /* for now we can only retrieve namespaces and interfaces from
1808 * pure listeners.
1809 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001810 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001811 const struct listener *l = fdtab[cur_fd].owner;
1812
Willy Tarreau818a92e2020-09-03 07:50:19 +02001813 if (l->rx.settings->interface) {
1814 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001815 if_nlen = strlen(if_name);
1816 }
1817
1818#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001819 if (l->rx.settings->netns) {
1820 ns_name = l->rx.settings->netns->node.key;
1821 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001822 }
1823#endif
1824 }
1825
1826 /* put the FD into the CMSG_DATA */
1827 tmpfd[nb_queued++] = cur_fd;
1828
1829 /* first block is <ns_name_len> <ns_name> */
1830 tmpbuf[curoff++] = ns_nlen;
1831 if (ns_nlen)
1832 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1833 curoff += ns_nlen;
1834
1835 /* second block is <if_name_len> <if_name> */
1836 tmpbuf[curoff++] = if_nlen;
1837 if (if_nlen)
1838 memcpy(tmpbuf + curoff, if_name, if_nlen);
1839 curoff += if_nlen;
1840
1841 /* we used to send the listener options here before 2.3 */
1842 memset(tmpbuf + curoff, 0, sizeof(int));
1843 curoff += sizeof(int);
1844
1845 /* there's a limit to how many FDs may be sent at once */
1846 if (nb_queued == MAX_SEND_FD) {
1847 iov.iov_len = curoff;
1848 if (sendmsg(fd, &msghdr, 0) != curoff) {
1849 ha_warning("Failed to transfer sockets\n");
1850 return -1;
1851 }
1852
1853 /* Wait for an ack */
1854 do {
1855 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
1856 } while (ret == -1 && errno == EINTR);
1857
1858 if (ret <= 0) {
1859 ha_warning("Unexpected error while transferring sockets\n");
1860 return -1;
1861 }
1862 curoff = 0;
1863 nb_queued = 0;
1864 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001865 }
1866
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001867 /* flush pending stuff */
1868 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02001869 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001870 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
1871 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02001872 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001873 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001874 goto out;
1875 }
1876 }
1877
1878out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001879 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001880 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001881 goto out;
1882 }
1883 appctx->st0 = CLI_ST_END;
1884 free(cmsgbuf);
1885 free(tmpbuf);
1886 return 1;
1887}
1888
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001889static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1890{
1891 if (*args[0] == 'h')
1892 /* help */
1893 cli_gen_usage_msg(appctx);
1894 else if (*args[0] == 'p')
1895 /* prompt */
1896 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1897 else if (*args[0] == 'q')
1898 /* quit */
1899 appctx->st0 = CLI_ST_END;
1900
1901 return 1;
1902}
Olivier Houchardf886e342017-04-05 22:24:59 +02001903
William Lallemand2f4ce202018-10-26 14:47:47 +02001904void pcli_write_prompt(struct stream *s)
1905{
1906 struct buffer *msg = get_trash_chunk();
1907 struct channel *oc = si_oc(&s->si[0]);
1908
William Lallemanddc12c2e2018-12-13 09:05:46 +01001909 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001910 return;
1911
William Lallemanddc12c2e2018-12-13 09:05:46 +01001912 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001913 chunk_appendf(msg, "+ ");
1914 } else {
1915 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001916 chunk_appendf(msg, "master%s> ",
1917 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001918 else
1919 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1920 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001921 co_inject(oc, msg->area, msg->data);
1922}
1923
William Lallemand291810d2018-10-26 14:47:38 +02001924
William Lallemandcf62f7e2018-10-26 14:47:40 +02001925/* The pcli_* functions are used for the CLI proxy in the master */
1926
William Lallemanddeeaa592018-10-26 14:47:48 +02001927void pcli_reply_and_close(struct stream *s, const char *msg)
1928{
1929 struct buffer *buf = get_trash_chunk();
1930
1931 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001932 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001933}
1934
William Lallemand291810d2018-10-26 14:47:38 +02001935static enum obj_type *pcli_pid_to_server(int proc_pid)
1936{
1937 struct mworker_proc *child;
1938
William Lallemand99e0bb92020-11-05 10:28:53 +01001939 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01001940 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01001941 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01001942
William Lallemand291810d2018-10-26 14:47:38 +02001943 list_for_each_entry(child, &proc_list, list) {
1944 if (child->pid == proc_pid){
1945 return &child->srv->obj_type;
1946 }
1947 }
1948 return NULL;
1949}
1950
1951/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1952 * Return:
1953 * 0: master
1954 * > 0: pid of a worker
1955 * < 0: didn't find a worker
1956 */
1957static int pcli_prefix_to_pid(const char *prefix)
1958{
1959 int proc_pid;
1960 struct mworker_proc *child;
1961 char *errtol = NULL;
1962
1963 if (*prefix != '@') /* not a prefix, should not happen */
1964 return -1;
1965
1966 prefix++;
1967 if (!*prefix) /* sent @ alone, return the master */
1968 return 0;
1969
1970 if (strcmp("master", prefix) == 0) {
1971 return 0;
1972 } else if (*prefix == '!') {
1973 prefix++;
1974 if (!*prefix)
1975 return -1;
1976
1977 proc_pid = strtol(prefix, &errtol, 10);
1978 if (*errtol != '\0')
1979 return -1;
1980 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001981 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001982 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001983 if (child->pid == proc_pid){
1984 return child->pid;
1985 }
1986 }
1987 } else {
1988 struct mworker_proc *chosen = NULL;
1989 /* this is a relative pid */
1990
1991 proc_pid = strtol(prefix, &errtol, 10);
1992 if (*errtol != '\0')
1993 return -1;
1994
1995 if (proc_pid == 0) /* return the master */
1996 return 0;
1997
1998 /* chose the right process, the current one is the one with the
1999 least number of reloads */
2000 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002001 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002002 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002003 if (child->relative_pid == proc_pid){
2004 if (child->reloads == 0)
2005 return child->pid;
2006 else if (chosen == NULL || child->reloads < chosen->reloads)
2007 chosen = child;
2008 }
2009 }
2010 if (chosen)
2011 return chosen->pid;
2012 }
2013 return -1;
2014}
2015
William Lallemandbddd33a2018-12-11 16:10:53 +01002016/* Return::
2017 * >= 0 : number of words to escape
2018 * = -1 : error
2019 */
2020
2021int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2022{
2023 if (argl < 1)
2024 return 0;
2025
2026 /* there is a prefix */
2027 if (args[0][0] == '@') {
2028 int target_pid = pcli_prefix_to_pid(args[0]);
2029
2030 if (target_pid == -1) {
2031 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2032 return -1;
2033 }
2034
2035 /* if the prefix is alone, define a default target */
2036 if (argl == 1)
2037 s->pcli_next_pid = target_pid;
2038 else
2039 *next_pid = target_pid;
2040 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002041 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002042 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002043 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002044
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002045 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002046 channel_shutr_now(&s->req);
2047 channel_shutw_now(&s->res);
2048 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002049 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002050 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2051 memprintf(errmsg, "Permission denied!\n");
2052 return -1;
2053 }
2054 s->pcli_flags &= ~ACCESS_LVL_MASK;
2055 s->pcli_flags |= ACCESS_LVL_OPER;
2056 return argl;
2057
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002058 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002059 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2060 memprintf(errmsg, "Permission denied!\n");
2061 return -1;
2062 }
2063 s->pcli_flags &= ~ACCESS_LVL_MASK;
2064 s->pcli_flags |= ACCESS_LVL_USER;
2065 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002066 }
2067
2068 return 0;
2069}
2070
2071/*
2072 * Parse the CLI request:
2073 * - It does basically the same as the cli_io_handler, but as a proxy
2074 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002075 *
2076 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002077 * - the number of characters to forward or
2078 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002079 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002080int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002081{
William Lallemandbddd33a2018-12-11 16:10:53 +01002082 char *str = (char *)ci_head(req);
2083 char *end = (char *)ci_stop(req);
2084 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2085 int argl; /* number of args */
2086 char *p;
2087 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002088 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002089 int wtrim = 0; /* number of words to trim */
2090 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002091 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002092 int i = 0;
2093
2094 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002095
William Lallemanddc12c2e2018-12-13 09:05:46 +01002096 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002097
2098 /* Looks for the end of one command */
2099 while (p+reql < end) {
2100 /* handle escaping */
2101 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002102 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002103 continue;
2104 }
2105 if (p[reql] == ';' || p[reql] == '\n') {
2106 /* found the end of the command */
2107 p[reql] = '\n';
2108 reql++;
2109 break;
2110 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002111 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002112 }
William Lallemandebf61802018-12-11 16:10:57 +01002113 } else {
2114 while (p+reql < end) {
2115 if (p[reql] == '\n') {
2116 /* found the end of the line */
2117 reql++;
2118 break;
2119 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002120 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002121 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002122 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002123
William Lallemandbddd33a2018-12-11 16:10:53 +01002124 /* set end to first byte after the end of the command */
2125 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002126
William Lallemandbddd33a2018-12-11 16:10:53 +01002127 /* there is no end to this command, need more to parse ! */
2128 if (*(end-1) != '\n') {
2129 return -1;
2130 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002131
William Lallemand3301f3e2018-12-13 09:05:48 +01002132 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2133 if (reql == 1) /* last line of the payload */
2134 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002135 return reql;
2136 }
2137
William Lallemandbddd33a2018-12-11 16:10:53 +01002138 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002139
William Lallemandbddd33a2018-12-11 16:10:53 +01002140 /* splits the command in words */
2141 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002142 /* skip leading spaces/tabs */
2143 p += strspn(p, " \t");
2144 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002145 break;
2146
William Lallemandbddd33a2018-12-11 16:10:53 +01002147 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002148 while (1) {
2149 p += strcspn(p, " \t\\");
2150 /* escaped chars using backlashes (\) */
2151 if (*p == '\\') {
2152 if (!*++p)
2153 break;
2154 if (!*++p)
2155 break;
2156 } else {
2157 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002158 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002159 }
William Lallemandfe249c32020-06-18 18:03:57 +02002160 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002161 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002162 }
2163
William Lallemandbddd33a2018-12-11 16:10:53 +01002164 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002165
William Lallemandbddd33a2018-12-11 16:10:53 +01002166 for (; i < MAX_STATS_ARGS + 1; i++)
2167 args[i] = NULL;
2168
2169 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2170
2171 /* End of words are ending by \0, we need to replace the \0s by spaces
21721 before forwarding them */
2173 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002174 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002175 if (*p == '\0')
2176 *p = ' ';
2177 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002178 }
2179
William Lallemand3301f3e2018-12-13 09:05:48 +01002180 payload = strstr(str, PAYLOAD_PATTERN);
2181 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2182 /* if the payload pattern is at the end */
2183 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002184 }
2185
William Lallemandbddd33a2018-12-11 16:10:53 +01002186 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002187
William Lallemandbddd33a2018-12-11 16:10:53 +01002188 if (wtrim > 0) {
2189 trim = &args[wtrim][0];
2190 if (trim == NULL) /* if this was the last word in the table */
2191 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002192
William Lallemandbddd33a2018-12-11 16:10:53 +01002193 b_del(&req->buf, trim - str);
2194
William Lallemandb7ea1412018-12-13 09:05:47 +01002195 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002196 } else if (wtrim < 0) {
2197 /* parsing error */
2198 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002199 } else {
2200 /* the whole string */
2201 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002202 }
2203
William Lallemandb7ea1412018-12-13 09:05:47 +01002204 if (ret > 1) {
2205 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2206 goto end;
2207 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002208 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2209 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002210 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002211 ci_insert_line2(req, 0, "user -", strlen("user -"));
2212 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002213 }
2214 }
2215end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002216
William Lallemandb7ea1412018-12-13 09:05:47 +01002217 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002218}
2219
2220int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2221{
William Lallemandbddd33a2018-12-11 16:10:53 +01002222 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002223 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002224 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002225
William Lallemandb7ea1412018-12-13 09:05:47 +01002226 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2227 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2228
William Lallemandcf62f7e2018-10-26 14:47:40 +02002229read_again:
2230 /* if the channel is closed for read, we won't receive any more data
2231 from the client, but we don't want to forward this close to the
2232 server */
2233 channel_dont_close(req);
2234
2235 /* We don't know yet to which server we will connect */
2236 channel_dont_connect(req);
2237
2238
2239 /* we are not waiting for a response, there is no more request and we
2240 * receive a close from the client, we can leave */
2241 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2242 channel_shutw_now(&s->res);
2243 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2244 return 1;
2245 }
2246
2247 req->flags |= CF_READ_DONTWAIT;
2248
2249 /* need more data */
2250 if (!ci_data(req))
2251 return 0;
2252
2253 /* If there is data available for analysis, log the end of the idle time. */
2254 if (c_data(req) && s->logs.t_idle == -1)
2255 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2256
William Lallemandbddd33a2018-12-11 16:10:53 +01002257 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002258 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002259 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002260 /* enough data */
2261
William Lallemandcf62f7e2018-10-26 14:47:40 +02002262 /* forward only 1 command */
2263 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002264
William Lallemanddc12c2e2018-12-13 09:05:46 +01002265 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002266 /* we send only 1 command per request, and we write close after it */
2267 channel_shutw_now(req);
2268 } else {
2269 pcli_write_prompt(s);
2270 }
2271
2272 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002273
2274 /* remove the XFER_DATA analysers, which forwards all
2275 * the data, we don't want to forward the next requests
2276 * We need to add CF_FLT_ANALYZE to abort the forward too.
2277 */
2278 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2279 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2280 s->res.analysers |= AN_RES_WAIT_CLI;
2281
William Lallemandebf61802018-12-11 16:10:57 +01002282 if (!(s->flags & SF_ASSIGNED)) {
2283 if (next_pid > -1)
2284 target_pid = next_pid;
2285 else
2286 target_pid = s->pcli_next_pid;
2287 /* we can connect now */
2288 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002289
William Lallemandebf61802018-12-11 16:10:57 +01002290 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2291 channel_auto_connect(req);
2292 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002293
2294 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002295 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002296 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002297 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002298 } else if (to_forward == -1 && errmsg) {
2299 /* there was an error during the parsing */
2300 pcli_reply_and_close(s, errmsg);
2301 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002302 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2303 /* buffer is full and we didn't catch the end of a command */
2304 goto send_help;
2305 }
2306
2307 return 0;
2308
2309send_help:
2310 b_reset(&req->buf);
2311 b_putblk(&req->buf, "help\n", 5);
2312 goto read_again;
2313}
2314
2315int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2316{
2317 struct proxy *fe = strm_fe(s);
2318 struct proxy *be = s->be;
2319
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002320 if (rep->flags & CF_READ_ERROR) {
2321 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2322 s->res.analysers &= ~AN_RES_WAIT_CLI;
2323 return 0;
2324 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002325 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2326 rep->flags |= CF_NEVER_WAIT;
2327
2328 /* don't forward the close */
2329 channel_dont_close(&s->res);
2330 channel_dont_close(&s->req);
2331
William Lallemanddc12c2e2018-12-13 09:05:46 +01002332 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002333 s->req.analysers |= AN_REQ_WAIT_CLI;
2334 s->res.analysers &= ~AN_RES_WAIT_CLI;
2335 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2336 return 0;
2337 }
2338
William Lallemandcf62f7e2018-10-26 14:47:40 +02002339 /* forward the data */
2340 if (ci_data(rep)) {
2341 c_adv(rep, ci_data(rep));
2342 return 0;
2343 }
2344
2345 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2346 /* stream cleanup */
2347
William Lallemand2f4ce202018-10-26 14:47:47 +02002348 pcli_write_prompt(s);
2349
William Lallemandcf62f7e2018-10-26 14:47:40 +02002350 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2351 si_shutr(&s->si[1]);
2352 si_shutw(&s->si[1]);
2353
2354 /*
2355 * starting from there this the same code as
2356 * http_end_txn_clean_session().
2357 *
2358 * It allows to do frontend keepalive while reconnecting to a
2359 * new server for each request.
2360 */
2361
2362 if (s->flags & SF_BE_ASSIGNED) {
2363 HA_ATOMIC_SUB(&be->beconn, 1);
2364 if (unlikely(s->srv_conn))
2365 sess_change_server(s, NULL);
2366 }
2367
2368 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2369 stream_process_counters(s);
2370
2371 /* don't count other requests' data */
2372 s->logs.bytes_in -= ci_data(&s->req);
2373 s->logs.bytes_out -= ci_data(&s->res);
2374
2375 /* we may need to know the position in the queue */
2376 pendconn_free(s);
2377
2378 /* let's do a final log if we need it */
2379 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2380 !(s->flags & SF_MONITOR) &&
2381 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2382 s->do_log(s);
2383 }
2384
2385 /* stop tracking content-based counters */
2386 stream_stop_content_counters(s);
2387 stream_update_time_stats(s);
2388
2389 s->logs.accept_date = date; /* user-visible date for logging */
2390 s->logs.tv_accept = now; /* corrected date for internal use */
2391 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2392 s->logs.t_idle = -1;
2393 tv_zero(&s->logs.tv_request);
2394 s->logs.t_queue = -1;
2395 s->logs.t_connect = -1;
2396 s->logs.t_data = -1;
2397 s->logs.t_close = 0;
2398 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2399 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2400
2401 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2402 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2403
2404 stream_del_srv_conn(s);
2405 if (objt_server(s->target)) {
2406 if (s->flags & SF_CURR_SESS) {
2407 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002408 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002409 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002410 if (may_dequeue_tasks(__objt_server(s->target), be))
2411 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002412 }
2413
2414 s->target = NULL;
2415
2416 /* only release our endpoint if we don't intend to reuse the
2417 * connection.
2418 */
2419 if (!si_conn_ready(&s->si[1])) {
2420 si_release_endpoint(&s->si[1]);
2421 s->srv_conn = NULL;
2422 }
2423
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002424 sockaddr_free(&s->target_addr);
2425
William Lallemandcf62f7e2018-10-26 14:47:40 +02002426 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2427 s->si[1].err_type = SI_ET_NONE;
2428 s->si[1].conn_retries = 0; /* used for logging too */
2429 s->si[1].exp = TICK_ETERNITY;
2430 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 +02002431 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 +02002432 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 +02002433 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2434 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2435 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2436 /* reinitialise the current rule list pointer to NULL. We are sure that
2437 * any rulelist match the NULL pointer.
2438 */
2439 s->current_rule_list = NULL;
2440
2441 s->be = strm_fe(s);
2442 s->logs.logwait = strm_fe(s)->to_log;
2443 s->logs.level = 0;
2444 stream_del_srv_conn(s);
2445 s->target = NULL;
2446 /* re-init store persistence */
2447 s->store_count = 0;
2448 s->uniq_id = global.req_count++;
2449
2450 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2451
2452 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2453
2454 s->req.analysers |= AN_REQ_WAIT_CLI;
2455 s->res.analysers &= ~AN_RES_WAIT_CLI;
2456
2457 /* We must trim any excess data from the response buffer, because we
2458 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002459 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002460 * we want those data to come along with next response. A typical
2461 * example of such data would be from a buggy server responding to
2462 * a HEAD with some data, or sending more than the advertised
2463 * content-length.
2464 */
2465 if (unlikely(ci_data(&s->res)))
2466 b_set_data(&s->res.buf, co_data(&s->res));
2467
2468 /* Now we can realign the response buffer */
2469 c_realign_if_empty(&s->res);
2470
2471 s->req.rto = strm_fe(s)->timeout.client;
2472 s->req.wto = TICK_ETERNITY;
2473
2474 s->res.rto = TICK_ETERNITY;
2475 s->res.wto = strm_fe(s)->timeout.client;
2476
2477 s->req.rex = TICK_ETERNITY;
2478 s->req.wex = TICK_ETERNITY;
2479 s->req.analyse_exp = TICK_ETERNITY;
2480 s->res.rex = TICK_ETERNITY;
2481 s->res.wex = TICK_ETERNITY;
2482 s->res.analyse_exp = TICK_ETERNITY;
2483 s->si[1].hcto = TICK_ETERNITY;
2484
2485 /* we're removing the analysers, we MUST re-enable events detection.
2486 * We don't enable close on the response channel since it's either
2487 * already closed, or in keep-alive with an idle connection handler.
2488 */
2489 channel_auto_read(&s->req);
2490 channel_auto_close(&s->req);
2491 channel_auto_read(&s->res);
2492
2493
2494 return 1;
2495 }
2496 return 0;
2497}
2498
William Lallemand8a022572018-10-26 14:47:35 +02002499/*
2500 * The mworker functions are used to initialize the CLI in the master process
2501 */
2502
William Lallemand309dc9a2018-10-26 14:47:45 +02002503 /*
2504 * Stop the mworker proxy
2505 */
2506void mworker_cli_proxy_stop()
2507{
William Lallemand550db6d2018-11-06 17:37:12 +01002508 if (mworker_proxy)
2509 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002510}
2511
William Lallemand8a022572018-10-26 14:47:35 +02002512/*
2513 * Create the mworker CLI proxy
2514 */
2515int mworker_cli_proxy_create()
2516{
2517 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002518 char *msg = NULL;
2519 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002520
2521 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2522 if (!mworker_proxy)
2523 return -1;
2524
2525 init_new_proxy(mworker_proxy);
2526 mworker_proxy->next = proxies_list;
2527 proxies_list = mworker_proxy;
2528 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002529 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002530 mworker_proxy->last_change = now.tv_sec;
2531 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2532 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2533 mworker_proxy->timeout.client = 0; /* no timeout */
2534 mworker_proxy->conf.file = strdup("MASTER");
2535 mworker_proxy->conf.line = 0;
2536 mworker_proxy->accept = frontend_accept;
2537 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2538
2539 /* Does not init the default target the CLI applet, but must be done in
2540 * the request parsing code */
2541 mworker_proxy->default_target = NULL;
2542
2543 /* the check_config_validity() will get an ID for the proxy */
2544 mworker_proxy->uuid = -1;
2545
2546 proxy_store_name(mworker_proxy);
2547
2548 /* create all servers using the mworker_proc list */
2549 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002550 struct server *newsrv = NULL;
2551 struct sockaddr_storage *sk;
2552 int port1, port2, port;
2553 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002554
William Lallemanda31b09e2020-01-14 15:25:02 +01002555 /* only the workers support the master CLI */
2556 if (!(child->options & PROC_O_TYPE_WORKER))
2557 continue;
2558
William Lallemand8a022572018-10-26 14:47:35 +02002559 newsrv = new_server(mworker_proxy);
2560 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002561 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002562
2563 /* we don't know the new pid yet */
2564 if (child->pid == -1)
2565 memprintf(&msg, "cur-%d", child->relative_pid);
2566 else
2567 memprintf(&msg, "old-%d", child->pid);
2568
2569 newsrv->next = mworker_proxy->srv;
2570 mworker_proxy->srv = newsrv;
2571 newsrv->conf.file = strdup(msg);
2572 newsrv->id = strdup(msg);
2573 newsrv->conf.line = 0;
2574
2575 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002576 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002577 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002578 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002579 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002580 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002581
Willy Tarreau5fc93282020-09-16 18:25:03 +02002582 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002583 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002584 }
2585
2586 /* no port specified */
2587 newsrv->flags |= SRV_F_MAPPORTS;
2588 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002589 /* don't let the server participate to load balancing */
2590 newsrv->iweight = 0;
2591 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002592 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002593
2594 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002595 }
2596 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002597
2598error:
2599 ha_alert("%s\n", errmsg);
2600
2601 list_for_each_entry(child, &proc_list, list) {
2602 free((char *)child->srv->conf.file); /* cast because of const char * */
2603 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002604 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002605 }
2606 free(mworker_proxy->id);
2607 free(mworker_proxy->conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002608 ha_free(&mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002609 free(errmsg);
2610 free(msg);
2611
2612 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002613}
Olivier Houchardf886e342017-04-05 22:24:59 +02002614
William Lallemandce83b4a2018-10-26 14:47:30 +02002615/*
William Lallemande7361152018-10-26 14:47:36 +02002616 * Create a new listener for the master CLI proxy
2617 */
2618int mworker_cli_proxy_new_listener(char *line)
2619{
2620 struct bind_conf *bind_conf;
2621 struct listener *l;
2622 char *err = NULL;
2623 char *args[MAX_LINE_ARGS + 1];
2624 int arg;
2625 int cur_arg;
2626
William Lallemand2e945c82019-11-25 09:58:37 +01002627 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002628 args[0] = line;
2629
2630 /* args is a bind configuration with spaces replaced by commas */
2631 while (*line && arg < MAX_LINE_ARGS) {
2632
2633 if (*line == ',') {
2634 *line++ = '\0';
2635 while (*line == ',')
2636 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002637 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002638 }
2639 line++;
2640 }
2641
William Lallemand2e945c82019-11-25 09:58:37 +01002642 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002643
2644 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002645 if (!bind_conf)
2646 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002647
2648 bind_conf->level &= ~ACCESS_LVL_MASK;
2649 bind_conf->level |= ACCESS_LVL_ADMIN;
2650
2651 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2652 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002653 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002654 }
2655
2656 cur_arg = 1;
2657
2658 while (*args[cur_arg]) {
2659 static int bind_dumped;
2660 struct bind_kw *kw;
2661
2662 kw = bind_find_kw(args[cur_arg]);
2663 if (kw) {
2664 if (!kw->parse) {
2665 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2666 args[0], args[1], args[cur_arg]);
2667 goto err;
2668 }
2669
2670 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2671 if (err)
2672 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2673 else
2674 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2675 args[0], args[1], args[cur_arg]);
2676 goto err;
2677 }
2678
2679 cur_arg += 1 + kw->skip;
2680 continue;
2681 }
2682
2683 if (!bind_dumped) {
2684 bind_dump_kws(&err);
2685 indent_msg(&err, 4);
2686 bind_dumped = 1;
2687 }
2688
2689 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2690 args[0], args[1], args[cur_arg],
2691 err ? " Registered keywords :" : "", err ? err : "");
2692 goto err;
2693 }
2694
2695
2696 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002697 l->accept = session_accept_fd;
2698 l->default_target = mworker_proxy->default_target;
2699 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002700 l->options |= LI_O_UNLIMITED;
2701 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002702 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002703 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002704 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002705 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002706
2707 return 0;
2708
2709err:
2710 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002711 free(err);
2712 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002713 return -1;
2714
2715}
2716
2717/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002718 * Create a new CLI socket using a socketpair for a worker process
2719 * <mworker_proc> is the process structure, and <proc> is the process number
2720 */
2721int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2722{
2723 struct bind_conf *bind_conf;
2724 struct listener *l;
2725 char *path = NULL;
2726 char *err = NULL;
2727
2728 /* master pipe to ensure the master is still alive */
2729 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2730 ha_alert("Cannot create worker socketpair.\n");
2731 return -1;
2732 }
2733
2734 /* XXX: we might want to use a separate frontend at some point */
2735 if (!global.stats_fe) {
2736 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2737 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002738 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002739 }
2740 }
2741
2742 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002743 if (!bind_conf)
2744 goto error;
2745
William Lallemandce83b4a2018-10-26 14:47:30 +02002746 bind_conf->level &= ~ACCESS_LVL_MASK;
2747 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2748
Willy Tarreaue26993c2020-09-03 07:18:55 +02002749 bind_conf->settings.bind_proc = 1UL << proc;
William Lallemandce83b4a2018-10-26 14:47:30 +02002750 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2751
2752 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2753 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002754 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002755 }
2756
2757 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002758 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002759 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002760 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002761 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002762 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002763
2764 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002765 l->accept = session_accept_fd;
2766 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002767 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau455585e2020-10-09 18:25:14 +02002768 HA_ATOMIC_ADD(&unstoppable_jobs, 1);
William Lallemandce83b4a2018-10-26 14:47:30 +02002769 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002770 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002771 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002772 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002773 }
2774
2775 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002776
2777error:
2778 close(mworker_proc->ipc_fd[0]);
2779 close(mworker_proc->ipc_fd[1]);
2780 free(err);
2781
2782 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002783}
2784
William Lallemand74c24fb2016-11-21 17:18:36 +01002785static struct applet cli_applet = {
2786 .obj_type = OBJ_TYPE_APPLET,
2787 .name = "<CLI>", /* used for logging */
2788 .fct = cli_io_handler,
2789 .release = cli_release_handler,
2790};
2791
William Lallemand99e0bb92020-11-05 10:28:53 +01002792/* master CLI */
2793static struct applet mcli_applet = {
2794 .obj_type = OBJ_TYPE_APPLET,
2795 .name = "<MCLI>", /* used for logging */
2796 .fct = cli_io_handler,
2797 .release = cli_release_handler,
2798};
2799
Willy Tarreau0a739292016-11-22 20:21:23 +01002800/* register cli keywords */
2801static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002802 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2803 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2804 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002805 { { "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 +01002806 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002807 { { "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 +01002808 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002809 { { "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 +02002810 { { "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 +01002811 { { "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 +02002812 { { "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 +01002813 { { "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 +01002814 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2815 { { "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 +02002816 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002817 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002818 {{},}
2819}};
2820
Willy Tarreau0108d902018-11-25 19:14:37 +01002821INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2822
William Lallemand74c24fb2016-11-21 17:18:36 +01002823static struct cfg_kw_list cfg_kws = {ILH, {
2824 { CFG_GLOBAL, "stats", stats_parse_global },
2825 { 0, NULL, NULL },
2826}};
2827
Willy Tarreau0108d902018-11-25 19:14:37 +01002828INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2829
William Lallemand74c24fb2016-11-21 17:18:36 +01002830static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002831 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2832 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002833 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002834 { NULL, NULL, 0 },
2835}};
2836
Willy Tarreau0108d902018-11-25 19:14:37 +01002837INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002838
2839/*
2840 * Local variables:
2841 * c-indent-level: 8
2842 * c-basic-offset: 8
2843 * End:
2844 */