blob: b9afc1b20481e172ad44d6b0f248c7bc36b42596 [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 Tarreau2eec9b52020-06-04 19:58:55 +020056#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020057#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020058#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020059#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020060#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020061#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020062#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020063#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010064
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020065#define PAYLOAD_PATTERN "<<"
66
William Lallemand74c24fb2016-11-21 17:18:36 +010067static struct applet cli_applet;
68
69static const char stats_sock_usage_msg[] =
70 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010071 " help : this message\n"
72 " prompt : toggle interactive mode with prompt\n"
73 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010074 "";
75
76static const char stats_permission_denied_msg[] =
77 "Permission denied\n"
78 "";
79
80
Christopher Faulet1bc04c72017-10-29 20:14:08 +010081static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010082
83/* List head of cli keywords */
84static struct cli_kw_list cli_keywords = {
85 .list = LIST_HEAD_INIT(cli_keywords.list)
86};
87
88extern const char *stat_status_codes[];
89
William Lallemand8a022572018-10-26 14:47:35 +020090static struct proxy *mworker_proxy; /* CLI proxy of the master */
91
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020092static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +010093{
94 struct cli_kw_list *kw_list;
95 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020096 struct buffer *tmp = get_trash_chunk();
97 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +010098
99 free(dynamic_usage_msg);
100 dynamic_usage_msg = NULL;
101
102 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200103 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100104
105 chunk_reset(tmp);
106 chunk_strcat(tmp, stats_sock_usage_msg);
107 list_for_each_entry(kw_list, &cli_keywords.list, list) {
108 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200109 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200110
111 /* in a worker or normal process, don't display master only commands */
112 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
113 goto next_kw;
114
115 /* in master don't displays if we don't have the master bits */
116 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
117 goto next_kw;
118
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200119 /* only show expert commands in expert mode */
120 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
121 goto next_kw;
122
William Lallemand0154edc2018-05-15 11:50:04 +0200123 if (kw->usage)
124 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200125
126next_kw:
127
William Lallemand74c24fb2016-11-21 17:18:36 +0100128 kw++;
129 }
130 }
131 chunk_init(&out, NULL, 0);
132 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200133 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200134
135end:
136 if (dynamic_usage_msg) {
137 appctx->ctx.cli.severity = LOG_INFO;
138 appctx->ctx.cli.msg = dynamic_usage_msg;
139 }
140 else {
141 appctx->ctx.cli.severity = LOG_INFO;
142 appctx->ctx.cli.msg = stats_sock_usage_msg;
143 }
144 appctx->st0 = CLI_ST_PRINT;
145
William Lallemand74c24fb2016-11-21 17:18:36 +0100146 return dynamic_usage_msg;
147}
148
149struct cli_kw* cli_find_kw(char **args)
150{
151 struct cli_kw_list *kw_list;
152 struct cli_kw *kw;/* current cli_kw */
153 char **tmp_args;
154 const char **tmp_str_kw;
155 int found = 0;
156
157 if (LIST_ISEMPTY(&cli_keywords.list))
158 return NULL;
159
160 list_for_each_entry(kw_list, &cli_keywords.list, list) {
161 kw = &kw_list->kw[0];
162 while (*kw->str_kw) {
163 tmp_args = args;
164 tmp_str_kw = kw->str_kw;
165 while (*tmp_str_kw) {
166 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
167 found = 1;
168 } else {
169 found = 0;
170 break;
171 }
172 tmp_args++;
173 tmp_str_kw++;
174 }
175 if (found)
176 return (kw);
177 kw++;
178 }
179 }
180 return NULL;
181}
182
183void cli_register_kw(struct cli_kw_list *kw_list)
184{
185 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
186}
187
188
189/* allocate a new stats frontend named <name>, and return it
190 * (or NULL in case of lack of memory).
191 */
192static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
193{
194 struct proxy *fe;
195
196 fe = calloc(1, sizeof(*fe));
197 if (!fe)
198 return NULL;
199
200 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100201 fe->next = proxies_list;
202 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100203 fe->last_change = now.tv_sec;
204 fe->id = strdup("GLOBAL");
205 fe->cap = PR_CAP_FE;
206 fe->maxconn = 10; /* default to 10 concurrent connections */
207 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
208 fe->conf.file = strdup(file);
209 fe->conf.line = line;
210 fe->accept = frontend_accept;
211 fe->default_target = &cli_applet.obj_type;
212
213 /* the stats frontend is the only one able to assign ID #0 */
214 fe->conf.id.key = fe->uuid = 0;
215 eb32_insert(&used_proxy_id, &fe->conf.id);
216 return fe;
217}
218
219/* This function parses a "stats" statement in the "global" section. It returns
220 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
221 * error message into the <err> buffer which will be preallocated. The trailing
222 * '\n' must not be written. The function must be called with <args> pointing to
223 * the first word after "stats".
224 */
225static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
226 struct proxy *defpx, const char *file, int line,
227 char **err)
228{
229 struct bind_conf *bind_conf;
230 struct listener *l;
231
232 if (!strcmp(args[1], "socket")) {
233 int cur_arg;
234
235 if (*args[2] == 0) {
236 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
237 return -1;
238 }
239
240 if (!global.stats_fe) {
241 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
242 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
243 return -1;
244 }
245 }
246
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100247 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200248 bind_conf->level &= ~ACCESS_LVL_MASK;
249 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100250
251 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
252 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
253 file, line, args[0], args[1], err && *err ? *err : "error");
254 return -1;
255 }
256
257 cur_arg = 3;
258 while (*args[cur_arg]) {
259 static int bind_dumped;
260 struct bind_kw *kw;
261
262 kw = bind_find_kw(args[cur_arg]);
263 if (kw) {
264 if (!kw->parse) {
265 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
266 args[0], args[1], args[cur_arg]);
267 return -1;
268 }
269
270 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
271 if (err && *err)
272 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
273 else
274 memprintf(err, "'%s %s' : error encountered while processing '%s'",
275 args[0], args[1], args[cur_arg]);
276 return -1;
277 }
278
279 cur_arg += 1 + kw->skip;
280 continue;
281 }
282
283 if (!bind_dumped) {
284 bind_dump_kws(err);
285 indent_msg(err, 4);
286 bind_dumped = 1;
287 }
288
289 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
290 args[0], args[1], args[cur_arg],
291 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
292 return -1;
293 }
294
295 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100296 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100297 l->default_target = global.stats_fe->default_target;
298 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
299 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100300 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100301 }
302 }
303 else if (!strcmp(args[1], "timeout")) {
304 unsigned timeout;
305 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
306
Willy Tarreau9faebe32019-06-07 19:00:37 +0200307 if (res == PARSE_TIME_OVER) {
308 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
309 args[2], args[0], args[1]);
310 return -1;
311 }
312 else if (res == PARSE_TIME_UNDER) {
313 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
314 args[2], args[0], args[1]);
315 return -1;
316 }
317 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100318 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
319 return -1;
320 }
321
322 if (!timeout) {
323 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
324 return -1;
325 }
326 if (!global.stats_fe) {
327 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
328 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
329 return -1;
330 }
331 }
332 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
333 }
334 else if (!strcmp(args[1], "maxconn")) {
335 int maxconn = atol(args[2]);
336
337 if (maxconn <= 0) {
338 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
339 return -1;
340 }
341
342 if (!global.stats_fe) {
343 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
344 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
345 return -1;
346 }
347 }
348 global.stats_fe->maxconn = maxconn;
349 }
350 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
351 int cur_arg = 2;
352 unsigned long set = 0;
353
354 if (!global.stats_fe) {
355 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
356 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
357 return -1;
358 }
359 }
360
361 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100362 if (strcmp(args[cur_arg], "all") == 0) {
363 set = 0;
364 break;
365 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100366 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100367 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100368 return -1;
369 }
370 cur_arg++;
371 }
372 global.stats_fe->bind_proc = set;
373 }
374 else {
375 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
376 return -1;
377 }
378 return 0;
379}
380
William Lallemand33d29e22019-04-01 11:30:06 +0200381/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200382 * This function exports the bound addresses of a <frontend> in the environment
383 * variable <varname>. Those addresses are separated by semicolons and prefixed
384 * with their type (abns@, unix@, sockpair@ etc)
385 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200386 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200387int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200388{
389 struct buffer *trash = get_trash_chunk();
390 struct bind_conf *bind_conf;
391
William Lallemand9a37fd02019-04-12 16:09:24 +0200392 if (frontend) {
393 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200394 struct listener *l;
395
396 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
397 char addr[46];
398 char port[6];
399
William Lallemand620072b2019-04-12 16:09:25 +0200400 /* separate listener by semicolons */
401 if (trash->data)
402 chunk_appendf(trash, ";");
403
William Lallemand33d29e22019-04-01 11:30:06 +0200404 if (l->addr.ss_family == AF_UNIX) {
405 const struct sockaddr_un *un;
406
407 un = (struct sockaddr_un *)&l->addr;
408 if (un->sun_path[0] == '\0') {
409 chunk_appendf(trash, "abns@%s", un->sun_path+1);
410 } else {
411 chunk_appendf(trash, "unix@%s", un->sun_path);
412 }
413 } else if (l->addr.ss_family == AF_INET) {
414 addr_to_str(&l->addr, addr, sizeof(addr));
415 port_to_str(&l->addr, port, sizeof(port));
416 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
417 } else if (l->addr.ss_family == AF_INET6) {
418 addr_to_str(&l->addr, addr, sizeof(addr));
419 port_to_str(&l->addr, port, sizeof(port));
420 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
421 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
422 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
423 }
William Lallemand33d29e22019-04-01 11:30:06 +0200424 }
425 }
426 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200427 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200428 return -1;
429 }
430
431 return 0;
432}
433
William Lallemand9a37fd02019-04-12 16:09:24 +0200434int cli_socket_setenv()
435{
436 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
437 return -1;
438 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
439 return -1;
440
441 return 0;
442}
443
William Lallemand33d29e22019-04-01 11:30:06 +0200444REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
445
Willy Tarreaude57a572016-11-23 17:01:39 +0100446/* Verifies that the CLI at least has a level at least as high as <level>
447 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
448 * failure, an error message is prepared and the appctx's state is adjusted
449 * to print it so that a return 1 is enough to abort any processing.
450 */
451int cli_has_level(struct appctx *appctx, int level)
452{
Willy Tarreaude57a572016-11-23 17:01:39 +0100453
William Lallemandf630d012018-12-13 09:05:44 +0100454 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau9d008692019-08-09 11:21:01 +0200455 cli_err(appctx, stats_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100456 return 0;
457 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100458 return 1;
459}
460
William Lallemandb7ea1412018-12-13 09:05:47 +0100461/* same as cli_has_level but for the CLI proxy and without error message */
462int pcli_has_level(struct stream *s, int level)
463{
464 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
465 return 0;
466 }
467 return 1;
468}
469
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200470/* Returns severity_output for the current session if set, or default for the socket */
471static int cli_get_severity_output(struct appctx *appctx)
472{
473 if (appctx->cli_severity_output)
474 return appctx->cli_severity_output;
475 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
476}
William Lallemand74c24fb2016-11-21 17:18:36 +0100477
Willy Tarreau41908562016-11-24 16:23:38 +0100478/* Processes the CLI interpreter on the stats socket. This function is called
479 * from the CLI's IO handler running in an appctx context. The function returns 1
480 * if the request was understood, otherwise zero. It is called with appctx->st0
481 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
482 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
483 * have its own I/O handler called again. Most of the time, parsers will only
484 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100485 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
486 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100487 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200488static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100489{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200490 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
491 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100492 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100493
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200494 appctx->st2 = 0;
495 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100496
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200497 p = appctx->chunk->area;
498 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100499
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200500 /*
501 * Get the payload start if there is one.
502 * For the sake of simplicity, the payload pattern is looked up
503 * everywhere from the start of the input but it can only be found
504 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
505 *
506 * The input string was zero terminated so it is safe to use
507 * the str*() functions throughout the parsing
508 */
509 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
510 payload = strstr(p, PAYLOAD_PATTERN);
511 end = payload;
512 /* skip the pattern */
513 payload += strlen(PAYLOAD_PATTERN);
514 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100515
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200516 /*
517 * Get pointers on words.
518 * One extra slot is reserved to store a pointer on a null byte.
519 */
520 while (i < MAX_STATS_ARGS && p < end) {
521 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100522
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200523 /* skip leading spaces/tabs */
524 p += strspn(p, " \t");
525 if (!*p)
526 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100527
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200528 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200529 while (1) {
530 p += strcspn(p, " \t\\");
531 /* escaped chars using backlashes (\) */
532 if (*p == '\\') {
533 if (!*++p)
534 break;
535 if (!*++p)
536 break;
537 } else {
538 break;
539 }
540 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200541 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100542
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200543 /* unescape backslashes (\) */
544 for (j = 0, k = 0; args[i][k]; k++) {
545 if (args[i][k] == '\\') {
546 if (args[i][k + 1] == '\\')
547 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100548 else
549 continue;
550 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200551 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100552 j++;
553 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200554 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100555
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200556 i++;
557 }
558 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200559 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200560 for (; i < MAX_STATS_ARGS + 1; i++)
561 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100562
563 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100564 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100565 return 0;
566
William Lallemand14721be2018-10-26 14:47:37 +0200567 /* in a worker or normal process, don't display master only commands */
568 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
569 return 0;
570
571 /* in master don't displays if we don't have the master bits */
572 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
573 return 0;
574
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200575 /* only accept expert commands in expert mode */
576 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
577 return 0;
578
Willy Tarreau41908562016-11-24 16:23:38 +0100579 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200580 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200581
582 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
583 goto fail;
584
585 /* kw->parse could set its own io_handler or io_release handler */
586 if (!appctx->io_handler)
587 goto fail;
588
589 appctx->st0 = CLI_ST_CALLBACK;
590 return 1;
591fail:
592 appctx->io_handler = NULL;
593 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100594 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100595}
596
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200597/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
598static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
599{
Willy Tarreau83061a82018-07-13 11:56:34 +0200600 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200601
602 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200603 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200604
605 tmp = get_trash_chunk();
606 chunk_reset(tmp);
607
608 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100609 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200610 chunk_printf(tmp, "[%d]: ", severity);
611 }
612 else {
613 switch (severity_output) {
614 case CLI_SEVERITY_NUMBER:
615 chunk_printf(tmp, "[%d]: ", severity);
616 break;
617 case CLI_SEVERITY_STRING:
618 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
619 break;
620 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100621 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200622 }
623 }
624 chunk_appendf(tmp, "%s", msg);
625
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200626 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200627}
628
William Lallemand74c24fb2016-11-21 17:18:36 +0100629/* This I/O handler runs as an applet embedded in a stream interface. It is
630 * used to processes I/O from/to the stats unix socket. The system relies on a
631 * state machine handling requests and various responses. We read a request,
632 * then we process it and send the response, and we possibly display a prompt.
633 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100634 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100635 * or not.
636 */
637static void cli_io_handler(struct appctx *appctx)
638{
639 struct stream_interface *si = appctx->owner;
640 struct channel *req = si_oc(si);
641 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200642 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100643 int reql;
644 int len;
645
646 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
647 goto out;
648
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800649 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200650 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100651 /* buf.size==0 means we failed to get a buffer and were
652 * already subscribed to a wait list to get a buffer.
653 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100654 goto out;
655 }
656
William Lallemand74c24fb2016-11-21 17:18:36 +0100657 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100658 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100659 /* Stats output not initialized yet */
660 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200661 /* reset severity to default at init */
662 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100663 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100664 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100665 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100666 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100667 /* Let's close for real now. We just close the request
668 * side, the conditions below will complete if needed.
669 */
670 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200671 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100672 break;
673 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100674 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200675 char *str;
676
677 /* use a trash chunk to store received data */
678 if (!appctx->chunk) {
679 appctx->chunk = alloc_trash_chunk();
680 if (!appctx->chunk) {
681 appctx->st0 = CLI_ST_END;
682 continue;
683 }
684 }
685
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200686 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200687
William Lallemand74c24fb2016-11-21 17:18:36 +0100688 /* ensure we have some output room left in the event we
689 * would want to return some info right after parsing.
690 */
691 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100692 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 break;
694 }
695
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200696 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200697 reql = co_getline(si_oc(si), str,
698 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100699 if (reql <= 0) { /* closed or EOL not found */
700 if (reql == 0)
701 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100702 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100703 continue;
704 }
705
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200706 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
707 /* seek for a possible unescaped semi-colon. If we find
708 * one, we replace it with an LF and skip only this part.
709 */
710 for (len = 0; len < reql; len++) {
711 if (str[len] == '\\') {
712 len++;
713 continue;
714 }
715 if (str[len] == ';') {
716 str[len] = '\n';
717 reql = len + 1;
718 break;
719 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100720 }
721 }
722
723 /* now it is time to check that we have a full line,
724 * remove the trailing \n and possibly \r, then cut the
725 * line.
726 */
727 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200728 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100729 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100730 continue;
731 }
732
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200733 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100734 len--;
735
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200737 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738
739 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200740 appctx->chunk->area[appctx->chunk->data] = '\n';
741 appctx->chunk->area[appctx->chunk->data + 1] = 0;
742 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100744
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100745 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200746
747 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
748 /* empty line */
749 if (!len) {
750 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200751 appctx->chunk->data -= 2;
752 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200753
754 if (!cli_parse_request(appctx))
755 cli_gen_usage_msg(appctx);
756
757 chunk_reset(appctx->chunk);
758 /* NB: cli_sock_parse_request() may have put
759 * another CLI_ST_O_* into appctx->st0.
760 */
761
762 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100763 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100764 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200765 else {
766 /*
767 * Look for the "payload start" pattern at the end of a line
768 * Its location is not remembered here, this is just to switch
769 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100770 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200771 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200772 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200773 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200774 /* no payload, the command is complete: parse the request */
775 if (!cli_parse_request(appctx))
776 cli_gen_usage_msg(appctx);
777
778 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200779 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100780 }
781
782 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200783 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100784 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
785 }
786 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200787 const char *msg;
788 int sev;
789
William Lallemand74c24fb2016-11-21 17:18:36 +0100790 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100791 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100792 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200793 case CLI_ST_PRINT: /* print const message in msg */
794 case CLI_ST_PRINT_ERR: /* print const error in msg */
795 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
796 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
797 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
798 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
799 LOG_ERR : appctx->ctx.cli.severity;
800 msg = appctx->ctx.cli.msg;
801 }
802 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
803 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
804 LOG_ERR : appctx->ctx.cli.severity;
805 msg = appctx->ctx.cli.err;
806 if (!msg) {
807 sev = LOG_ERR;
808 msg = "Out of memory.\n";
809 }
810 }
811 else {
812 sev = LOG_ERR;
813 msg = "Internal error.\n";
814 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200815
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200816 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
817 if (appctx->st0 == CLI_ST_PRINT_FREE ||
818 appctx->st0 == CLI_ST_PRINT_DYN) {
819 free(appctx->ctx.cli.err);
820 appctx->ctx.cli.err = NULL;
821 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100822 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100823 }
824 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100825 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200827
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100828 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100829 if (appctx->io_handler)
830 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100831 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100832 if (appctx->io_release) {
833 appctx->io_release(appctx);
834 appctx->io_release = NULL;
835 }
836 }
837 break;
838 default: /* abnormal state */
839 si->flags |= SI_FL_ERR;
840 break;
841 }
842
843 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100844 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200845 const char *prompt = "";
846
847 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
848 /*
849 * when entering a payload with interactive mode, change the prompt
850 * to emphasize that more data can still be sent
851 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200852 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200853 prompt = "+ ";
854 else
855 prompt = "\n> ";
856 }
857 else {
William Lallemandad032882019-07-01 10:56:15 +0200858 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200859 prompt = "\n";
860 }
861
862 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100863 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100864 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100865 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100866 }
867
868 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100869 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100870 break;
871
872 /* Now we close the output if one of the writers did so,
873 * or if we're not in interactive mode and the request
874 * buffer is empty. This still allows pipelined requests
875 * to be sent in non-interactive mode.
876 */
William Lallemand3de09d52018-12-11 16:10:56 +0100877 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
878 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100879 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100880 continue;
881 }
882
883 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100884 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200885 /* reactivate the \n at the end of the response for the next command */
886 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100887 }
888 }
889
890 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
891 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
892 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
893 /* Other side has closed, let's abort if we have no more processing to do
894 * and nothing more to consume. This is comparable to a broken pipe, so
895 * we forward the close to the request side so that it flows upstream to
896 * the client.
897 */
898 si_shutw(si);
899 }
900
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100901 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100902 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
903 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
904 /* We have no more processing to do, and nothing more to send, and
905 * the client side has closed. So we'll forward this state downstream
906 * on the response buffer.
907 */
908 si_shutr(si);
909 res->flags |= CF_READ_NULL;
910 }
911
912 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200913 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 +0100914 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200915 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 +0100916}
917
William Lallemand74c24fb2016-11-21 17:18:36 +0100918/* This is called when the stream interface is closed. For instance, upon an
919 * external abort, we won't call the i/o handler anymore so we may need to
920 * remove back references to the stream currently being dumped.
921 */
922static void cli_release_handler(struct appctx *appctx)
923{
924 if (appctx->io_release) {
925 appctx->io_release(appctx);
926 appctx->io_release = NULL;
927 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200928 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100929 free(appctx->ctx.cli.err);
930 appctx->ctx.cli.err = NULL;
931 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100932}
933
934/* This function dumps all environmnent variables to the buffer. It returns 0
935 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100936 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
937 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100938 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100939static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100940{
Willy Tarreau0a739292016-11-22 20:21:23 +0100941 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100942 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100943
944 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
945 return 1;
946
947 chunk_reset(&trash);
948
949 /* we have two inner loops here, one for the proxy, the other one for
950 * the buffer.
951 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100952 while (*var) {
953 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100954
Willy Tarreau06d80a92017-10-19 14:32:15 +0200955 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100956 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100957 return 0;
958 }
959 if (appctx->st2 == STAT_ST_END)
960 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100961 var++;
962 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100963 }
964
965 /* dump complete */
966 return 1;
967}
968
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200969/* This function dumps all file descriptors states (or the requested one) to
970 * the buffer. It returns 0 if the output buffer is full and it needs to be
971 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
972 * It uses cli.i0 as the fd number to restart from.
973 */
974static int cli_io_handler_show_fd(struct appctx *appctx)
975{
976 struct stream_interface *si = appctx->owner;
977 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100978 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200979
980 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100981 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200982
983 chunk_reset(&trash);
984
Willy Tarreauca1b1572018-12-18 15:45:11 +0100985 /* isolate the threads once per round. We're limited to a buffer worth
986 * of output anyway, it cannot last very long.
987 */
988 thread_isolate();
989
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200990 /* we have two inner loops here, one for the proxy, the other one for
991 * the buffer.
992 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100993 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200994 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200995 struct listener *li = NULL;
996 struct server *sv = NULL;
997 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200998 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200999 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001000 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001001 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001002
1003 fdt = fdtab[fd];
1004
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001005 /* When DEBUG_FD is set, we also report closed FDs that have a
1006 * non-null event count to detect stuck ones.
1007 */
1008 if (!fdt.owner
1009#ifdef DEBUG_FD
1010 && !fdt.event_count
1011#endif
1012 )
Willy Tarreau017af242017-10-04 20:24:54 +02001013 goto skip; // closed
1014
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001015 if (fdt.iocb == conn_fd_handler) {
1016 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 }
1024 else if (fdt.iocb == listener_accept)
1025 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 }
1068 else if (fdt.iocb == listener_accept) {
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 Tarreaue6182842019-04-15 18:54:10 +02001178#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001179
Willy Tarreaud6a78502019-05-27 07:03:38 +02001180#if defined(DEBUG_DEV)
1181 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001182 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1183 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1184 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001185#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001186
1187 if (ci_putchk(si_ic(si), &trash) == -1) {
1188 chunk_reset(&trash);
1189 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001190 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001191 }
1192
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001193#undef SHOW_AVG
1194#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001195 /* dump complete */
1196 return 1;
1197}
1198
William Lallemandeceddf72016-12-15 18:06:44 +01001199/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001200 * CLI IO handler for `show cli sockets`.
1201 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001202 */
1203static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1204{
1205 struct bind_conf *bind_conf;
1206 struct stream_interface *si = appctx->owner;
1207
1208 chunk_reset(&trash);
1209
1210 switch (appctx->st2) {
1211 case STAT_ST_INIT:
1212 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001213 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001214 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001215 return 0;
1216 }
William Lallemandeceddf72016-12-15 18:06:44 +01001217 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001218 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001219
1220 case STAT_ST_LIST:
1221 if (global.stats_fe) {
1222 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1223 struct listener *l;
1224
1225 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001226 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001227 * if the current node is the first of the list
1228 */
1229
Willy Tarreau3af9d832016-12-16 12:58:09 +01001230 if (appctx->ctx.cli.p0 &&
1231 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001232 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001233 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001234 continue;
1235 }
1236
1237 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1238
1239 char addr[46];
1240 char port[6];
1241
1242 if (l->addr.ss_family == AF_UNIX) {
1243 const struct sockaddr_un *un;
1244
1245 un = (struct sockaddr_un *)&l->addr;
William Lallemande58915f2019-04-01 11:30:05 +02001246 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001247 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001248 } else {
1249 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1250 }
William Lallemandeceddf72016-12-15 18:06:44 +01001251 } else if (l->addr.ss_family == AF_INET) {
1252 addr_to_str(&l->addr, addr, sizeof(addr));
1253 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001254 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001255 } else if (l->addr.ss_family == AF_INET6) {
1256 addr_to_str(&l->addr, addr, sizeof(addr));
1257 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001258 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001259 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1260 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001261 } else
William Lallemand26314342018-10-26 14:47:41 +02001262 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001263
William Lallemand07a62f72017-05-24 00:57:40 +02001264 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001265 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001266 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1267 chunk_appendf(&trash, "operator ");
1268 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1269 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001270 else
1271 chunk_appendf(&trash, " ");
1272
1273 if (bind_conf->bind_proc != 0) {
1274 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001275 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001276 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001277 chunk_appendf(&trash, "%d,", pos+1);
1278 }
1279 }
1280 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001281 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001282
1283 } else {
1284 chunk_appendf(&trash, "all\n");
1285 }
1286
Willy Tarreau06d80a92017-10-19 14:32:15 +02001287 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001288 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001289 return 0;
1290 }
1291 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001292 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001293 }
1294 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001295 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001296 default:
1297 appctx->st2 = STAT_ST_FIN;
1298 return 1;
1299 }
1300}
1301
1302
Willy Tarreau0a739292016-11-22 20:21:23 +01001303/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001304 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1305 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001306 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001307static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001308{
1309 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001310 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001311
1312 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1313 return 1;
1314
Willy Tarreauf6710f82016-12-16 17:45:44 +01001315 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001316
1317 if (*args[2]) {
1318 int len = strlen(args[2]);
1319
Willy Tarreauf6710f82016-12-16 17:45:44 +01001320 for (; *var; var++) {
1321 if (strncmp(*var, args[2], len) == 0 &&
1322 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001323 break;
1324 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001325 if (!*var)
1326 return cli_err(appctx, "Variable not found\n");
1327
Willy Tarreau0a739292016-11-22 20:21:23 +01001328 appctx->st2 = STAT_ST_END;
1329 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001330 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001331 return 0;
1332}
1333
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001334/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1335 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1336 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1337 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001338static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001339{
1340 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1341 return 1;
1342
1343 appctx->ctx.cli.i0 = 0;
1344
1345 if (*args[2]) {
1346 appctx->ctx.cli.i0 = atoi(args[2]);
1347 appctx->st2 = STAT_ST_END;
1348 }
1349 return 0;
1350}
1351
Willy Tarreau599852e2016-11-22 20:33:32 +01001352/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001353static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001354{
1355 struct stream_interface *si = appctx->owner;
1356 struct stream *s = si_strm(si);
1357
1358 if (strcmp(args[2], "cli") == 0) {
1359 unsigned timeout;
1360 const char *res;
1361
Willy Tarreau9d008692019-08-09 11:21:01 +02001362 if (!*args[3])
1363 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001364
1365 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001366 if (res || timeout < 1)
1367 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001368
1369 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1370 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1371 return 1;
1372 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001373
1374 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001375}
1376
Willy Tarreau2af99412016-11-23 11:10:59 +01001377/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001378static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001379{
1380 int v;
1381
1382 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1383 return 1;
1384
Willy Tarreau9d008692019-08-09 11:21:01 +02001385 if (!*args[3])
1386 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001387
1388 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001389 if (v > global.hardmaxconn)
1390 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001391
1392 /* check for unlimited values */
1393 if (v <= 0)
1394 v = global.hardmaxconn;
1395
1396 global.maxconn = v;
1397
1398 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001399 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001400
1401 return 1;
1402}
1403
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001404static int set_severity_output(int *target, char *argument)
1405{
1406 if (!strcmp(argument, "none")) {
1407 *target = CLI_SEVERITY_NONE;
1408 return 1;
1409 }
1410 else if (!strcmp(argument, "number")) {
1411 *target = CLI_SEVERITY_NUMBER;
1412 return 1;
1413 }
1414 else if (!strcmp(argument, "string")) {
1415 *target = CLI_SEVERITY_STRING;
1416 return 1;
1417 }
1418 return 0;
1419}
1420
1421/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001422static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001423{
1424 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1425 return 0;
1426
Willy Tarreau9d008692019-08-09 11:21:01 +02001427 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001428}
William Lallemandeceddf72016-12-15 18:06:44 +01001429
William Lallemand67a234f2018-12-13 09:05:45 +01001430
1431/* show the level of the current CLI session */
1432static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1433{
William Lallemand67a234f2018-12-13 09:05:45 +01001434 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001435 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001436 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001437 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001438 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001439 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001440 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001441 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001442}
1443
1444/* parse and set the CLI level dynamically */
1445static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1446{
William Lallemandad032882019-07-01 10:56:15 +02001447 /* this will ask the applet to not output a \n after the command */
1448 if (!strcmp(args[1], "-"))
1449 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1450
William Lallemand67a234f2018-12-13 09:05:45 +01001451 if (!strcmp(args[0], "operator")) {
1452 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1453 return 1;
1454 }
1455 appctx->cli_level &= ~ACCESS_LVL_MASK;
1456 appctx->cli_level |= ACCESS_LVL_OPER;
1457
1458 } else if (!strcmp(args[0], "user")) {
1459 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1460 return 1;
1461 }
1462 appctx->cli_level &= ~ACCESS_LVL_MASK;
1463 appctx->cli_level |= ACCESS_LVL_USER;
1464 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001465 appctx->cli_level &= ~ACCESS_EXPERT;
1466 return 1;
1467}
1468
1469
1470/* parse and set the CLI expert-mode dynamically */
1471static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1472{
1473 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1474 return 1;
1475
1476 if (!*args[1])
1477 return (appctx->cli_level & ACCESS_EXPERT)
1478 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1479 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1480
1481 appctx->cli_level &= ~ACCESS_EXPERT;
1482 if (strcmp(args[1], "on") == 0)
1483 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001484 return 1;
1485}
1486
William Lallemanda57b7e32018-12-14 21:11:31 +01001487
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001488int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001489{
1490 return 0;
1491}
1492
Willy Tarreau45c742b2016-11-24 14:51:17 +01001493/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001494static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001495{
1496 int v;
1497 int *res;
1498 int mul = 1;
1499
1500 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1501 return 1;
1502
1503 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1504 res = &global.cps_lim;
1505 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1506 res = &global.sps_lim;
1507#ifdef USE_OPENSSL
1508 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1509 res = &global.ssl_lim;
1510#endif
1511 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1512 res = &global.comp_rate_lim;
1513 mul = 1024;
1514 }
1515 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001516 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001517 "'set rate-limit' only supports :\n"
1518 " - 'connections global' to set the per-process maximum connection rate\n"
1519 " - 'sessions global' to set the per-process maximum session rate\n"
1520#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001521 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001522#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001523 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001524 }
1525
Willy Tarreau9d008692019-08-09 11:21:01 +02001526 if (!*args[4])
1527 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001528
1529 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001530 if (v < 0)
1531 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001532
1533 *res = v * mul;
1534
1535 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001536 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001537
1538 return 1;
1539}
1540
William Lallemandf6975e92017-05-26 17:42:10 +02001541/* parse the "expose-fd" argument on the bind lines */
1542static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1543{
1544 if (!*args[cur_arg + 1]) {
1545 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1546 return ERR_ALERT | ERR_FATAL;
1547 }
1548 if (!strcmp(args[cur_arg+1], "listeners")) {
1549 conf->level |= ACCESS_FD_LISTENERS;
1550 } else {
1551 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1552 args[cur_arg], args[cur_arg+1]);
1553 return ERR_ALERT | ERR_FATAL;
1554 }
1555
1556 return 0;
1557}
1558
William Lallemand74c24fb2016-11-21 17:18:36 +01001559/* parse the "level" argument on the bind lines */
1560static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1561{
1562 if (!*args[cur_arg + 1]) {
1563 memprintf(err, "'%s' : missing level", args[cur_arg]);
1564 return ERR_ALERT | ERR_FATAL;
1565 }
1566
William Lallemand07a62f72017-05-24 00:57:40 +02001567 if (!strcmp(args[cur_arg+1], "user")) {
1568 conf->level &= ~ACCESS_LVL_MASK;
1569 conf->level |= ACCESS_LVL_USER;
1570 } else if (!strcmp(args[cur_arg+1], "operator")) {
1571 conf->level &= ~ACCESS_LVL_MASK;
1572 conf->level |= ACCESS_LVL_OPER;
1573 } else if (!strcmp(args[cur_arg+1], "admin")) {
1574 conf->level &= ~ACCESS_LVL_MASK;
1575 conf->level |= ACCESS_LVL_ADMIN;
1576 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001577 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1578 args[cur_arg], args[cur_arg+1]);
1579 return ERR_ALERT | ERR_FATAL;
1580 }
1581
1582 return 0;
1583}
1584
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001585static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1586{
1587 if (!*args[cur_arg + 1]) {
1588 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1589 return ERR_ALERT | ERR_FATAL;
1590 }
1591
1592 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1593 return 0;
1594 else {
1595 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1596 args[cur_arg], args[cur_arg+1]);
1597 return ERR_ALERT | ERR_FATAL;
1598 }
1599}
1600
William Lallemandd308c5e2020-01-16 16:26:41 +01001601/*
1602 * For one proxy, fill the iov and send the msghdr. Also update fd_it and offset.
1603 * Return -1 upon error, otherwise 0.
1604 *
1605 * This function is only meant to deduplicate the code between the peers and
1606 * the proxy list in _getsocks(), not to be used anywhere else.
1607 */
1608inline static int _getsocks_gen_send(struct proxy *px, int sendfd, int *tmpfd, struct iovec *iov,
1609 int tot_fd_nb, int *fd_it, int *offset, struct msghdr *msghdr)
1610{
1611 int i = *fd_it;
1612 int curoff = *offset;
1613 struct listener *l;
1614 unsigned char *tmpbuf = iov->iov_base;
1615
1616 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1617 int ret;
1618 /* Only transfer IPv4/IPv6 sockets */
1619 if (l->state >= LI_ZOMBIE &&
1620 (l->proto->sock_family == AF_INET ||
1621 l->proto->sock_family == AF_INET6 ||
1622 l->proto->sock_family == AF_UNIX)) {
1623 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1624 if (!l->netns)
1625 tmpbuf[curoff++] = 0;
1626#ifdef USE_NS
1627 else {
1628 char *name = l->netns->node.key;
1629 unsigned char len = l->netns->name_len;
1630 tmpbuf[curoff++] = len;
1631 memcpy(tmpbuf + curoff, name, len);
1632 curoff += len;
1633 }
1634#endif
1635 if (l->interface) {
1636 unsigned char len = strlen(l->interface);
1637 tmpbuf[curoff++] = len;
1638 memcpy(tmpbuf + curoff, l->interface, len);
1639 curoff += len;
1640 } else
1641 tmpbuf[curoff++] = 0;
1642 memcpy(tmpbuf + curoff, &l->options,
1643 sizeof(l->options));
1644 curoff += sizeof(l->options);
1645
1646 i++;
1647 } else
1648 continue;
1649 /* if it reaches the max number of fd per msghdr */
1650 if ((!(i % MAX_SEND_FD))) {
1651 iov->iov_len = curoff;
1652 if (sendmsg(sendfd, msghdr, 0) != curoff) {
1653 ha_warning("Failed to transfer sockets\n");
1654 return -1;
1655 }
1656 /* Wait for an ack */
1657 do {
1658 ret = recv(sendfd, &tot_fd_nb,
1659 sizeof(tot_fd_nb), 0);
1660 } while (ret == -1 && errno == EINTR);
1661 if (ret <= 0) {
1662 ha_warning("Unexpected error while transferring sockets\n");
1663 return -1;
1664 }
1665 curoff = 0;
1666 }
1667 }
1668
1669 *fd_it = i;
1670 *offset = curoff;
1671
1672 return 0;
1673}
William Lallemand16dd1b32018-11-19 18:46:18 +01001674
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001675
Olivier Houchardf886e342017-04-05 22:24:59 +02001676/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001677static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001678{
1679 char *cmsgbuf = NULL;
1680 unsigned char *tmpbuf = NULL;
1681 struct cmsghdr *cmsg;
1682 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001683 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001684 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001685 struct msghdr msghdr;
1686 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001687 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001688 int *tmpfd;
1689 int tot_fd_nb = 0;
1690 struct proxy *px;
William Lallemand5fd3b282020-01-16 15:32:08 +01001691 struct peers *prs;
Olivier Houchardf886e342017-04-05 22:24:59 +02001692 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001693 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001694 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001695 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001696 int ret;
1697
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001698 if (!remote) {
1699 ha_warning("Only works on real connections\n");
1700 goto out;
1701 }
1702
1703 fd = remote->handle.fd;
1704
Olivier Houchardf886e342017-04-05 22:24:59 +02001705 /* Temporary set the FD in blocking mode, that will make our life easier */
1706 old_fcntl = fcntl(fd, F_GETFL);
1707 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001708 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001709 goto out;
1710 }
1711 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1712 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001713 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001714 goto out;
1715 }
1716 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001717 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001718 goto out;
1719 }
Olivier Houchard54740872017-04-06 14:45:14 +02001720 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001721 iov.iov_base = &tot_fd_nb;
1722 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001723 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001724 goto out;
1725 memset(&msghdr, 0, sizeof(msghdr));
1726 /*
1727 * First, calculates the total number of FD, so that we can let
1728 * the caller know how much he should expects.
1729 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001730 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001731 while (px) {
1732 struct listener *l;
1733
1734 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001735 /* Only transfer IPv4/IPv6/UNIX sockets */
1736 if (l->state >= LI_ZOMBIE &&
1737 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001738 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001739 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001740 tot_fd_nb++;
1741 }
1742 px = px->next;
1743 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001744 prs = cfg_peers;
1745 while (prs) {
1746 if (prs->peers_fe) {
1747 struct listener *l;
1748
1749 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1750 /* Only transfer IPv4/IPv6/UNIX sockets */
1751 if (l->state >= LI_ZOMBIE &&
1752 (l->proto->sock_family == AF_INET ||
1753 l->proto->sock_family == AF_INET6 ||
1754 l->proto->sock_family == AF_UNIX))
1755 tot_fd_nb++;
1756 }
1757 }
1758 prs = prs->next;
1759 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001760 if (tot_fd_nb == 0)
1761 goto out;
1762
1763 /* First send the total number of file descriptors, so that the
1764 * receiving end knows what to expect.
1765 */
1766 msghdr.msg_iov = &iov;
1767 msghdr.msg_iovlen = 1;
1768 ret = sendmsg(fd, &msghdr, 0);
1769 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001770 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001771 goto out;
1772 }
1773
1774 /* Now send the fds */
1775 msghdr.msg_control = cmsgbuf;
1776 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1777 cmsg = CMSG_FIRSTHDR(&msghdr);
1778 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1779 cmsg->cmsg_level = SOL_SOCKET;
1780 cmsg->cmsg_type = SCM_RIGHTS;
1781 tmpfd = (int *)CMSG_DATA(cmsg);
1782
Olivier Houchardf886e342017-04-05 22:24:59 +02001783 /* For each socket, e message is sent, containing the following :
1784 * Size of the namespace name (or 0 if none), as an unsigned char.
1785 * The namespace name, if any
1786 * Size of the interface name (or 0 if none), as an unsigned char
1787 * The interface name, if any
1788 * Listener options, as an int.
1789 */
1790 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001791 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001792 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001793 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001794 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001795 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001796 goto out;
1797 }
1798 iov.iov_base = tmpbuf;
William Lallemand5fd3b282020-01-16 15:32:08 +01001799 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001800 while (px) {
William Lallemandd308c5e2020-01-16 16:26:41 +01001801 if (_getsocks_gen_send(px, fd, tmpfd, &iov,
1802 tot_fd_nb, &i, &curoff, &msghdr) < 0)
1803 goto out;
Olivier Houchardf886e342017-04-05 22:24:59 +02001804 px = px->next;
1805 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001806 /* should be done for peers too */
1807 prs = cfg_peers;
1808 while (prs) {
William Lallemandd308c5e2020-01-16 16:26:41 +01001809 if (prs->peers_fe)
1810 if (_getsocks_gen_send(prs->peers_fe, fd, tmpfd, &iov,
1811 tot_fd_nb, &i, &curoff, &msghdr) < 0)
1812 goto out;
William Lallemand5fd3b282020-01-16 15:32:08 +01001813 prs = prs->next;
1814 }
1815
Olivier Houchardf886e342017-04-05 22:24:59 +02001816 if (i % MAX_SEND_FD) {
1817 iov.iov_len = curoff;
1818 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1819 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1820 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001821 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001822 goto out;
1823 }
1824 }
1825
1826out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001827 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001828 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001829 goto out;
1830 }
1831 appctx->st0 = CLI_ST_END;
1832 free(cmsgbuf);
1833 free(tmpbuf);
1834 return 1;
1835}
1836
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001837static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1838{
1839 if (*args[0] == 'h')
1840 /* help */
1841 cli_gen_usage_msg(appctx);
1842 else if (*args[0] == 'p')
1843 /* prompt */
1844 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1845 else if (*args[0] == 'q')
1846 /* quit */
1847 appctx->st0 = CLI_ST_END;
1848
1849 return 1;
1850}
Olivier Houchardf886e342017-04-05 22:24:59 +02001851
William Lallemand2f4ce202018-10-26 14:47:47 +02001852void pcli_write_prompt(struct stream *s)
1853{
1854 struct buffer *msg = get_trash_chunk();
1855 struct channel *oc = si_oc(&s->si[0]);
1856
William Lallemanddc12c2e2018-12-13 09:05:46 +01001857 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001858 return;
1859
William Lallemanddc12c2e2018-12-13 09:05:46 +01001860 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001861 chunk_appendf(msg, "+ ");
1862 } else {
1863 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001864 chunk_appendf(msg, "master%s> ",
1865 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001866 else
1867 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1868 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001869 co_inject(oc, msg->area, msg->data);
1870}
1871
William Lallemand291810d2018-10-26 14:47:38 +02001872
William Lallemandcf62f7e2018-10-26 14:47:40 +02001873/* The pcli_* functions are used for the CLI proxy in the master */
1874
William Lallemanddeeaa592018-10-26 14:47:48 +02001875void pcli_reply_and_close(struct stream *s, const char *msg)
1876{
1877 struct buffer *buf = get_trash_chunk();
1878
1879 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001880 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001881}
1882
William Lallemand291810d2018-10-26 14:47:38 +02001883static enum obj_type *pcli_pid_to_server(int proc_pid)
1884{
1885 struct mworker_proc *child;
1886
William Lallemandbddd33a2018-12-11 16:10:53 +01001887 /* return the CLI applet of the master */
1888 if (proc_pid == 0)
1889 return &cli_applet.obj_type;
1890
William Lallemand291810d2018-10-26 14:47:38 +02001891 list_for_each_entry(child, &proc_list, list) {
1892 if (child->pid == proc_pid){
1893 return &child->srv->obj_type;
1894 }
1895 }
1896 return NULL;
1897}
1898
1899/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1900 * Return:
1901 * 0: master
1902 * > 0: pid of a worker
1903 * < 0: didn't find a worker
1904 */
1905static int pcli_prefix_to_pid(const char *prefix)
1906{
1907 int proc_pid;
1908 struct mworker_proc *child;
1909 char *errtol = NULL;
1910
1911 if (*prefix != '@') /* not a prefix, should not happen */
1912 return -1;
1913
1914 prefix++;
1915 if (!*prefix) /* sent @ alone, return the master */
1916 return 0;
1917
1918 if (strcmp("master", prefix) == 0) {
1919 return 0;
1920 } else if (*prefix == '!') {
1921 prefix++;
1922 if (!*prefix)
1923 return -1;
1924
1925 proc_pid = strtol(prefix, &errtol, 10);
1926 if (*errtol != '\0')
1927 return -1;
1928 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001929 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001930 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001931 if (child->pid == proc_pid){
1932 return child->pid;
1933 }
1934 }
1935 } else {
1936 struct mworker_proc *chosen = NULL;
1937 /* this is a relative pid */
1938
1939 proc_pid = strtol(prefix, &errtol, 10);
1940 if (*errtol != '\0')
1941 return -1;
1942
1943 if (proc_pid == 0) /* return the master */
1944 return 0;
1945
1946 /* chose the right process, the current one is the one with the
1947 least number of reloads */
1948 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001949 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001950 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001951 if (child->relative_pid == proc_pid){
1952 if (child->reloads == 0)
1953 return child->pid;
1954 else if (chosen == NULL || child->reloads < chosen->reloads)
1955 chosen = child;
1956 }
1957 }
1958 if (chosen)
1959 return chosen->pid;
1960 }
1961 return -1;
1962}
1963
William Lallemandbddd33a2018-12-11 16:10:53 +01001964/* Return::
1965 * >= 0 : number of words to escape
1966 * = -1 : error
1967 */
1968
1969int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1970{
1971 if (argl < 1)
1972 return 0;
1973
1974 /* there is a prefix */
1975 if (args[0][0] == '@') {
1976 int target_pid = pcli_prefix_to_pid(args[0]);
1977
1978 if (target_pid == -1) {
1979 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1980 return -1;
1981 }
1982
1983 /* if the prefix is alone, define a default target */
1984 if (argl == 1)
1985 s->pcli_next_pid = target_pid;
1986 else
1987 *next_pid = target_pid;
1988 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001989 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001990 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001991 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001992
1993 } else if (!strcmp("quit", args[0])) {
1994 channel_shutr_now(&s->req);
1995 channel_shutw_now(&s->res);
1996 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001997 } else if (!strcmp(args[0], "operator")) {
1998 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1999 memprintf(errmsg, "Permission denied!\n");
2000 return -1;
2001 }
2002 s->pcli_flags &= ~ACCESS_LVL_MASK;
2003 s->pcli_flags |= ACCESS_LVL_OPER;
2004 return argl;
2005
2006 } else if (!strcmp(args[0], "user")) {
2007 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2008 memprintf(errmsg, "Permission denied!\n");
2009 return -1;
2010 }
2011 s->pcli_flags &= ~ACCESS_LVL_MASK;
2012 s->pcli_flags |= ACCESS_LVL_USER;
2013 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002014 }
2015
2016 return 0;
2017}
2018
2019/*
2020 * Parse the CLI request:
2021 * - It does basically the same as the cli_io_handler, but as a proxy
2022 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002023 *
2024 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002025 * - the number of characters to forward or
2026 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002027 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002028int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002029{
William Lallemandbddd33a2018-12-11 16:10:53 +01002030 char *str = (char *)ci_head(req);
2031 char *end = (char *)ci_stop(req);
2032 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2033 int argl; /* number of args */
2034 char *p;
2035 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002036 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002037 int wtrim = 0; /* number of words to trim */
2038 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002039 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002040 int i = 0;
2041
2042 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002043
William Lallemanddc12c2e2018-12-13 09:05:46 +01002044 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002045
2046 /* Looks for the end of one command */
2047 while (p+reql < end) {
2048 /* handle escaping */
2049 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002050 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002051 continue;
2052 }
2053 if (p[reql] == ';' || p[reql] == '\n') {
2054 /* found the end of the command */
2055 p[reql] = '\n';
2056 reql++;
2057 break;
2058 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002059 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002060 }
William Lallemandebf61802018-12-11 16:10:57 +01002061 } else {
2062 while (p+reql < end) {
2063 if (p[reql] == '\n') {
2064 /* found the end of the line */
2065 reql++;
2066 break;
2067 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002068 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002069 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002070 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002071
William Lallemandbddd33a2018-12-11 16:10:53 +01002072 /* set end to first byte after the end of the command */
2073 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002074
William Lallemandbddd33a2018-12-11 16:10:53 +01002075 /* there is no end to this command, need more to parse ! */
2076 if (*(end-1) != '\n') {
2077 return -1;
2078 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002079
William Lallemand3301f3e2018-12-13 09:05:48 +01002080 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2081 if (reql == 1) /* last line of the payload */
2082 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002083 return reql;
2084 }
2085
William Lallemandbddd33a2018-12-11 16:10:53 +01002086 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002087
William Lallemandbddd33a2018-12-11 16:10:53 +01002088 /* splits the command in words */
2089 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002090 /* skip leading spaces/tabs */
2091 p += strspn(p, " \t");
2092 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002093 break;
2094
William Lallemandbddd33a2018-12-11 16:10:53 +01002095 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002096 while (1) {
2097 p += strcspn(p, " \t\\");
2098 /* escaped chars using backlashes (\) */
2099 if (*p == '\\') {
2100 if (!*++p)
2101 break;
2102 if (!*++p)
2103 break;
2104 } else {
2105 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002106 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002107 }
William Lallemandfe249c32020-06-18 18:03:57 +02002108 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002109 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002110 }
2111
William Lallemandbddd33a2018-12-11 16:10:53 +01002112 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002113
William Lallemandbddd33a2018-12-11 16:10:53 +01002114 for (; i < MAX_STATS_ARGS + 1; i++)
2115 args[i] = NULL;
2116
2117 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2118
2119 /* End of words are ending by \0, we need to replace the \0s by spaces
21201 before forwarding them */
2121 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002122 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002123 if (*p == '\0')
2124 *p = ' ';
2125 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002126 }
2127
William Lallemand3301f3e2018-12-13 09:05:48 +01002128 payload = strstr(str, PAYLOAD_PATTERN);
2129 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2130 /* if the payload pattern is at the end */
2131 s->pcli_flags |= PCLI_F_PAYLOAD;
2132 ret = reql;
2133 }
2134
William Lallemandbddd33a2018-12-11 16:10:53 +01002135 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002136
William Lallemandbddd33a2018-12-11 16:10:53 +01002137 if (wtrim > 0) {
2138 trim = &args[wtrim][0];
2139 if (trim == NULL) /* if this was the last word in the table */
2140 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002141
William Lallemandbddd33a2018-12-11 16:10:53 +01002142 b_del(&req->buf, trim - str);
2143
William Lallemandb7ea1412018-12-13 09:05:47 +01002144 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002145 } else if (wtrim < 0) {
2146 /* parsing error */
2147 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002148 } else {
2149 /* the whole string */
2150 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002151 }
2152
William Lallemandb7ea1412018-12-13 09:05:47 +01002153 if (ret > 1) {
2154 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2155 goto end;
2156 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002157 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2158 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002159 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002160 ci_insert_line2(req, 0, "user -", strlen("user -"));
2161 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002162 }
2163 }
2164end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002165
William Lallemandb7ea1412018-12-13 09:05:47 +01002166 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002167}
2168
2169int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2170{
William Lallemandbddd33a2018-12-11 16:10:53 +01002171 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002172 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002173 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002174
William Lallemandb7ea1412018-12-13 09:05:47 +01002175 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2176 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2177
William Lallemandcf62f7e2018-10-26 14:47:40 +02002178read_again:
2179 /* if the channel is closed for read, we won't receive any more data
2180 from the client, but we don't want to forward this close to the
2181 server */
2182 channel_dont_close(req);
2183
2184 /* We don't know yet to which server we will connect */
2185 channel_dont_connect(req);
2186
2187
2188 /* we are not waiting for a response, there is no more request and we
2189 * receive a close from the client, we can leave */
2190 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2191 channel_shutw_now(&s->res);
2192 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2193 return 1;
2194 }
2195
2196 req->flags |= CF_READ_DONTWAIT;
2197
2198 /* need more data */
2199 if (!ci_data(req))
2200 return 0;
2201
2202 /* If there is data available for analysis, log the end of the idle time. */
2203 if (c_data(req) && s->logs.t_idle == -1)
2204 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2205
William Lallemandbddd33a2018-12-11 16:10:53 +01002206 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002207 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002208 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002209 /* enough data */
2210
William Lallemandcf62f7e2018-10-26 14:47:40 +02002211 /* forward only 1 command */
2212 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002213
William Lallemanddc12c2e2018-12-13 09:05:46 +01002214 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002215 /* we send only 1 command per request, and we write close after it */
2216 channel_shutw_now(req);
2217 } else {
2218 pcli_write_prompt(s);
2219 }
2220
2221 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002222
2223 /* remove the XFER_DATA analysers, which forwards all
2224 * the data, we don't want to forward the next requests
2225 * We need to add CF_FLT_ANALYZE to abort the forward too.
2226 */
2227 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2228 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2229 s->res.analysers |= AN_RES_WAIT_CLI;
2230
William Lallemandebf61802018-12-11 16:10:57 +01002231 if (!(s->flags & SF_ASSIGNED)) {
2232 if (next_pid > -1)
2233 target_pid = next_pid;
2234 else
2235 target_pid = s->pcli_next_pid;
2236 /* we can connect now */
2237 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002238
William Lallemandebf61802018-12-11 16:10:57 +01002239 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2240 channel_auto_connect(req);
2241 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002242
2243 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002244 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002245 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002246 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002247 } else if (to_forward == -1 && errmsg) {
2248 /* there was an error during the parsing */
2249 pcli_reply_and_close(s, errmsg);
2250 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002251 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2252 /* buffer is full and we didn't catch the end of a command */
2253 goto send_help;
2254 }
2255
2256 return 0;
2257
2258send_help:
2259 b_reset(&req->buf);
2260 b_putblk(&req->buf, "help\n", 5);
2261 goto read_again;
2262}
2263
2264int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2265{
2266 struct proxy *fe = strm_fe(s);
2267 struct proxy *be = s->be;
2268
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002269 if (rep->flags & CF_READ_ERROR) {
2270 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2271 s->res.analysers &= ~AN_RES_WAIT_CLI;
2272 return 0;
2273 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002274 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2275 rep->flags |= CF_NEVER_WAIT;
2276
2277 /* don't forward the close */
2278 channel_dont_close(&s->res);
2279 channel_dont_close(&s->req);
2280
William Lallemanddc12c2e2018-12-13 09:05:46 +01002281 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002282 s->req.analysers |= AN_REQ_WAIT_CLI;
2283 s->res.analysers &= ~AN_RES_WAIT_CLI;
2284 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2285 return 0;
2286 }
2287
William Lallemandcf62f7e2018-10-26 14:47:40 +02002288 /* forward the data */
2289 if (ci_data(rep)) {
2290 c_adv(rep, ci_data(rep));
2291 return 0;
2292 }
2293
2294 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2295 /* stream cleanup */
2296
William Lallemand2f4ce202018-10-26 14:47:47 +02002297 pcli_write_prompt(s);
2298
William Lallemandcf62f7e2018-10-26 14:47:40 +02002299 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2300 si_shutr(&s->si[1]);
2301 si_shutw(&s->si[1]);
2302
2303 /*
2304 * starting from there this the same code as
2305 * http_end_txn_clean_session().
2306 *
2307 * It allows to do frontend keepalive while reconnecting to a
2308 * new server for each request.
2309 */
2310
2311 if (s->flags & SF_BE_ASSIGNED) {
2312 HA_ATOMIC_SUB(&be->beconn, 1);
2313 if (unlikely(s->srv_conn))
2314 sess_change_server(s, NULL);
2315 }
2316
2317 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2318 stream_process_counters(s);
2319
2320 /* don't count other requests' data */
2321 s->logs.bytes_in -= ci_data(&s->req);
2322 s->logs.bytes_out -= ci_data(&s->res);
2323
2324 /* we may need to know the position in the queue */
2325 pendconn_free(s);
2326
2327 /* let's do a final log if we need it */
2328 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2329 !(s->flags & SF_MONITOR) &&
2330 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2331 s->do_log(s);
2332 }
2333
2334 /* stop tracking content-based counters */
2335 stream_stop_content_counters(s);
2336 stream_update_time_stats(s);
2337
2338 s->logs.accept_date = date; /* user-visible date for logging */
2339 s->logs.tv_accept = now; /* corrected date for internal use */
2340 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2341 s->logs.t_idle = -1;
2342 tv_zero(&s->logs.tv_request);
2343 s->logs.t_queue = -1;
2344 s->logs.t_connect = -1;
2345 s->logs.t_data = -1;
2346 s->logs.t_close = 0;
2347 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2348 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2349
2350 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2351 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2352
2353 stream_del_srv_conn(s);
2354 if (objt_server(s->target)) {
2355 if (s->flags & SF_CURR_SESS) {
2356 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002357 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002358 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002359 if (may_dequeue_tasks(__objt_server(s->target), be))
2360 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002361 }
2362
2363 s->target = NULL;
2364
2365 /* only release our endpoint if we don't intend to reuse the
2366 * connection.
2367 */
2368 if (!si_conn_ready(&s->si[1])) {
2369 si_release_endpoint(&s->si[1]);
2370 s->srv_conn = NULL;
2371 }
2372
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002373 sockaddr_free(&s->target_addr);
2374
William Lallemandcf62f7e2018-10-26 14:47:40 +02002375 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2376 s->si[1].err_type = SI_ET_NONE;
2377 s->si[1].conn_retries = 0; /* used for logging too */
2378 s->si[1].exp = TICK_ETERNITY;
2379 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 +02002380 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 +02002381 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 +02002382 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2383 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2384 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2385 /* reinitialise the current rule list pointer to NULL. We are sure that
2386 * any rulelist match the NULL pointer.
2387 */
2388 s->current_rule_list = NULL;
2389
2390 s->be = strm_fe(s);
2391 s->logs.logwait = strm_fe(s)->to_log;
2392 s->logs.level = 0;
2393 stream_del_srv_conn(s);
2394 s->target = NULL;
2395 /* re-init store persistence */
2396 s->store_count = 0;
2397 s->uniq_id = global.req_count++;
2398
2399 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2400
2401 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2402
2403 s->req.analysers |= AN_REQ_WAIT_CLI;
2404 s->res.analysers &= ~AN_RES_WAIT_CLI;
2405
2406 /* We must trim any excess data from the response buffer, because we
2407 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002408 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002409 * we want those data to come along with next response. A typical
2410 * example of such data would be from a buggy server responding to
2411 * a HEAD with some data, or sending more than the advertised
2412 * content-length.
2413 */
2414 if (unlikely(ci_data(&s->res)))
2415 b_set_data(&s->res.buf, co_data(&s->res));
2416
2417 /* Now we can realign the response buffer */
2418 c_realign_if_empty(&s->res);
2419
2420 s->req.rto = strm_fe(s)->timeout.client;
2421 s->req.wto = TICK_ETERNITY;
2422
2423 s->res.rto = TICK_ETERNITY;
2424 s->res.wto = strm_fe(s)->timeout.client;
2425
2426 s->req.rex = TICK_ETERNITY;
2427 s->req.wex = TICK_ETERNITY;
2428 s->req.analyse_exp = TICK_ETERNITY;
2429 s->res.rex = TICK_ETERNITY;
2430 s->res.wex = TICK_ETERNITY;
2431 s->res.analyse_exp = TICK_ETERNITY;
2432 s->si[1].hcto = TICK_ETERNITY;
2433
2434 /* we're removing the analysers, we MUST re-enable events detection.
2435 * We don't enable close on the response channel since it's either
2436 * already closed, or in keep-alive with an idle connection handler.
2437 */
2438 channel_auto_read(&s->req);
2439 channel_auto_close(&s->req);
2440 channel_auto_read(&s->res);
2441
2442
2443 return 1;
2444 }
2445 return 0;
2446}
2447
William Lallemand8a022572018-10-26 14:47:35 +02002448/*
2449 * The mworker functions are used to initialize the CLI in the master process
2450 */
2451
William Lallemand309dc9a2018-10-26 14:47:45 +02002452 /*
2453 * Stop the mworker proxy
2454 */
2455void mworker_cli_proxy_stop()
2456{
William Lallemand550db6d2018-11-06 17:37:12 +01002457 if (mworker_proxy)
2458 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002459}
2460
William Lallemand8a022572018-10-26 14:47:35 +02002461/*
2462 * Create the mworker CLI proxy
2463 */
2464int mworker_cli_proxy_create()
2465{
2466 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002467 char *msg = NULL;
2468 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002469
2470 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2471 if (!mworker_proxy)
2472 return -1;
2473
2474 init_new_proxy(mworker_proxy);
2475 mworker_proxy->next = proxies_list;
2476 proxies_list = mworker_proxy;
2477 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002478 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002479 mworker_proxy->state = PR_STNEW;
2480 mworker_proxy->last_change = now.tv_sec;
2481 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2482 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2483 mworker_proxy->timeout.client = 0; /* no timeout */
2484 mworker_proxy->conf.file = strdup("MASTER");
2485 mworker_proxy->conf.line = 0;
2486 mworker_proxy->accept = frontend_accept;
2487 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2488
2489 /* Does not init the default target the CLI applet, but must be done in
2490 * the request parsing code */
2491 mworker_proxy->default_target = NULL;
2492
2493 /* the check_config_validity() will get an ID for the proxy */
2494 mworker_proxy->uuid = -1;
2495
2496 proxy_store_name(mworker_proxy);
2497
2498 /* create all servers using the mworker_proc list */
2499 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002500 struct server *newsrv = NULL;
2501 struct sockaddr_storage *sk;
2502 int port1, port2, port;
2503 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002504
William Lallemanda31b09e2020-01-14 15:25:02 +01002505 /* only the workers support the master CLI */
2506 if (!(child->options & PROC_O_TYPE_WORKER))
2507 continue;
2508
William Lallemand8a022572018-10-26 14:47:35 +02002509 newsrv = new_server(mworker_proxy);
2510 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002511 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002512
2513 /* we don't know the new pid yet */
2514 if (child->pid == -1)
2515 memprintf(&msg, "cur-%d", child->relative_pid);
2516 else
2517 memprintf(&msg, "old-%d", child->pid);
2518
2519 newsrv->next = mworker_proxy->srv;
2520 mworker_proxy->srv = newsrv;
2521 newsrv->conf.file = strdup(msg);
2522 newsrv->id = strdup(msg);
2523 newsrv->conf.line = 0;
2524
2525 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002526 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002527 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002528 }
2529 free(msg);
2530 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002531
2532 proto = protocol_by_family(sk->ss_family);
2533 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002534 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002535 }
2536
2537 /* no port specified */
2538 newsrv->flags |= SRV_F_MAPPORTS;
2539 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002540 /* don't let the server participate to load balancing */
2541 newsrv->iweight = 0;
2542 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002543 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002544
2545 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002546 }
2547 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002548
2549error:
2550 ha_alert("%s\n", errmsg);
2551
2552 list_for_each_entry(child, &proc_list, list) {
2553 free((char *)child->srv->conf.file); /* cast because of const char * */
2554 free(child->srv->id);
2555 free(child->srv);
2556 child->srv = NULL;
2557 }
2558 free(mworker_proxy->id);
2559 free(mworker_proxy->conf.file);
2560 free(mworker_proxy);
2561 mworker_proxy = NULL;
2562 free(errmsg);
2563 free(msg);
2564
2565 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002566}
Olivier Houchardf886e342017-04-05 22:24:59 +02002567
William Lallemandce83b4a2018-10-26 14:47:30 +02002568/*
William Lallemande7361152018-10-26 14:47:36 +02002569 * Create a new listener for the master CLI proxy
2570 */
2571int mworker_cli_proxy_new_listener(char *line)
2572{
2573 struct bind_conf *bind_conf;
2574 struct listener *l;
2575 char *err = NULL;
2576 char *args[MAX_LINE_ARGS + 1];
2577 int arg;
2578 int cur_arg;
2579
William Lallemand2e945c82019-11-25 09:58:37 +01002580 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002581 args[0] = line;
2582
2583 /* args is a bind configuration with spaces replaced by commas */
2584 while (*line && arg < MAX_LINE_ARGS) {
2585
2586 if (*line == ',') {
2587 *line++ = '\0';
2588 while (*line == ',')
2589 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002590 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002591 }
2592 line++;
2593 }
2594
William Lallemand2e945c82019-11-25 09:58:37 +01002595 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002596
2597 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002598 if (!bind_conf)
2599 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002600
2601 bind_conf->level &= ~ACCESS_LVL_MASK;
2602 bind_conf->level |= ACCESS_LVL_ADMIN;
2603
2604 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2605 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002606 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002607 }
2608
2609 cur_arg = 1;
2610
2611 while (*args[cur_arg]) {
2612 static int bind_dumped;
2613 struct bind_kw *kw;
2614
2615 kw = bind_find_kw(args[cur_arg]);
2616 if (kw) {
2617 if (!kw->parse) {
2618 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2619 args[0], args[1], args[cur_arg]);
2620 goto err;
2621 }
2622
2623 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2624 if (err)
2625 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2626 else
2627 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2628 args[0], args[1], args[cur_arg]);
2629 goto err;
2630 }
2631
2632 cur_arg += 1 + kw->skip;
2633 continue;
2634 }
2635
2636 if (!bind_dumped) {
2637 bind_dump_kws(&err);
2638 indent_msg(&err, 4);
2639 bind_dumped = 1;
2640 }
2641
2642 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2643 args[0], args[1], args[cur_arg],
2644 err ? " Registered keywords :" : "", err ? err : "");
2645 goto err;
2646 }
2647
2648
2649 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002650 l->accept = session_accept_fd;
2651 l->default_target = mworker_proxy->default_target;
2652 /* don't make the peers subject to global limits and don't close it in the master */
2653 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2654 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002655 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002656 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002657 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002658
2659 return 0;
2660
2661err:
2662 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002663 free(err);
2664 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002665 return -1;
2666
2667}
2668
2669/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002670 * Create a new CLI socket using a socketpair for a worker process
2671 * <mworker_proc> is the process structure, and <proc> is the process number
2672 */
2673int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2674{
2675 struct bind_conf *bind_conf;
2676 struct listener *l;
2677 char *path = NULL;
2678 char *err = NULL;
2679
2680 /* master pipe to ensure the master is still alive */
2681 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2682 ha_alert("Cannot create worker socketpair.\n");
2683 return -1;
2684 }
2685
2686 /* XXX: we might want to use a separate frontend at some point */
2687 if (!global.stats_fe) {
2688 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2689 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002690 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002691 }
2692 }
2693
2694 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002695 if (!bind_conf)
2696 goto error;
2697
William Lallemandce83b4a2018-10-26 14:47:30 +02002698 bind_conf->level &= ~ACCESS_LVL_MASK;
2699 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2700
2701 bind_conf->bind_proc = 1UL << proc;
2702 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2703
2704 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2705 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002706 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002707 }
2708
2709 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002710 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002711 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002712 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002713 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002714 free(path);
2715 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002716
2717 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002718 l->accept = session_accept_fd;
2719 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002720 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002721 /* it's a sockpair but we don't want to keep the fd in the master */
2722 l->options &= ~LI_O_INHERITED;
2723 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002724 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002725 }
2726
2727 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002728
2729error:
2730 close(mworker_proc->ipc_fd[0]);
2731 close(mworker_proc->ipc_fd[1]);
2732 free(err);
2733
2734 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002735}
2736
William Lallemand74c24fb2016-11-21 17:18:36 +01002737static struct applet cli_applet = {
2738 .obj_type = OBJ_TYPE_APPLET,
2739 .name = "<CLI>", /* used for logging */
2740 .fct = cli_io_handler,
2741 .release = cli_release_handler,
2742};
2743
Willy Tarreau0a739292016-11-22 20:21:23 +01002744/* register cli keywords */
2745static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002746 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2747 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2748 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002749 { { "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 +01002750 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002751 { { "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 +01002752 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002753 { { "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 +02002754 { { "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 +01002755 { { "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 +02002756 { { "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 +01002757 { { "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 +01002758 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2759 { { "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 +02002760 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002761 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002762 {{},}
2763}};
2764
Willy Tarreau0108d902018-11-25 19:14:37 +01002765INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2766
William Lallemand74c24fb2016-11-21 17:18:36 +01002767static struct cfg_kw_list cfg_kws = {ILH, {
2768 { CFG_GLOBAL, "stats", stats_parse_global },
2769 { 0, NULL, NULL },
2770}};
2771
Willy Tarreau0108d902018-11-25 19:14:37 +01002772INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2773
William Lallemand74c24fb2016-11-21 17:18:36 +01002774static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002775 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2776 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002777 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002778 { NULL, NULL, 0 },
2779}};
2780
Willy Tarreau0108d902018-11-25 19:14:37 +01002781INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002782
2783/*
2784 * Local variables:
2785 * c-indent-level: 8
2786 * c-basic-offset: 8
2787 * End:
2788 */