blob: e39ef68b35a30c3de817ab209a712768f1072ffb [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;
69
70static const char stats_sock_usage_msg[] =
71 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010072 " help : this message\n"
73 " prompt : toggle interactive mode with prompt\n"
74 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010075 "";
76
77static const char stats_permission_denied_msg[] =
78 "Permission denied\n"
79 "";
80
81
Christopher Faulet1bc04c72017-10-29 20:14:08 +010082static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010083
84/* List head of cli keywords */
85static struct cli_kw_list cli_keywords = {
86 .list = LIST_HEAD_INIT(cli_keywords.list)
87};
88
89extern const char *stat_status_codes[];
90
William Lallemand8a022572018-10-26 14:47:35 +020091static struct proxy *mworker_proxy; /* CLI proxy of the master */
92
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020093static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +010094{
95 struct cli_kw_list *kw_list;
96 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020097 struct buffer *tmp = get_trash_chunk();
98 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +010099
100 free(dynamic_usage_msg);
101 dynamic_usage_msg = NULL;
102
103 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200104 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100105
106 chunk_reset(tmp);
107 chunk_strcat(tmp, stats_sock_usage_msg);
108 list_for_each_entry(kw_list, &cli_keywords.list, list) {
109 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200110 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200111
112 /* in a worker or normal process, don't display master only commands */
113 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
114 goto next_kw;
115
116 /* in master don't displays if we don't have the master bits */
117 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
118 goto next_kw;
119
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200120 /* only show expert commands in expert mode */
121 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
122 goto next_kw;
123
William Lallemand0154edc2018-05-15 11:50:04 +0200124 if (kw->usage)
125 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200126
127next_kw:
128
William Lallemand74c24fb2016-11-21 17:18:36 +0100129 kw++;
130 }
131 }
132 chunk_init(&out, NULL, 0);
133 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200134 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200135
136end:
137 if (dynamic_usage_msg) {
138 appctx->ctx.cli.severity = LOG_INFO;
139 appctx->ctx.cli.msg = dynamic_usage_msg;
140 }
141 else {
142 appctx->ctx.cli.severity = LOG_INFO;
143 appctx->ctx.cli.msg = stats_sock_usage_msg;
144 }
145 appctx->st0 = CLI_ST_PRINT;
146
William Lallemand74c24fb2016-11-21 17:18:36 +0100147 return dynamic_usage_msg;
148}
149
150struct cli_kw* cli_find_kw(char **args)
151{
152 struct cli_kw_list *kw_list;
153 struct cli_kw *kw;/* current cli_kw */
154 char **tmp_args;
155 const char **tmp_str_kw;
156 int found = 0;
157
158 if (LIST_ISEMPTY(&cli_keywords.list))
159 return NULL;
160
161 list_for_each_entry(kw_list, &cli_keywords.list, list) {
162 kw = &kw_list->kw[0];
163 while (*kw->str_kw) {
164 tmp_args = args;
165 tmp_str_kw = kw->str_kw;
166 while (*tmp_str_kw) {
167 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
168 found = 1;
169 } else {
170 found = 0;
171 break;
172 }
173 tmp_args++;
174 tmp_str_kw++;
175 }
176 if (found)
177 return (kw);
178 kw++;
179 }
180 }
181 return NULL;
182}
183
184void cli_register_kw(struct cli_kw_list *kw_list)
185{
186 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
187}
188
189
190/* allocate a new stats frontend named <name>, and return it
191 * (or NULL in case of lack of memory).
192 */
193static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
194{
195 struct proxy *fe;
196
197 fe = calloc(1, sizeof(*fe));
198 if (!fe)
199 return NULL;
200
201 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100202 fe->next = proxies_list;
203 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100204 fe->last_change = now.tv_sec;
205 fe->id = strdup("GLOBAL");
206 fe->cap = PR_CAP_FE;
207 fe->maxconn = 10; /* default to 10 concurrent connections */
208 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
209 fe->conf.file = strdup(file);
210 fe->conf.line = line;
211 fe->accept = frontend_accept;
212 fe->default_target = &cli_applet.obj_type;
213
214 /* the stats frontend is the only one able to assign ID #0 */
215 fe->conf.id.key = fe->uuid = 0;
216 eb32_insert(&used_proxy_id, &fe->conf.id);
217 return fe;
218}
219
220/* This function parses a "stats" statement in the "global" section. It returns
221 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
222 * error message into the <err> buffer which will be preallocated. The trailing
223 * '\n' must not be written. The function must be called with <args> pointing to
224 * the first word after "stats".
225 */
226static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
227 struct proxy *defpx, const char *file, int line,
228 char **err)
229{
230 struct bind_conf *bind_conf;
231 struct listener *l;
232
233 if (!strcmp(args[1], "socket")) {
234 int cur_arg;
235
236 if (*args[2] == 0) {
237 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
238 return -1;
239 }
240
241 if (!global.stats_fe) {
242 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
243 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
244 return -1;
245 }
246 }
247
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100248 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200249 bind_conf->level &= ~ACCESS_LVL_MASK;
250 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100251
252 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
253 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
254 file, line, args[0], args[1], err && *err ? *err : "error");
255 return -1;
256 }
257
258 cur_arg = 3;
259 while (*args[cur_arg]) {
260 static int bind_dumped;
261 struct bind_kw *kw;
262
263 kw = bind_find_kw(args[cur_arg]);
264 if (kw) {
265 if (!kw->parse) {
266 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
267 args[0], args[1], args[cur_arg]);
268 return -1;
269 }
270
271 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
272 if (err && *err)
273 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
274 else
275 memprintf(err, "'%s %s' : error encountered while processing '%s'",
276 args[0], args[1], args[cur_arg]);
277 return -1;
278 }
279
280 cur_arg += 1 + kw->skip;
281 continue;
282 }
283
284 if (!bind_dumped) {
285 bind_dump_kws(err);
286 indent_msg(err, 4);
287 bind_dumped = 1;
288 }
289
290 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
291 args[0], args[1], args[cur_arg],
292 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
293 return -1;
294 }
295
296 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100297 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100298 l->default_target = global.stats_fe->default_target;
299 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
300 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100301 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100302 }
303 }
304 else if (!strcmp(args[1], "timeout")) {
305 unsigned timeout;
306 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
307
Willy Tarreau9faebe32019-06-07 19:00:37 +0200308 if (res == PARSE_TIME_OVER) {
309 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
310 args[2], args[0], args[1]);
311 return -1;
312 }
313 else if (res == PARSE_TIME_UNDER) {
314 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
315 args[2], args[0], args[1]);
316 return -1;
317 }
318 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100319 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
320 return -1;
321 }
322
323 if (!timeout) {
324 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
325 return -1;
326 }
327 if (!global.stats_fe) {
328 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
329 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
330 return -1;
331 }
332 }
333 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
334 }
335 else if (!strcmp(args[1], "maxconn")) {
336 int maxconn = atol(args[2]);
337
338 if (maxconn <= 0) {
339 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
340 return -1;
341 }
342
343 if (!global.stats_fe) {
344 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
345 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
346 return -1;
347 }
348 }
349 global.stats_fe->maxconn = maxconn;
350 }
351 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
352 int cur_arg = 2;
353 unsigned long set = 0;
354
355 if (!global.stats_fe) {
356 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
357 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
358 return -1;
359 }
360 }
361
362 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100363 if (strcmp(args[cur_arg], "all") == 0) {
364 set = 0;
365 break;
366 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100367 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100368 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100369 return -1;
370 }
371 cur_arg++;
372 }
373 global.stats_fe->bind_proc = set;
374 }
375 else {
376 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
377 return -1;
378 }
379 return 0;
380}
381
William Lallemand33d29e22019-04-01 11:30:06 +0200382/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200383 * This function exports the bound addresses of a <frontend> in the environment
384 * variable <varname>. Those addresses are separated by semicolons and prefixed
385 * with their type (abns@, unix@, sockpair@ etc)
386 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200387 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200388int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200389{
390 struct buffer *trash = get_trash_chunk();
391 struct bind_conf *bind_conf;
392
William Lallemand9a37fd02019-04-12 16:09:24 +0200393 if (frontend) {
394 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200395 struct listener *l;
396
397 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
398 char addr[46];
399 char port[6];
400
William Lallemand620072b2019-04-12 16:09:25 +0200401 /* separate listener by semicolons */
402 if (trash->data)
403 chunk_appendf(trash, ";");
404
Willy Tarreau37159062020-08-27 07:48:42 +0200405 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200406 const struct sockaddr_un *un;
407
Willy Tarreau37159062020-08-27 07:48:42 +0200408 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200409 if (un->sun_path[0] == '\0') {
410 chunk_appendf(trash, "abns@%s", un->sun_path+1);
411 } else {
412 chunk_appendf(trash, "unix@%s", un->sun_path);
413 }
Willy Tarreau37159062020-08-27 07:48:42 +0200414 } else if (l->rx.addr.ss_family == AF_INET) {
415 addr_to_str(&l->rx.addr, addr, sizeof(addr));
416 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200417 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200418 } else if (l->rx.addr.ss_family == AF_INET6) {
419 addr_to_str(&l->rx.addr, addr, sizeof(addr));
420 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200421 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200422 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
423 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200424 }
William Lallemand33d29e22019-04-01 11:30:06 +0200425 }
426 }
427 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200428 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200429 return -1;
430 }
431
432 return 0;
433}
434
William Lallemand9a37fd02019-04-12 16:09:24 +0200435int cli_socket_setenv()
436{
437 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
438 return -1;
439 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
440 return -1;
441
442 return 0;
443}
444
William Lallemand33d29e22019-04-01 11:30:06 +0200445REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
446
Willy Tarreaude57a572016-11-23 17:01:39 +0100447/* Verifies that the CLI at least has a level at least as high as <level>
448 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
449 * failure, an error message is prepared and the appctx's state is adjusted
450 * to print it so that a return 1 is enough to abort any processing.
451 */
452int cli_has_level(struct appctx *appctx, int level)
453{
Willy Tarreaude57a572016-11-23 17:01:39 +0100454
William Lallemandf630d012018-12-13 09:05:44 +0100455 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau9d008692019-08-09 11:21:01 +0200456 cli_err(appctx, stats_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100457 return 0;
458 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100459 return 1;
460}
461
William Lallemandb7ea1412018-12-13 09:05:47 +0100462/* same as cli_has_level but for the CLI proxy and without error message */
463int pcli_has_level(struct stream *s, int level)
464{
465 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
466 return 0;
467 }
468 return 1;
469}
470
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200471/* Returns severity_output for the current session if set, or default for the socket */
472static int cli_get_severity_output(struct appctx *appctx)
473{
474 if (appctx->cli_severity_output)
475 return appctx->cli_severity_output;
476 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
477}
William Lallemand74c24fb2016-11-21 17:18:36 +0100478
Willy Tarreau41908562016-11-24 16:23:38 +0100479/* Processes the CLI interpreter on the stats socket. This function is called
480 * from the CLI's IO handler running in an appctx context. The function returns 1
481 * if the request was understood, otherwise zero. It is called with appctx->st0
482 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
483 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
484 * have its own I/O handler called again. Most of the time, parsers will only
485 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100486 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
487 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100488 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200489static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100490{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200491 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
492 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100493 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100494
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200495 appctx->st2 = 0;
496 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100497
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200498 p = appctx->chunk->area;
499 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100500
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200501 /*
502 * Get the payload start if there is one.
503 * For the sake of simplicity, the payload pattern is looked up
504 * everywhere from the start of the input but it can only be found
505 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
506 *
507 * The input string was zero terminated so it is safe to use
508 * the str*() functions throughout the parsing
509 */
510 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
511 payload = strstr(p, PAYLOAD_PATTERN);
512 end = payload;
513 /* skip the pattern */
514 payload += strlen(PAYLOAD_PATTERN);
515 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100516
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200517 /*
518 * Get pointers on words.
519 * One extra slot is reserved to store a pointer on a null byte.
520 */
521 while (i < MAX_STATS_ARGS && p < end) {
522 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100523
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200524 /* skip leading spaces/tabs */
525 p += strspn(p, " \t");
526 if (!*p)
527 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100528
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200529 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200530 while (1) {
531 p += strcspn(p, " \t\\");
532 /* escaped chars using backlashes (\) */
533 if (*p == '\\') {
534 if (!*++p)
535 break;
536 if (!*++p)
537 break;
538 } else {
539 break;
540 }
541 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200542 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100543
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200544 /* unescape backslashes (\) */
545 for (j = 0, k = 0; args[i][k]; k++) {
546 if (args[i][k] == '\\') {
547 if (args[i][k + 1] == '\\')
548 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100549 else
550 continue;
551 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200552 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100553 j++;
554 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200555 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100556
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200557 i++;
558 }
559 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200560 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200561 for (; i < MAX_STATS_ARGS + 1; i++)
562 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100563
564 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100565 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100566 return 0;
567
William Lallemand14721be2018-10-26 14:47:37 +0200568 /* in a worker or normal process, don't display master only commands */
569 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
570 return 0;
571
572 /* in master don't displays if we don't have the master bits */
573 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
574 return 0;
575
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200576 /* only accept expert commands in expert mode */
577 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
578 return 0;
579
Willy Tarreau41908562016-11-24 16:23:38 +0100580 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200581 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200582
583 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
584 goto fail;
585
586 /* kw->parse could set its own io_handler or io_release handler */
587 if (!appctx->io_handler)
588 goto fail;
589
590 appctx->st0 = CLI_ST_CALLBACK;
591 return 1;
592fail:
593 appctx->io_handler = NULL;
594 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100595 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100596}
597
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200598/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
599static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
600{
Willy Tarreau83061a82018-07-13 11:56:34 +0200601 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200602
603 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200604 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200605
606 tmp = get_trash_chunk();
607 chunk_reset(tmp);
608
609 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100610 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200611 chunk_printf(tmp, "[%d]: ", severity);
612 }
613 else {
614 switch (severity_output) {
615 case CLI_SEVERITY_NUMBER:
616 chunk_printf(tmp, "[%d]: ", severity);
617 break;
618 case CLI_SEVERITY_STRING:
619 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
620 break;
621 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100622 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200623 }
624 }
625 chunk_appendf(tmp, "%s", msg);
626
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200627 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200628}
629
William Lallemand74c24fb2016-11-21 17:18:36 +0100630/* This I/O handler runs as an applet embedded in a stream interface. It is
631 * used to processes I/O from/to the stats unix socket. The system relies on a
632 * state machine handling requests and various responses. We read a request,
633 * then we process it and send the response, and we possibly display a prompt.
634 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100635 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100636 * or not.
637 */
638static void cli_io_handler(struct appctx *appctx)
639{
640 struct stream_interface *si = appctx->owner;
641 struct channel *req = si_oc(si);
642 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200643 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100644 int reql;
645 int len;
646
647 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
648 goto out;
649
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800650 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200651 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100652 /* buf.size==0 means we failed to get a buffer and were
653 * already subscribed to a wait list to get a buffer.
654 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100655 goto out;
656 }
657
William Lallemand74c24fb2016-11-21 17:18:36 +0100658 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100659 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100660 /* Stats output not initialized yet */
661 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200662 /* reset severity to default at init */
663 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100664 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100665 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100666 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100667 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100668 /* Let's close for real now. We just close the request
669 * side, the conditions below will complete if needed.
670 */
671 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200672 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100673 break;
674 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100675 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200676 char *str;
677
678 /* use a trash chunk to store received data */
679 if (!appctx->chunk) {
680 appctx->chunk = alloc_trash_chunk();
681 if (!appctx->chunk) {
682 appctx->st0 = CLI_ST_END;
683 continue;
684 }
685 }
686
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200687 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200688
William Lallemand74c24fb2016-11-21 17:18:36 +0100689 /* ensure we have some output room left in the event we
690 * would want to return some info right after parsing.
691 */
692 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100693 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100694 break;
695 }
696
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200697 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200698 reql = co_getline(si_oc(si), str,
699 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100700 if (reql <= 0) { /* closed or EOL not found */
701 if (reql == 0)
702 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100703 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100704 continue;
705 }
706
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200707 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
708 /* seek for a possible unescaped semi-colon. If we find
709 * one, we replace it with an LF and skip only this part.
710 */
711 for (len = 0; len < reql; len++) {
712 if (str[len] == '\\') {
713 len++;
714 continue;
715 }
716 if (str[len] == ';') {
717 str[len] = '\n';
718 reql = len + 1;
719 break;
720 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100721 }
722 }
723
724 /* now it is time to check that we have a full line,
725 * remove the trailing \n and possibly \r, then cut the
726 * line.
727 */
728 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200729 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100730 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100731 continue;
732 }
733
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200734 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100735 len--;
736
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200738 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200739
740 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200741 appctx->chunk->area[appctx->chunk->data] = '\n';
742 appctx->chunk->area[appctx->chunk->data + 1] = 0;
743 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200744 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100745
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100746 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200747
748 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
749 /* empty line */
750 if (!len) {
751 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200752 appctx->chunk->data -= 2;
753 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200754
755 if (!cli_parse_request(appctx))
756 cli_gen_usage_msg(appctx);
757
758 chunk_reset(appctx->chunk);
759 /* NB: cli_sock_parse_request() may have put
760 * another CLI_ST_O_* into appctx->st0.
761 */
762
763 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100764 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100765 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200766 else {
767 /*
768 * Look for the "payload start" pattern at the end of a line
769 * Its location is not remembered here, this is just to switch
770 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100771 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200772 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200773 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200774 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200775 /* no payload, the command is complete: parse the request */
776 if (!cli_parse_request(appctx))
777 cli_gen_usage_msg(appctx);
778
779 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200780 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100781 }
782
783 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200784 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100785 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
786 }
787 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200788 const char *msg;
789 int sev;
790
William Lallemand74c24fb2016-11-21 17:18:36 +0100791 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100792 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100793 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200794 case CLI_ST_PRINT: /* print const message in msg */
795 case CLI_ST_PRINT_ERR: /* print const error in msg */
796 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
797 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
798 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
799 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
800 LOG_ERR : appctx->ctx.cli.severity;
801 msg = appctx->ctx.cli.msg;
802 }
803 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
804 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
805 LOG_ERR : appctx->ctx.cli.severity;
806 msg = appctx->ctx.cli.err;
807 if (!msg) {
808 sev = LOG_ERR;
809 msg = "Out of memory.\n";
810 }
811 }
812 else {
813 sev = LOG_ERR;
814 msg = "Internal error.\n";
815 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200816
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200817 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
818 if (appctx->st0 == CLI_ST_PRINT_FREE ||
819 appctx->st0 == CLI_ST_PRINT_DYN) {
820 free(appctx->ctx.cli.err);
821 appctx->ctx.cli.err = NULL;
822 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100823 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100824 }
825 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100826 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100827 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200828
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100829 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100830 if (appctx->io_handler)
831 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100832 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100833 if (appctx->io_release) {
834 appctx->io_release(appctx);
835 appctx->io_release = NULL;
836 }
837 }
838 break;
839 default: /* abnormal state */
840 si->flags |= SI_FL_ERR;
841 break;
842 }
843
844 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100845 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200846 const char *prompt = "";
847
848 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
849 /*
850 * when entering a payload with interactive mode, change the prompt
851 * to emphasize that more data can still be sent
852 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200853 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200854 prompt = "+ ";
855 else
856 prompt = "\n> ";
857 }
858 else {
William Lallemandad032882019-07-01 10:56:15 +0200859 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200860 prompt = "\n";
861 }
862
863 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100864 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100865 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100866 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100867 }
868
869 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100870 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100871 break;
872
873 /* Now we close the output if one of the writers did so,
874 * or if we're not in interactive mode and the request
875 * buffer is empty. This still allows pipelined requests
876 * to be sent in non-interactive mode.
877 */
William Lallemand3de09d52018-12-11 16:10:56 +0100878 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
879 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100880 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100881 continue;
882 }
883
884 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100885 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200886 /* reactivate the \n at the end of the response for the next command */
887 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100888 }
889 }
890
891 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
892 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
893 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
894 /* Other side has closed, let's abort if we have no more processing to do
895 * and nothing more to consume. This is comparable to a broken pipe, so
896 * we forward the close to the request side so that it flows upstream to
897 * the client.
898 */
899 si_shutw(si);
900 }
901
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100902 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
904 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
905 /* We have no more processing to do, and nothing more to send, and
906 * the client side has closed. So we'll forward this state downstream
907 * on the response buffer.
908 */
909 si_shutr(si);
910 res->flags |= CF_READ_NULL;
911 }
912
913 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200914 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 +0100915 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200916 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 +0100917}
918
William Lallemand74c24fb2016-11-21 17:18:36 +0100919/* This is called when the stream interface is closed. For instance, upon an
920 * external abort, we won't call the i/o handler anymore so we may need to
921 * remove back references to the stream currently being dumped.
922 */
923static void cli_release_handler(struct appctx *appctx)
924{
925 if (appctx->io_release) {
926 appctx->io_release(appctx);
927 appctx->io_release = NULL;
928 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200929 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100930 free(appctx->ctx.cli.err);
931 appctx->ctx.cli.err = NULL;
932 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100933}
934
935/* This function dumps all environmnent variables to the buffer. It returns 0
936 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100937 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
938 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100939 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100940static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100941{
Willy Tarreau0a739292016-11-22 20:21:23 +0100942 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100943 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100944
945 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
946 return 1;
947
948 chunk_reset(&trash);
949
950 /* we have two inner loops here, one for the proxy, the other one for
951 * the buffer.
952 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100953 while (*var) {
954 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100955
Willy Tarreau06d80a92017-10-19 14:32:15 +0200956 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100957 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100958 return 0;
959 }
960 if (appctx->st2 == STAT_ST_END)
961 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100962 var++;
963 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100964 }
965
966 /* dump complete */
967 return 1;
968}
969
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200970/* This function dumps all file descriptors states (or the requested one) to
971 * the buffer. It returns 0 if the output buffer is full and it needs to be
972 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
973 * It uses cli.i0 as the fd number to restart from.
974 */
975static int cli_io_handler_show_fd(struct appctx *appctx)
976{
977 struct stream_interface *si = appctx->owner;
978 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100979 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200980
981 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100982 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200983
984 chunk_reset(&trash);
985
Willy Tarreauca1b1572018-12-18 15:45:11 +0100986 /* isolate the threads once per round. We're limited to a buffer worth
987 * of output anyway, it cannot last very long.
988 */
989 thread_isolate();
990
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200991 /* we have two inner loops here, one for the proxy, the other one for
992 * the buffer.
993 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100994 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200995 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200996 struct listener *li = NULL;
997 struct server *sv = NULL;
998 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200999 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001000 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001001 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001002 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001003
1004 fdt = fdtab[fd];
1005
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001006 /* When DEBUG_FD is set, we also report closed FDs that have a
1007 * non-null event count to detect stuck ones.
1008 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001009 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001010#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001011 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001012#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001013 goto skip; // closed
1014 }
1015 else if (fdt.iocb == conn_fd_handler) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001016 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001017 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001018 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001019 li = objt_listener(((struct connection *)fdt.owner)->target);
1020 sv = objt_server(((struct connection *)fdt.owner)->target);
1021 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001022 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001023 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001024 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001025 li = fdt.owner;
1026
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001027 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001028 " %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 +02001029 fd,
1030 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001031 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1032 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001033 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1034 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1035 fdt.ev,
1036 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1037 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1038 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1039 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1040 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001041 fdt.linger_risk ? 'L' : 'l',
1042 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001043 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001044 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001045 fdt.iocb);
1046 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001047
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001048 if (!fdt.owner) {
1049 chunk_appendf(&trash, ")");
1050 }
1051 else if (fdt.iocb == conn_fd_handler) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001052 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001053 if (px)
1054 chunk_appendf(&trash, " px=%s", px->id);
1055 else if (sv)
1056 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1057 else if (li)
1058 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001059
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001060 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001061 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001062 if (mux->show_fd)
1063 mux->show_fd(&trash, fdt.owner);
1064 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001065 else
1066 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001067 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001068 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001069 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001070 listener_state_str(li),
1071 li->bind_conf->frontend->id);
1072 }
1073
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001074#ifdef DEBUG_FD
1075 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
1076#endif
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001077 chunk_appendf(&trash, ")\n");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001078
Willy Tarreau06d80a92017-10-19 14:32:15 +02001079 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001080 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001081 appctx->ctx.cli.i0 = fd;
1082 ret = 0;
1083 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001084 }
1085 skip:
1086 if (appctx->st2 == STAT_ST_END)
1087 break;
1088
1089 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001090 }
1091
Willy Tarreauca1b1572018-12-18 15:45:11 +01001092 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001093 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001094
1095 thread_release();
1096 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001097}
1098
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001099/* This function dumps some activity counters used by developers and support to
1100 * rule out some hypothesis during bug reports. It returns 0 if the output
1101 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1102 * everything at once in the buffer and is not designed to do it in multiple
1103 * passes.
1104 */
1105static int cli_io_handler_show_activity(struct appctx *appctx)
1106{
1107 struct stream_interface *si = appctx->owner;
1108 int thr;
1109
1110 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1111 return 1;
1112
1113 chunk_reset(&trash);
1114
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001115#undef SHOW_TOT
1116#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001117 do { \
1118 unsigned int _v[MAX_THREADS]; \
1119 unsigned int _tot; \
1120 const unsigned int _nbt = global.nbthread; \
1121 for (_tot = t = 0; t < _nbt; t++) \
1122 _tot += _v[t] = (x); \
1123 if (_nbt == 1) { \
1124 chunk_appendf(&trash, " %u\n", _tot); \
1125 break; \
1126 } \
1127 chunk_appendf(&trash, " %u [", _tot); \
1128 for (t = 0; t < _nbt; t++) \
1129 chunk_appendf(&trash, " %u", _v[t]); \
1130 chunk_appendf(&trash, " ]\n"); \
1131 } while (0)
1132
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001133#undef SHOW_AVG
1134#define SHOW_AVG(t, x) \
1135 do { \
1136 unsigned int _v[MAX_THREADS]; \
1137 unsigned int _tot; \
1138 const unsigned int _nbt = global.nbthread; \
1139 for (_tot = t = 0; t < _nbt; t++) \
1140 _tot += _v[t] = (x); \
1141 if (_nbt == 1) { \
1142 chunk_appendf(&trash, " %u\n", _tot); \
1143 break; \
1144 } \
1145 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1146 for (t = 0; t < _nbt; t++) \
1147 chunk_appendf(&trash, " %u", _v[t]); \
1148 chunk_appendf(&trash, " ]\n"); \
1149 } while (0)
1150
Willy Tarreaua0211b82019-05-28 15:09:08 +02001151 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1152 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001153 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1154 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1155 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1156 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001157 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001158 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1159 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001160 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001161 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001162 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1163 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1164 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001165 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001166 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001167 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1168 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001169 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1170 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1171 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1172 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1173 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1174 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1175 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001176#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001177 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 +02001178 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001179#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001180
Willy Tarreaud6a78502019-05-27 07:03:38 +02001181#if defined(DEBUG_DEV)
1182 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001183 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1184 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1185 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001186#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001187
1188 if (ci_putchk(si_ic(si), &trash) == -1) {
1189 chunk_reset(&trash);
1190 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001191 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001192 }
1193
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001194#undef SHOW_AVG
1195#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001196 /* dump complete */
1197 return 1;
1198}
1199
William Lallemandeceddf72016-12-15 18:06:44 +01001200/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001201 * CLI IO handler for `show cli sockets`.
1202 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001203 */
1204static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1205{
1206 struct bind_conf *bind_conf;
1207 struct stream_interface *si = appctx->owner;
1208
1209 chunk_reset(&trash);
1210
1211 switch (appctx->st2) {
1212 case STAT_ST_INIT:
1213 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001214 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001215 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001216 return 0;
1217 }
William Lallemandeceddf72016-12-15 18:06:44 +01001218 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001219 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001220
1221 case STAT_ST_LIST:
1222 if (global.stats_fe) {
1223 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1224 struct listener *l;
1225
1226 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001227 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001228 * if the current node is the first of the list
1229 */
1230
Willy Tarreau3af9d832016-12-16 12:58:09 +01001231 if (appctx->ctx.cli.p0 &&
1232 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001233 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001234 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001235 continue;
1236 }
1237
1238 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1239
1240 char addr[46];
1241 char port[6];
1242
Willy Tarreau37159062020-08-27 07:48:42 +02001243 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001244 const struct sockaddr_un *un;
1245
Willy Tarreau37159062020-08-27 07:48:42 +02001246 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001247 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001248 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001249 } else {
1250 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1251 }
Willy Tarreau37159062020-08-27 07:48:42 +02001252 } else if (l->rx.addr.ss_family == AF_INET) {
1253 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1254 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001255 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001256 } else if (l->rx.addr.ss_family == AF_INET6) {
1257 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1258 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001259 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001260 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1261 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001262 } else
William Lallemand26314342018-10-26 14:47:41 +02001263 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001264
William Lallemand07a62f72017-05-24 00:57:40 +02001265 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001266 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001267 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1268 chunk_appendf(&trash, "operator ");
1269 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1270 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001271 else
1272 chunk_appendf(&trash, " ");
1273
Willy Tarreaue26993c2020-09-03 07:18:55 +02001274 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001275 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001276 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1277 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001278 chunk_appendf(&trash, "%d,", pos+1);
1279 }
1280 }
1281 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001282 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001283
1284 } else {
1285 chunk_appendf(&trash, "all\n");
1286 }
1287
Willy Tarreau06d80a92017-10-19 14:32:15 +02001288 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001289 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001290 return 0;
1291 }
1292 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001293 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001294 }
1295 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001296 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001297 default:
1298 appctx->st2 = STAT_ST_FIN;
1299 return 1;
1300 }
1301}
1302
1303
Willy Tarreau0a739292016-11-22 20:21:23 +01001304/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001305 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1306 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001307 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001308static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001309{
1310 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001311 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001312
1313 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1314 return 1;
1315
Willy Tarreauf6710f82016-12-16 17:45:44 +01001316 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001317
1318 if (*args[2]) {
1319 int len = strlen(args[2]);
1320
Willy Tarreauf6710f82016-12-16 17:45:44 +01001321 for (; *var; var++) {
1322 if (strncmp(*var, args[2], len) == 0 &&
1323 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001324 break;
1325 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001326 if (!*var)
1327 return cli_err(appctx, "Variable not found\n");
1328
Willy Tarreau0a739292016-11-22 20:21:23 +01001329 appctx->st2 = STAT_ST_END;
1330 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001331 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001332 return 0;
1333}
1334
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001335/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1336 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1337 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1338 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001339static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001340{
1341 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1342 return 1;
1343
1344 appctx->ctx.cli.i0 = 0;
1345
1346 if (*args[2]) {
1347 appctx->ctx.cli.i0 = atoi(args[2]);
1348 appctx->st2 = STAT_ST_END;
1349 }
1350 return 0;
1351}
1352
Willy Tarreau599852e2016-11-22 20:33:32 +01001353/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001354static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001355{
1356 struct stream_interface *si = appctx->owner;
1357 struct stream *s = si_strm(si);
1358
1359 if (strcmp(args[2], "cli") == 0) {
1360 unsigned timeout;
1361 const char *res;
1362
Willy Tarreau9d008692019-08-09 11:21:01 +02001363 if (!*args[3])
1364 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001365
1366 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001367 if (res || timeout < 1)
1368 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001369
1370 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1371 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1372 return 1;
1373 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001374
1375 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001376}
1377
Willy Tarreau2af99412016-11-23 11:10:59 +01001378/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001379static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001380{
1381 int v;
1382
1383 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1384 return 1;
1385
Willy Tarreau9d008692019-08-09 11:21:01 +02001386 if (!*args[3])
1387 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001388
1389 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001390 if (v > global.hardmaxconn)
1391 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001392
1393 /* check for unlimited values */
1394 if (v <= 0)
1395 v = global.hardmaxconn;
1396
1397 global.maxconn = v;
1398
1399 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001400 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001401
1402 return 1;
1403}
1404
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001405static int set_severity_output(int *target, char *argument)
1406{
1407 if (!strcmp(argument, "none")) {
1408 *target = CLI_SEVERITY_NONE;
1409 return 1;
1410 }
1411 else if (!strcmp(argument, "number")) {
1412 *target = CLI_SEVERITY_NUMBER;
1413 return 1;
1414 }
1415 else if (!strcmp(argument, "string")) {
1416 *target = CLI_SEVERITY_STRING;
1417 return 1;
1418 }
1419 return 0;
1420}
1421
1422/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001423static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001424{
1425 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1426 return 0;
1427
Willy Tarreau9d008692019-08-09 11:21:01 +02001428 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001429}
William Lallemandeceddf72016-12-15 18:06:44 +01001430
William Lallemand67a234f2018-12-13 09:05:45 +01001431
1432/* show the level of the current CLI session */
1433static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1434{
William Lallemand67a234f2018-12-13 09:05:45 +01001435 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001436 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001437 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001438 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001439 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001440 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001441 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001442 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001443}
1444
1445/* parse and set the CLI level dynamically */
1446static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1447{
William Lallemandad032882019-07-01 10:56:15 +02001448 /* this will ask the applet to not output a \n after the command */
1449 if (!strcmp(args[1], "-"))
1450 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1451
William Lallemand67a234f2018-12-13 09:05:45 +01001452 if (!strcmp(args[0], "operator")) {
1453 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1454 return 1;
1455 }
1456 appctx->cli_level &= ~ACCESS_LVL_MASK;
1457 appctx->cli_level |= ACCESS_LVL_OPER;
1458
1459 } else if (!strcmp(args[0], "user")) {
1460 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1461 return 1;
1462 }
1463 appctx->cli_level &= ~ACCESS_LVL_MASK;
1464 appctx->cli_level |= ACCESS_LVL_USER;
1465 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001466 appctx->cli_level &= ~ACCESS_EXPERT;
1467 return 1;
1468}
1469
1470
1471/* parse and set the CLI expert-mode dynamically */
1472static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1473{
1474 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1475 return 1;
1476
1477 if (!*args[1])
1478 return (appctx->cli_level & ACCESS_EXPERT)
1479 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1480 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1481
1482 appctx->cli_level &= ~ACCESS_EXPERT;
1483 if (strcmp(args[1], "on") == 0)
1484 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001485 return 1;
1486}
1487
William Lallemanda57b7e32018-12-14 21:11:31 +01001488
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001489int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001490{
1491 return 0;
1492}
1493
Willy Tarreau45c742b2016-11-24 14:51:17 +01001494/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001495static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001496{
1497 int v;
1498 int *res;
1499 int mul = 1;
1500
1501 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1502 return 1;
1503
1504 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1505 res = &global.cps_lim;
1506 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1507 res = &global.sps_lim;
1508#ifdef USE_OPENSSL
1509 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1510 res = &global.ssl_lim;
1511#endif
1512 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1513 res = &global.comp_rate_lim;
1514 mul = 1024;
1515 }
1516 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001517 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001518 "'set rate-limit' only supports :\n"
1519 " - 'connections global' to set the per-process maximum connection rate\n"
1520 " - 'sessions global' to set the per-process maximum session rate\n"
1521#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001522 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001523#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001524 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001525 }
1526
Willy Tarreau9d008692019-08-09 11:21:01 +02001527 if (!*args[4])
1528 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001529
1530 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001531 if (v < 0)
1532 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001533
1534 *res = v * mul;
1535
1536 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001537 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001538
1539 return 1;
1540}
1541
William Lallemandf6975e92017-05-26 17:42:10 +02001542/* parse the "expose-fd" argument on the bind lines */
1543static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1544{
1545 if (!*args[cur_arg + 1]) {
1546 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1547 return ERR_ALERT | ERR_FATAL;
1548 }
1549 if (!strcmp(args[cur_arg+1], "listeners")) {
1550 conf->level |= ACCESS_FD_LISTENERS;
1551 } else {
1552 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1553 args[cur_arg], args[cur_arg+1]);
1554 return ERR_ALERT | ERR_FATAL;
1555 }
1556
1557 return 0;
1558}
1559
William Lallemand74c24fb2016-11-21 17:18:36 +01001560/* parse the "level" argument on the bind lines */
1561static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1562{
1563 if (!*args[cur_arg + 1]) {
1564 memprintf(err, "'%s' : missing level", args[cur_arg]);
1565 return ERR_ALERT | ERR_FATAL;
1566 }
1567
William Lallemand07a62f72017-05-24 00:57:40 +02001568 if (!strcmp(args[cur_arg+1], "user")) {
1569 conf->level &= ~ACCESS_LVL_MASK;
1570 conf->level |= ACCESS_LVL_USER;
1571 } else if (!strcmp(args[cur_arg+1], "operator")) {
1572 conf->level &= ~ACCESS_LVL_MASK;
1573 conf->level |= ACCESS_LVL_OPER;
1574 } else if (!strcmp(args[cur_arg+1], "admin")) {
1575 conf->level &= ~ACCESS_LVL_MASK;
1576 conf->level |= ACCESS_LVL_ADMIN;
1577 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001578 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1579 args[cur_arg], args[cur_arg+1]);
1580 return ERR_ALERT | ERR_FATAL;
1581 }
1582
1583 return 0;
1584}
1585
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001586static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1587{
1588 if (!*args[cur_arg + 1]) {
1589 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1590 return ERR_ALERT | ERR_FATAL;
1591 }
1592
1593 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1594 return 0;
1595 else {
1596 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1597 args[cur_arg], args[cur_arg+1]);
1598 return ERR_ALERT | ERR_FATAL;
1599 }
1600}
1601
Olivier Houchardf886e342017-04-05 22:24:59 +02001602/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001603static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001604{
1605 char *cmsgbuf = NULL;
1606 unsigned char *tmpbuf = NULL;
1607 struct cmsghdr *cmsg;
1608 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001609 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001610 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001611 struct msghdr msghdr;
1612 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001613 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001614 const char *ns_name, *if_name;
1615 unsigned char ns_nlen, if_nlen;
1616 int nb_queued;
1617 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001618 int *tmpfd;
1619 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001620 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001621 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001622 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001623 int ret;
1624
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001625 if (!remote) {
1626 ha_warning("Only works on real connections\n");
1627 goto out;
1628 }
1629
1630 fd = remote->handle.fd;
1631
Olivier Houchardf886e342017-04-05 22:24:59 +02001632 /* Temporary set the FD in blocking mode, that will make our life easier */
1633 old_fcntl = fcntl(fd, F_GETFL);
1634 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001635 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001636 goto out;
1637 }
1638 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1639 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001640 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001641 goto out;
1642 }
1643 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001644 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001645 goto out;
1646 }
Olivier Houchard54740872017-04-06 14:45:14 +02001647 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001648 iov.iov_base = &tot_fd_nb;
1649 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001650 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001651 goto out;
1652 memset(&msghdr, 0, sizeof(msghdr));
1653 /*
1654 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001655 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001656 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001657 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
1658 tot_fd_nb += fdtab[cur_fd].exported;
William Lallemand5fd3b282020-01-16 15:32:08 +01001659
Olivier Houchardf886e342017-04-05 22:24:59 +02001660 if (tot_fd_nb == 0)
1661 goto out;
1662
1663 /* First send the total number of file descriptors, so that the
1664 * receiving end knows what to expect.
1665 */
1666 msghdr.msg_iov = &iov;
1667 msghdr.msg_iovlen = 1;
1668 ret = sendmsg(fd, &msghdr, 0);
1669 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001670 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001671 goto out;
1672 }
1673
1674 /* Now send the fds */
1675 msghdr.msg_control = cmsgbuf;
1676 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1677 cmsg = CMSG_FIRSTHDR(&msghdr);
1678 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1679 cmsg->cmsg_level = SOL_SOCKET;
1680 cmsg->cmsg_type = SCM_RIGHTS;
1681 tmpfd = (int *)CMSG_DATA(cmsg);
1682
Olivier Houchardf886e342017-04-05 22:24:59 +02001683 /* For each socket, e message is sent, containing the following :
1684 * Size of the namespace name (or 0 if none), as an unsigned char.
1685 * The namespace name, if any
1686 * Size of the interface name (or 0 if none), as an unsigned char
1687 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001688 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001689 */
1690 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001691 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001692 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001693 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001694 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001695 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001696 goto out;
1697 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001698
1699 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001700 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001701 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
1702 if (!(fdtab[cur_fd].exported))
1703 continue;
1704
1705 ns_name = if_name = "";
1706 ns_nlen = if_nlen = 0;
1707
1708 /* for now we can only retrieve namespaces and interfaces from
1709 * pure listeners.
1710 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001711 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001712 const struct listener *l = fdtab[cur_fd].owner;
1713
Willy Tarreau818a92e2020-09-03 07:50:19 +02001714 if (l->rx.settings->interface) {
1715 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001716 if_nlen = strlen(if_name);
1717 }
1718
1719#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001720 if (l->rx.settings->netns) {
1721 ns_name = l->rx.settings->netns->node.key;
1722 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001723 }
1724#endif
1725 }
1726
1727 /* put the FD into the CMSG_DATA */
1728 tmpfd[nb_queued++] = cur_fd;
1729
1730 /* first block is <ns_name_len> <ns_name> */
1731 tmpbuf[curoff++] = ns_nlen;
1732 if (ns_nlen)
1733 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1734 curoff += ns_nlen;
1735
1736 /* second block is <if_name_len> <if_name> */
1737 tmpbuf[curoff++] = if_nlen;
1738 if (if_nlen)
1739 memcpy(tmpbuf + curoff, if_name, if_nlen);
1740 curoff += if_nlen;
1741
1742 /* we used to send the listener options here before 2.3 */
1743 memset(tmpbuf + curoff, 0, sizeof(int));
1744 curoff += sizeof(int);
1745
1746 /* there's a limit to how many FDs may be sent at once */
1747 if (nb_queued == MAX_SEND_FD) {
1748 iov.iov_len = curoff;
1749 if (sendmsg(fd, &msghdr, 0) != curoff) {
1750 ha_warning("Failed to transfer sockets\n");
1751 return -1;
1752 }
1753
1754 /* Wait for an ack */
1755 do {
1756 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
1757 } while (ret == -1 && errno == EINTR);
1758
1759 if (ret <= 0) {
1760 ha_warning("Unexpected error while transferring sockets\n");
1761 return -1;
1762 }
1763 curoff = 0;
1764 nb_queued = 0;
1765 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001766 }
1767
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001768 /* flush pending stuff */
1769 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02001770 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001771 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
1772 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02001773 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001774 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001775 goto out;
1776 }
1777 }
1778
1779out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001780 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001781 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001782 goto out;
1783 }
1784 appctx->st0 = CLI_ST_END;
1785 free(cmsgbuf);
1786 free(tmpbuf);
1787 return 1;
1788}
1789
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001790static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1791{
1792 if (*args[0] == 'h')
1793 /* help */
1794 cli_gen_usage_msg(appctx);
1795 else if (*args[0] == 'p')
1796 /* prompt */
1797 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1798 else if (*args[0] == 'q')
1799 /* quit */
1800 appctx->st0 = CLI_ST_END;
1801
1802 return 1;
1803}
Olivier Houchardf886e342017-04-05 22:24:59 +02001804
William Lallemand2f4ce202018-10-26 14:47:47 +02001805void pcli_write_prompt(struct stream *s)
1806{
1807 struct buffer *msg = get_trash_chunk();
1808 struct channel *oc = si_oc(&s->si[0]);
1809
William Lallemanddc12c2e2018-12-13 09:05:46 +01001810 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001811 return;
1812
William Lallemanddc12c2e2018-12-13 09:05:46 +01001813 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001814 chunk_appendf(msg, "+ ");
1815 } else {
1816 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001817 chunk_appendf(msg, "master%s> ",
1818 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001819 else
1820 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1821 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001822 co_inject(oc, msg->area, msg->data);
1823}
1824
William Lallemand291810d2018-10-26 14:47:38 +02001825
William Lallemandcf62f7e2018-10-26 14:47:40 +02001826/* The pcli_* functions are used for the CLI proxy in the master */
1827
William Lallemanddeeaa592018-10-26 14:47:48 +02001828void pcli_reply_and_close(struct stream *s, const char *msg)
1829{
1830 struct buffer *buf = get_trash_chunk();
1831
1832 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001833 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001834}
1835
William Lallemand291810d2018-10-26 14:47:38 +02001836static enum obj_type *pcli_pid_to_server(int proc_pid)
1837{
1838 struct mworker_proc *child;
1839
William Lallemandbddd33a2018-12-11 16:10:53 +01001840 /* return the CLI applet of the master */
1841 if (proc_pid == 0)
1842 return &cli_applet.obj_type;
1843
William Lallemand291810d2018-10-26 14:47:38 +02001844 list_for_each_entry(child, &proc_list, list) {
1845 if (child->pid == proc_pid){
1846 return &child->srv->obj_type;
1847 }
1848 }
1849 return NULL;
1850}
1851
1852/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1853 * Return:
1854 * 0: master
1855 * > 0: pid of a worker
1856 * < 0: didn't find a worker
1857 */
1858static int pcli_prefix_to_pid(const char *prefix)
1859{
1860 int proc_pid;
1861 struct mworker_proc *child;
1862 char *errtol = NULL;
1863
1864 if (*prefix != '@') /* not a prefix, should not happen */
1865 return -1;
1866
1867 prefix++;
1868 if (!*prefix) /* sent @ alone, return the master */
1869 return 0;
1870
1871 if (strcmp("master", prefix) == 0) {
1872 return 0;
1873 } else if (*prefix == '!') {
1874 prefix++;
1875 if (!*prefix)
1876 return -1;
1877
1878 proc_pid = strtol(prefix, &errtol, 10);
1879 if (*errtol != '\0')
1880 return -1;
1881 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001882 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001883 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001884 if (child->pid == proc_pid){
1885 return child->pid;
1886 }
1887 }
1888 } else {
1889 struct mworker_proc *chosen = NULL;
1890 /* this is a relative pid */
1891
1892 proc_pid = strtol(prefix, &errtol, 10);
1893 if (*errtol != '\0')
1894 return -1;
1895
1896 if (proc_pid == 0) /* return the master */
1897 return 0;
1898
1899 /* chose the right process, the current one is the one with the
1900 least number of reloads */
1901 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001902 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001903 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001904 if (child->relative_pid == proc_pid){
1905 if (child->reloads == 0)
1906 return child->pid;
1907 else if (chosen == NULL || child->reloads < chosen->reloads)
1908 chosen = child;
1909 }
1910 }
1911 if (chosen)
1912 return chosen->pid;
1913 }
1914 return -1;
1915}
1916
William Lallemandbddd33a2018-12-11 16:10:53 +01001917/* Return::
1918 * >= 0 : number of words to escape
1919 * = -1 : error
1920 */
1921
1922int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1923{
1924 if (argl < 1)
1925 return 0;
1926
1927 /* there is a prefix */
1928 if (args[0][0] == '@') {
1929 int target_pid = pcli_prefix_to_pid(args[0]);
1930
1931 if (target_pid == -1) {
1932 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1933 return -1;
1934 }
1935
1936 /* if the prefix is alone, define a default target */
1937 if (argl == 1)
1938 s->pcli_next_pid = target_pid;
1939 else
1940 *next_pid = target_pid;
1941 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001942 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001943 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001944 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001945
1946 } else if (!strcmp("quit", args[0])) {
1947 channel_shutr_now(&s->req);
1948 channel_shutw_now(&s->res);
1949 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001950 } else if (!strcmp(args[0], "operator")) {
1951 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1952 memprintf(errmsg, "Permission denied!\n");
1953 return -1;
1954 }
1955 s->pcli_flags &= ~ACCESS_LVL_MASK;
1956 s->pcli_flags |= ACCESS_LVL_OPER;
1957 return argl;
1958
1959 } else if (!strcmp(args[0], "user")) {
1960 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1961 memprintf(errmsg, "Permission denied!\n");
1962 return -1;
1963 }
1964 s->pcli_flags &= ~ACCESS_LVL_MASK;
1965 s->pcli_flags |= ACCESS_LVL_USER;
1966 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001967 }
1968
1969 return 0;
1970}
1971
1972/*
1973 * Parse the CLI request:
1974 * - It does basically the same as the cli_io_handler, but as a proxy
1975 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001976 *
1977 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01001978 * - the number of characters to forward or
1979 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02001980 */
William Lallemandbddd33a2018-12-11 16:10:53 +01001981int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001982{
William Lallemandbddd33a2018-12-11 16:10:53 +01001983 char *str = (char *)ci_head(req);
1984 char *end = (char *)ci_stop(req);
1985 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
1986 int argl; /* number of args */
1987 char *p;
1988 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01001989 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01001990 int wtrim = 0; /* number of words to trim */
1991 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01001992 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01001993 int i = 0;
1994
1995 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001996
William Lallemanddc12c2e2018-12-13 09:05:46 +01001997 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01001998
1999 /* Looks for the end of one command */
2000 while (p+reql < end) {
2001 /* handle escaping */
2002 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002003 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002004 continue;
2005 }
2006 if (p[reql] == ';' || p[reql] == '\n') {
2007 /* found the end of the command */
2008 p[reql] = '\n';
2009 reql++;
2010 break;
2011 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002012 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002013 }
William Lallemandebf61802018-12-11 16:10:57 +01002014 } else {
2015 while (p+reql < end) {
2016 if (p[reql] == '\n') {
2017 /* found the end of the line */
2018 reql++;
2019 break;
2020 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002021 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002022 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002023 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002024
William Lallemandbddd33a2018-12-11 16:10:53 +01002025 /* set end to first byte after the end of the command */
2026 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002027
William Lallemandbddd33a2018-12-11 16:10:53 +01002028 /* there is no end to this command, need more to parse ! */
2029 if (*(end-1) != '\n') {
2030 return -1;
2031 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002032
William Lallemand3301f3e2018-12-13 09:05:48 +01002033 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2034 if (reql == 1) /* last line of the payload */
2035 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002036 return reql;
2037 }
2038
William Lallemandbddd33a2018-12-11 16:10:53 +01002039 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002040
William Lallemandbddd33a2018-12-11 16:10:53 +01002041 /* splits the command in words */
2042 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002043 /* skip leading spaces/tabs */
2044 p += strspn(p, " \t");
2045 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002046 break;
2047
William Lallemandbddd33a2018-12-11 16:10:53 +01002048 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002049 while (1) {
2050 p += strcspn(p, " \t\\");
2051 /* escaped chars using backlashes (\) */
2052 if (*p == '\\') {
2053 if (!*++p)
2054 break;
2055 if (!*++p)
2056 break;
2057 } else {
2058 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002059 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002060 }
William Lallemandfe249c32020-06-18 18:03:57 +02002061 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002062 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002063 }
2064
William Lallemandbddd33a2018-12-11 16:10:53 +01002065 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002066
William Lallemandbddd33a2018-12-11 16:10:53 +01002067 for (; i < MAX_STATS_ARGS + 1; i++)
2068 args[i] = NULL;
2069
2070 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2071
2072 /* End of words are ending by \0, we need to replace the \0s by spaces
20731 before forwarding them */
2074 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002075 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002076 if (*p == '\0')
2077 *p = ' ';
2078 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002079 }
2080
William Lallemand3301f3e2018-12-13 09:05:48 +01002081 payload = strstr(str, PAYLOAD_PATTERN);
2082 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2083 /* if the payload pattern is at the end */
2084 s->pcli_flags |= PCLI_F_PAYLOAD;
2085 ret = reql;
2086 }
2087
William Lallemandbddd33a2018-12-11 16:10:53 +01002088 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002089
William Lallemandbddd33a2018-12-11 16:10:53 +01002090 if (wtrim > 0) {
2091 trim = &args[wtrim][0];
2092 if (trim == NULL) /* if this was the last word in the table */
2093 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002094
William Lallemandbddd33a2018-12-11 16:10:53 +01002095 b_del(&req->buf, trim - str);
2096
William Lallemandb7ea1412018-12-13 09:05:47 +01002097 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002098 } else if (wtrim < 0) {
2099 /* parsing error */
2100 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002101 } else {
2102 /* the whole string */
2103 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002104 }
2105
William Lallemandb7ea1412018-12-13 09:05:47 +01002106 if (ret > 1) {
2107 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2108 goto end;
2109 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002110 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2111 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002112 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002113 ci_insert_line2(req, 0, "user -", strlen("user -"));
2114 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002115 }
2116 }
2117end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002118
William Lallemandb7ea1412018-12-13 09:05:47 +01002119 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002120}
2121
2122int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2123{
William Lallemandbddd33a2018-12-11 16:10:53 +01002124 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002125 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002126 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002127
William Lallemandb7ea1412018-12-13 09:05:47 +01002128 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2129 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2130
William Lallemandcf62f7e2018-10-26 14:47:40 +02002131read_again:
2132 /* if the channel is closed for read, we won't receive any more data
2133 from the client, but we don't want to forward this close to the
2134 server */
2135 channel_dont_close(req);
2136
2137 /* We don't know yet to which server we will connect */
2138 channel_dont_connect(req);
2139
2140
2141 /* we are not waiting for a response, there is no more request and we
2142 * receive a close from the client, we can leave */
2143 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2144 channel_shutw_now(&s->res);
2145 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2146 return 1;
2147 }
2148
2149 req->flags |= CF_READ_DONTWAIT;
2150
2151 /* need more data */
2152 if (!ci_data(req))
2153 return 0;
2154
2155 /* If there is data available for analysis, log the end of the idle time. */
2156 if (c_data(req) && s->logs.t_idle == -1)
2157 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2158
William Lallemandbddd33a2018-12-11 16:10:53 +01002159 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002160 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002161 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002162 /* enough data */
2163
William Lallemandcf62f7e2018-10-26 14:47:40 +02002164 /* forward only 1 command */
2165 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002166
William Lallemanddc12c2e2018-12-13 09:05:46 +01002167 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002168 /* we send only 1 command per request, and we write close after it */
2169 channel_shutw_now(req);
2170 } else {
2171 pcli_write_prompt(s);
2172 }
2173
2174 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002175
2176 /* remove the XFER_DATA analysers, which forwards all
2177 * the data, we don't want to forward the next requests
2178 * We need to add CF_FLT_ANALYZE to abort the forward too.
2179 */
2180 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2181 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2182 s->res.analysers |= AN_RES_WAIT_CLI;
2183
William Lallemandebf61802018-12-11 16:10:57 +01002184 if (!(s->flags & SF_ASSIGNED)) {
2185 if (next_pid > -1)
2186 target_pid = next_pid;
2187 else
2188 target_pid = s->pcli_next_pid;
2189 /* we can connect now */
2190 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002191
William Lallemandebf61802018-12-11 16:10:57 +01002192 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2193 channel_auto_connect(req);
2194 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002195
2196 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002197 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002198 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002199 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002200 } else if (to_forward == -1 && errmsg) {
2201 /* there was an error during the parsing */
2202 pcli_reply_and_close(s, errmsg);
2203 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002204 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2205 /* buffer is full and we didn't catch the end of a command */
2206 goto send_help;
2207 }
2208
2209 return 0;
2210
2211send_help:
2212 b_reset(&req->buf);
2213 b_putblk(&req->buf, "help\n", 5);
2214 goto read_again;
2215}
2216
2217int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2218{
2219 struct proxy *fe = strm_fe(s);
2220 struct proxy *be = s->be;
2221
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002222 if (rep->flags & CF_READ_ERROR) {
2223 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2224 s->res.analysers &= ~AN_RES_WAIT_CLI;
2225 return 0;
2226 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002227 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2228 rep->flags |= CF_NEVER_WAIT;
2229
2230 /* don't forward the close */
2231 channel_dont_close(&s->res);
2232 channel_dont_close(&s->req);
2233
William Lallemanddc12c2e2018-12-13 09:05:46 +01002234 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002235 s->req.analysers |= AN_REQ_WAIT_CLI;
2236 s->res.analysers &= ~AN_RES_WAIT_CLI;
2237 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2238 return 0;
2239 }
2240
William Lallemandcf62f7e2018-10-26 14:47:40 +02002241 /* forward the data */
2242 if (ci_data(rep)) {
2243 c_adv(rep, ci_data(rep));
2244 return 0;
2245 }
2246
2247 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2248 /* stream cleanup */
2249
William Lallemand2f4ce202018-10-26 14:47:47 +02002250 pcli_write_prompt(s);
2251
William Lallemandcf62f7e2018-10-26 14:47:40 +02002252 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2253 si_shutr(&s->si[1]);
2254 si_shutw(&s->si[1]);
2255
2256 /*
2257 * starting from there this the same code as
2258 * http_end_txn_clean_session().
2259 *
2260 * It allows to do frontend keepalive while reconnecting to a
2261 * new server for each request.
2262 */
2263
2264 if (s->flags & SF_BE_ASSIGNED) {
2265 HA_ATOMIC_SUB(&be->beconn, 1);
2266 if (unlikely(s->srv_conn))
2267 sess_change_server(s, NULL);
2268 }
2269
2270 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2271 stream_process_counters(s);
2272
2273 /* don't count other requests' data */
2274 s->logs.bytes_in -= ci_data(&s->req);
2275 s->logs.bytes_out -= ci_data(&s->res);
2276
2277 /* we may need to know the position in the queue */
2278 pendconn_free(s);
2279
2280 /* let's do a final log if we need it */
2281 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2282 !(s->flags & SF_MONITOR) &&
2283 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2284 s->do_log(s);
2285 }
2286
2287 /* stop tracking content-based counters */
2288 stream_stop_content_counters(s);
2289 stream_update_time_stats(s);
2290
2291 s->logs.accept_date = date; /* user-visible date for logging */
2292 s->logs.tv_accept = now; /* corrected date for internal use */
2293 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2294 s->logs.t_idle = -1;
2295 tv_zero(&s->logs.tv_request);
2296 s->logs.t_queue = -1;
2297 s->logs.t_connect = -1;
2298 s->logs.t_data = -1;
2299 s->logs.t_close = 0;
2300 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2301 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2302
2303 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2304 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2305
2306 stream_del_srv_conn(s);
2307 if (objt_server(s->target)) {
2308 if (s->flags & SF_CURR_SESS) {
2309 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002310 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002311 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002312 if (may_dequeue_tasks(__objt_server(s->target), be))
2313 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002314 }
2315
2316 s->target = NULL;
2317
2318 /* only release our endpoint if we don't intend to reuse the
2319 * connection.
2320 */
2321 if (!si_conn_ready(&s->si[1])) {
2322 si_release_endpoint(&s->si[1]);
2323 s->srv_conn = NULL;
2324 }
2325
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002326 sockaddr_free(&s->target_addr);
2327
William Lallemandcf62f7e2018-10-26 14:47:40 +02002328 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2329 s->si[1].err_type = SI_ET_NONE;
2330 s->si[1].conn_retries = 0; /* used for logging too */
2331 s->si[1].exp = TICK_ETERNITY;
2332 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 +02002333 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 +02002334 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 +02002335 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2336 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2337 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2338 /* reinitialise the current rule list pointer to NULL. We are sure that
2339 * any rulelist match the NULL pointer.
2340 */
2341 s->current_rule_list = NULL;
2342
2343 s->be = strm_fe(s);
2344 s->logs.logwait = strm_fe(s)->to_log;
2345 s->logs.level = 0;
2346 stream_del_srv_conn(s);
2347 s->target = NULL;
2348 /* re-init store persistence */
2349 s->store_count = 0;
2350 s->uniq_id = global.req_count++;
2351
2352 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2353
2354 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2355
2356 s->req.analysers |= AN_REQ_WAIT_CLI;
2357 s->res.analysers &= ~AN_RES_WAIT_CLI;
2358
2359 /* We must trim any excess data from the response buffer, because we
2360 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002361 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002362 * we want those data to come along with next response. A typical
2363 * example of such data would be from a buggy server responding to
2364 * a HEAD with some data, or sending more than the advertised
2365 * content-length.
2366 */
2367 if (unlikely(ci_data(&s->res)))
2368 b_set_data(&s->res.buf, co_data(&s->res));
2369
2370 /* Now we can realign the response buffer */
2371 c_realign_if_empty(&s->res);
2372
2373 s->req.rto = strm_fe(s)->timeout.client;
2374 s->req.wto = TICK_ETERNITY;
2375
2376 s->res.rto = TICK_ETERNITY;
2377 s->res.wto = strm_fe(s)->timeout.client;
2378
2379 s->req.rex = TICK_ETERNITY;
2380 s->req.wex = TICK_ETERNITY;
2381 s->req.analyse_exp = TICK_ETERNITY;
2382 s->res.rex = TICK_ETERNITY;
2383 s->res.wex = TICK_ETERNITY;
2384 s->res.analyse_exp = TICK_ETERNITY;
2385 s->si[1].hcto = TICK_ETERNITY;
2386
2387 /* we're removing the analysers, we MUST re-enable events detection.
2388 * We don't enable close on the response channel since it's either
2389 * already closed, or in keep-alive with an idle connection handler.
2390 */
2391 channel_auto_read(&s->req);
2392 channel_auto_close(&s->req);
2393 channel_auto_read(&s->res);
2394
2395
2396 return 1;
2397 }
2398 return 0;
2399}
2400
William Lallemand8a022572018-10-26 14:47:35 +02002401/*
2402 * The mworker functions are used to initialize the CLI in the master process
2403 */
2404
William Lallemand309dc9a2018-10-26 14:47:45 +02002405 /*
2406 * Stop the mworker proxy
2407 */
2408void mworker_cli_proxy_stop()
2409{
William Lallemand550db6d2018-11-06 17:37:12 +01002410 if (mworker_proxy)
2411 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002412}
2413
William Lallemand8a022572018-10-26 14:47:35 +02002414/*
2415 * Create the mworker CLI proxy
2416 */
2417int mworker_cli_proxy_create()
2418{
2419 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002420 char *msg = NULL;
2421 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002422
2423 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2424 if (!mworker_proxy)
2425 return -1;
2426
2427 init_new_proxy(mworker_proxy);
2428 mworker_proxy->next = proxies_list;
2429 proxies_list = mworker_proxy;
2430 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002431 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002432 mworker_proxy->last_change = now.tv_sec;
2433 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2434 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2435 mworker_proxy->timeout.client = 0; /* no timeout */
2436 mworker_proxy->conf.file = strdup("MASTER");
2437 mworker_proxy->conf.line = 0;
2438 mworker_proxy->accept = frontend_accept;
2439 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2440
2441 /* Does not init the default target the CLI applet, but must be done in
2442 * the request parsing code */
2443 mworker_proxy->default_target = NULL;
2444
2445 /* the check_config_validity() will get an ID for the proxy */
2446 mworker_proxy->uuid = -1;
2447
2448 proxy_store_name(mworker_proxy);
2449
2450 /* create all servers using the mworker_proc list */
2451 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002452 struct server *newsrv = NULL;
2453 struct sockaddr_storage *sk;
2454 int port1, port2, port;
2455 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002456
William Lallemanda31b09e2020-01-14 15:25:02 +01002457 /* only the workers support the master CLI */
2458 if (!(child->options & PROC_O_TYPE_WORKER))
2459 continue;
2460
William Lallemand8a022572018-10-26 14:47:35 +02002461 newsrv = new_server(mworker_proxy);
2462 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002463 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002464
2465 /* we don't know the new pid yet */
2466 if (child->pid == -1)
2467 memprintf(&msg, "cur-%d", child->relative_pid);
2468 else
2469 memprintf(&msg, "old-%d", child->pid);
2470
2471 newsrv->next = mworker_proxy->srv;
2472 mworker_proxy->srv = newsrv;
2473 newsrv->conf.file = strdup(msg);
2474 newsrv->id = strdup(msg);
2475 newsrv->conf.line = 0;
2476
2477 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002478 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002479 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002480 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002481 }
2482 free(msg);
2483 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002484
Willy Tarreau5fc93282020-09-16 18:25:03 +02002485 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002486 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002487 }
2488
2489 /* no port specified */
2490 newsrv->flags |= SRV_F_MAPPORTS;
2491 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002492 /* don't let the server participate to load balancing */
2493 newsrv->iweight = 0;
2494 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002495 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002496
2497 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002498 }
2499 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002500
2501error:
2502 ha_alert("%s\n", errmsg);
2503
2504 list_for_each_entry(child, &proc_list, list) {
2505 free((char *)child->srv->conf.file); /* cast because of const char * */
2506 free(child->srv->id);
2507 free(child->srv);
2508 child->srv = NULL;
2509 }
2510 free(mworker_proxy->id);
2511 free(mworker_proxy->conf.file);
2512 free(mworker_proxy);
2513 mworker_proxy = NULL;
2514 free(errmsg);
2515 free(msg);
2516
2517 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002518}
Olivier Houchardf886e342017-04-05 22:24:59 +02002519
William Lallemandce83b4a2018-10-26 14:47:30 +02002520/*
William Lallemande7361152018-10-26 14:47:36 +02002521 * Create a new listener for the master CLI proxy
2522 */
2523int mworker_cli_proxy_new_listener(char *line)
2524{
2525 struct bind_conf *bind_conf;
2526 struct listener *l;
2527 char *err = NULL;
2528 char *args[MAX_LINE_ARGS + 1];
2529 int arg;
2530 int cur_arg;
2531
William Lallemand2e945c82019-11-25 09:58:37 +01002532 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002533 args[0] = line;
2534
2535 /* args is a bind configuration with spaces replaced by commas */
2536 while (*line && arg < MAX_LINE_ARGS) {
2537
2538 if (*line == ',') {
2539 *line++ = '\0';
2540 while (*line == ',')
2541 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002542 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002543 }
2544 line++;
2545 }
2546
William Lallemand2e945c82019-11-25 09:58:37 +01002547 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002548
2549 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002550 if (!bind_conf)
2551 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002552
2553 bind_conf->level &= ~ACCESS_LVL_MASK;
2554 bind_conf->level |= ACCESS_LVL_ADMIN;
2555
2556 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2557 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002558 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002559 }
2560
2561 cur_arg = 1;
2562
2563 while (*args[cur_arg]) {
2564 static int bind_dumped;
2565 struct bind_kw *kw;
2566
2567 kw = bind_find_kw(args[cur_arg]);
2568 if (kw) {
2569 if (!kw->parse) {
2570 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2571 args[0], args[1], args[cur_arg]);
2572 goto err;
2573 }
2574
2575 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2576 if (err)
2577 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2578 else
2579 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2580 args[0], args[1], args[cur_arg]);
2581 goto err;
2582 }
2583
2584 cur_arg += 1 + kw->skip;
2585 continue;
2586 }
2587
2588 if (!bind_dumped) {
2589 bind_dump_kws(&err);
2590 indent_msg(&err, 4);
2591 bind_dumped = 1;
2592 }
2593
2594 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2595 args[0], args[1], args[cur_arg],
2596 err ? " Registered keywords :" : "", err ? err : "");
2597 goto err;
2598 }
2599
2600
2601 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002602 l->accept = session_accept_fd;
2603 l->default_target = mworker_proxy->default_target;
2604 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002605 l->options |= LI_O_UNLIMITED;
2606 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002607 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002608 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002609 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002610 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002611
2612 return 0;
2613
2614err:
2615 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002616 free(err);
2617 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002618 return -1;
2619
2620}
2621
2622/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002623 * Create a new CLI socket using a socketpair for a worker process
2624 * <mworker_proc> is the process structure, and <proc> is the process number
2625 */
2626int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2627{
2628 struct bind_conf *bind_conf;
2629 struct listener *l;
2630 char *path = NULL;
2631 char *err = NULL;
2632
2633 /* master pipe to ensure the master is still alive */
2634 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2635 ha_alert("Cannot create worker socketpair.\n");
2636 return -1;
2637 }
2638
2639 /* XXX: we might want to use a separate frontend at some point */
2640 if (!global.stats_fe) {
2641 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2642 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002643 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002644 }
2645 }
2646
2647 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002648 if (!bind_conf)
2649 goto error;
2650
William Lallemandce83b4a2018-10-26 14:47:30 +02002651 bind_conf->level &= ~ACCESS_LVL_MASK;
2652 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2653
Willy Tarreaue26993c2020-09-03 07:18:55 +02002654 bind_conf->settings.bind_proc = 1UL << proc;
William Lallemandce83b4a2018-10-26 14:47:30 +02002655 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2656
2657 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2658 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002659 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002660 }
2661
2662 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002663 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002664 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002665 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002666 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002667 free(path);
2668 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002669
2670 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002671 l->accept = session_accept_fd;
2672 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002673 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau455585e2020-10-09 18:25:14 +02002674 HA_ATOMIC_ADD(&unstoppable_jobs, 1);
William Lallemandce83b4a2018-10-26 14:47:30 +02002675 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002676 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002677 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002678 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002679 }
2680
2681 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002682
2683error:
2684 close(mworker_proc->ipc_fd[0]);
2685 close(mworker_proc->ipc_fd[1]);
2686 free(err);
2687
2688 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002689}
2690
William Lallemand74c24fb2016-11-21 17:18:36 +01002691static struct applet cli_applet = {
2692 .obj_type = OBJ_TYPE_APPLET,
2693 .name = "<CLI>", /* used for logging */
2694 .fct = cli_io_handler,
2695 .release = cli_release_handler,
2696};
2697
Willy Tarreau0a739292016-11-22 20:21:23 +01002698/* register cli keywords */
2699static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002700 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2701 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2702 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002703 { { "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 +01002704 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002705 { { "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 +01002706 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002707 { { "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 +02002708 { { "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 +01002709 { { "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 +02002710 { { "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 +01002711 { { "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 +01002712 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2713 { { "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 +02002714 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002715 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002716 {{},}
2717}};
2718
Willy Tarreau0108d902018-11-25 19:14:37 +01002719INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2720
William Lallemand74c24fb2016-11-21 17:18:36 +01002721static struct cfg_kw_list cfg_kws = {ILH, {
2722 { CFG_GLOBAL, "stats", stats_parse_global },
2723 { 0, NULL, NULL },
2724}};
2725
Willy Tarreau0108d902018-11-25 19:14:37 +01002726INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2727
William Lallemand74c24fb2016-11-21 17:18:36 +01002728static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002729 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2730 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002731 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002732 { NULL, NULL, 0 },
2733}};
2734
Willy Tarreau0108d902018-11-25 19:14:37 +01002735INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002736
2737/*
2738 * Local variables:
2739 * c-indent-level: 8
2740 * c-basic-offset: 8
2741 * End:
2742 */