blob: 135b6b216fad05326617e456935dbbeba473e3ce [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/applet-t.h>
32#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020038#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020039#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020042#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020043#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020044#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020045#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020046#include <haproxy/log.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020054#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020055#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020056#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020057#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020058#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020059#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020060#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020061#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020062#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020063#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020064#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010065
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020066#define PAYLOAD_PATTERN "<<"
67
William Lallemand74c24fb2016-11-21 17:18:36 +010068static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010069static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010070
71static const char stats_sock_usage_msg[] =
72 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010073 " help : this message\n"
74 " prompt : toggle interactive mode with prompt\n"
75 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010076 "";
77
78static const char stats_permission_denied_msg[] =
79 "Permission denied\n"
80 "";
81
82
Christopher Faulet1bc04c72017-10-29 20:14:08 +010083static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010084
85/* List head of cli keywords */
86static struct cli_kw_list cli_keywords = {
87 .list = LIST_HEAD_INIT(cli_keywords.list)
88};
89
90extern const char *stat_status_codes[];
91
William Lallemand8a022572018-10-26 14:47:35 +020092static struct proxy *mworker_proxy; /* CLI proxy of the master */
93
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020094static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +010095{
96 struct cli_kw_list *kw_list;
97 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020098 struct buffer *tmp = get_trash_chunk();
99 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100100
101 free(dynamic_usage_msg);
102 dynamic_usage_msg = NULL;
103
104 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200105 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100106
107 chunk_reset(tmp);
108 chunk_strcat(tmp, stats_sock_usage_msg);
109 list_for_each_entry(kw_list, &cli_keywords.list, list) {
110 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200111 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200112
113 /* in a worker or normal process, don't display master only commands */
William Lallemand99e0bb92020-11-05 10:28:53 +0100114 if (appctx->applet == &cli_applet && (kw->level & ACCESS_MASTER_ONLY))
William Lallemand14721be2018-10-26 14:47:37 +0200115 goto next_kw;
116
117 /* in master don't displays if we don't have the master bits */
William Lallemand99e0bb92020-11-05 10:28:53 +0100118 if (appctx->applet == &mcli_applet && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
William Lallemand14721be2018-10-26 14:47:37 +0200119 goto next_kw;
120
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200121 /* only show expert commands in expert mode */
122 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
123 goto next_kw;
124
William Lallemand0154edc2018-05-15 11:50:04 +0200125 if (kw->usage)
126 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200127
128next_kw:
129
William Lallemand74c24fb2016-11-21 17:18:36 +0100130 kw++;
131 }
132 }
133 chunk_init(&out, NULL, 0);
134 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200135 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200136
137end:
138 if (dynamic_usage_msg) {
139 appctx->ctx.cli.severity = LOG_INFO;
140 appctx->ctx.cli.msg = dynamic_usage_msg;
141 }
142 else {
143 appctx->ctx.cli.severity = LOG_INFO;
144 appctx->ctx.cli.msg = stats_sock_usage_msg;
145 }
146 appctx->st0 = CLI_ST_PRINT;
147
William Lallemand74c24fb2016-11-21 17:18:36 +0100148 return dynamic_usage_msg;
149}
150
151struct cli_kw* cli_find_kw(char **args)
152{
153 struct cli_kw_list *kw_list;
154 struct cli_kw *kw;/* current cli_kw */
155 char **tmp_args;
156 const char **tmp_str_kw;
157 int found = 0;
158
159 if (LIST_ISEMPTY(&cli_keywords.list))
160 return NULL;
161
162 list_for_each_entry(kw_list, &cli_keywords.list, list) {
163 kw = &kw_list->kw[0];
164 while (*kw->str_kw) {
165 tmp_args = args;
166 tmp_str_kw = kw->str_kw;
167 while (*tmp_str_kw) {
168 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
169 found = 1;
170 } else {
171 found = 0;
172 break;
173 }
174 tmp_args++;
175 tmp_str_kw++;
176 }
177 if (found)
178 return (kw);
179 kw++;
180 }
181 }
182 return NULL;
183}
184
185void cli_register_kw(struct cli_kw_list *kw_list)
186{
187 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
188}
189
190
191/* allocate a new stats frontend named <name>, and return it
192 * (or NULL in case of lack of memory).
193 */
194static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
195{
196 struct proxy *fe;
197
198 fe = calloc(1, sizeof(*fe));
199 if (!fe)
200 return NULL;
201
202 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100203 fe->next = proxies_list;
204 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100205 fe->last_change = now.tv_sec;
206 fe->id = strdup("GLOBAL");
207 fe->cap = PR_CAP_FE;
208 fe->maxconn = 10; /* default to 10 concurrent connections */
209 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
210 fe->conf.file = strdup(file);
211 fe->conf.line = line;
212 fe->accept = frontend_accept;
213 fe->default_target = &cli_applet.obj_type;
214
215 /* the stats frontend is the only one able to assign ID #0 */
216 fe->conf.id.key = fe->uuid = 0;
217 eb32_insert(&used_proxy_id, &fe->conf.id);
218 return fe;
219}
220
221/* This function parses a "stats" statement in the "global" section. It returns
222 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
223 * error message into the <err> buffer which will be preallocated. The trailing
224 * '\n' must not be written. The function must be called with <args> pointing to
225 * the first word after "stats".
226 */
227static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
228 struct proxy *defpx, const char *file, int line,
229 char **err)
230{
231 struct bind_conf *bind_conf;
232 struct listener *l;
233
234 if (!strcmp(args[1], "socket")) {
235 int cur_arg;
236
237 if (*args[2] == 0) {
238 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
239 return -1;
240 }
241
242 if (!global.stats_fe) {
243 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
244 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
245 return -1;
246 }
247 }
248
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100249 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200250 bind_conf->level &= ~ACCESS_LVL_MASK;
251 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100252
253 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
254 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
255 file, line, args[0], args[1], err && *err ? *err : "error");
256 return -1;
257 }
258
259 cur_arg = 3;
260 while (*args[cur_arg]) {
261 static int bind_dumped;
262 struct bind_kw *kw;
263
264 kw = bind_find_kw(args[cur_arg]);
265 if (kw) {
266 if (!kw->parse) {
267 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
268 args[0], args[1], args[cur_arg]);
269 return -1;
270 }
271
272 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
273 if (err && *err)
274 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
275 else
276 memprintf(err, "'%s %s' : error encountered while processing '%s'",
277 args[0], args[1], args[cur_arg]);
278 return -1;
279 }
280
281 cur_arg += 1 + kw->skip;
282 continue;
283 }
284
285 if (!bind_dumped) {
286 bind_dump_kws(err);
287 indent_msg(err, 4);
288 bind_dumped = 1;
289 }
290
291 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
292 args[0], args[1], args[cur_arg],
293 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
294 return -1;
295 }
296
297 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100298 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100299 l->default_target = global.stats_fe->default_target;
300 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
301 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100302 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100303 }
304 }
305 else if (!strcmp(args[1], "timeout")) {
306 unsigned timeout;
307 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
308
Willy Tarreau9faebe32019-06-07 19:00:37 +0200309 if (res == PARSE_TIME_OVER) {
310 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
311 args[2], args[0], args[1]);
312 return -1;
313 }
314 else if (res == PARSE_TIME_UNDER) {
315 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
316 args[2], args[0], args[1]);
317 return -1;
318 }
319 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100320 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
321 return -1;
322 }
323
324 if (!timeout) {
325 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
326 return -1;
327 }
328 if (!global.stats_fe) {
329 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
330 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
331 return -1;
332 }
333 }
334 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
335 }
336 else if (!strcmp(args[1], "maxconn")) {
337 int maxconn = atol(args[2]);
338
339 if (maxconn <= 0) {
340 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
341 return -1;
342 }
343
344 if (!global.stats_fe) {
345 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
346 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
347 return -1;
348 }
349 }
350 global.stats_fe->maxconn = maxconn;
351 }
352 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
353 int cur_arg = 2;
354 unsigned long set = 0;
355
356 if (!global.stats_fe) {
357 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
358 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
359 return -1;
360 }
361 }
362
363 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100364 if (strcmp(args[cur_arg], "all") == 0) {
365 set = 0;
366 break;
367 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100368 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100369 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100370 return -1;
371 }
372 cur_arg++;
373 }
374 global.stats_fe->bind_proc = set;
375 }
376 else {
377 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
378 return -1;
379 }
380 return 0;
381}
382
William Lallemand33d29e22019-04-01 11:30:06 +0200383/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200384 * This function exports the bound addresses of a <frontend> in the environment
385 * variable <varname>. Those addresses are separated by semicolons and prefixed
386 * with their type (abns@, unix@, sockpair@ etc)
387 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200388 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200389int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200390{
391 struct buffer *trash = get_trash_chunk();
392 struct bind_conf *bind_conf;
393
William Lallemand9a37fd02019-04-12 16:09:24 +0200394 if (frontend) {
395 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200396 struct listener *l;
397
398 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
399 char addr[46];
400 char port[6];
401
William Lallemand620072b2019-04-12 16:09:25 +0200402 /* separate listener by semicolons */
403 if (trash->data)
404 chunk_appendf(trash, ";");
405
Willy Tarreau37159062020-08-27 07:48:42 +0200406 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200407 const struct sockaddr_un *un;
408
Willy Tarreau37159062020-08-27 07:48:42 +0200409 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200410 if (un->sun_path[0] == '\0') {
411 chunk_appendf(trash, "abns@%s", un->sun_path+1);
412 } else {
413 chunk_appendf(trash, "unix@%s", un->sun_path);
414 }
Willy Tarreau37159062020-08-27 07:48:42 +0200415 } else if (l->rx.addr.ss_family == AF_INET) {
416 addr_to_str(&l->rx.addr, addr, sizeof(addr));
417 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200418 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200419 } else if (l->rx.addr.ss_family == AF_INET6) {
420 addr_to_str(&l->rx.addr, addr, sizeof(addr));
421 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200422 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200423 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
424 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200425 }
William Lallemand33d29e22019-04-01 11:30:06 +0200426 }
427 }
428 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200429 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200430 return -1;
431 }
432
433 return 0;
434}
435
William Lallemand9a37fd02019-04-12 16:09:24 +0200436int cli_socket_setenv()
437{
438 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
439 return -1;
440 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
441 return -1;
442
443 return 0;
444}
445
William Lallemand33d29e22019-04-01 11:30:06 +0200446REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
447
Willy Tarreaude57a572016-11-23 17:01:39 +0100448/* Verifies that the CLI at least has a level at least as high as <level>
449 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
450 * failure, an error message is prepared and the appctx's state is adjusted
451 * to print it so that a return 1 is enough to abort any processing.
452 */
453int cli_has_level(struct appctx *appctx, int level)
454{
Willy Tarreaude57a572016-11-23 17:01:39 +0100455
William Lallemandf630d012018-12-13 09:05:44 +0100456 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau9d008692019-08-09 11:21:01 +0200457 cli_err(appctx, stats_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100458 return 0;
459 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100460 return 1;
461}
462
William Lallemandb7ea1412018-12-13 09:05:47 +0100463/* same as cli_has_level but for the CLI proxy and without error message */
464int pcli_has_level(struct stream *s, int level)
465{
466 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
467 return 0;
468 }
469 return 1;
470}
471
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200472/* Returns severity_output for the current session if set, or default for the socket */
473static int cli_get_severity_output(struct appctx *appctx)
474{
475 if (appctx->cli_severity_output)
476 return appctx->cli_severity_output;
477 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
478}
William Lallemand74c24fb2016-11-21 17:18:36 +0100479
Willy Tarreau41908562016-11-24 16:23:38 +0100480/* Processes the CLI interpreter on the stats socket. This function is called
481 * from the CLI's IO handler running in an appctx context. The function returns 1
482 * if the request was understood, otherwise zero. It is called with appctx->st0
483 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
484 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
485 * have its own I/O handler called again. Most of the time, parsers will only
486 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100487 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
488 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100489 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200490static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100491{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200492 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
493 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100494 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100495
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200496 appctx->st2 = 0;
497 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100498
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200499 p = appctx->chunk->area;
500 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100501
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200502 /*
503 * Get the payload start if there is one.
504 * For the sake of simplicity, the payload pattern is looked up
505 * everywhere from the start of the input but it can only be found
506 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
507 *
508 * The input string was zero terminated so it is safe to use
509 * the str*() functions throughout the parsing
510 */
511 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
512 payload = strstr(p, PAYLOAD_PATTERN);
513 end = payload;
514 /* skip the pattern */
515 payload += strlen(PAYLOAD_PATTERN);
516 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100517
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200518 /*
519 * Get pointers on words.
520 * One extra slot is reserved to store a pointer on a null byte.
521 */
522 while (i < MAX_STATS_ARGS && p < end) {
523 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100524
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200525 /* skip leading spaces/tabs */
526 p += strspn(p, " \t");
527 if (!*p)
528 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100529
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200530 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200531 while (1) {
532 p += strcspn(p, " \t\\");
533 /* escaped chars using backlashes (\) */
534 if (*p == '\\') {
535 if (!*++p)
536 break;
537 if (!*++p)
538 break;
539 } else {
540 break;
541 }
542 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200543 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100544
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200545 /* unescape backslashes (\) */
546 for (j = 0, k = 0; args[i][k]; k++) {
547 if (args[i][k] == '\\') {
548 if (args[i][k + 1] == '\\')
549 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100550 else
551 continue;
552 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200553 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100554 j++;
555 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200556 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100557
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200558 i++;
559 }
560 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200561 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200562 for (; i < MAX_STATS_ARGS + 1; i++)
563 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100564
565 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100566 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100567 return 0;
568
William Lallemand14721be2018-10-26 14:47:37 +0200569 /* in a worker or normal process, don't display master only commands */
William Lallemand99e0bb92020-11-05 10:28:53 +0100570 if (appctx->applet == &cli_applet && (kw->level & ACCESS_MASTER_ONLY))
William Lallemand14721be2018-10-26 14:47:37 +0200571 return 0;
572
573 /* in master don't displays if we don't have the master bits */
William Lallemand99e0bb92020-11-05 10:28:53 +0100574 if (appctx->applet == &mcli_applet && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
William Lallemand14721be2018-10-26 14:47:37 +0200575 return 0;
576
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200577 /* only accept expert commands in expert mode */
578 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
579 return 0;
580
Willy Tarreau41908562016-11-24 16:23:38 +0100581 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200582 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200583
584 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
585 goto fail;
586
587 /* kw->parse could set its own io_handler or io_release handler */
588 if (!appctx->io_handler)
589 goto fail;
590
591 appctx->st0 = CLI_ST_CALLBACK;
592 return 1;
593fail:
594 appctx->io_handler = NULL;
595 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100596 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100597}
598
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200599/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
600static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
601{
Willy Tarreau83061a82018-07-13 11:56:34 +0200602 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200603
604 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200605 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200606
607 tmp = get_trash_chunk();
608 chunk_reset(tmp);
609
610 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100611 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200612 chunk_printf(tmp, "[%d]: ", severity);
613 }
614 else {
615 switch (severity_output) {
616 case CLI_SEVERITY_NUMBER:
617 chunk_printf(tmp, "[%d]: ", severity);
618 break;
619 case CLI_SEVERITY_STRING:
620 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
621 break;
622 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100623 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200624 }
625 }
626 chunk_appendf(tmp, "%s", msg);
627
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200628 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200629}
630
William Lallemand74c24fb2016-11-21 17:18:36 +0100631/* This I/O handler runs as an applet embedded in a stream interface. It is
632 * used to processes I/O from/to the stats unix socket. The system relies on a
633 * state machine handling requests and various responses. We read a request,
634 * then we process it and send the response, and we possibly display a prompt.
635 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100636 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100637 * or not.
638 */
639static void cli_io_handler(struct appctx *appctx)
640{
641 struct stream_interface *si = appctx->owner;
642 struct channel *req = si_oc(si);
643 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200644 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100645 int reql;
646 int len;
647
648 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
649 goto out;
650
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800651 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200652 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100653 /* buf.size==0 means we failed to get a buffer and were
654 * already subscribed to a wait list to get a buffer.
655 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100656 goto out;
657 }
658
William Lallemand74c24fb2016-11-21 17:18:36 +0100659 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100660 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100661 /* Stats output not initialized yet */
662 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200663 /* reset severity to default at init */
664 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100665 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100666 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100667 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100668 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100669 /* Let's close for real now. We just close the request
670 * side, the conditions below will complete if needed.
671 */
672 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200673 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100674 break;
675 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100676 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200677 char *str;
678
679 /* use a trash chunk to store received data */
680 if (!appctx->chunk) {
681 appctx->chunk = alloc_trash_chunk();
682 if (!appctx->chunk) {
683 appctx->st0 = CLI_ST_END;
684 continue;
685 }
686 }
687
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200688 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200689
William Lallemand74c24fb2016-11-21 17:18:36 +0100690 /* ensure we have some output room left in the event we
691 * would want to return some info right after parsing.
692 */
693 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100694 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100695 break;
696 }
697
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200698 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200699 reql = co_getline(si_oc(si), str,
700 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100701 if (reql <= 0) { /* closed or EOL not found */
702 if (reql == 0)
703 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100704 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100705 continue;
706 }
707
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200708 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
709 /* seek for a possible unescaped semi-colon. If we find
710 * one, we replace it with an LF and skip only this part.
711 */
712 for (len = 0; len < reql; len++) {
713 if (str[len] == '\\') {
714 len++;
715 continue;
716 }
717 if (str[len] == ';') {
718 str[len] = '\n';
719 reql = len + 1;
720 break;
721 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100722 }
723 }
724
725 /* now it is time to check that we have a full line,
726 * remove the trailing \n and possibly \r, then cut the
727 * line.
728 */
729 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100731 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100732 continue;
733 }
734
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200735 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100736 len--;
737
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200739 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200740
741 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200742 appctx->chunk->area[appctx->chunk->data] = '\n';
743 appctx->chunk->area[appctx->chunk->data + 1] = 0;
744 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200745 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100746
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100747 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748
749 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
750 /* empty line */
751 if (!len) {
752 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200753 appctx->chunk->data -= 2;
754 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200755
756 if (!cli_parse_request(appctx))
757 cli_gen_usage_msg(appctx);
758
759 chunk_reset(appctx->chunk);
760 /* NB: cli_sock_parse_request() may have put
761 * another CLI_ST_O_* into appctx->st0.
762 */
763
764 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100765 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100766 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200767 else {
768 /*
769 * Look for the "payload start" pattern at the end of a line
770 * Its location is not remembered here, this is just to switch
771 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100772 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200773 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200774 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200775 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200776 /* no payload, the command is complete: parse the request */
777 if (!cli_parse_request(appctx))
778 cli_gen_usage_msg(appctx);
779
780 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200781 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100782 }
783
784 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200785 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100786 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
787 }
788 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200789 const char *msg;
790 int sev;
791
William Lallemand74c24fb2016-11-21 17:18:36 +0100792 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100793 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100794 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200795 case CLI_ST_PRINT: /* print const message in msg */
796 case CLI_ST_PRINT_ERR: /* print const error in msg */
797 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
798 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
799 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
800 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
801 LOG_ERR : appctx->ctx.cli.severity;
802 msg = appctx->ctx.cli.msg;
803 }
804 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
805 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
806 LOG_ERR : appctx->ctx.cli.severity;
807 msg = appctx->ctx.cli.err;
808 if (!msg) {
809 sev = LOG_ERR;
810 msg = "Out of memory.\n";
811 }
812 }
813 else {
814 sev = LOG_ERR;
815 msg = "Internal error.\n";
816 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200817
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200818 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
819 if (appctx->st0 == CLI_ST_PRINT_FREE ||
820 appctx->st0 == CLI_ST_PRINT_DYN) {
821 free(appctx->ctx.cli.err);
822 appctx->ctx.cli.err = NULL;
823 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100824 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100825 }
826 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100827 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100828 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200829
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100830 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100831 if (appctx->io_handler)
832 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100833 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100834 if (appctx->io_release) {
835 appctx->io_release(appctx);
836 appctx->io_release = NULL;
837 }
838 }
839 break;
840 default: /* abnormal state */
841 si->flags |= SI_FL_ERR;
842 break;
843 }
844
845 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100846 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200847 const char *prompt = "";
848
849 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
850 /*
851 * when entering a payload with interactive mode, change the prompt
852 * to emphasize that more data can still be sent
853 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200854 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200855 prompt = "+ ";
856 else
857 prompt = "\n> ";
858 }
859 else {
William Lallemandad032882019-07-01 10:56:15 +0200860 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200861 prompt = "\n";
862 }
863
864 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100865 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100866 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100867 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100868 }
869
870 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100871 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100872 break;
873
874 /* Now we close the output if one of the writers did so,
875 * or if we're not in interactive mode and the request
876 * buffer is empty. This still allows pipelined requests
877 * to be sent in non-interactive mode.
878 */
William Lallemand3de09d52018-12-11 16:10:56 +0100879 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
880 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100881 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100882 continue;
883 }
884
885 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100886 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200887 /* reactivate the \n at the end of the response for the next command */
888 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100889 }
890 }
891
892 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
893 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
894 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
895 /* Other side has closed, let's abort if we have no more processing to do
896 * and nothing more to consume. This is comparable to a broken pipe, so
897 * we forward the close to the request side so that it flows upstream to
898 * the client.
899 */
900 si_shutw(si);
901 }
902
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100903 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100904 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
905 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
906 /* We have no more processing to do, and nothing more to send, and
907 * the client side has closed. So we'll forward this state downstream
908 * on the response buffer.
909 */
910 si_shutr(si);
911 res->flags |= CF_READ_NULL;
912 }
913
914 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200915 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 +0100916 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200917 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 +0100918}
919
William Lallemand74c24fb2016-11-21 17:18:36 +0100920/* This is called when the stream interface is closed. For instance, upon an
921 * external abort, we won't call the i/o handler anymore so we may need to
922 * remove back references to the stream currently being dumped.
923 */
924static void cli_release_handler(struct appctx *appctx)
925{
926 if (appctx->io_release) {
927 appctx->io_release(appctx);
928 appctx->io_release = NULL;
929 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200930 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100931 free(appctx->ctx.cli.err);
932 appctx->ctx.cli.err = NULL;
933 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100934}
935
936/* This function dumps all environmnent variables to the buffer. It returns 0
937 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100938 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
939 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100940 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100941static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100942{
Willy Tarreau0a739292016-11-22 20:21:23 +0100943 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100944 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100945
946 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
947 return 1;
948
949 chunk_reset(&trash);
950
951 /* we have two inner loops here, one for the proxy, the other one for
952 * the buffer.
953 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100954 while (*var) {
955 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100956
Willy Tarreau06d80a92017-10-19 14:32:15 +0200957 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100958 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100959 return 0;
960 }
961 if (appctx->st2 == STAT_ST_END)
962 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100963 var++;
964 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100965 }
966
967 /* dump complete */
968 return 1;
969}
970
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200971/* This function dumps all file descriptors states (or the requested one) to
972 * the buffer. It returns 0 if the output buffer is full and it needs to be
973 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
974 * It uses cli.i0 as the fd number to restart from.
975 */
976static int cli_io_handler_show_fd(struct appctx *appctx)
977{
978 struct stream_interface *si = appctx->owner;
979 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100980 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200981
982 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100983 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200984
985 chunk_reset(&trash);
986
Willy Tarreauca1b1572018-12-18 15:45:11 +0100987 /* isolate the threads once per round. We're limited to a buffer worth
988 * of output anyway, it cannot last very long.
989 */
990 thread_isolate();
991
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200992 /* we have two inner loops here, one for the proxy, the other one for
993 * the buffer.
994 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100995 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200996 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200997 struct listener *li = NULL;
998 struct server *sv = NULL;
999 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001000 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001001 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001002 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001003 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001004
1005 fdt = fdtab[fd];
1006
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001007 /* When DEBUG_FD is set, we also report closed FDs that have a
1008 * non-null event count to detect stuck ones.
1009 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001010 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001011#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001012 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001013#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001014 goto skip; // closed
1015 }
1016 else if (fdt.iocb == conn_fd_handler) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001017 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001018 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001019 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001020 li = objt_listener(((struct connection *)fdt.owner)->target);
1021 sv = objt_server(((struct connection *)fdt.owner)->target);
1022 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001023 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001024 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001025 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001026 li = fdt.owner;
1027
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001028 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001029 " %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 +02001030 fd,
1031 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001032 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1033 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001034 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1035 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1036 fdt.ev,
1037 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1038 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1039 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1040 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1041 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001042 fdt.linger_risk ? 'L' : 'l',
1043 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001044 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001045 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001046 fdt.iocb);
1047 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001048
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001049 if (!fdt.owner) {
1050 chunk_appendf(&trash, ")");
1051 }
1052 else if (fdt.iocb == conn_fd_handler) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001053 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001054 if (px)
1055 chunk_appendf(&trash, " px=%s", px->id);
1056 else if (sv)
1057 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1058 else if (li)
1059 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001060
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001061 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001062 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001063 if (mux->show_fd)
1064 mux->show_fd(&trash, fdt.owner);
1065 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001066 else
1067 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001068 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001069 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001070 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001071 listener_state_str(li),
1072 li->bind_conf->frontend->id);
1073 }
1074
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001075#ifdef DEBUG_FD
1076 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
1077#endif
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001078 chunk_appendf(&trash, ")\n");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001079
Willy Tarreau06d80a92017-10-19 14:32:15 +02001080 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001081 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001082 appctx->ctx.cli.i0 = fd;
1083 ret = 0;
1084 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001085 }
1086 skip:
1087 if (appctx->st2 == STAT_ST_END)
1088 break;
1089
1090 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001091 }
1092
Willy Tarreauca1b1572018-12-18 15:45:11 +01001093 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001094 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001095
1096 thread_release();
1097 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001098}
1099
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001100/* This function dumps some activity counters used by developers and support to
1101 * rule out some hypothesis during bug reports. It returns 0 if the output
1102 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1103 * everything at once in the buffer and is not designed to do it in multiple
1104 * passes.
1105 */
1106static int cli_io_handler_show_activity(struct appctx *appctx)
1107{
1108 struct stream_interface *si = appctx->owner;
1109 int thr;
1110
1111 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1112 return 1;
1113
1114 chunk_reset(&trash);
1115
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001116#undef SHOW_TOT
1117#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001118 do { \
1119 unsigned int _v[MAX_THREADS]; \
1120 unsigned int _tot; \
1121 const unsigned int _nbt = global.nbthread; \
1122 for (_tot = t = 0; t < _nbt; t++) \
1123 _tot += _v[t] = (x); \
1124 if (_nbt == 1) { \
1125 chunk_appendf(&trash, " %u\n", _tot); \
1126 break; \
1127 } \
1128 chunk_appendf(&trash, " %u [", _tot); \
1129 for (t = 0; t < _nbt; t++) \
1130 chunk_appendf(&trash, " %u", _v[t]); \
1131 chunk_appendf(&trash, " ]\n"); \
1132 } while (0)
1133
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001134#undef SHOW_AVG
1135#define SHOW_AVG(t, x) \
1136 do { \
1137 unsigned int _v[MAX_THREADS]; \
1138 unsigned int _tot; \
1139 const unsigned int _nbt = global.nbthread; \
1140 for (_tot = t = 0; t < _nbt; t++) \
1141 _tot += _v[t] = (x); \
1142 if (_nbt == 1) { \
1143 chunk_appendf(&trash, " %u\n", _tot); \
1144 break; \
1145 } \
1146 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1147 for (t = 0; t < _nbt; t++) \
1148 chunk_appendf(&trash, " %u", _v[t]); \
1149 chunk_appendf(&trash, " ]\n"); \
1150 } while (0)
1151
Willy Tarreaua0211b82019-05-28 15:09:08 +02001152 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1153 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001154 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1155 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1156 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1157 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001158 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001159 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1160 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001161 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001162 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001163 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1164 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1165 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001166 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001167 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001168 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1169 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001170 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1171 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1172 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1173 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1174 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1175 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1176 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001177#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001178 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 +02001179 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001180#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001181
Willy Tarreaud6a78502019-05-27 07:03:38 +02001182#if defined(DEBUG_DEV)
1183 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001184 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1185 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1186 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001187#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001188
1189 if (ci_putchk(si_ic(si), &trash) == -1) {
1190 chunk_reset(&trash);
1191 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001192 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001193 }
1194
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001195#undef SHOW_AVG
1196#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001197 /* dump complete */
1198 return 1;
1199}
1200
William Lallemandeceddf72016-12-15 18:06:44 +01001201/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001202 * CLI IO handler for `show cli sockets`.
1203 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001204 */
1205static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1206{
1207 struct bind_conf *bind_conf;
1208 struct stream_interface *si = appctx->owner;
1209
1210 chunk_reset(&trash);
1211
1212 switch (appctx->st2) {
1213 case STAT_ST_INIT:
1214 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001215 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001216 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001217 return 0;
1218 }
William Lallemandeceddf72016-12-15 18:06:44 +01001219 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001220 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001221
1222 case STAT_ST_LIST:
1223 if (global.stats_fe) {
1224 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1225 struct listener *l;
1226
1227 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001228 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001229 * if the current node is the first of the list
1230 */
1231
Willy Tarreau3af9d832016-12-16 12:58:09 +01001232 if (appctx->ctx.cli.p0 &&
1233 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001234 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001235 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001236 continue;
1237 }
1238
1239 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1240
1241 char addr[46];
1242 char port[6];
1243
Willy Tarreau37159062020-08-27 07:48:42 +02001244 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001245 const struct sockaddr_un *un;
1246
Willy Tarreau37159062020-08-27 07:48:42 +02001247 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001248 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001249 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001250 } else {
1251 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1252 }
Willy Tarreau37159062020-08-27 07:48:42 +02001253 } else if (l->rx.addr.ss_family == AF_INET) {
1254 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1255 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001256 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001257 } else if (l->rx.addr.ss_family == AF_INET6) {
1258 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1259 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001260 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001261 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1262 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001263 } else
William Lallemand26314342018-10-26 14:47:41 +02001264 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001265
William Lallemand07a62f72017-05-24 00:57:40 +02001266 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001267 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001268 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1269 chunk_appendf(&trash, "operator ");
1270 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1271 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001272 else
1273 chunk_appendf(&trash, " ");
1274
Willy Tarreaue26993c2020-09-03 07:18:55 +02001275 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001276 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001277 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1278 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001279 chunk_appendf(&trash, "%d,", pos+1);
1280 }
1281 }
1282 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001283 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001284
1285 } else {
1286 chunk_appendf(&trash, "all\n");
1287 }
1288
Willy Tarreau06d80a92017-10-19 14:32:15 +02001289 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001290 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001291 return 0;
1292 }
1293 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001294 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001295 }
1296 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001297 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001298 default:
1299 appctx->st2 = STAT_ST_FIN;
1300 return 1;
1301 }
1302}
1303
1304
Willy Tarreau0a739292016-11-22 20:21:23 +01001305/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001306 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1307 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001308 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001309static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001310{
1311 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001312 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001313
1314 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1315 return 1;
1316
Willy Tarreauf6710f82016-12-16 17:45:44 +01001317 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001318
1319 if (*args[2]) {
1320 int len = strlen(args[2]);
1321
Willy Tarreauf6710f82016-12-16 17:45:44 +01001322 for (; *var; var++) {
1323 if (strncmp(*var, args[2], len) == 0 &&
1324 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001325 break;
1326 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001327 if (!*var)
1328 return cli_err(appctx, "Variable not found\n");
1329
Willy Tarreau0a739292016-11-22 20:21:23 +01001330 appctx->st2 = STAT_ST_END;
1331 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001332 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001333 return 0;
1334}
1335
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001336/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1337 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1338 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1339 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001340static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001341{
1342 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1343 return 1;
1344
1345 appctx->ctx.cli.i0 = 0;
1346
1347 if (*args[2]) {
1348 appctx->ctx.cli.i0 = atoi(args[2]);
1349 appctx->st2 = STAT_ST_END;
1350 }
1351 return 0;
1352}
1353
Willy Tarreau599852e2016-11-22 20:33:32 +01001354/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001355static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001356{
1357 struct stream_interface *si = appctx->owner;
1358 struct stream *s = si_strm(si);
1359
1360 if (strcmp(args[2], "cli") == 0) {
1361 unsigned timeout;
1362 const char *res;
1363
Willy Tarreau9d008692019-08-09 11:21:01 +02001364 if (!*args[3])
1365 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001366
1367 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001368 if (res || timeout < 1)
1369 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001370
1371 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1372 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1373 return 1;
1374 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001375
1376 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001377}
1378
Willy Tarreau2af99412016-11-23 11:10:59 +01001379/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001380static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001381{
1382 int v;
1383
1384 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1385 return 1;
1386
Willy Tarreau9d008692019-08-09 11:21:01 +02001387 if (!*args[3])
1388 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001389
1390 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001391 if (v > global.hardmaxconn)
1392 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001393
1394 /* check for unlimited values */
1395 if (v <= 0)
1396 v = global.hardmaxconn;
1397
1398 global.maxconn = v;
1399
1400 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001401 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001402
1403 return 1;
1404}
1405
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001406static int set_severity_output(int *target, char *argument)
1407{
1408 if (!strcmp(argument, "none")) {
1409 *target = CLI_SEVERITY_NONE;
1410 return 1;
1411 }
1412 else if (!strcmp(argument, "number")) {
1413 *target = CLI_SEVERITY_NUMBER;
1414 return 1;
1415 }
1416 else if (!strcmp(argument, "string")) {
1417 *target = CLI_SEVERITY_STRING;
1418 return 1;
1419 }
1420 return 0;
1421}
1422
1423/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001424static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001425{
1426 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1427 return 0;
1428
Willy Tarreau9d008692019-08-09 11:21:01 +02001429 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001430}
William Lallemandeceddf72016-12-15 18:06:44 +01001431
William Lallemand67a234f2018-12-13 09:05:45 +01001432
1433/* show the level of the current CLI session */
1434static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1435{
William Lallemand67a234f2018-12-13 09:05:45 +01001436 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001437 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001438 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001439 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001440 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001441 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001442 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001443 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001444}
1445
1446/* parse and set the CLI level dynamically */
1447static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1448{
William Lallemandad032882019-07-01 10:56:15 +02001449 /* this will ask the applet to not output a \n after the command */
1450 if (!strcmp(args[1], "-"))
1451 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1452
William Lallemand67a234f2018-12-13 09:05:45 +01001453 if (!strcmp(args[0], "operator")) {
1454 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1455 return 1;
1456 }
1457 appctx->cli_level &= ~ACCESS_LVL_MASK;
1458 appctx->cli_level |= ACCESS_LVL_OPER;
1459
1460 } else if (!strcmp(args[0], "user")) {
1461 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1462 return 1;
1463 }
1464 appctx->cli_level &= ~ACCESS_LVL_MASK;
1465 appctx->cli_level |= ACCESS_LVL_USER;
1466 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001467 appctx->cli_level &= ~ACCESS_EXPERT;
1468 return 1;
1469}
1470
1471
1472/* parse and set the CLI expert-mode dynamically */
1473static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1474{
1475 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1476 return 1;
1477
1478 if (!*args[1])
1479 return (appctx->cli_level & ACCESS_EXPERT)
1480 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1481 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1482
1483 appctx->cli_level &= ~ACCESS_EXPERT;
1484 if (strcmp(args[1], "on") == 0)
1485 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001486 return 1;
1487}
1488
William Lallemanda57b7e32018-12-14 21:11:31 +01001489
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001490int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001491{
1492 return 0;
1493}
1494
Willy Tarreau45c742b2016-11-24 14:51:17 +01001495/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001496static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001497{
1498 int v;
1499 int *res;
1500 int mul = 1;
1501
1502 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1503 return 1;
1504
1505 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1506 res = &global.cps_lim;
1507 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1508 res = &global.sps_lim;
1509#ifdef USE_OPENSSL
1510 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1511 res = &global.ssl_lim;
1512#endif
1513 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1514 res = &global.comp_rate_lim;
1515 mul = 1024;
1516 }
1517 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001518 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001519 "'set rate-limit' only supports :\n"
1520 " - 'connections global' to set the per-process maximum connection rate\n"
1521 " - 'sessions global' to set the per-process maximum session rate\n"
1522#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001523 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001524#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001525 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001526 }
1527
Willy Tarreau9d008692019-08-09 11:21:01 +02001528 if (!*args[4])
1529 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001530
1531 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001532 if (v < 0)
1533 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001534
1535 *res = v * mul;
1536
1537 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001538 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001539
1540 return 1;
1541}
1542
William Lallemandf6975e92017-05-26 17:42:10 +02001543/* parse the "expose-fd" argument on the bind lines */
1544static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1545{
1546 if (!*args[cur_arg + 1]) {
1547 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1548 return ERR_ALERT | ERR_FATAL;
1549 }
1550 if (!strcmp(args[cur_arg+1], "listeners")) {
1551 conf->level |= ACCESS_FD_LISTENERS;
1552 } else {
1553 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1554 args[cur_arg], args[cur_arg+1]);
1555 return ERR_ALERT | ERR_FATAL;
1556 }
1557
1558 return 0;
1559}
1560
William Lallemand74c24fb2016-11-21 17:18:36 +01001561/* parse the "level" argument on the bind lines */
1562static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1563{
1564 if (!*args[cur_arg + 1]) {
1565 memprintf(err, "'%s' : missing level", args[cur_arg]);
1566 return ERR_ALERT | ERR_FATAL;
1567 }
1568
William Lallemand07a62f72017-05-24 00:57:40 +02001569 if (!strcmp(args[cur_arg+1], "user")) {
1570 conf->level &= ~ACCESS_LVL_MASK;
1571 conf->level |= ACCESS_LVL_USER;
1572 } else if (!strcmp(args[cur_arg+1], "operator")) {
1573 conf->level &= ~ACCESS_LVL_MASK;
1574 conf->level |= ACCESS_LVL_OPER;
1575 } else if (!strcmp(args[cur_arg+1], "admin")) {
1576 conf->level &= ~ACCESS_LVL_MASK;
1577 conf->level |= ACCESS_LVL_ADMIN;
1578 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001579 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1580 args[cur_arg], args[cur_arg+1]);
1581 return ERR_ALERT | ERR_FATAL;
1582 }
1583
1584 return 0;
1585}
1586
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001587static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1588{
1589 if (!*args[cur_arg + 1]) {
1590 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1591 return ERR_ALERT | ERR_FATAL;
1592 }
1593
1594 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1595 return 0;
1596 else {
1597 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1598 args[cur_arg], args[cur_arg+1]);
1599 return ERR_ALERT | ERR_FATAL;
1600 }
1601}
1602
Olivier Houchardf886e342017-04-05 22:24:59 +02001603/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001604static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001605{
1606 char *cmsgbuf = NULL;
1607 unsigned char *tmpbuf = NULL;
1608 struct cmsghdr *cmsg;
1609 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001610 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001611 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001612 struct msghdr msghdr;
1613 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001614 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001615 const char *ns_name, *if_name;
1616 unsigned char ns_nlen, if_nlen;
1617 int nb_queued;
1618 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001619 int *tmpfd;
1620 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001621 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001622 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001623 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001624 int ret;
1625
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001626 if (!remote) {
1627 ha_warning("Only works on real connections\n");
1628 goto out;
1629 }
1630
1631 fd = remote->handle.fd;
1632
Olivier Houchardf886e342017-04-05 22:24:59 +02001633 /* Temporary set the FD in blocking mode, that will make our life easier */
1634 old_fcntl = fcntl(fd, F_GETFL);
1635 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001636 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001637 goto out;
1638 }
1639 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1640 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001641 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001642 goto out;
1643 }
1644 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001645 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001646 goto out;
1647 }
Olivier Houchard54740872017-04-06 14:45:14 +02001648 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001649 iov.iov_base = &tot_fd_nb;
1650 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001651 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001652 goto out;
1653 memset(&msghdr, 0, sizeof(msghdr));
1654 /*
1655 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001656 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001657 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001658 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
1659 tot_fd_nb += fdtab[cur_fd].exported;
William Lallemand5fd3b282020-01-16 15:32:08 +01001660
Olivier Houchardf886e342017-04-05 22:24:59 +02001661 if (tot_fd_nb == 0)
1662 goto out;
1663
1664 /* First send the total number of file descriptors, so that the
1665 * receiving end knows what to expect.
1666 */
1667 msghdr.msg_iov = &iov;
1668 msghdr.msg_iovlen = 1;
1669 ret = sendmsg(fd, &msghdr, 0);
1670 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001671 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001672 goto out;
1673 }
1674
1675 /* Now send the fds */
1676 msghdr.msg_control = cmsgbuf;
1677 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1678 cmsg = CMSG_FIRSTHDR(&msghdr);
1679 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1680 cmsg->cmsg_level = SOL_SOCKET;
1681 cmsg->cmsg_type = SCM_RIGHTS;
1682 tmpfd = (int *)CMSG_DATA(cmsg);
1683
Olivier Houchardf886e342017-04-05 22:24:59 +02001684 /* For each socket, e message is sent, containing the following :
1685 * Size of the namespace name (or 0 if none), as an unsigned char.
1686 * The namespace name, if any
1687 * Size of the interface name (or 0 if none), as an unsigned char
1688 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001689 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001690 */
1691 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001692 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001693 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001694 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001695 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001696 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001697 goto out;
1698 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001699
1700 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001701 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001702 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
1703 if (!(fdtab[cur_fd].exported))
1704 continue;
1705
1706 ns_name = if_name = "";
1707 ns_nlen = if_nlen = 0;
1708
1709 /* for now we can only retrieve namespaces and interfaces from
1710 * pure listeners.
1711 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001712 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001713 const struct listener *l = fdtab[cur_fd].owner;
1714
Willy Tarreau818a92e2020-09-03 07:50:19 +02001715 if (l->rx.settings->interface) {
1716 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001717 if_nlen = strlen(if_name);
1718 }
1719
1720#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001721 if (l->rx.settings->netns) {
1722 ns_name = l->rx.settings->netns->node.key;
1723 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001724 }
1725#endif
1726 }
1727
1728 /* put the FD into the CMSG_DATA */
1729 tmpfd[nb_queued++] = cur_fd;
1730
1731 /* first block is <ns_name_len> <ns_name> */
1732 tmpbuf[curoff++] = ns_nlen;
1733 if (ns_nlen)
1734 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1735 curoff += ns_nlen;
1736
1737 /* second block is <if_name_len> <if_name> */
1738 tmpbuf[curoff++] = if_nlen;
1739 if (if_nlen)
1740 memcpy(tmpbuf + curoff, if_name, if_nlen);
1741 curoff += if_nlen;
1742
1743 /* we used to send the listener options here before 2.3 */
1744 memset(tmpbuf + curoff, 0, sizeof(int));
1745 curoff += sizeof(int);
1746
1747 /* there's a limit to how many FDs may be sent at once */
1748 if (nb_queued == MAX_SEND_FD) {
1749 iov.iov_len = curoff;
1750 if (sendmsg(fd, &msghdr, 0) != curoff) {
1751 ha_warning("Failed to transfer sockets\n");
1752 return -1;
1753 }
1754
1755 /* Wait for an ack */
1756 do {
1757 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
1758 } while (ret == -1 && errno == EINTR);
1759
1760 if (ret <= 0) {
1761 ha_warning("Unexpected error while transferring sockets\n");
1762 return -1;
1763 }
1764 curoff = 0;
1765 nb_queued = 0;
1766 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001767 }
1768
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001769 /* flush pending stuff */
1770 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02001771 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001772 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
1773 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02001774 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001775 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001776 goto out;
1777 }
1778 }
1779
1780out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001781 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001782 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001783 goto out;
1784 }
1785 appctx->st0 = CLI_ST_END;
1786 free(cmsgbuf);
1787 free(tmpbuf);
1788 return 1;
1789}
1790
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001791static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1792{
1793 if (*args[0] == 'h')
1794 /* help */
1795 cli_gen_usage_msg(appctx);
1796 else if (*args[0] == 'p')
1797 /* prompt */
1798 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1799 else if (*args[0] == 'q')
1800 /* quit */
1801 appctx->st0 = CLI_ST_END;
1802
1803 return 1;
1804}
Olivier Houchardf886e342017-04-05 22:24:59 +02001805
William Lallemand2f4ce202018-10-26 14:47:47 +02001806void pcli_write_prompt(struct stream *s)
1807{
1808 struct buffer *msg = get_trash_chunk();
1809 struct channel *oc = si_oc(&s->si[0]);
1810
William Lallemanddc12c2e2018-12-13 09:05:46 +01001811 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001812 return;
1813
William Lallemanddc12c2e2018-12-13 09:05:46 +01001814 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001815 chunk_appendf(msg, "+ ");
1816 } else {
1817 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001818 chunk_appendf(msg, "master%s> ",
1819 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001820 else
1821 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1822 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001823 co_inject(oc, msg->area, msg->data);
1824}
1825
William Lallemand291810d2018-10-26 14:47:38 +02001826
William Lallemandcf62f7e2018-10-26 14:47:40 +02001827/* The pcli_* functions are used for the CLI proxy in the master */
1828
William Lallemanddeeaa592018-10-26 14:47:48 +02001829void pcli_reply_and_close(struct stream *s, const char *msg)
1830{
1831 struct buffer *buf = get_trash_chunk();
1832
1833 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001834 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001835}
1836
William Lallemand291810d2018-10-26 14:47:38 +02001837static enum obj_type *pcli_pid_to_server(int proc_pid)
1838{
1839 struct mworker_proc *child;
1840
William Lallemand99e0bb92020-11-05 10:28:53 +01001841 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01001842 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01001843 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01001844
William Lallemand291810d2018-10-26 14:47:38 +02001845 list_for_each_entry(child, &proc_list, list) {
1846 if (child->pid == proc_pid){
1847 return &child->srv->obj_type;
1848 }
1849 }
1850 return NULL;
1851}
1852
1853/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1854 * Return:
1855 * 0: master
1856 * > 0: pid of a worker
1857 * < 0: didn't find a worker
1858 */
1859static int pcli_prefix_to_pid(const char *prefix)
1860{
1861 int proc_pid;
1862 struct mworker_proc *child;
1863 char *errtol = NULL;
1864
1865 if (*prefix != '@') /* not a prefix, should not happen */
1866 return -1;
1867
1868 prefix++;
1869 if (!*prefix) /* sent @ alone, return the master */
1870 return 0;
1871
1872 if (strcmp("master", prefix) == 0) {
1873 return 0;
1874 } else if (*prefix == '!') {
1875 prefix++;
1876 if (!*prefix)
1877 return -1;
1878
1879 proc_pid = strtol(prefix, &errtol, 10);
1880 if (*errtol != '\0')
1881 return -1;
1882 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001883 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001884 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001885 if (child->pid == proc_pid){
1886 return child->pid;
1887 }
1888 }
1889 } else {
1890 struct mworker_proc *chosen = NULL;
1891 /* this is a relative pid */
1892
1893 proc_pid = strtol(prefix, &errtol, 10);
1894 if (*errtol != '\0')
1895 return -1;
1896
1897 if (proc_pid == 0) /* return the master */
1898 return 0;
1899
1900 /* chose the right process, the current one is the one with the
1901 least number of reloads */
1902 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001903 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001904 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001905 if (child->relative_pid == proc_pid){
1906 if (child->reloads == 0)
1907 return child->pid;
1908 else if (chosen == NULL || child->reloads < chosen->reloads)
1909 chosen = child;
1910 }
1911 }
1912 if (chosen)
1913 return chosen->pid;
1914 }
1915 return -1;
1916}
1917
William Lallemandbddd33a2018-12-11 16:10:53 +01001918/* Return::
1919 * >= 0 : number of words to escape
1920 * = -1 : error
1921 */
1922
1923int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1924{
1925 if (argl < 1)
1926 return 0;
1927
1928 /* there is a prefix */
1929 if (args[0][0] == '@') {
1930 int target_pid = pcli_prefix_to_pid(args[0]);
1931
1932 if (target_pid == -1) {
1933 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1934 return -1;
1935 }
1936
1937 /* if the prefix is alone, define a default target */
1938 if (argl == 1)
1939 s->pcli_next_pid = target_pid;
1940 else
1941 *next_pid = target_pid;
1942 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001943 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001944 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001945 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001946
1947 } else if (!strcmp("quit", args[0])) {
1948 channel_shutr_now(&s->req);
1949 channel_shutw_now(&s->res);
1950 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001951 } else if (!strcmp(args[0], "operator")) {
1952 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1953 memprintf(errmsg, "Permission denied!\n");
1954 return -1;
1955 }
1956 s->pcli_flags &= ~ACCESS_LVL_MASK;
1957 s->pcli_flags |= ACCESS_LVL_OPER;
1958 return argl;
1959
1960 } else if (!strcmp(args[0], "user")) {
1961 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1962 memprintf(errmsg, "Permission denied!\n");
1963 return -1;
1964 }
1965 s->pcli_flags &= ~ACCESS_LVL_MASK;
1966 s->pcli_flags |= ACCESS_LVL_USER;
1967 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001968 }
1969
1970 return 0;
1971}
1972
1973/*
1974 * Parse the CLI request:
1975 * - It does basically the same as the cli_io_handler, but as a proxy
1976 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001977 *
1978 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01001979 * - the number of characters to forward or
1980 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02001981 */
William Lallemandbddd33a2018-12-11 16:10:53 +01001982int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001983{
William Lallemandbddd33a2018-12-11 16:10:53 +01001984 char *str = (char *)ci_head(req);
1985 char *end = (char *)ci_stop(req);
1986 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
1987 int argl; /* number of args */
1988 char *p;
1989 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01001990 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01001991 int wtrim = 0; /* number of words to trim */
1992 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01001993 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01001994 int i = 0;
1995
1996 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001997
William Lallemanddc12c2e2018-12-13 09:05:46 +01001998 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01001999
2000 /* Looks for the end of one command */
2001 while (p+reql < end) {
2002 /* handle escaping */
2003 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002004 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002005 continue;
2006 }
2007 if (p[reql] == ';' || p[reql] == '\n') {
2008 /* found the end of the command */
2009 p[reql] = '\n';
2010 reql++;
2011 break;
2012 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002013 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002014 }
William Lallemandebf61802018-12-11 16:10:57 +01002015 } else {
2016 while (p+reql < end) {
2017 if (p[reql] == '\n') {
2018 /* found the end of the line */
2019 reql++;
2020 break;
2021 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002022 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002023 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002024 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002025
William Lallemandbddd33a2018-12-11 16:10:53 +01002026 /* set end to first byte after the end of the command */
2027 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002028
William Lallemandbddd33a2018-12-11 16:10:53 +01002029 /* there is no end to this command, need more to parse ! */
2030 if (*(end-1) != '\n') {
2031 return -1;
2032 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002033
William Lallemand3301f3e2018-12-13 09:05:48 +01002034 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2035 if (reql == 1) /* last line of the payload */
2036 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002037 return reql;
2038 }
2039
William Lallemandbddd33a2018-12-11 16:10:53 +01002040 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002041
William Lallemandbddd33a2018-12-11 16:10:53 +01002042 /* splits the command in words */
2043 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002044 /* skip leading spaces/tabs */
2045 p += strspn(p, " \t");
2046 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002047 break;
2048
William Lallemandbddd33a2018-12-11 16:10:53 +01002049 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002050 while (1) {
2051 p += strcspn(p, " \t\\");
2052 /* escaped chars using backlashes (\) */
2053 if (*p == '\\') {
2054 if (!*++p)
2055 break;
2056 if (!*++p)
2057 break;
2058 } else {
2059 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002060 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002061 }
William Lallemandfe249c32020-06-18 18:03:57 +02002062 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002063 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002064 }
2065
William Lallemandbddd33a2018-12-11 16:10:53 +01002066 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002067
William Lallemandbddd33a2018-12-11 16:10:53 +01002068 for (; i < MAX_STATS_ARGS + 1; i++)
2069 args[i] = NULL;
2070
2071 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2072
2073 /* End of words are ending by \0, we need to replace the \0s by spaces
20741 before forwarding them */
2075 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002076 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002077 if (*p == '\0')
2078 *p = ' ';
2079 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002080 }
2081
William Lallemand3301f3e2018-12-13 09:05:48 +01002082 payload = strstr(str, PAYLOAD_PATTERN);
2083 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2084 /* if the payload pattern is at the end */
2085 s->pcli_flags |= PCLI_F_PAYLOAD;
2086 ret = reql;
2087 }
2088
William Lallemandbddd33a2018-12-11 16:10:53 +01002089 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002090
William Lallemandbddd33a2018-12-11 16:10:53 +01002091 if (wtrim > 0) {
2092 trim = &args[wtrim][0];
2093 if (trim == NULL) /* if this was the last word in the table */
2094 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002095
William Lallemandbddd33a2018-12-11 16:10:53 +01002096 b_del(&req->buf, trim - str);
2097
William Lallemandb7ea1412018-12-13 09:05:47 +01002098 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002099 } else if (wtrim < 0) {
2100 /* parsing error */
2101 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002102 } else {
2103 /* the whole string */
2104 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002105 }
2106
William Lallemandb7ea1412018-12-13 09:05:47 +01002107 if (ret > 1) {
2108 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2109 goto end;
2110 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002111 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2112 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002113 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002114 ci_insert_line2(req, 0, "user -", strlen("user -"));
2115 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002116 }
2117 }
2118end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002119
William Lallemandb7ea1412018-12-13 09:05:47 +01002120 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002121}
2122
2123int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2124{
William Lallemandbddd33a2018-12-11 16:10:53 +01002125 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002126 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002127 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002128
William Lallemandb7ea1412018-12-13 09:05:47 +01002129 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2130 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2131
William Lallemandcf62f7e2018-10-26 14:47:40 +02002132read_again:
2133 /* if the channel is closed for read, we won't receive any more data
2134 from the client, but we don't want to forward this close to the
2135 server */
2136 channel_dont_close(req);
2137
2138 /* We don't know yet to which server we will connect */
2139 channel_dont_connect(req);
2140
2141
2142 /* we are not waiting for a response, there is no more request and we
2143 * receive a close from the client, we can leave */
2144 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2145 channel_shutw_now(&s->res);
2146 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2147 return 1;
2148 }
2149
2150 req->flags |= CF_READ_DONTWAIT;
2151
2152 /* need more data */
2153 if (!ci_data(req))
2154 return 0;
2155
2156 /* If there is data available for analysis, log the end of the idle time. */
2157 if (c_data(req) && s->logs.t_idle == -1)
2158 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2159
William Lallemandbddd33a2018-12-11 16:10:53 +01002160 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002161 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002162 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002163 /* enough data */
2164
William Lallemandcf62f7e2018-10-26 14:47:40 +02002165 /* forward only 1 command */
2166 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002167
William Lallemanddc12c2e2018-12-13 09:05:46 +01002168 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002169 /* we send only 1 command per request, and we write close after it */
2170 channel_shutw_now(req);
2171 } else {
2172 pcli_write_prompt(s);
2173 }
2174
2175 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002176
2177 /* remove the XFER_DATA analysers, which forwards all
2178 * the data, we don't want to forward the next requests
2179 * We need to add CF_FLT_ANALYZE to abort the forward too.
2180 */
2181 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2182 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2183 s->res.analysers |= AN_RES_WAIT_CLI;
2184
William Lallemandebf61802018-12-11 16:10:57 +01002185 if (!(s->flags & SF_ASSIGNED)) {
2186 if (next_pid > -1)
2187 target_pid = next_pid;
2188 else
2189 target_pid = s->pcli_next_pid;
2190 /* we can connect now */
2191 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002192
William Lallemandebf61802018-12-11 16:10:57 +01002193 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2194 channel_auto_connect(req);
2195 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002196
2197 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002198 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002199 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002200 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002201 } else if (to_forward == -1 && errmsg) {
2202 /* there was an error during the parsing */
2203 pcli_reply_and_close(s, errmsg);
2204 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002205 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2206 /* buffer is full and we didn't catch the end of a command */
2207 goto send_help;
2208 }
2209
2210 return 0;
2211
2212send_help:
2213 b_reset(&req->buf);
2214 b_putblk(&req->buf, "help\n", 5);
2215 goto read_again;
2216}
2217
2218int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2219{
2220 struct proxy *fe = strm_fe(s);
2221 struct proxy *be = s->be;
2222
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002223 if (rep->flags & CF_READ_ERROR) {
2224 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2225 s->res.analysers &= ~AN_RES_WAIT_CLI;
2226 return 0;
2227 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002228 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2229 rep->flags |= CF_NEVER_WAIT;
2230
2231 /* don't forward the close */
2232 channel_dont_close(&s->res);
2233 channel_dont_close(&s->req);
2234
William Lallemanddc12c2e2018-12-13 09:05:46 +01002235 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002236 s->req.analysers |= AN_REQ_WAIT_CLI;
2237 s->res.analysers &= ~AN_RES_WAIT_CLI;
2238 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2239 return 0;
2240 }
2241
William Lallemandcf62f7e2018-10-26 14:47:40 +02002242 /* forward the data */
2243 if (ci_data(rep)) {
2244 c_adv(rep, ci_data(rep));
2245 return 0;
2246 }
2247
2248 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2249 /* stream cleanup */
2250
William Lallemand2f4ce202018-10-26 14:47:47 +02002251 pcli_write_prompt(s);
2252
William Lallemandcf62f7e2018-10-26 14:47:40 +02002253 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2254 si_shutr(&s->si[1]);
2255 si_shutw(&s->si[1]);
2256
2257 /*
2258 * starting from there this the same code as
2259 * http_end_txn_clean_session().
2260 *
2261 * It allows to do frontend keepalive while reconnecting to a
2262 * new server for each request.
2263 */
2264
2265 if (s->flags & SF_BE_ASSIGNED) {
2266 HA_ATOMIC_SUB(&be->beconn, 1);
2267 if (unlikely(s->srv_conn))
2268 sess_change_server(s, NULL);
2269 }
2270
2271 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2272 stream_process_counters(s);
2273
2274 /* don't count other requests' data */
2275 s->logs.bytes_in -= ci_data(&s->req);
2276 s->logs.bytes_out -= ci_data(&s->res);
2277
2278 /* we may need to know the position in the queue */
2279 pendconn_free(s);
2280
2281 /* let's do a final log if we need it */
2282 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2283 !(s->flags & SF_MONITOR) &&
2284 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2285 s->do_log(s);
2286 }
2287
2288 /* stop tracking content-based counters */
2289 stream_stop_content_counters(s);
2290 stream_update_time_stats(s);
2291
2292 s->logs.accept_date = date; /* user-visible date for logging */
2293 s->logs.tv_accept = now; /* corrected date for internal use */
2294 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2295 s->logs.t_idle = -1;
2296 tv_zero(&s->logs.tv_request);
2297 s->logs.t_queue = -1;
2298 s->logs.t_connect = -1;
2299 s->logs.t_data = -1;
2300 s->logs.t_close = 0;
2301 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2302 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2303
2304 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2305 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2306
2307 stream_del_srv_conn(s);
2308 if (objt_server(s->target)) {
2309 if (s->flags & SF_CURR_SESS) {
2310 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002311 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002312 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002313 if (may_dequeue_tasks(__objt_server(s->target), be))
2314 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002315 }
2316
2317 s->target = NULL;
2318
2319 /* only release our endpoint if we don't intend to reuse the
2320 * connection.
2321 */
2322 if (!si_conn_ready(&s->si[1])) {
2323 si_release_endpoint(&s->si[1]);
2324 s->srv_conn = NULL;
2325 }
2326
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002327 sockaddr_free(&s->target_addr);
2328
William Lallemandcf62f7e2018-10-26 14:47:40 +02002329 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2330 s->si[1].err_type = SI_ET_NONE;
2331 s->si[1].conn_retries = 0; /* used for logging too */
2332 s->si[1].exp = TICK_ETERNITY;
2333 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 +02002334 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 +02002335 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 +02002336 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2337 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2338 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2339 /* reinitialise the current rule list pointer to NULL. We are sure that
2340 * any rulelist match the NULL pointer.
2341 */
2342 s->current_rule_list = NULL;
2343
2344 s->be = strm_fe(s);
2345 s->logs.logwait = strm_fe(s)->to_log;
2346 s->logs.level = 0;
2347 stream_del_srv_conn(s);
2348 s->target = NULL;
2349 /* re-init store persistence */
2350 s->store_count = 0;
2351 s->uniq_id = global.req_count++;
2352
2353 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2354
2355 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2356
2357 s->req.analysers |= AN_REQ_WAIT_CLI;
2358 s->res.analysers &= ~AN_RES_WAIT_CLI;
2359
2360 /* We must trim any excess data from the response buffer, because we
2361 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002362 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002363 * we want those data to come along with next response. A typical
2364 * example of such data would be from a buggy server responding to
2365 * a HEAD with some data, or sending more than the advertised
2366 * content-length.
2367 */
2368 if (unlikely(ci_data(&s->res)))
2369 b_set_data(&s->res.buf, co_data(&s->res));
2370
2371 /* Now we can realign the response buffer */
2372 c_realign_if_empty(&s->res);
2373
2374 s->req.rto = strm_fe(s)->timeout.client;
2375 s->req.wto = TICK_ETERNITY;
2376
2377 s->res.rto = TICK_ETERNITY;
2378 s->res.wto = strm_fe(s)->timeout.client;
2379
2380 s->req.rex = TICK_ETERNITY;
2381 s->req.wex = TICK_ETERNITY;
2382 s->req.analyse_exp = TICK_ETERNITY;
2383 s->res.rex = TICK_ETERNITY;
2384 s->res.wex = TICK_ETERNITY;
2385 s->res.analyse_exp = TICK_ETERNITY;
2386 s->si[1].hcto = TICK_ETERNITY;
2387
2388 /* we're removing the analysers, we MUST re-enable events detection.
2389 * We don't enable close on the response channel since it's either
2390 * already closed, or in keep-alive with an idle connection handler.
2391 */
2392 channel_auto_read(&s->req);
2393 channel_auto_close(&s->req);
2394 channel_auto_read(&s->res);
2395
2396
2397 return 1;
2398 }
2399 return 0;
2400}
2401
William Lallemand8a022572018-10-26 14:47:35 +02002402/*
2403 * The mworker functions are used to initialize the CLI in the master process
2404 */
2405
William Lallemand309dc9a2018-10-26 14:47:45 +02002406 /*
2407 * Stop the mworker proxy
2408 */
2409void mworker_cli_proxy_stop()
2410{
William Lallemand550db6d2018-11-06 17:37:12 +01002411 if (mworker_proxy)
2412 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002413}
2414
William Lallemand8a022572018-10-26 14:47:35 +02002415/*
2416 * Create the mworker CLI proxy
2417 */
2418int mworker_cli_proxy_create()
2419{
2420 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002421 char *msg = NULL;
2422 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002423
2424 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2425 if (!mworker_proxy)
2426 return -1;
2427
2428 init_new_proxy(mworker_proxy);
2429 mworker_proxy->next = proxies_list;
2430 proxies_list = mworker_proxy;
2431 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002433 mworker_proxy->last_change = now.tv_sec;
2434 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2435 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2436 mworker_proxy->timeout.client = 0; /* no timeout */
2437 mworker_proxy->conf.file = strdup("MASTER");
2438 mworker_proxy->conf.line = 0;
2439 mworker_proxy->accept = frontend_accept;
2440 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2441
2442 /* Does not init the default target the CLI applet, but must be done in
2443 * the request parsing code */
2444 mworker_proxy->default_target = NULL;
2445
2446 /* the check_config_validity() will get an ID for the proxy */
2447 mworker_proxy->uuid = -1;
2448
2449 proxy_store_name(mworker_proxy);
2450
2451 /* create all servers using the mworker_proc list */
2452 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002453 struct server *newsrv = NULL;
2454 struct sockaddr_storage *sk;
2455 int port1, port2, port;
2456 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002457
William Lallemanda31b09e2020-01-14 15:25:02 +01002458 /* only the workers support the master CLI */
2459 if (!(child->options & PROC_O_TYPE_WORKER))
2460 continue;
2461
William Lallemand8a022572018-10-26 14:47:35 +02002462 newsrv = new_server(mworker_proxy);
2463 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002464 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002465
2466 /* we don't know the new pid yet */
2467 if (child->pid == -1)
2468 memprintf(&msg, "cur-%d", child->relative_pid);
2469 else
2470 memprintf(&msg, "old-%d", child->pid);
2471
2472 newsrv->next = mworker_proxy->srv;
2473 mworker_proxy->srv = newsrv;
2474 newsrv->conf.file = strdup(msg);
2475 newsrv->id = strdup(msg);
2476 newsrv->conf.line = 0;
2477
2478 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002479 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002480 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002481 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002482 }
2483 free(msg);
2484 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002485
Willy Tarreau5fc93282020-09-16 18:25:03 +02002486 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002487 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002488 }
2489
2490 /* no port specified */
2491 newsrv->flags |= SRV_F_MAPPORTS;
2492 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002493 /* don't let the server participate to load balancing */
2494 newsrv->iweight = 0;
2495 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002496 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002497
2498 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002499 }
2500 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002501
2502error:
2503 ha_alert("%s\n", errmsg);
2504
2505 list_for_each_entry(child, &proc_list, list) {
2506 free((char *)child->srv->conf.file); /* cast because of const char * */
2507 free(child->srv->id);
2508 free(child->srv);
2509 child->srv = NULL;
2510 }
2511 free(mworker_proxy->id);
2512 free(mworker_proxy->conf.file);
2513 free(mworker_proxy);
2514 mworker_proxy = NULL;
2515 free(errmsg);
2516 free(msg);
2517
2518 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002519}
Olivier Houchardf886e342017-04-05 22:24:59 +02002520
William Lallemandce83b4a2018-10-26 14:47:30 +02002521/*
William Lallemande7361152018-10-26 14:47:36 +02002522 * Create a new listener for the master CLI proxy
2523 */
2524int mworker_cli_proxy_new_listener(char *line)
2525{
2526 struct bind_conf *bind_conf;
2527 struct listener *l;
2528 char *err = NULL;
2529 char *args[MAX_LINE_ARGS + 1];
2530 int arg;
2531 int cur_arg;
2532
William Lallemand2e945c82019-11-25 09:58:37 +01002533 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002534 args[0] = line;
2535
2536 /* args is a bind configuration with spaces replaced by commas */
2537 while (*line && arg < MAX_LINE_ARGS) {
2538
2539 if (*line == ',') {
2540 *line++ = '\0';
2541 while (*line == ',')
2542 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002543 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002544 }
2545 line++;
2546 }
2547
William Lallemand2e945c82019-11-25 09:58:37 +01002548 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002549
2550 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002551 if (!bind_conf)
2552 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002553
2554 bind_conf->level &= ~ACCESS_LVL_MASK;
2555 bind_conf->level |= ACCESS_LVL_ADMIN;
2556
2557 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2558 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002559 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002560 }
2561
2562 cur_arg = 1;
2563
2564 while (*args[cur_arg]) {
2565 static int bind_dumped;
2566 struct bind_kw *kw;
2567
2568 kw = bind_find_kw(args[cur_arg]);
2569 if (kw) {
2570 if (!kw->parse) {
2571 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2572 args[0], args[1], args[cur_arg]);
2573 goto err;
2574 }
2575
2576 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2577 if (err)
2578 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2579 else
2580 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2581 args[0], args[1], args[cur_arg]);
2582 goto err;
2583 }
2584
2585 cur_arg += 1 + kw->skip;
2586 continue;
2587 }
2588
2589 if (!bind_dumped) {
2590 bind_dump_kws(&err);
2591 indent_msg(&err, 4);
2592 bind_dumped = 1;
2593 }
2594
2595 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2596 args[0], args[1], args[cur_arg],
2597 err ? " Registered keywords :" : "", err ? err : "");
2598 goto err;
2599 }
2600
2601
2602 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002603 l->accept = session_accept_fd;
2604 l->default_target = mworker_proxy->default_target;
2605 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002606 l->options |= LI_O_UNLIMITED;
2607 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002608 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002609 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002610 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002611 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002612
2613 return 0;
2614
2615err:
2616 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002617 free(err);
2618 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002619 return -1;
2620
2621}
2622
2623/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002624 * Create a new CLI socket using a socketpair for a worker process
2625 * <mworker_proc> is the process structure, and <proc> is the process number
2626 */
2627int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2628{
2629 struct bind_conf *bind_conf;
2630 struct listener *l;
2631 char *path = NULL;
2632 char *err = NULL;
2633
2634 /* master pipe to ensure the master is still alive */
2635 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2636 ha_alert("Cannot create worker socketpair.\n");
2637 return -1;
2638 }
2639
2640 /* XXX: we might want to use a separate frontend at some point */
2641 if (!global.stats_fe) {
2642 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2643 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002644 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002645 }
2646 }
2647
2648 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002649 if (!bind_conf)
2650 goto error;
2651
William Lallemandce83b4a2018-10-26 14:47:30 +02002652 bind_conf->level &= ~ACCESS_LVL_MASK;
2653 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2654
Willy Tarreaue26993c2020-09-03 07:18:55 +02002655 bind_conf->settings.bind_proc = 1UL << proc;
William Lallemandce83b4a2018-10-26 14:47:30 +02002656 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2657
2658 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2659 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002660 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002661 }
2662
2663 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002664 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002665 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002666 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002667 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002668 free(path);
2669 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002670
2671 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002672 l->accept = session_accept_fd;
2673 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002674 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau455585e2020-10-09 18:25:14 +02002675 HA_ATOMIC_ADD(&unstoppable_jobs, 1);
William Lallemandce83b4a2018-10-26 14:47:30 +02002676 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002677 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002678 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002679 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002680 }
2681
2682 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002683
2684error:
2685 close(mworker_proc->ipc_fd[0]);
2686 close(mworker_proc->ipc_fd[1]);
2687 free(err);
2688
2689 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002690}
2691
William Lallemand74c24fb2016-11-21 17:18:36 +01002692static struct applet cli_applet = {
2693 .obj_type = OBJ_TYPE_APPLET,
2694 .name = "<CLI>", /* used for logging */
2695 .fct = cli_io_handler,
2696 .release = cli_release_handler,
2697};
2698
William Lallemand99e0bb92020-11-05 10:28:53 +01002699/* master CLI */
2700static struct applet mcli_applet = {
2701 .obj_type = OBJ_TYPE_APPLET,
2702 .name = "<MCLI>", /* used for logging */
2703 .fct = cli_io_handler,
2704 .release = cli_release_handler,
2705};
2706
Willy Tarreau0a739292016-11-22 20:21:23 +01002707/* register cli keywords */
2708static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002709 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2710 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2711 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002712 { { "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 +01002713 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002714 { { "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 +01002715 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002716 { { "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 +02002717 { { "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 +01002718 { { "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 +02002719 { { "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 +01002720 { { "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 +01002721 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2722 { { "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 +02002723 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002724 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002725 {{},}
2726}};
2727
Willy Tarreau0108d902018-11-25 19:14:37 +01002728INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2729
William Lallemand74c24fb2016-11-21 17:18:36 +01002730static struct cfg_kw_list cfg_kws = {ILH, {
2731 { CFG_GLOBAL, "stats", stats_parse_global },
2732 { 0, NULL, NULL },
2733}};
2734
Willy Tarreau0108d902018-11-25 19:14:37 +01002735INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2736
William Lallemand74c24fb2016-11-21 17:18:36 +01002737static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002738 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2739 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002740 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002741 { NULL, NULL, 0 },
2742}};
2743
Willy Tarreau0108d902018-11-25 19:14:37 +01002744INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002745
2746/*
2747 * Local variables:
2748 * c-indent-level: 8
2749 * c-basic-offset: 8
2750 * End:
2751 */