blob: f4478ff16349ac983d35b97d376000418f7b2f23 [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
William Lallemand74c24fb2016-11-21 17:18:36 +010029#include <common/cfgparse.h>
30#include <common/compat.h>
31#include <common/config.h>
32#include <common/debug.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010033#include <common/initcall.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010034#include <common/memory.h>
35#include <common/mini-clist.h>
36#include <common/standard.h>
37#include <common/ticks.h>
38#include <common/time.h>
39#include <common/uri_auth.h>
40#include <common/version.h>
41#include <common/base64.h>
42
43#include <types/applet.h>
William Lallemand9ed62032016-11-21 17:49:11 +010044#include <types/cli.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010045#include <types/global.h>
46#include <types/dns.h>
William Lallemand9ed62032016-11-21 17:49:11 +010047#include <types/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010048
Willy Tarreau609aad92018-11-22 08:31:09 +010049#include <proto/activity.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010050#include <proto/backend.h>
51#include <proto/channel.h>
52#include <proto/checks.h>
53#include <proto/compression.h>
William Lallemand9ed62032016-11-21 17:49:11 +010054#include <proto/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010055#include <proto/fd.h>
56#include <proto/freq_ctr.h>
57#include <proto/frontend.h>
58#include <proto/log.h>
59#include <proto/pattern.h>
60#include <proto/pipe.h>
William Lallemandce83b4a2018-10-26 14:47:30 +020061#include <proto/protocol.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010062#include <proto/listener.h>
63#include <proto/map.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010064#include <proto/proxy.h>
65#include <proto/sample.h>
66#include <proto/session.h>
67#include <proto/stream.h>
68#include <proto/server.h>
Willy Tarreauc125cef2019-05-10 09:58:43 +020069#include <proto/ssl_sock.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010070#include <proto/stream_interface.h>
71#include <proto/task.h>
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +020072#include <proto/proto_udp.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010073
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020074#define PAYLOAD_PATTERN "<<"
75
William Lallemand74c24fb2016-11-21 17:18:36 +010076static struct applet cli_applet;
77
78static const char stats_sock_usage_msg[] =
79 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010080 " help : this message\n"
81 " prompt : toggle interactive mode with prompt\n"
82 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010083 "";
84
85static const char stats_permission_denied_msg[] =
86 "Permission denied\n"
87 "";
88
89
Christopher Faulet1bc04c72017-10-29 20:14:08 +010090static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010091
92/* List head of cli keywords */
93static struct cli_kw_list cli_keywords = {
94 .list = LIST_HEAD_INIT(cli_keywords.list)
95};
96
97extern const char *stat_status_codes[];
98
William Lallemand8a022572018-10-26 14:47:35 +020099static struct proxy *mworker_proxy; /* CLI proxy of the master */
100
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200101static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100102{
103 struct cli_kw_list *kw_list;
104 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200105 struct buffer *tmp = get_trash_chunk();
106 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100107
108 free(dynamic_usage_msg);
109 dynamic_usage_msg = NULL;
110
111 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200112 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100113
114 chunk_reset(tmp);
115 chunk_strcat(tmp, stats_sock_usage_msg);
116 list_for_each_entry(kw_list, &cli_keywords.list, list) {
117 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200118 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200119
120 /* in a worker or normal process, don't display master only commands */
121 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
122 goto next_kw;
123
124 /* in master don't displays if we don't have the master bits */
125 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
126 goto next_kw;
127
William Lallemand0154edc2018-05-15 11:50:04 +0200128 if (kw->usage)
129 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200130
131next_kw:
132
William Lallemand74c24fb2016-11-21 17:18:36 +0100133 kw++;
134 }
135 }
136 chunk_init(&out, NULL, 0);
137 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200138 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200139
140end:
141 if (dynamic_usage_msg) {
142 appctx->ctx.cli.severity = LOG_INFO;
143 appctx->ctx.cli.msg = dynamic_usage_msg;
144 }
145 else {
146 appctx->ctx.cli.severity = LOG_INFO;
147 appctx->ctx.cli.msg = stats_sock_usage_msg;
148 }
149 appctx->st0 = CLI_ST_PRINT;
150
William Lallemand74c24fb2016-11-21 17:18:36 +0100151 return dynamic_usage_msg;
152}
153
154struct cli_kw* cli_find_kw(char **args)
155{
156 struct cli_kw_list *kw_list;
157 struct cli_kw *kw;/* current cli_kw */
158 char **tmp_args;
159 const char **tmp_str_kw;
160 int found = 0;
161
162 if (LIST_ISEMPTY(&cli_keywords.list))
163 return NULL;
164
165 list_for_each_entry(kw_list, &cli_keywords.list, list) {
166 kw = &kw_list->kw[0];
167 while (*kw->str_kw) {
168 tmp_args = args;
169 tmp_str_kw = kw->str_kw;
170 while (*tmp_str_kw) {
171 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
172 found = 1;
173 } else {
174 found = 0;
175 break;
176 }
177 tmp_args++;
178 tmp_str_kw++;
179 }
180 if (found)
181 return (kw);
182 kw++;
183 }
184 }
185 return NULL;
186}
187
188void cli_register_kw(struct cli_kw_list *kw_list)
189{
190 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
191}
192
193
194/* allocate a new stats frontend named <name>, and return it
195 * (or NULL in case of lack of memory).
196 */
197static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
198{
199 struct proxy *fe;
200
201 fe = calloc(1, sizeof(*fe));
202 if (!fe)
203 return NULL;
204
205 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100206 fe->next = proxies_list;
207 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100208 fe->last_change = now.tv_sec;
209 fe->id = strdup("GLOBAL");
210 fe->cap = PR_CAP_FE;
211 fe->maxconn = 10; /* default to 10 concurrent connections */
212 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
213 fe->conf.file = strdup(file);
214 fe->conf.line = line;
215 fe->accept = frontend_accept;
216 fe->default_target = &cli_applet.obj_type;
217
218 /* the stats frontend is the only one able to assign ID #0 */
219 fe->conf.id.key = fe->uuid = 0;
220 eb32_insert(&used_proxy_id, &fe->conf.id);
221 return fe;
222}
223
224/* This function parses a "stats" statement in the "global" section. It returns
225 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
226 * error message into the <err> buffer which will be preallocated. The trailing
227 * '\n' must not be written. The function must be called with <args> pointing to
228 * the first word after "stats".
229 */
230static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
231 struct proxy *defpx, const char *file, int line,
232 char **err)
233{
234 struct bind_conf *bind_conf;
235 struct listener *l;
236
237 if (!strcmp(args[1], "socket")) {
238 int cur_arg;
239
240 if (*args[2] == 0) {
241 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
242 return -1;
243 }
244
245 if (!global.stats_fe) {
246 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
247 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
248 return -1;
249 }
250 }
251
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100252 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200253 bind_conf->level &= ~ACCESS_LVL_MASK;
254 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100255
256 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
257 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
258 file, line, args[0], args[1], err && *err ? *err : "error");
259 return -1;
260 }
261
262 cur_arg = 3;
263 while (*args[cur_arg]) {
264 static int bind_dumped;
265 struct bind_kw *kw;
266
267 kw = bind_find_kw(args[cur_arg]);
268 if (kw) {
269 if (!kw->parse) {
270 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
271 args[0], args[1], args[cur_arg]);
272 return -1;
273 }
274
275 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
276 if (err && *err)
277 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
278 else
279 memprintf(err, "'%s %s' : error encountered while processing '%s'",
280 args[0], args[1], args[cur_arg]);
281 return -1;
282 }
283
284 cur_arg += 1 + kw->skip;
285 continue;
286 }
287
288 if (!bind_dumped) {
289 bind_dump_kws(err);
290 indent_msg(err, 4);
291 bind_dumped = 1;
292 }
293
294 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
295 args[0], args[1], args[cur_arg],
296 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
297 return -1;
298 }
299
300 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100301 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100302 l->default_target = global.stats_fe->default_target;
303 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
304 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100305 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100306 }
307 }
308 else if (!strcmp(args[1], "timeout")) {
309 unsigned timeout;
310 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
311
Willy Tarreau9faebe32019-06-07 19:00:37 +0200312 if (res == PARSE_TIME_OVER) {
313 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
314 args[2], args[0], args[1]);
315 return -1;
316 }
317 else if (res == PARSE_TIME_UNDER) {
318 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
319 args[2], args[0], args[1]);
320 return -1;
321 }
322 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100323 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
324 return -1;
325 }
326
327 if (!timeout) {
328 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
329 return -1;
330 }
331 if (!global.stats_fe) {
332 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
333 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
334 return -1;
335 }
336 }
337 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
338 }
339 else if (!strcmp(args[1], "maxconn")) {
340 int maxconn = atol(args[2]);
341
342 if (maxconn <= 0) {
343 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
344 return -1;
345 }
346
347 if (!global.stats_fe) {
348 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
349 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
350 return -1;
351 }
352 }
353 global.stats_fe->maxconn = maxconn;
354 }
355 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
356 int cur_arg = 2;
357 unsigned long set = 0;
358
359 if (!global.stats_fe) {
360 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
361 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
362 return -1;
363 }
364 }
365
366 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100367 if (strcmp(args[cur_arg], "all") == 0) {
368 set = 0;
369 break;
370 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100371 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100372 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100373 return -1;
374 }
375 cur_arg++;
376 }
377 global.stats_fe->bind_proc = set;
378 }
379 else {
380 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
381 return -1;
382 }
383 return 0;
384}
385
William Lallemand33d29e22019-04-01 11:30:06 +0200386/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200387 * This function exports the bound addresses of a <frontend> in the environment
388 * variable <varname>. Those addresses are separated by semicolons and prefixed
389 * with their type (abns@, unix@, sockpair@ etc)
390 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200391 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200392int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200393{
394 struct buffer *trash = get_trash_chunk();
395 struct bind_conf *bind_conf;
396
William Lallemand9a37fd02019-04-12 16:09:24 +0200397 if (frontend) {
398 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200399 struct listener *l;
400
401 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
402 char addr[46];
403 char port[6];
404
William Lallemand620072b2019-04-12 16:09:25 +0200405 /* separate listener by semicolons */
406 if (trash->data)
407 chunk_appendf(trash, ";");
408
William Lallemand33d29e22019-04-01 11:30:06 +0200409 if (l->addr.ss_family == AF_UNIX) {
410 const struct sockaddr_un *un;
411
412 un = (struct sockaddr_un *)&l->addr;
413 if (un->sun_path[0] == '\0') {
414 chunk_appendf(trash, "abns@%s", un->sun_path+1);
415 } else {
416 chunk_appendf(trash, "unix@%s", un->sun_path);
417 }
418 } else if (l->addr.ss_family == AF_INET) {
419 addr_to_str(&l->addr, addr, sizeof(addr));
420 port_to_str(&l->addr, port, sizeof(port));
421 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
422 } else if (l->addr.ss_family == AF_INET6) {
423 addr_to_str(&l->addr, addr, sizeof(addr));
424 port_to_str(&l->addr, port, sizeof(port));
425 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
426 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
427 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
428 }
William Lallemand33d29e22019-04-01 11:30:06 +0200429 }
430 }
431 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200432 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200433 return -1;
434 }
435
436 return 0;
437}
438
William Lallemand9a37fd02019-04-12 16:09:24 +0200439int cli_socket_setenv()
440{
441 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
442 return -1;
443 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
444 return -1;
445
446 return 0;
447}
448
William Lallemand33d29e22019-04-01 11:30:06 +0200449REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
450
Willy Tarreaude57a572016-11-23 17:01:39 +0100451/* Verifies that the CLI at least has a level at least as high as <level>
452 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
453 * failure, an error message is prepared and the appctx's state is adjusted
454 * to print it so that a return 1 is enough to abort any processing.
455 */
456int cli_has_level(struct appctx *appctx, int level)
457{
Willy Tarreaude57a572016-11-23 17:01:39 +0100458
William Lallemandf630d012018-12-13 09:05:44 +0100459 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200460 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100461 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100462 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100463 return 0;
464 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100465 return 1;
466}
467
William Lallemandb7ea1412018-12-13 09:05:47 +0100468/* same as cli_has_level but for the CLI proxy and without error message */
469int pcli_has_level(struct stream *s, int level)
470{
471 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
472 return 0;
473 }
474 return 1;
475}
476
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200477/* Returns severity_output for the current session if set, or default for the socket */
478static int cli_get_severity_output(struct appctx *appctx)
479{
480 if (appctx->cli_severity_output)
481 return appctx->cli_severity_output;
482 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
483}
William Lallemand74c24fb2016-11-21 17:18:36 +0100484
Willy Tarreau41908562016-11-24 16:23:38 +0100485/* Processes the CLI interpreter on the stats socket. This function is called
486 * from the CLI's IO handler running in an appctx context. The function returns 1
487 * if the request was understood, otherwise zero. It is called with appctx->st0
488 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
489 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
490 * have its own I/O handler called again. Most of the time, parsers will only
491 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100492 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
493 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100494 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200495static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100496{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200497 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
498 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100499 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100500
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200501 appctx->st2 = 0;
502 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100503
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200504 p = appctx->chunk->area;
505 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100506
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200507 /*
508 * Get the payload start if there is one.
509 * For the sake of simplicity, the payload pattern is looked up
510 * everywhere from the start of the input but it can only be found
511 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
512 *
513 * The input string was zero terminated so it is safe to use
514 * the str*() functions throughout the parsing
515 */
516 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
517 payload = strstr(p, PAYLOAD_PATTERN);
518 end = payload;
519 /* skip the pattern */
520 payload += strlen(PAYLOAD_PATTERN);
521 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100522
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200523 /*
524 * Get pointers on words.
525 * One extra slot is reserved to store a pointer on a null byte.
526 */
527 while (i < MAX_STATS_ARGS && p < end) {
528 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100529
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200530 /* skip leading spaces/tabs */
531 p += strspn(p, " \t");
532 if (!*p)
533 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100534
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200535 args[i] = p;
Yves Lafon7ed43aa2020-06-08 16:08:06 +0200536 while (1) {
537 p += strcspn(p, " \t\\");
538 /* escaped chars using backlashes (\) */
539 if (*p == '\\') {
540 if (!*++p)
541 break;
542 if (!*++p)
543 break;
544 } else {
545 break;
546 }
547 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200548 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100549
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200550 /* unescape backslashes (\) */
551 for (j = 0, k = 0; args[i][k]; k++) {
552 if (args[i][k] == '\\') {
553 if (args[i][k + 1] == '\\')
554 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100555 else
556 continue;
557 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200558 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100559 j++;
560 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200561 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100562
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200563 i++;
564 }
565 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200566 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200567 for (; i < MAX_STATS_ARGS + 1; i++)
568 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100569
570 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100571 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100572 return 0;
573
William Lallemand14721be2018-10-26 14:47:37 +0200574 /* in a worker or normal process, don't display master only commands */
575 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
576 return 0;
577
578 /* in master don't displays if we don't have the master bits */
579 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
580 return 0;
581
Willy Tarreau41908562016-11-24 16:23:38 +0100582 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200583 appctx->io_release = kw->io_release;
William Lallemandd4f20fa2019-10-25 21:10:14 +0200584
585 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
586 goto fail;
587
588 /* kw->parse could set its own io_handler or io_release handler */
589 if (!appctx->io_handler)
590 goto fail;
591
592 appctx->st0 = CLI_ST_CALLBACK;
593 return 1;
594fail:
595 appctx->io_handler = NULL;
596 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100597 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100598}
599
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200600/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
601static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
602{
Willy Tarreau83061a82018-07-13 11:56:34 +0200603 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200604
605 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200606 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200607
608 tmp = get_trash_chunk();
609 chunk_reset(tmp);
610
611 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100612 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200613 chunk_printf(tmp, "[%d]: ", severity);
614 }
615 else {
616 switch (severity_output) {
617 case CLI_SEVERITY_NUMBER:
618 chunk_printf(tmp, "[%d]: ", severity);
619 break;
620 case CLI_SEVERITY_STRING:
621 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
622 break;
623 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100624 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200625 }
626 }
627 chunk_appendf(tmp, "%s", msg);
628
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200629 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200630}
631
William Lallemand74c24fb2016-11-21 17:18:36 +0100632/* This I/O handler runs as an applet embedded in a stream interface. It is
633 * used to processes I/O from/to the stats unix socket. The system relies on a
634 * state machine handling requests and various responses. We read a request,
635 * then we process it and send the response, and we possibly display a prompt.
636 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100637 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100638 * or not.
639 */
640static void cli_io_handler(struct appctx *appctx)
641{
642 struct stream_interface *si = appctx->owner;
643 struct channel *req = si_oc(si);
644 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200645 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100646 int reql;
647 int len;
648
649 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
650 goto out;
651
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800652 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200653 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100654 /* buf.size==0 means we failed to get a buffer and were
655 * already subscribed to a wait list to get a buffer.
656 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100657 goto out;
658 }
659
William Lallemand74c24fb2016-11-21 17:18:36 +0100660 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100661 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100662 /* Stats output not initialized yet */
663 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200664 /* reset severity to default at init */
665 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100666 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100667 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100668 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100669 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100670 /* Let's close for real now. We just close the request
671 * side, the conditions below will complete if needed.
672 */
673 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200674 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100675 break;
676 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100677 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200678 char *str;
679
680 /* use a trash chunk to store received data */
681 if (!appctx->chunk) {
682 appctx->chunk = alloc_trash_chunk();
683 if (!appctx->chunk) {
684 appctx->st0 = CLI_ST_END;
685 continue;
686 }
687 }
688
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200689 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200690
William Lallemand74c24fb2016-11-21 17:18:36 +0100691 /* ensure we have some output room left in the event we
692 * would want to return some info right after parsing.
693 */
694 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100695 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100696 break;
697 }
698
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200699 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200700 reql = co_getline(si_oc(si), str,
701 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100702 if (reql <= 0) { /* closed or EOL not found */
703 if (reql == 0)
704 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100705 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100706 continue;
707 }
708
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200709 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
710 /* seek for a possible unescaped semi-colon. If we find
711 * one, we replace it with an LF and skip only this part.
712 */
713 for (len = 0; len < reql; len++) {
714 if (str[len] == '\\') {
715 len++;
716 continue;
717 }
718 if (str[len] == ';') {
719 str[len] = '\n';
720 reql = len + 1;
721 break;
722 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100723 }
724 }
725
726 /* now it is time to check that we have a full line,
727 * remove the trailing \n and possibly \r, then cut the
728 * line.
729 */
730 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200731 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100732 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100733 continue;
734 }
735
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100737 len--;
738
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200739 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200740 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741
742 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200743 appctx->chunk->area[appctx->chunk->data] = '\n';
744 appctx->chunk->area[appctx->chunk->data + 1] = 0;
745 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200746 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100747
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100748 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200749
750 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
751 /* empty line */
752 if (!len) {
753 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200754 appctx->chunk->data -= 2;
755 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200756
757 if (!cli_parse_request(appctx))
758 cli_gen_usage_msg(appctx);
759
760 chunk_reset(appctx->chunk);
761 /* NB: cli_sock_parse_request() may have put
762 * another CLI_ST_O_* into appctx->st0.
763 */
764
765 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100766 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100767 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200768 else {
769 /*
770 * Look for the "payload start" pattern at the end of a line
771 * Its location is not remembered here, this is just to switch
772 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100773 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200774 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200775 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200776 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200777 /* no payload, the command is complete: parse the request */
778 if (!cli_parse_request(appctx))
779 cli_gen_usage_msg(appctx);
780
781 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200782 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100783 }
784
785 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200786 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100787 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
788 }
789 else { /* output functions */
790 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 Tarreau3b6e5472016-11-24 15:53:53 +0100793 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200794 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
795 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100796 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100797 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100798 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100799 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200800 case CLI_ST_PRINT_FREE: {
801 const char *msg = appctx->ctx.cli.err;
802
803 if (!msg)
804 msg = "Out of memory.\n";
805
806 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100807 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100808 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100809 }
810 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100811 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100812 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200813 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100814 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100815 if (appctx->io_handler)
816 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100817 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100818 if (appctx->io_release) {
819 appctx->io_release(appctx);
820 appctx->io_release = NULL;
821 }
822 }
823 break;
824 default: /* abnormal state */
825 si->flags |= SI_FL_ERR;
826 break;
827 }
828
829 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100830 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200831 const char *prompt = "";
832
833 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
834 /*
835 * when entering a payload with interactive mode, change the prompt
836 * to emphasize that more data can still be sent
837 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200838 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200839 prompt = "+ ";
840 else
841 prompt = "\n> ";
842 }
843 else {
William Lallemand1bd140e2019-07-01 10:56:15 +0200844 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200845 prompt = "\n";
846 }
847
848 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100849 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100850 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100851 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100852 }
853
854 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100855 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100856 break;
857
858 /* Now we close the output if one of the writers did so,
859 * or if we're not in interactive mode and the request
860 * buffer is empty. This still allows pipelined requests
861 * to be sent in non-interactive mode.
862 */
William Lallemand3de09d52018-12-11 16:10:56 +0100863 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
864 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100865 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100866 continue;
867 }
868
869 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100870 appctx->st0 = CLI_ST_GETREQ;
William Lallemand1bd140e2019-07-01 10:56:15 +0200871 /* reactivate the \n at the end of the response for the next command */
872 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100873 }
874 }
875
876 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
877 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
878 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
879 /* Other side has closed, let's abort if we have no more processing to do
880 * and nothing more to consume. This is comparable to a broken pipe, so
881 * we forward the close to the request side so that it flows upstream to
882 * the client.
883 */
884 si_shutw(si);
885 }
886
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100887 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100888 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
889 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
890 /* We have no more processing to do, and nothing more to send, and
891 * the client side has closed. So we'll forward this state downstream
892 * on the response buffer.
893 */
894 si_shutr(si);
895 res->flags |= CF_READ_NULL;
896 }
897
898 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200899 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 +0100900 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200901 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 +0100902}
903
William Lallemand74c24fb2016-11-21 17:18:36 +0100904/* This is called when the stream interface is closed. For instance, upon an
905 * external abort, we won't call the i/o handler anymore so we may need to
906 * remove back references to the stream currently being dumped.
907 */
908static void cli_release_handler(struct appctx *appctx)
909{
910 if (appctx->io_release) {
911 appctx->io_release(appctx);
912 appctx->io_release = NULL;
913 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100914 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100915 free(appctx->ctx.cli.err);
916 appctx->ctx.cli.err = NULL;
917 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100918}
919
920/* This function dumps all environmnent variables to the buffer. It returns 0
921 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100922 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
923 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100924 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100925static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100926{
Willy Tarreau0a739292016-11-22 20:21:23 +0100927 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100928 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100929
930 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
931 return 1;
932
933 chunk_reset(&trash);
934
935 /* we have two inner loops here, one for the proxy, the other one for
936 * the buffer.
937 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100938 while (*var) {
939 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100940
Willy Tarreau06d80a92017-10-19 14:32:15 +0200941 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100942 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100943 return 0;
944 }
945 if (appctx->st2 == STAT_ST_END)
946 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100947 var++;
948 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100949 }
950
951 /* dump complete */
952 return 1;
953}
954
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200955/* This function dumps all file descriptors states (or the requested one) to
956 * the buffer. It returns 0 if the output buffer is full and it needs to be
957 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
958 * It uses cli.i0 as the fd number to restart from.
959 */
960static int cli_io_handler_show_fd(struct appctx *appctx)
961{
962 struct stream_interface *si = appctx->owner;
963 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100964 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200965
966 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100967 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200968
969 chunk_reset(&trash);
970
Willy Tarreauca1b1572018-12-18 15:45:11 +0100971 /* isolate the threads once per round. We're limited to a buffer worth
972 * of output anyway, it cannot last very long.
973 */
974 thread_isolate();
975
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200976 /* we have two inner loops here, one for the proxy, the other one for
977 * the buffer.
978 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100979 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200980 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200981 struct listener *li = NULL;
982 struct server *sv = NULL;
983 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200984 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200985 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +0200986 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100987 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200988
989 fdt = fdtab[fd];
990
Willy Tarreauca1b1572018-12-18 15:45:11 +0100991 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +0200992 goto skip; // closed
993
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200994 if (fdt.iocb == conn_fd_handler) {
995 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200996 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100997 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200998 li = objt_listener(((struct connection *)fdt.owner)->target);
999 sv = objt_server(((struct connection *)fdt.owner)->target);
1000 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001001 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001002 }
1003 else if (fdt.iocb == listener_accept)
1004 li = fdt.owner;
1005
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001006 chunk_printf(&trash,
Willy Tarreauc754b342018-03-30 15:00:15 +02001007 " %5d : st=0x%02x(R:%c%c%c W:%c%c%c) ev=0x%02x(%c%c%c%c%c) [%c%c] cnext=%d cprev=%d tmask=0x%lx umask=0x%lx owner=%p iocb=%p(%s)",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001008 fd,
1009 fdt.state,
1010 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
1011 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1012 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
1013 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
1014 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1015 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1016 fdt.ev,
1017 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1018 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1019 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1020 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1021 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001022 fdt.linger_risk ? 'L' : 'l',
1023 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001024 fdt.cache.next,
1025 fdt.cache.prev,
1026 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001027 fdt.owner,
1028 fdt.iocb,
1029 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
1030 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
1031 (fdt.iocb == listener_accept) ? "listener_accept" :
Olivier Houchard79321b92018-07-26 17:55:11 +02001032 (fdt.iocb == poller_pipe_io_handler) ? "poller_pipe_io_handler" :
William Lallemanddb6bdfb2018-11-20 17:36:51 +01001033 (fdt.iocb == mworker_accept_wrapper) ? "mworker_accept_wrapper" :
Emeric Brund0e095c2019-04-19 17:15:28 +02001034#ifdef USE_OPENSSL
Willy Tarreau5db847a2019-05-09 14:13:35 +02001035#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL) && !defined(OPENSSL_NO_ASYNC)
Emeric Brund0e095c2019-04-19 17:15:28 +02001036 (fdt.iocb == ssl_async_fd_free) ? "ssl_async_fd_free" :
1037 (fdt.iocb == ssl_async_fd_handler) ? "ssl_async_fd_handler" :
1038#endif
1039#endif
Willy Tarreauc754b342018-03-30 15:00:15 +02001040 "unknown");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001041
1042 if (fdt.iocb == conn_fd_handler) {
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001043 chunk_appendf(&trash, " back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001044 if (px)
1045 chunk_appendf(&trash, " px=%s", px->id);
1046 else if (sv)
1047 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1048 else if (li)
1049 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001050
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001051 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001052 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001053 if (mux->show_fd)
1054 mux->show_fd(&trash, fdt.owner);
1055 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001056 else
1057 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001058 }
1059 else if (fdt.iocb == listener_accept) {
1060 chunk_appendf(&trash, " l.st=%s fe=%s",
1061 listener_state_str(li),
1062 li->bind_conf->frontend->id);
1063 }
1064
1065 chunk_appendf(&trash, "\n");
1066
Willy Tarreau06d80a92017-10-19 14:32:15 +02001067 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001068 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001069 appctx->ctx.cli.i0 = fd;
1070 ret = 0;
1071 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001072 }
1073 skip:
1074 if (appctx->st2 == STAT_ST_END)
1075 break;
1076
1077 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001078 }
1079
Willy Tarreauca1b1572018-12-18 15:45:11 +01001080 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001081 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001082
1083 thread_release();
1084 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001085}
1086
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001087/* This function dumps some activity counters used by developers and support to
1088 * rule out some hypothesis during bug reports. It returns 0 if the output
1089 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1090 * everything at once in the buffer and is not designed to do it in multiple
1091 * passes.
1092 */
1093static int cli_io_handler_show_activity(struct appctx *appctx)
1094{
1095 struct stream_interface *si = appctx->owner;
1096 int thr;
1097
1098 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1099 return 1;
1100
1101 chunk_reset(&trash);
1102
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001103#undef SHOW_TOT
1104#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001105 do { \
1106 unsigned int _v[MAX_THREADS]; \
1107 unsigned int _tot; \
1108 const unsigned int _nbt = global.nbthread; \
1109 for (_tot = t = 0; t < _nbt; t++) \
1110 _tot += _v[t] = (x); \
1111 if (_nbt == 1) { \
1112 chunk_appendf(&trash, " %u\n", _tot); \
1113 break; \
1114 } \
1115 chunk_appendf(&trash, " %u [", _tot); \
1116 for (t = 0; t < _nbt; t++) \
1117 chunk_appendf(&trash, " %u", _v[t]); \
1118 chunk_appendf(&trash, " ]\n"); \
1119 } while (0)
1120
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001121#undef SHOW_AVG
1122#define SHOW_AVG(t, x) \
1123 do { \
1124 unsigned int _v[MAX_THREADS]; \
1125 unsigned int _tot; \
1126 const unsigned int _nbt = global.nbthread; \
1127 for (_tot = t = 0; t < _nbt; t++) \
1128 _tot += _v[t] = (x); \
1129 if (_nbt == 1) { \
1130 chunk_appendf(&trash, " %u\n", _tot); \
1131 break; \
1132 } \
1133 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1134 for (t = 0; t < _nbt; t++) \
1135 chunk_appendf(&trash, " %u", _v[t]); \
1136 chunk_appendf(&trash, " ]\n"); \
1137 } while (0)
1138
Willy Tarreaua0211b82019-05-28 15:09:08 +02001139 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1140 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001141 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
1142 chunk_appendf(&trash, "wake_cache:"); SHOW_TOT(thr, activity[thr].wake_cache);
1143 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1144 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
1145 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
1146 chunk_appendf(&trash, "poll_drop:"); SHOW_TOT(thr, activity[thr].poll_drop);
1147 chunk_appendf(&trash, "poll_dead:"); SHOW_TOT(thr, activity[thr].poll_dead);
1148 chunk_appendf(&trash, "poll_skip:"); SHOW_TOT(thr, activity[thr].poll_skip);
1149 chunk_appendf(&trash, "fd_lock:"); SHOW_TOT(thr, activity[thr].fd_lock);
1150 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
1151 chunk_appendf(&trash, "stream:"); SHOW_TOT(thr, activity[thr].stream);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001152 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1153 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001154 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1155 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
1156 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1157 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1158 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1159 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1160 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1161 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1162 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1163 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1164 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001165#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001166 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 +02001167#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001168
Willy Tarreaud6a78502019-05-27 07:03:38 +02001169#if defined(DEBUG_DEV)
1170 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001171 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1172 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1173 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001174#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001175
1176 if (ci_putchk(si_ic(si), &trash) == -1) {
1177 chunk_reset(&trash);
1178 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001179 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001180 }
1181
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001182#undef SHOW_AVG
1183#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001184 /* dump complete */
1185 return 1;
1186}
1187
William Lallemandeceddf72016-12-15 18:06:44 +01001188/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001189 * CLI IO handler for `show cli sockets`.
1190 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001191 */
1192static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1193{
1194 struct bind_conf *bind_conf;
1195 struct stream_interface *si = appctx->owner;
1196
1197 chunk_reset(&trash);
1198
1199 switch (appctx->st2) {
1200 case STAT_ST_INIT:
1201 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001202 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001203 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001204 return 0;
1205 }
William Lallemandeceddf72016-12-15 18:06:44 +01001206 appctx->st2 = STAT_ST_LIST;
1207
1208 case STAT_ST_LIST:
1209 if (global.stats_fe) {
1210 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1211 struct listener *l;
1212
1213 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001214 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001215 * if the current node is the first of the list
1216 */
1217
Willy Tarreau3af9d832016-12-16 12:58:09 +01001218 if (appctx->ctx.cli.p0 &&
1219 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001220 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001221 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001222 continue;
1223 }
1224
1225 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1226
1227 char addr[46];
1228 char port[6];
1229
1230 if (l->addr.ss_family == AF_UNIX) {
1231 const struct sockaddr_un *un;
1232
1233 un = (struct sockaddr_un *)&l->addr;
William Lallemande58915f2019-04-01 11:30:05 +02001234 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001235 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001236 } else {
1237 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1238 }
William Lallemandeceddf72016-12-15 18:06:44 +01001239 } else if (l->addr.ss_family == AF_INET) {
1240 addr_to_str(&l->addr, addr, sizeof(addr));
1241 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001242 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001243 } else if (l->addr.ss_family == AF_INET6) {
1244 addr_to_str(&l->addr, addr, sizeof(addr));
1245 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001246 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001247 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1248 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001249 } else
William Lallemand26314342018-10-26 14:47:41 +02001250 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001251
William Lallemand07a62f72017-05-24 00:57:40 +02001252 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001253 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001254 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1255 chunk_appendf(&trash, "operator ");
1256 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1257 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001258 else
1259 chunk_appendf(&trash, " ");
1260
1261 if (bind_conf->bind_proc != 0) {
1262 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001263 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001264 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001265 chunk_appendf(&trash, "%d,", pos+1);
1266 }
1267 }
1268 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001269 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001270
1271 } else {
1272 chunk_appendf(&trash, "all\n");
1273 }
1274
Willy Tarreau06d80a92017-10-19 14:32:15 +02001275 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001276 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001277 return 0;
1278 }
1279 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001280 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001281 }
1282 }
1283 default:
1284 appctx->st2 = STAT_ST_FIN;
1285 return 1;
1286 }
1287}
1288
1289
Willy Tarreau0a739292016-11-22 20:21:23 +01001290/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001291 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1292 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001293 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001294static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001295{
1296 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001297 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001298
1299 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1300 return 1;
1301
Willy Tarreauf6710f82016-12-16 17:45:44 +01001302 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001303
1304 if (*args[2]) {
1305 int len = strlen(args[2]);
1306
Willy Tarreauf6710f82016-12-16 17:45:44 +01001307 for (; *var; var++) {
1308 if (strncmp(*var, args[2], len) == 0 &&
1309 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001310 break;
1311 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001312 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001313 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001314 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001315 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001316 return 1;
1317 }
1318 appctx->st2 = STAT_ST_END;
1319 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001320 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001321 return 0;
1322}
1323
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001324/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1325 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1326 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1327 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001328static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001329{
1330 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1331 return 1;
1332
1333 appctx->ctx.cli.i0 = 0;
1334
1335 if (*args[2]) {
1336 appctx->ctx.cli.i0 = atoi(args[2]);
1337 appctx->st2 = STAT_ST_END;
1338 }
1339 return 0;
1340}
1341
Willy Tarreau599852e2016-11-22 20:33:32 +01001342/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001343static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001344{
1345 struct stream_interface *si = appctx->owner;
1346 struct stream *s = si_strm(si);
1347
1348 if (strcmp(args[2], "cli") == 0) {
1349 unsigned timeout;
1350 const char *res;
1351
1352 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001353 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001354 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001355 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001356 return 1;
1357 }
1358
1359 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1360 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001361 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001362 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001363 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001364 return 1;
1365 }
1366
1367 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1368 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1369 return 1;
1370 }
1371 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001372 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001373 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001374 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001375 return 1;
1376 }
1377}
1378
Willy Tarreau2af99412016-11-23 11:10:59 +01001379/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001380static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001381{
1382 int v;
1383
1384 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1385 return 1;
1386
1387 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001388 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001389 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001390 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001391 return 1;
1392 }
1393
1394 v = atoi(args[3]);
1395 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001396 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001397 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001398 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001399 return 1;
1400 }
1401
1402 /* check for unlimited values */
1403 if (v <= 0)
1404 v = global.hardmaxconn;
1405
1406 global.maxconn = v;
1407
1408 /* Dequeues all of the listeners waiting for a resource */
1409 if (!LIST_ISEMPTY(&global_listener_queue))
1410 dequeue_all_listeners(&global_listener_queue);
1411
1412 return 1;
1413}
1414
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001415static int set_severity_output(int *target, char *argument)
1416{
1417 if (!strcmp(argument, "none")) {
1418 *target = CLI_SEVERITY_NONE;
1419 return 1;
1420 }
1421 else if (!strcmp(argument, "number")) {
1422 *target = CLI_SEVERITY_NUMBER;
1423 return 1;
1424 }
1425 else if (!strcmp(argument, "string")) {
1426 *target = CLI_SEVERITY_STRING;
1427 return 1;
1428 }
1429 return 0;
1430}
1431
1432/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001433static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001434{
1435 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1436 return 0;
1437
1438 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001439 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001440 appctx->st0 = CLI_ST_PRINT;
1441 return 1;
1442}
William Lallemandeceddf72016-12-15 18:06:44 +01001443
William Lallemand67a234f2018-12-13 09:05:45 +01001444
1445/* show the level of the current CLI session */
1446static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1447{
1448
1449 appctx->ctx.cli.severity = LOG_INFO;
1450 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1451 appctx->ctx.cli.msg = "admin\n";
1452 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1453 appctx->ctx.cli.msg = "operator\n";
1454 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1455 appctx->ctx.cli.msg = "user\n";
1456 else
1457 appctx->ctx.cli.msg = "unknown\n";
1458
1459 appctx->st0 = CLI_ST_PRINT;
1460 return 1;
1461
1462}
1463
1464/* parse and set the CLI level dynamically */
1465static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1466{
William Lallemand1bd140e2019-07-01 10:56:15 +02001467 /* this will ask the applet to not output a \n after the command */
1468 if (!strcmp(args[1], "-"))
1469 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1470
William Lallemand67a234f2018-12-13 09:05:45 +01001471 if (!strcmp(args[0], "operator")) {
1472 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1473 return 1;
1474 }
1475 appctx->cli_level &= ~ACCESS_LVL_MASK;
1476 appctx->cli_level |= ACCESS_LVL_OPER;
1477
1478 } else if (!strcmp(args[0], "user")) {
1479 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1480 return 1;
1481 }
1482 appctx->cli_level &= ~ACCESS_LVL_MASK;
1483 appctx->cli_level |= ACCESS_LVL_USER;
1484 }
1485 return 1;
1486}
1487
William Lallemanda57b7e32018-12-14 21:11:31 +01001488
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001489int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001490{
1491 return 0;
1492}
1493
Willy Tarreau45c742b2016-11-24 14:51:17 +01001494/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001495static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001496{
1497 int v;
1498 int *res;
1499 int mul = 1;
1500
1501 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1502 return 1;
1503
1504 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1505 res = &global.cps_lim;
1506 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1507 res = &global.sps_lim;
1508#ifdef USE_OPENSSL
1509 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1510 res = &global.ssl_lim;
1511#endif
1512 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1513 res = &global.comp_rate_lim;
1514 mul = 1024;
1515 }
1516 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001517 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001518 appctx->ctx.cli.msg =
1519 "'set rate-limit' only supports :\n"
1520 " - 'connections global' to set the per-process maximum connection rate\n"
1521 " - 'sessions global' to set the per-process maximum session rate\n"
1522#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001523 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001524#endif
1525 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001526 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001527 return 1;
1528 }
1529
1530 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001531 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001532 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001533 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001534 return 1;
1535 }
1536
1537 v = atoi(args[4]);
1538 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001539 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001540 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001541 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001542 return 1;
1543 }
1544
1545 *res = v * mul;
1546
1547 /* Dequeues all of the listeners waiting for a resource */
1548 if (!LIST_ISEMPTY(&global_listener_queue))
1549 dequeue_all_listeners(&global_listener_queue);
1550
1551 return 1;
1552}
1553
William Lallemandf6975e92017-05-26 17:42:10 +02001554/* parse the "expose-fd" argument on the bind lines */
1555static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1556{
1557 if (!*args[cur_arg + 1]) {
1558 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1559 return ERR_ALERT | ERR_FATAL;
1560 }
1561 if (!strcmp(args[cur_arg+1], "listeners")) {
1562 conf->level |= ACCESS_FD_LISTENERS;
1563 } else {
1564 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1565 args[cur_arg], args[cur_arg+1]);
1566 return ERR_ALERT | ERR_FATAL;
1567 }
1568
1569 return 0;
1570}
1571
William Lallemand74c24fb2016-11-21 17:18:36 +01001572/* parse the "level" argument on the bind lines */
1573static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1574{
1575 if (!*args[cur_arg + 1]) {
1576 memprintf(err, "'%s' : missing level", args[cur_arg]);
1577 return ERR_ALERT | ERR_FATAL;
1578 }
1579
William Lallemand07a62f72017-05-24 00:57:40 +02001580 if (!strcmp(args[cur_arg+1], "user")) {
1581 conf->level &= ~ACCESS_LVL_MASK;
1582 conf->level |= ACCESS_LVL_USER;
1583 } else if (!strcmp(args[cur_arg+1], "operator")) {
1584 conf->level &= ~ACCESS_LVL_MASK;
1585 conf->level |= ACCESS_LVL_OPER;
1586 } else if (!strcmp(args[cur_arg+1], "admin")) {
1587 conf->level &= ~ACCESS_LVL_MASK;
1588 conf->level |= ACCESS_LVL_ADMIN;
1589 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001590 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1591 args[cur_arg], args[cur_arg+1]);
1592 return ERR_ALERT | ERR_FATAL;
1593 }
1594
1595 return 0;
1596}
1597
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001598static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1599{
1600 if (!*args[cur_arg + 1]) {
1601 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1602 return ERR_ALERT | ERR_FATAL;
1603 }
1604
1605 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1606 return 0;
1607 else {
1608 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1609 args[cur_arg], args[cur_arg+1]);
1610 return ERR_ALERT | ERR_FATAL;
1611 }
1612}
1613
William Lallemand16dd1b32018-11-19 18:46:18 +01001614
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001615
Olivier Houchardf886e342017-04-05 22:24:59 +02001616/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001617static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001618{
1619 char *cmsgbuf = NULL;
1620 unsigned char *tmpbuf = NULL;
1621 struct cmsghdr *cmsg;
1622 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001623 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001624 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001625 struct msghdr msghdr;
1626 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001627 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001628 int *tmpfd;
1629 int tot_fd_nb = 0;
1630 struct proxy *px;
William Lallemand8dc8aec2020-01-16 15:32:08 +01001631 struct peers *prs;
Olivier Houchardf886e342017-04-05 22:24:59 +02001632 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001633 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001634 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001635 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001636 int ret;
1637
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001638 if (!remote) {
1639 ha_warning("Only works on real connections\n");
1640 goto out;
1641 }
1642
1643 fd = remote->handle.fd;
1644
Olivier Houchardf886e342017-04-05 22:24:59 +02001645 /* Temporary set the FD in blocking mode, that will make our life easier */
1646 old_fcntl = fcntl(fd, F_GETFL);
1647 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001648 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001649 goto out;
1650 }
1651 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1652 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001653 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001654 goto out;
1655 }
1656 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001657 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001658 goto out;
1659 }
Olivier Houchard54740872017-04-06 14:45:14 +02001660 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001661 iov.iov_base = &tot_fd_nb;
1662 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001663 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001664 goto out;
1665 memset(&msghdr, 0, sizeof(msghdr));
1666 /*
1667 * First, calculates the total number of FD, so that we can let
1668 * the caller know how much he should expects.
1669 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001670 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001671 while (px) {
1672 struct listener *l;
1673
1674 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001675 /* Only transfer IPv4/IPv6/UNIX sockets */
1676 if (l->state >= LI_ZOMBIE &&
1677 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001678 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001679 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001680 tot_fd_nb++;
1681 }
1682 px = px->next;
1683 }
William Lallemand8dc8aec2020-01-16 15:32:08 +01001684 prs = cfg_peers;
1685 while (prs) {
1686 if (prs->peers_fe) {
1687 struct listener *l;
1688
1689 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1690 /* Only transfer IPv4/IPv6/UNIX sockets */
1691 if (l->state >= LI_ZOMBIE &&
1692 (l->proto->sock_family == AF_INET ||
1693 l->proto->sock_family == AF_INET6 ||
1694 l->proto->sock_family == AF_UNIX))
1695 tot_fd_nb++;
1696 }
1697 }
1698 prs = prs->next;
1699 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001700 if (tot_fd_nb == 0)
1701 goto out;
1702
1703 /* First send the total number of file descriptors, so that the
1704 * receiving end knows what to expect.
1705 */
1706 msghdr.msg_iov = &iov;
1707 msghdr.msg_iovlen = 1;
1708 ret = sendmsg(fd, &msghdr, 0);
1709 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001710 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001711 goto out;
1712 }
1713
1714 /* Now send the fds */
1715 msghdr.msg_control = cmsgbuf;
1716 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1717 cmsg = CMSG_FIRSTHDR(&msghdr);
1718 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1719 cmsg->cmsg_level = SOL_SOCKET;
1720 cmsg->cmsg_type = SCM_RIGHTS;
1721 tmpfd = (int *)CMSG_DATA(cmsg);
1722
Olivier Houchardf886e342017-04-05 22:24:59 +02001723 /* For each socket, e message is sent, containing the following :
1724 * Size of the namespace name (or 0 if none), as an unsigned char.
1725 * The namespace name, if any
1726 * Size of the interface name (or 0 if none), as an unsigned char
1727 * The interface name, if any
1728 * Listener options, as an int.
1729 */
1730 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1731 * buffer big enough to store the socket informations.
1732 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001733 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001734 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001735 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001736 goto out;
1737 }
1738 iov.iov_base = tmpbuf;
William Lallemand8dc8aec2020-01-16 15:32:08 +01001739 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001740 while (px) {
1741 struct listener *l;
1742
1743 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1744 int ret;
1745 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001746 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001747 (l->proto->sock_family == AF_INET ||
1748 l->proto->sock_family == AF_INET6 ||
1749 l->proto->sock_family == AF_UNIX)) {
1750 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1751 if (!l->netns)
1752 tmpbuf[curoff++] = 0;
Willy Tarreaue5733232019-05-22 19:24:06 +02001753#ifdef USE_NS
Olivier Houchardf886e342017-04-05 22:24:59 +02001754 else {
1755 char *name = l->netns->node.key;
1756 unsigned char len = l->netns->name_len;
1757 tmpbuf[curoff++] = len;
1758 memcpy(tmpbuf + curoff, name, len);
1759 curoff += len;
1760 }
1761#endif
1762 if (l->interface) {
1763 unsigned char len = strlen(l->interface);
1764 tmpbuf[curoff++] = len;
1765 memcpy(tmpbuf + curoff, l->interface, len);
1766 curoff += len;
1767 } else
1768 tmpbuf[curoff++] = 0;
1769 memcpy(tmpbuf + curoff, &l->options,
1770 sizeof(l->options));
1771 curoff += sizeof(l->options);
1772
Olivier Houchardf886e342017-04-05 22:24:59 +02001773 i++;
1774 } else
1775 continue;
1776 if ((!(i % MAX_SEND_FD))) {
1777 iov.iov_len = curoff;
1778 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001779 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001780 goto out;
1781 }
1782 /* Wait for an ack */
1783 do {
1784 ret = recv(fd, &tot_fd_nb,
1785 sizeof(tot_fd_nb), 0);
1786 } while (ret == -1 && errno == EINTR);
1787 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001788 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001789 goto out;
1790 }
1791 curoff = 0;
1792 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001793 }
1794 px = px->next;
1795 }
William Lallemand8dc8aec2020-01-16 15:32:08 +01001796 /* should be done for peers too */
1797 prs = cfg_peers;
1798 while (prs) {
1799 if (prs->peers_fe) {
1800 struct listener *l;
1801
1802 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1803 int ret;
1804 /* Only transfer IPv4/IPv6 sockets */
1805 if (l->state >= LI_ZOMBIE &&
1806 (l->proto->sock_family == AF_INET ||
1807 l->proto->sock_family == AF_INET6 ||
1808 l->proto->sock_family == AF_UNIX)) {
1809 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1810 if (!l->netns)
1811 tmpbuf[curoff++] = 0;
1812#ifdef USE_NS
1813 else {
1814 char *name = l->netns->node.key;
1815 unsigned char len = l->netns->name_len;
1816 tmpbuf[curoff++] = len;
1817 memcpy(tmpbuf + curoff, name, len);
1818 curoff += len;
1819 }
1820#endif
1821 if (l->interface) {
1822 unsigned char len = strlen(l->interface);
1823 tmpbuf[curoff++] = len;
1824 memcpy(tmpbuf + curoff, l->interface, len);
1825 curoff += len;
1826 } else
1827 tmpbuf[curoff++] = 0;
1828 memcpy(tmpbuf + curoff, &l->options,
1829 sizeof(l->options));
1830 curoff += sizeof(l->options);
1831
1832 i++;
1833 } else
1834 continue;
1835 if ((!(i % MAX_SEND_FD))) {
1836 iov.iov_len = curoff;
1837 if (sendmsg(fd, &msghdr, 0) != curoff) {
1838 ha_warning("Failed to transfer sockets\n");
1839 goto out;
1840 }
1841 /* Wait for an ack */
1842 do {
1843 ret = recv(fd, &tot_fd_nb,
1844 sizeof(tot_fd_nb), 0);
1845 } while (ret == -1 && errno == EINTR);
1846 if (ret <= 0) {
1847 ha_warning("Unexpected error while transferring sockets\n");
1848 goto out;
1849 }
1850 curoff = 0;
1851 }
1852 }
1853 }
1854 prs = prs->next;
1855 }
1856
Olivier Houchardf886e342017-04-05 22:24:59 +02001857 if (i % MAX_SEND_FD) {
1858 iov.iov_len = curoff;
1859 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1860 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1861 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001862 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001863 goto out;
1864 }
1865 }
1866
1867out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001868 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001869 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001870 goto out;
1871 }
1872 appctx->st0 = CLI_ST_END;
1873 free(cmsgbuf);
1874 free(tmpbuf);
1875 return 1;
1876}
1877
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001878static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1879{
1880 if (*args[0] == 'h')
1881 /* help */
1882 cli_gen_usage_msg(appctx);
1883 else if (*args[0] == 'p')
1884 /* prompt */
1885 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1886 else if (*args[0] == 'q')
1887 /* quit */
1888 appctx->st0 = CLI_ST_END;
1889
1890 return 1;
1891}
Olivier Houchardf886e342017-04-05 22:24:59 +02001892
William Lallemand2f4ce202018-10-26 14:47:47 +02001893void pcli_write_prompt(struct stream *s)
1894{
1895 struct buffer *msg = get_trash_chunk();
1896 struct channel *oc = si_oc(&s->si[0]);
1897
William Lallemanddc12c2e2018-12-13 09:05:46 +01001898 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001899 return;
1900
William Lallemanddc12c2e2018-12-13 09:05:46 +01001901 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001902 chunk_appendf(msg, "+ ");
1903 } else {
1904 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001905 chunk_appendf(msg, "master%s> ",
1906 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001907 else
1908 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1909 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001910 co_inject(oc, msg->area, msg->data);
1911}
1912
William Lallemand291810d2018-10-26 14:47:38 +02001913
William Lallemandcf62f7e2018-10-26 14:47:40 +02001914/* The pcli_* functions are used for the CLI proxy in the master */
1915
William Lallemanddeeaa592018-10-26 14:47:48 +02001916void pcli_reply_and_close(struct stream *s, const char *msg)
1917{
1918 struct buffer *buf = get_trash_chunk();
1919
1920 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001921 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001922}
1923
William Lallemand291810d2018-10-26 14:47:38 +02001924static enum obj_type *pcli_pid_to_server(int proc_pid)
1925{
1926 struct mworker_proc *child;
1927
William Lallemandbddd33a2018-12-11 16:10:53 +01001928 /* return the CLI applet of the master */
1929 if (proc_pid == 0)
1930 return &cli_applet.obj_type;
1931
William Lallemand291810d2018-10-26 14:47:38 +02001932 list_for_each_entry(child, &proc_list, list) {
1933 if (child->pid == proc_pid){
1934 return &child->srv->obj_type;
1935 }
1936 }
1937 return NULL;
1938}
1939
1940/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1941 * Return:
1942 * 0: master
1943 * > 0: pid of a worker
1944 * < 0: didn't find a worker
1945 */
1946static int pcli_prefix_to_pid(const char *prefix)
1947{
1948 int proc_pid;
1949 struct mworker_proc *child;
1950 char *errtol = NULL;
1951
1952 if (*prefix != '@') /* not a prefix, should not happen */
1953 return -1;
1954
1955 prefix++;
1956 if (!*prefix) /* sent @ alone, return the master */
1957 return 0;
1958
1959 if (strcmp("master", prefix) == 0) {
1960 return 0;
1961 } else if (*prefix == '!') {
1962 prefix++;
1963 if (!*prefix)
1964 return -1;
1965
1966 proc_pid = strtol(prefix, &errtol, 10);
1967 if (*errtol != '\0')
1968 return -1;
1969 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001970 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001971 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001972 if (child->pid == proc_pid){
1973 return child->pid;
1974 }
1975 }
1976 } else {
1977 struct mworker_proc *chosen = NULL;
1978 /* this is a relative pid */
1979
1980 proc_pid = strtol(prefix, &errtol, 10);
1981 if (*errtol != '\0')
1982 return -1;
1983
1984 if (proc_pid == 0) /* return the master */
1985 return 0;
1986
1987 /* chose the right process, the current one is the one with the
1988 least number of reloads */
1989 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001990 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001991 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001992 if (child->relative_pid == proc_pid){
1993 if (child->reloads == 0)
1994 return child->pid;
1995 else if (chosen == NULL || child->reloads < chosen->reloads)
1996 chosen = child;
1997 }
1998 }
1999 if (chosen)
2000 return chosen->pid;
2001 }
2002 return -1;
2003}
2004
William Lallemandbddd33a2018-12-11 16:10:53 +01002005/* Return::
2006 * >= 0 : number of words to escape
2007 * = -1 : error
2008 */
2009
2010int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2011{
2012 if (argl < 1)
2013 return 0;
2014
2015 /* there is a prefix */
2016 if (args[0][0] == '@') {
2017 int target_pid = pcli_prefix_to_pid(args[0]);
2018
2019 if (target_pid == -1) {
2020 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2021 return -1;
2022 }
2023
2024 /* if the prefix is alone, define a default target */
2025 if (argl == 1)
2026 s->pcli_next_pid = target_pid;
2027 else
2028 *next_pid = target_pid;
2029 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01002030 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002031 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002032 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002033
2034 } else if (!strcmp("quit", args[0])) {
2035 channel_shutr_now(&s->req);
2036 channel_shutw_now(&s->res);
2037 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01002038 } else if (!strcmp(args[0], "operator")) {
2039 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2040 memprintf(errmsg, "Permission denied!\n");
2041 return -1;
2042 }
2043 s->pcli_flags &= ~ACCESS_LVL_MASK;
2044 s->pcli_flags |= ACCESS_LVL_OPER;
2045 return argl;
2046
2047 } else if (!strcmp(args[0], "user")) {
2048 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2049 memprintf(errmsg, "Permission denied!\n");
2050 return -1;
2051 }
2052 s->pcli_flags &= ~ACCESS_LVL_MASK;
2053 s->pcli_flags |= ACCESS_LVL_USER;
2054 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002055 }
2056
2057 return 0;
2058}
2059
2060/*
2061 * Parse the CLI request:
2062 * - It does basically the same as the cli_io_handler, but as a proxy
2063 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002064 *
2065 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002066 * - the number of characters to forward or
2067 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002068 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002069int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002070{
William Lallemandbddd33a2018-12-11 16:10:53 +01002071 char *str = (char *)ci_head(req);
2072 char *end = (char *)ci_stop(req);
2073 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2074 int argl; /* number of args */
2075 char *p;
2076 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002077 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002078 int wtrim = 0; /* number of words to trim */
2079 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002080 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002081 int i = 0;
2082
2083 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002084
William Lallemanddc12c2e2018-12-13 09:05:46 +01002085 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002086
2087 /* Looks for the end of one command */
2088 while (p+reql < end) {
2089 /* handle escaping */
2090 if (p[reql] == '\\') {
William Lallemandc3a2e352020-06-18 18:45:04 +02002091 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002092 continue;
2093 }
2094 if (p[reql] == ';' || p[reql] == '\n') {
2095 /* found the end of the command */
2096 p[reql] = '\n';
2097 reql++;
2098 break;
2099 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002100 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002101 }
William Lallemandebf61802018-12-11 16:10:57 +01002102 } else {
2103 while (p+reql < end) {
2104 if (p[reql] == '\n') {
2105 /* found the end of the line */
2106 reql++;
2107 break;
2108 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002109 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002110 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002111 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002112
William Lallemandbddd33a2018-12-11 16:10:53 +01002113 /* set end to first byte after the end of the command */
2114 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002115
William Lallemandbddd33a2018-12-11 16:10:53 +01002116 /* there is no end to this command, need more to parse ! */
2117 if (*(end-1) != '\n') {
2118 return -1;
2119 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002120
William Lallemand3301f3e2018-12-13 09:05:48 +01002121 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2122 if (reql == 1) /* last line of the payload */
2123 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002124 return reql;
2125 }
2126
William Lallemandbddd33a2018-12-11 16:10:53 +01002127 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002128
William Lallemandbddd33a2018-12-11 16:10:53 +01002129 /* splits the command in words */
2130 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002131 /* skip leading spaces/tabs */
2132 p += strspn(p, " \t");
2133 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002134 break;
2135
William Lallemandbddd33a2018-12-11 16:10:53 +01002136 args[i] = p;
William Lallemandda9a2d12020-06-18 18:03:57 +02002137 while (1) {
2138 p += strcspn(p, " \t\\");
2139 /* escaped chars using backlashes (\) */
2140 if (*p == '\\') {
2141 if (!*++p)
2142 break;
2143 if (!*++p)
2144 break;
2145 } else {
2146 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002147 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002148 }
William Lallemandda9a2d12020-06-18 18:03:57 +02002149 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002150 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002151 }
2152
William Lallemandbddd33a2018-12-11 16:10:53 +01002153 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002154
William Lallemandbddd33a2018-12-11 16:10:53 +01002155 for (; i < MAX_STATS_ARGS + 1; i++)
2156 args[i] = NULL;
2157
2158 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2159
2160 /* End of words are ending by \0, we need to replace the \0s by spaces
21611 before forwarding them */
2162 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002163 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002164 if (*p == '\0')
2165 *p = ' ';
2166 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002167 }
2168
William Lallemand3301f3e2018-12-13 09:05:48 +01002169 payload = strstr(str, PAYLOAD_PATTERN);
2170 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2171 /* if the payload pattern is at the end */
2172 s->pcli_flags |= PCLI_F_PAYLOAD;
2173 ret = reql;
2174 }
2175
William Lallemandbddd33a2018-12-11 16:10:53 +01002176 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002177
William Lallemandbddd33a2018-12-11 16:10:53 +01002178 if (wtrim > 0) {
2179 trim = &args[wtrim][0];
2180 if (trim == NULL) /* if this was the last word in the table */
2181 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002182
William Lallemandbddd33a2018-12-11 16:10:53 +01002183 b_del(&req->buf, trim - str);
2184
William Lallemandb7ea1412018-12-13 09:05:47 +01002185 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002186 } else if (wtrim < 0) {
2187 /* parsing error */
2188 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002189 } else {
2190 /* the whole string */
2191 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002192 }
2193
William Lallemandb7ea1412018-12-13 09:05:47 +01002194 if (ret > 1) {
2195 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2196 goto end;
2197 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemand1bd140e2019-07-01 10:56:15 +02002198 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2199 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002200 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemand1bd140e2019-07-01 10:56:15 +02002201 ci_insert_line2(req, 0, "user -", strlen("user -"));
2202 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002203 }
2204 }
2205end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002206
William Lallemandb7ea1412018-12-13 09:05:47 +01002207 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002208}
2209
2210int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2211{
William Lallemandbddd33a2018-12-11 16:10:53 +01002212 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002213 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002214 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002215
William Lallemandb7ea1412018-12-13 09:05:47 +01002216 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2217 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2218
William Lallemandcf62f7e2018-10-26 14:47:40 +02002219read_again:
2220 /* if the channel is closed for read, we won't receive any more data
2221 from the client, but we don't want to forward this close to the
2222 server */
2223 channel_dont_close(req);
2224
2225 /* We don't know yet to which server we will connect */
2226 channel_dont_connect(req);
2227
2228
2229 /* we are not waiting for a response, there is no more request and we
2230 * receive a close from the client, we can leave */
2231 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2232 channel_shutw_now(&s->res);
2233 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2234 return 1;
2235 }
2236
2237 req->flags |= CF_READ_DONTWAIT;
2238
2239 /* need more data */
2240 if (!ci_data(req))
2241 return 0;
2242
2243 /* If there is data available for analysis, log the end of the idle time. */
2244 if (c_data(req) && s->logs.t_idle == -1)
2245 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2246
William Lallemandbddd33a2018-12-11 16:10:53 +01002247 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002248 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002249 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002250 /* enough data */
2251
William Lallemandcf62f7e2018-10-26 14:47:40 +02002252 /* forward only 1 command */
2253 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002254
William Lallemanddc12c2e2018-12-13 09:05:46 +01002255 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002256 /* we send only 1 command per request, and we write close after it */
2257 channel_shutw_now(req);
2258 } else {
2259 pcli_write_prompt(s);
2260 }
2261
2262 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002263
2264 /* remove the XFER_DATA analysers, which forwards all
2265 * the data, we don't want to forward the next requests
2266 * We need to add CF_FLT_ANALYZE to abort the forward too.
2267 */
2268 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2269 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2270 s->res.analysers |= AN_RES_WAIT_CLI;
2271
William Lallemandebf61802018-12-11 16:10:57 +01002272 if (!(s->flags & SF_ASSIGNED)) {
2273 if (next_pid > -1)
2274 target_pid = next_pid;
2275 else
2276 target_pid = s->pcli_next_pid;
2277 /* we can connect now */
2278 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002279
William Lallemandebf61802018-12-11 16:10:57 +01002280 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2281 channel_auto_connect(req);
2282 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002283
2284 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002285 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002286 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002287 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002288 } else if (to_forward == -1 && errmsg) {
2289 /* there was an error during the parsing */
2290 pcli_reply_and_close(s, errmsg);
2291 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002292 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2293 /* buffer is full and we didn't catch the end of a command */
2294 goto send_help;
2295 }
2296
2297 return 0;
2298
2299send_help:
2300 b_reset(&req->buf);
2301 b_putblk(&req->buf, "help\n", 5);
2302 goto read_again;
2303}
2304
2305int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2306{
2307 struct proxy *fe = strm_fe(s);
2308 struct proxy *be = s->be;
2309
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002310 if (rep->flags & CF_READ_ERROR) {
2311 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2312 s->res.analysers &= ~AN_RES_WAIT_CLI;
2313 return 0;
2314 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002315 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2316 rep->flags |= CF_NEVER_WAIT;
2317
2318 /* don't forward the close */
2319 channel_dont_close(&s->res);
2320 channel_dont_close(&s->req);
2321
William Lallemanddc12c2e2018-12-13 09:05:46 +01002322 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002323 s->req.analysers |= AN_REQ_WAIT_CLI;
2324 s->res.analysers &= ~AN_RES_WAIT_CLI;
2325 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2326 return 0;
2327 }
2328
William Lallemandcf62f7e2018-10-26 14:47:40 +02002329 /* forward the data */
2330 if (ci_data(rep)) {
2331 c_adv(rep, ci_data(rep));
2332 return 0;
2333 }
2334
2335 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2336 /* stream cleanup */
2337
William Lallemand2f4ce202018-10-26 14:47:47 +02002338 pcli_write_prompt(s);
2339
William Lallemandcf62f7e2018-10-26 14:47:40 +02002340 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2341 si_shutr(&s->si[1]);
2342 si_shutw(&s->si[1]);
2343
2344 /*
2345 * starting from there this the same code as
2346 * http_end_txn_clean_session().
2347 *
2348 * It allows to do frontend keepalive while reconnecting to a
2349 * new server for each request.
2350 */
2351
2352 if (s->flags & SF_BE_ASSIGNED) {
2353 HA_ATOMIC_SUB(&be->beconn, 1);
2354 if (unlikely(s->srv_conn))
2355 sess_change_server(s, NULL);
2356 }
2357
2358 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2359 stream_process_counters(s);
2360
2361 /* don't count other requests' data */
2362 s->logs.bytes_in -= ci_data(&s->req);
2363 s->logs.bytes_out -= ci_data(&s->res);
2364
2365 /* we may need to know the position in the queue */
2366 pendconn_free(s);
2367
2368 /* let's do a final log if we need it */
2369 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2370 !(s->flags & SF_MONITOR) &&
2371 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2372 s->do_log(s);
2373 }
2374
2375 /* stop tracking content-based counters */
2376 stream_stop_content_counters(s);
2377 stream_update_time_stats(s);
2378
2379 s->logs.accept_date = date; /* user-visible date for logging */
2380 s->logs.tv_accept = now; /* corrected date for internal use */
2381 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2382 s->logs.t_idle = -1;
2383 tv_zero(&s->logs.tv_request);
2384 s->logs.t_queue = -1;
2385 s->logs.t_connect = -1;
2386 s->logs.t_data = -1;
2387 s->logs.t_close = 0;
2388 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2389 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2390
2391 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2392 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2393
2394 stream_del_srv_conn(s);
2395 if (objt_server(s->target)) {
2396 if (s->flags & SF_CURR_SESS) {
2397 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002398 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002399 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002400 if (may_dequeue_tasks(__objt_server(s->target), be))
2401 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002402 }
2403
2404 s->target = NULL;
2405
2406 /* only release our endpoint if we don't intend to reuse the
2407 * connection.
2408 */
2409 if (!si_conn_ready(&s->si[1])) {
2410 si_release_endpoint(&s->si[1]);
2411 s->srv_conn = NULL;
2412 }
2413
2414 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2415 s->si[1].err_type = SI_ET_NONE;
2416 s->si[1].conn_retries = 0; /* used for logging too */
2417 s->si[1].exp = TICK_ETERNITY;
2418 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2419 s->req.flags &= ~(CF_SHUTW|CF_SHUTW_NOW|CF_AUTO_CONNECT|CF_WRITE_ERROR|CF_STREAMER|CF_STREAMER_FAST|CF_NEVER_WAIT|CF_WAKE_CONNECT|CF_WROTE_DATA);
William Lallemandd12fb062019-06-25 18:00:19 +02002420 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 +02002421 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2422 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2423 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2424 /* reinitialise the current rule list pointer to NULL. We are sure that
2425 * any rulelist match the NULL pointer.
2426 */
2427 s->current_rule_list = NULL;
2428
2429 s->be = strm_fe(s);
2430 s->logs.logwait = strm_fe(s)->to_log;
2431 s->logs.level = 0;
2432 stream_del_srv_conn(s);
2433 s->target = NULL;
2434 /* re-init store persistence */
2435 s->store_count = 0;
2436 s->uniq_id = global.req_count++;
2437
2438 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2439
2440 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2441
2442 s->req.analysers |= AN_REQ_WAIT_CLI;
2443 s->res.analysers &= ~AN_RES_WAIT_CLI;
2444
2445 /* We must trim any excess data from the response buffer, because we
2446 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002447 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448 * we want those data to come along with next response. A typical
2449 * example of such data would be from a buggy server responding to
2450 * a HEAD with some data, or sending more than the advertised
2451 * content-length.
2452 */
2453 if (unlikely(ci_data(&s->res)))
2454 b_set_data(&s->res.buf, co_data(&s->res));
2455
2456 /* Now we can realign the response buffer */
2457 c_realign_if_empty(&s->res);
2458
2459 s->req.rto = strm_fe(s)->timeout.client;
2460 s->req.wto = TICK_ETERNITY;
2461
2462 s->res.rto = TICK_ETERNITY;
2463 s->res.wto = strm_fe(s)->timeout.client;
2464
2465 s->req.rex = TICK_ETERNITY;
2466 s->req.wex = TICK_ETERNITY;
2467 s->req.analyse_exp = TICK_ETERNITY;
2468 s->res.rex = TICK_ETERNITY;
2469 s->res.wex = TICK_ETERNITY;
2470 s->res.analyse_exp = TICK_ETERNITY;
2471 s->si[1].hcto = TICK_ETERNITY;
2472
2473 /* we're removing the analysers, we MUST re-enable events detection.
2474 * We don't enable close on the response channel since it's either
2475 * already closed, or in keep-alive with an idle connection handler.
2476 */
2477 channel_auto_read(&s->req);
2478 channel_auto_close(&s->req);
2479 channel_auto_read(&s->res);
2480
2481
2482 return 1;
2483 }
2484 return 0;
2485}
2486
William Lallemand8a022572018-10-26 14:47:35 +02002487/*
2488 * The mworker functions are used to initialize the CLI in the master process
2489 */
2490
William Lallemand309dc9a2018-10-26 14:47:45 +02002491 /*
2492 * Stop the mworker proxy
2493 */
2494void mworker_cli_proxy_stop()
2495{
William Lallemand550db6d2018-11-06 17:37:12 +01002496 if (mworker_proxy)
2497 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002498}
2499
William Lallemand8a022572018-10-26 14:47:35 +02002500/*
2501 * Create the mworker CLI proxy
2502 */
2503int mworker_cli_proxy_create()
2504{
2505 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002506 char *msg = NULL;
2507 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002508
2509 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2510 if (!mworker_proxy)
2511 return -1;
2512
2513 init_new_proxy(mworker_proxy);
2514 mworker_proxy->next = proxies_list;
2515 proxies_list = mworker_proxy;
2516 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002517 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002518 mworker_proxy->state = PR_STNEW;
2519 mworker_proxy->last_change = now.tv_sec;
2520 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2521 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2522 mworker_proxy->timeout.client = 0; /* no timeout */
2523 mworker_proxy->conf.file = strdup("MASTER");
2524 mworker_proxy->conf.line = 0;
2525 mworker_proxy->accept = frontend_accept;
2526 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2527
2528 /* Does not init the default target the CLI applet, but must be done in
2529 * the request parsing code */
2530 mworker_proxy->default_target = NULL;
2531
2532 /* the check_config_validity() will get an ID for the proxy */
2533 mworker_proxy->uuid = -1;
2534
2535 proxy_store_name(mworker_proxy);
2536
2537 /* create all servers using the mworker_proc list */
2538 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002539 struct server *newsrv = NULL;
2540 struct sockaddr_storage *sk;
2541 int port1, port2, port;
2542 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002543
William Lallemandf0d9dd42020-01-14 15:25:02 +01002544 /* only the workers support the master CLI */
2545 if (!(child->options & PROC_O_TYPE_WORKER))
2546 continue;
2547
William Lallemand8a022572018-10-26 14:47:35 +02002548 newsrv = new_server(mworker_proxy);
2549 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002550 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002551
2552 /* we don't know the new pid yet */
2553 if (child->pid == -1)
2554 memprintf(&msg, "cur-%d", child->relative_pid);
2555 else
2556 memprintf(&msg, "old-%d", child->pid);
2557
2558 newsrv->next = mworker_proxy->srv;
2559 mworker_proxy->srv = newsrv;
2560 newsrv->conf.file = strdup(msg);
2561 newsrv->id = strdup(msg);
2562 newsrv->conf.line = 0;
2563
2564 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002565 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002566 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002567 }
2568 free(msg);
2569 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002570
2571 proto = protocol_by_family(sk->ss_family);
2572 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002573 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002574 }
2575
2576 /* no port specified */
2577 newsrv->flags |= SRV_F_MAPPORTS;
2578 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002579 /* don't let the server participate to load balancing */
2580 newsrv->iweight = 0;
2581 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002582 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002583
2584 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002585 }
2586 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002587
2588error:
2589 ha_alert("%s\n", errmsg);
2590
2591 list_for_each_entry(child, &proc_list, list) {
2592 free((char *)child->srv->conf.file); /* cast because of const char * */
2593 free(child->srv->id);
2594 free(child->srv);
2595 child->srv = NULL;
2596 }
2597 free(mworker_proxy->id);
2598 free(mworker_proxy->conf.file);
2599 free(mworker_proxy);
2600 mworker_proxy = NULL;
2601 free(errmsg);
2602 free(msg);
2603
2604 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002605}
Olivier Houchardf886e342017-04-05 22:24:59 +02002606
William Lallemandce83b4a2018-10-26 14:47:30 +02002607/*
William Lallemande7361152018-10-26 14:47:36 +02002608 * Create a new listener for the master CLI proxy
2609 */
2610int mworker_cli_proxy_new_listener(char *line)
2611{
2612 struct bind_conf *bind_conf;
2613 struct listener *l;
2614 char *err = NULL;
2615 char *args[MAX_LINE_ARGS + 1];
2616 int arg;
2617 int cur_arg;
2618
William Lallemandb4f87862019-11-25 09:58:37 +01002619 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002620 args[0] = line;
2621
2622 /* args is a bind configuration with spaces replaced by commas */
2623 while (*line && arg < MAX_LINE_ARGS) {
2624
2625 if (*line == ',') {
2626 *line++ = '\0';
2627 while (*line == ',')
2628 line++;
William Lallemandb4f87862019-11-25 09:58:37 +01002629 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002630 }
2631 line++;
2632 }
2633
William Lallemandb4f87862019-11-25 09:58:37 +01002634 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002635
2636 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002637 if (!bind_conf)
2638 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002639
2640 bind_conf->level &= ~ACCESS_LVL_MASK;
2641 bind_conf->level |= ACCESS_LVL_ADMIN;
2642
2643 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2644 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002645 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002646 }
2647
2648 cur_arg = 1;
2649
2650 while (*args[cur_arg]) {
2651 static int bind_dumped;
2652 struct bind_kw *kw;
2653
2654 kw = bind_find_kw(args[cur_arg]);
2655 if (kw) {
2656 if (!kw->parse) {
2657 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2658 args[0], args[1], args[cur_arg]);
2659 goto err;
2660 }
2661
2662 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2663 if (err)
2664 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2665 else
2666 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2667 args[0], args[1], args[cur_arg]);
2668 goto err;
2669 }
2670
2671 cur_arg += 1 + kw->skip;
2672 continue;
2673 }
2674
2675 if (!bind_dumped) {
2676 bind_dump_kws(&err);
2677 indent_msg(&err, 4);
2678 bind_dumped = 1;
2679 }
2680
2681 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2682 args[0], args[1], args[cur_arg],
2683 err ? " Registered keywords :" : "", err ? err : "");
2684 goto err;
2685 }
2686
2687
2688 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002689 l->accept = session_accept_fd;
2690 l->default_target = mworker_proxy->default_target;
2691 /* don't make the peers subject to global limits and don't close it in the master */
2692 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2693 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002694 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002695 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002696 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002697
2698 return 0;
2699
2700err:
2701 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002702 free(err);
2703 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002704 return -1;
2705
2706}
2707
2708/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002709 * Create a new CLI socket using a socketpair for a worker process
2710 * <mworker_proc> is the process structure, and <proc> is the process number
2711 */
2712int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2713{
2714 struct bind_conf *bind_conf;
2715 struct listener *l;
2716 char *path = NULL;
2717 char *err = NULL;
2718
2719 /* master pipe to ensure the master is still alive */
2720 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2721 ha_alert("Cannot create worker socketpair.\n");
2722 return -1;
2723 }
2724
2725 /* XXX: we might want to use a separate frontend at some point */
2726 if (!global.stats_fe) {
2727 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2728 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002729 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002730 }
2731 }
2732
2733 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002734 if (!bind_conf)
2735 goto error;
2736
William Lallemandce83b4a2018-10-26 14:47:30 +02002737 bind_conf->level &= ~ACCESS_LVL_MASK;
2738 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2739
2740 bind_conf->bind_proc = 1UL << proc;
2741 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2742
2743 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2744 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002745 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002746 }
2747
2748 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002749 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002750 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002751 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002752 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002753 free(path);
2754 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002755
2756 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002757 l->accept = session_accept_fd;
2758 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002759 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002760 /* it's a sockpair but we don't want to keep the fd in the master */
2761 l->options &= ~LI_O_INHERITED;
2762 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002763 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002764 }
2765
2766 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002767
2768error:
2769 close(mworker_proc->ipc_fd[0]);
2770 close(mworker_proc->ipc_fd[1]);
2771 free(err);
2772
2773 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002774}
2775
William Lallemand74c24fb2016-11-21 17:18:36 +01002776static struct applet cli_applet = {
2777 .obj_type = OBJ_TYPE_APPLET,
2778 .name = "<CLI>", /* used for logging */
2779 .fct = cli_io_handler,
2780 .release = cli_release_handler,
2781};
2782
Willy Tarreau0a739292016-11-22 20:21:23 +01002783/* register cli keywords */
2784static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002785 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2786 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2787 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002788 { { "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 +01002789 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002790 { { "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 +01002791 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002792 { { "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 +02002793 { { "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 +01002794 { { "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 +02002795 { { "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 +01002796 { { "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 +01002797 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2798 { { "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 +02002799 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002800 {{},}
2801}};
2802
Willy Tarreau0108d902018-11-25 19:14:37 +01002803INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2804
William Lallemand74c24fb2016-11-21 17:18:36 +01002805static struct cfg_kw_list cfg_kws = {ILH, {
2806 { CFG_GLOBAL, "stats", stats_parse_global },
2807 { 0, NULL, NULL },
2808}};
2809
Willy Tarreau0108d902018-11-25 19:14:37 +01002810INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2811
William Lallemand74c24fb2016-11-21 17:18:36 +01002812static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002813 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2814 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002815 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002816 { NULL, NULL, 0 },
2817}};
2818
Willy Tarreau0108d902018-11-25 19:14:37 +01002819INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002820
2821/*
2822 * Local variables:
2823 * c-indent-level: 8
2824 * c-basic-offset: 8
2825 * End:
2826 */