blob: 97e3086e6056cba913420dfa31f937439e5948a8 [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>
33#include <common/memory.h>
34#include <common/mini-clist.h>
35#include <common/standard.h>
36#include <common/ticks.h>
37#include <common/time.h>
38#include <common/uri_auth.h>
39#include <common/version.h>
40#include <common/base64.h>
41
42#include <types/applet.h>
William Lallemand9ed62032016-11-21 17:49:11 +010043#include <types/cli.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010044#include <types/global.h>
45#include <types/dns.h>
William Lallemand9ed62032016-11-21 17:49:11 +010046#include <types/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010047
48#include <proto/backend.h>
49#include <proto/channel.h>
50#include <proto/checks.h>
51#include <proto/compression.h>
William Lallemand9ed62032016-11-21 17:49:11 +010052#include <proto/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010053#include <proto/fd.h>
54#include <proto/freq_ctr.h>
55#include <proto/frontend.h>
56#include <proto/log.h>
57#include <proto/pattern.h>
58#include <proto/pipe.h>
59#include <proto/listener.h>
60#include <proto/map.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010061#include <proto/proxy.h>
62#include <proto/sample.h>
63#include <proto/session.h>
64#include <proto/stream.h>
65#include <proto/server.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010066#include <proto/stream_interface.h>
67#include <proto/task.h>
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +020068#include <proto/proto_udp.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010069
William Lallemand74c24fb2016-11-21 17:18:36 +010070static struct applet cli_applet;
71
72static const char stats_sock_usage_msg[] =
73 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010074 " help : this message\n"
75 " prompt : toggle interactive mode with prompt\n"
76 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010077 "";
78
79static const char stats_permission_denied_msg[] =
80 "Permission denied\n"
81 "";
82
83
84static char *dynamic_usage_msg = NULL;
85
86/* List head of cli keywords */
87static struct cli_kw_list cli_keywords = {
88 .list = LIST_HEAD_INIT(cli_keywords.list)
89};
90
91extern const char *stat_status_codes[];
92
93char *cli_gen_usage_msg()
94{
95 struct cli_kw_list *kw_list;
96 struct cli_kw *kw;
97 struct chunk *tmp = get_trash_chunk();
98 struct chunk out;
99
100 free(dynamic_usage_msg);
101 dynamic_usage_msg = NULL;
102
103 if (LIST_ISEMPTY(&cli_keywords.list))
104 return NULL;
105
106 chunk_reset(tmp);
107 chunk_strcat(tmp, stats_sock_usage_msg);
108 list_for_each_entry(kw_list, &cli_keywords.list, list) {
109 kw = &kw_list->kw[0];
110 while (kw->usage) {
111 chunk_appendf(tmp, " %s\n", kw->usage);
112 kw++;
113 }
114 }
115 chunk_init(&out, NULL, 0);
116 chunk_dup(&out, tmp);
117 dynamic_usage_msg = out.str;
118 return dynamic_usage_msg;
119}
120
121struct cli_kw* cli_find_kw(char **args)
122{
123 struct cli_kw_list *kw_list;
124 struct cli_kw *kw;/* current cli_kw */
125 char **tmp_args;
126 const char **tmp_str_kw;
127 int found = 0;
128
129 if (LIST_ISEMPTY(&cli_keywords.list))
130 return NULL;
131
132 list_for_each_entry(kw_list, &cli_keywords.list, list) {
133 kw = &kw_list->kw[0];
134 while (*kw->str_kw) {
135 tmp_args = args;
136 tmp_str_kw = kw->str_kw;
137 while (*tmp_str_kw) {
138 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
139 found = 1;
140 } else {
141 found = 0;
142 break;
143 }
144 tmp_args++;
145 tmp_str_kw++;
146 }
147 if (found)
148 return (kw);
149 kw++;
150 }
151 }
152 return NULL;
153}
154
155void cli_register_kw(struct cli_kw_list *kw_list)
156{
157 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
158}
159
160
161/* allocate a new stats frontend named <name>, and return it
162 * (or NULL in case of lack of memory).
163 */
164static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
165{
166 struct proxy *fe;
167
168 fe = calloc(1, sizeof(*fe));
169 if (!fe)
170 return NULL;
171
172 init_new_proxy(fe);
173 fe->next = proxy;
174 proxy = fe;
175 fe->last_change = now.tv_sec;
176 fe->id = strdup("GLOBAL");
177 fe->cap = PR_CAP_FE;
178 fe->maxconn = 10; /* default to 10 concurrent connections */
179 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
180 fe->conf.file = strdup(file);
181 fe->conf.line = line;
182 fe->accept = frontend_accept;
183 fe->default_target = &cli_applet.obj_type;
184
185 /* the stats frontend is the only one able to assign ID #0 */
186 fe->conf.id.key = fe->uuid = 0;
187 eb32_insert(&used_proxy_id, &fe->conf.id);
188 return fe;
189}
190
191/* This function parses a "stats" statement in the "global" section. It returns
192 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
193 * error message into the <err> buffer which will be preallocated. The trailing
194 * '\n' must not be written. The function must be called with <args> pointing to
195 * the first word after "stats".
196 */
197static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
198 struct proxy *defpx, const char *file, int line,
199 char **err)
200{
201 struct bind_conf *bind_conf;
202 struct listener *l;
203
204 if (!strcmp(args[1], "socket")) {
205 int cur_arg;
206
207 if (*args[2] == 0) {
208 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
209 return -1;
210 }
211
212 if (!global.stats_fe) {
213 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
214 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
215 return -1;
216 }
217 }
218
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100219 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200220 bind_conf->level &= ~ACCESS_LVL_MASK;
221 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100222
223 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
224 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
225 file, line, args[0], args[1], err && *err ? *err : "error");
226 return -1;
227 }
228
229 cur_arg = 3;
230 while (*args[cur_arg]) {
231 static int bind_dumped;
232 struct bind_kw *kw;
233
234 kw = bind_find_kw(args[cur_arg]);
235 if (kw) {
236 if (!kw->parse) {
237 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
238 args[0], args[1], args[cur_arg]);
239 return -1;
240 }
241
242 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
243 if (err && *err)
244 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
245 else
246 memprintf(err, "'%s %s' : error encountered while processing '%s'",
247 args[0], args[1], args[cur_arg]);
248 return -1;
249 }
250
251 cur_arg += 1 + kw->skip;
252 continue;
253 }
254
255 if (!bind_dumped) {
256 bind_dump_kws(err);
257 indent_msg(err, 4);
258 bind_dumped = 1;
259 }
260
261 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
262 args[0], args[1], args[cur_arg],
263 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
264 return -1;
265 }
266
267 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
268 l->maxconn = global.stats_fe->maxconn;
269 l->backlog = global.stats_fe->backlog;
270 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100271 l->default_target = global.stats_fe->default_target;
272 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
273 l->nice = -64; /* we want to boost priority for local stats */
274 global.maxsock += l->maxconn;
275 }
276 }
277 else if (!strcmp(args[1], "timeout")) {
278 unsigned timeout;
279 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
280
281 if (res) {
282 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
283 return -1;
284 }
285
286 if (!timeout) {
287 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
288 return -1;
289 }
290 if (!global.stats_fe) {
291 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
292 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
293 return -1;
294 }
295 }
296 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
297 }
298 else if (!strcmp(args[1], "maxconn")) {
299 int maxconn = atol(args[2]);
300
301 if (maxconn <= 0) {
302 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
303 return -1;
304 }
305
306 if (!global.stats_fe) {
307 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
308 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
309 return -1;
310 }
311 }
312 global.stats_fe->maxconn = maxconn;
313 }
314 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
315 int cur_arg = 2;
316 unsigned long set = 0;
317
318 if (!global.stats_fe) {
319 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
320 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
321 return -1;
322 }
323 }
324
325 while (*args[cur_arg]) {
326 unsigned int low, high;
327
328 if (strcmp(args[cur_arg], "all") == 0) {
329 set = 0;
330 break;
331 }
332 else if (strcmp(args[cur_arg], "odd") == 0) {
333 set |= ~0UL/3UL; /* 0x555....555 */
334 }
335 else if (strcmp(args[cur_arg], "even") == 0) {
336 set |= (~0UL/3UL) << 1; /* 0xAAA...AAA */
337 }
338 else if (isdigit((int)*args[cur_arg])) {
339 char *dash = strchr(args[cur_arg], '-');
340
341 low = high = str2uic(args[cur_arg]);
342 if (dash)
343 high = str2uic(dash + 1);
344
345 if (high < low) {
346 unsigned int swap = low;
347 low = high;
348 high = swap;
349 }
350
351 if (low < 1 || high > LONGBITS) {
352 memprintf(err, "'%s %s' supports process numbers from 1 to %d.\n",
353 args[0], args[1], LONGBITS);
354 return -1;
355 }
356 while (low <= high)
357 set |= 1UL << (low++ - 1);
358 }
359 else {
360 memprintf(err,
361 "'%s %s' expects 'all', 'odd', 'even', or a list of process ranges with numbers from 1 to %d.\n",
362 args[0], args[1], LONGBITS);
363 return -1;
364 }
365 cur_arg++;
366 }
367 global.stats_fe->bind_proc = set;
368 }
369 else {
370 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
371 return -1;
372 }
373 return 0;
374}
375
Willy Tarreaude57a572016-11-23 17:01:39 +0100376/* Verifies that the CLI at least has a level at least as high as <level>
377 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
378 * failure, an error message is prepared and the appctx's state is adjusted
379 * to print it so that a return 1 is enough to abort any processing.
380 */
381int cli_has_level(struct appctx *appctx, int level)
382{
383 struct stream_interface *si = appctx->owner;
384 struct stream *s = si_strm(si);
385
William Lallemand07a62f72017-05-24 00:57:40 +0200386 if ((strm_li(s)->bind_conf->level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200387 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100388 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100389 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100390 return 0;
391 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100392 return 1;
393}
394
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200395/* Returns severity_output for the current session if set, or default for the socket */
396static int cli_get_severity_output(struct appctx *appctx)
397{
398 if (appctx->cli_severity_output)
399 return appctx->cli_severity_output;
400 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
401}
William Lallemand74c24fb2016-11-21 17:18:36 +0100402
Willy Tarreau41908562016-11-24 16:23:38 +0100403/* Processes the CLI interpreter on the stats socket. This function is called
404 * from the CLI's IO handler running in an appctx context. The function returns 1
405 * if the request was understood, otherwise zero. It is called with appctx->st0
406 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
407 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
408 * have its own I/O handler called again. Most of the time, parsers will only
409 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100410 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
411 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100412 */
Willy Tarreau41908562016-11-24 16:23:38 +0100413static int cli_parse_request(struct appctx *appctx, char *line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100414{
William Lallemand74c24fb2016-11-21 17:18:36 +0100415 char *args[MAX_STATS_ARGS + 1];
416 struct cli_kw *kw;
417 int arg;
418 int i, j;
419
420 while (isspace((unsigned char)*line))
421 line++;
422
423 arg = 0;
424 args[arg] = line;
425
426 while (*line && arg < MAX_STATS_ARGS) {
427 if (*line == '\\') {
428 line++;
429 if (*line == '\0')
430 break;
431 }
432 else if (isspace((unsigned char)*line)) {
433 *line++ = '\0';
434
435 while (isspace((unsigned char)*line))
436 line++;
437
438 args[++arg] = line;
439 continue;
440 }
441
442 line++;
443 }
444
445 while (++arg <= MAX_STATS_ARGS)
446 args[arg] = line;
447
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100448 /* unescape '\' */
William Lallemand74c24fb2016-11-21 17:18:36 +0100449 arg = 0;
450 while (*args[arg] != '\0') {
451 j = 0;
452 for (i=0; args[arg][i] != '\0'; i++) {
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100453 if (args[arg][i] == '\\') {
454 if (args[arg][i+1] == '\\')
455 i++;
456 else
457 continue;
458 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100459 args[arg][j] = args[arg][i];
460 j++;
461 }
462 args[arg][j] = '\0';
463 arg++;
464 }
465
Willy Tarreau41908562016-11-24 16:23:38 +0100466 appctx->st2 = 0;
Willy Tarreaua2d58722016-12-16 12:37:03 +0100467 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
Willy Tarreau41908562016-11-24 16:23:38 +0100468
469 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100470 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100471 return 0;
472
473 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200474 appctx->io_release = kw->io_release;
475 /* kw->parse could set its own io_handler or ip_release handler */
Willy Tarreaueaffde32016-12-16 17:59:25 +0100476 if ((!kw->parse || kw->parse(args, appctx, kw->private) == 0) && appctx->io_handler) {
Willy Tarreau41908562016-11-24 16:23:38 +0100477 appctx->st0 = CLI_ST_CALLBACK;
William Lallemand74c24fb2016-11-21 17:18:36 +0100478 }
Willy Tarreau41908562016-11-24 16:23:38 +0100479 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100480}
481
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200482/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
483static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
484{
485 struct chunk *tmp;
486
487 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200488 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200489
490 tmp = get_trash_chunk();
491 chunk_reset(tmp);
492
493 if (severity < 0 || severity > 7) {
494 Warning("socket command feedback with invalid severity %d", severity);
495 chunk_printf(tmp, "[%d]: ", severity);
496 }
497 else {
498 switch (severity_output) {
499 case CLI_SEVERITY_NUMBER:
500 chunk_printf(tmp, "[%d]: ", severity);
501 break;
502 case CLI_SEVERITY_STRING:
503 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
504 break;
505 default:
506 Warning("Unrecognized severity output %d", severity_output);
507 }
508 }
509 chunk_appendf(tmp, "%s", msg);
510
Willy Tarreau06d80a92017-10-19 14:32:15 +0200511 return ci_putblk(chn, tmp->str, strlen(tmp->str));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200512}
513
William Lallemand74c24fb2016-11-21 17:18:36 +0100514/* This I/O handler runs as an applet embedded in a stream interface. It is
515 * used to processes I/O from/to the stats unix socket. The system relies on a
516 * state machine handling requests and various responses. We read a request,
517 * then we process it and send the response, and we possibly display a prompt.
518 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100519 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100520 * or not.
521 */
522static void cli_io_handler(struct appctx *appctx)
523{
524 struct stream_interface *si = appctx->owner;
525 struct channel *req = si_oc(si);
526 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200527 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100528 int reql;
529 int len;
530
531 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
532 goto out;
533
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100534 /* Check if the input buffer is avalaible. */
535 if (res->buf->size == 0) {
536 si_applet_cant_put(si);
537 goto out;
538 }
539
William Lallemand74c24fb2016-11-21 17:18:36 +0100540 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100541 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 /* Stats output not initialized yet */
543 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200544 /* reset severity to default at init */
545 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100546 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100547 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100548 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100549 /* Let's close for real now. We just close the request
550 * side, the conditions below will complete if needed.
551 */
552 si_shutw(si);
553 break;
554 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100555 else if (appctx->st0 == CLI_ST_GETREQ) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100556 /* ensure we have some output room left in the event we
557 * would want to return some info right after parsing.
558 */
559 if (buffer_almost_full(si_ib(si))) {
560 si_applet_cant_put(si);
561 break;
562 }
563
Willy Tarreau06d80a92017-10-19 14:32:15 +0200564 reql = co_getline(si_oc(si), trash.str, trash.size);
William Lallemand74c24fb2016-11-21 17:18:36 +0100565 if (reql <= 0) { /* closed or EOL not found */
566 if (reql == 0)
567 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100568 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100569 continue;
570 }
571
572 /* seek for a possible unescaped semi-colon. If we find
573 * one, we replace it with an LF and skip only this part.
574 */
575 for (len = 0; len < reql; len++) {
576 if (trash.str[len] == '\\') {
577 len++;
578 continue;
579 }
580 if (trash.str[len] == ';') {
581 trash.str[len] = '\n';
582 reql = len + 1;
583 break;
584 }
585 }
586
587 /* now it is time to check that we have a full line,
588 * remove the trailing \n and possibly \r, then cut the
589 * line.
590 */
591 len = reql - 1;
592 if (trash.str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100593 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100594 continue;
595 }
596
597 if (len && trash.str[len-1] == '\r')
598 len--;
599
600 trash.str[len] = '\0';
601
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100602 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100603 if (len) {
604 if (strcmp(trash.str, "quit") == 0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100605 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100606 continue;
607 }
608 else if (strcmp(trash.str, "prompt") == 0)
609 appctx->st1 = !appctx->st1;
610 else if (strcmp(trash.str, "help") == 0 ||
Willy Tarreau41908562016-11-24 16:23:38 +0100611 !cli_parse_request(appctx, trash.str)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100612 cli_gen_usage_msg();
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200613 if (dynamic_usage_msg) {
614 appctx->ctx.cli.severity = LOG_INFO;
William Lallemand74c24fb2016-11-21 17:18:36 +0100615 appctx->ctx.cli.msg = dynamic_usage_msg;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200616 }
617 else {
618 appctx->ctx.cli.severity = LOG_INFO;
William Lallemand74c24fb2016-11-21 17:18:36 +0100619 appctx->ctx.cli.msg = stats_sock_usage_msg;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200620 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100621 appctx->st0 = CLI_ST_PRINT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100622 }
623 /* NB: stats_sock_parse_request() may have put
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100624 * another CLI_ST_O_* into appctx->st0.
William Lallemand74c24fb2016-11-21 17:18:36 +0100625 */
626 }
627 else if (!appctx->st1) {
628 /* if prompt is disabled, print help on empty lines,
629 * so that the user at least knows how to enable
630 * prompt and find help.
631 */
632 cli_gen_usage_msg();
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200633 if (dynamic_usage_msg) {
634 appctx->ctx.cli.severity = LOG_INFO;
William Lallemand74c24fb2016-11-21 17:18:36 +0100635 appctx->ctx.cli.msg = dynamic_usage_msg;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200636 }
637 else {
638 appctx->ctx.cli.severity = LOG_INFO;
William Lallemand74c24fb2016-11-21 17:18:36 +0100639 appctx->ctx.cli.msg = stats_sock_usage_msg;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200640 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100641 appctx->st0 = CLI_ST_PRINT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100642 }
643
644 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200645 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100646 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
647 }
648 else { /* output functions */
649 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100650 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100651 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100652 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200653 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
654 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100655 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100656 else
657 si_applet_cant_put(si);
658 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100659 case CLI_ST_PRINT_FREE:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200660 if (cli_output_msg(res, appctx->ctx.cli.err, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100661 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100662 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100663 }
664 else
665 si_applet_cant_put(si);
666 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100667 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100668 if (appctx->io_handler)
669 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100670 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100671 if (appctx->io_release) {
672 appctx->io_release(appctx);
673 appctx->io_release = NULL;
674 }
675 }
676 break;
677 default: /* abnormal state */
678 si->flags |= SI_FL_ERR;
679 break;
680 }
681
682 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100683 if (appctx->st0 == CLI_ST_PROMPT) {
Willy Tarreau06d80a92017-10-19 14:32:15 +0200684 if (ci_putstr(si_ic(si), appctx->st1 ? "\n> " : "\n") != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100685 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100686 else
687 si_applet_cant_put(si);
688 }
689
690 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100691 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100692 break;
693
694 /* Now we close the output if one of the writers did so,
695 * or if we're not in interactive mode and the request
696 * buffer is empty. This still allows pipelined requests
697 * to be sent in non-interactive mode.
698 */
699 if ((res->flags & (CF_SHUTW|CF_SHUTW_NOW)) || (!appctx->st1 && !req->buf->o)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100700 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100701 continue;
702 }
703
704 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100705 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100706 }
707 }
708
709 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
710 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
711 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
712 /* Other side has closed, let's abort if we have no more processing to do
713 * and nothing more to consume. This is comparable to a broken pipe, so
714 * we forward the close to the request side so that it flows upstream to
715 * the client.
716 */
717 si_shutw(si);
718 }
719
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100720 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100721 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
722 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
723 /* We have no more processing to do, and nothing more to send, and
724 * the client side has closed. So we'll forward this state downstream
725 * on the response buffer.
726 */
727 si_shutr(si);
728 res->flags |= CF_READ_NULL;
729 }
730
731 out:
732 DPRINTF(stderr, "%s@%d: st=%d, rqf=%x, rpf=%x, rqh=%d, rqs=%d, rh=%d, rs=%d\n",
733 __FUNCTION__, __LINE__,
734 si->state, req->flags, res->flags, req->buf->i, req->buf->o, res->buf->i, res->buf->o);
735}
736
William Lallemand74c24fb2016-11-21 17:18:36 +0100737/* This is called when the stream interface is closed. For instance, upon an
738 * external abort, we won't call the i/o handler anymore so we may need to
739 * remove back references to the stream currently being dumped.
740 */
741static void cli_release_handler(struct appctx *appctx)
742{
743 if (appctx->io_release) {
744 appctx->io_release(appctx);
745 appctx->io_release = NULL;
746 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100747 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100748 free(appctx->ctx.cli.err);
749 appctx->ctx.cli.err = NULL;
750 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100751}
752
753/* This function dumps all environmnent variables to the buffer. It returns 0
754 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100755 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
756 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100757 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100758static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100759{
Willy Tarreau0a739292016-11-22 20:21:23 +0100760 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100761 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100762
763 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
764 return 1;
765
766 chunk_reset(&trash);
767
768 /* we have two inner loops here, one for the proxy, the other one for
769 * the buffer.
770 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100771 while (*var) {
772 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100773
Willy Tarreau06d80a92017-10-19 14:32:15 +0200774 if (ci_putchk(si_ic(si), &trash) == -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100775 si_applet_cant_put(si);
776 return 0;
777 }
778 if (appctx->st2 == STAT_ST_END)
779 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100780 var++;
781 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100782 }
783
784 /* dump complete */
785 return 1;
786}
787
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200788/* This function dumps all file descriptors states (or the requested one) to
789 * the buffer. It returns 0 if the output buffer is full and it needs to be
790 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
791 * It uses cli.i0 as the fd number to restart from.
792 */
793static int cli_io_handler_show_fd(struct appctx *appctx)
794{
795 struct stream_interface *si = appctx->owner;
796 int fd = appctx->ctx.cli.i0;
797
798 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
799 return 1;
800
801 chunk_reset(&trash);
802
803 /* we have two inner loops here, one for the proxy, the other one for
804 * the buffer.
805 */
806 while (fd < maxfd) {
807 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200808 struct listener *li = NULL;
809 struct server *sv = NULL;
810 struct proxy *px = NULL;
811 uint32_t conn_flags = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200812
813 fdt = fdtab[fd];
814
Willy Tarreau017af242017-10-04 20:24:54 +0200815 if (!fdt.owner)
816 goto skip; // closed
817
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200818 if (fdt.iocb == conn_fd_handler) {
819 conn_flags = ((struct connection *)fdt.owner)->flags;
820 li = objt_listener(((struct connection *)fdt.owner)->target);
821 sv = objt_server(((struct connection *)fdt.owner)->target);
822 px = objt_proxy(((struct connection *)fdt.owner)->target);
823 }
824 else if (fdt.iocb == listener_accept)
825 li = fdt.owner;
826
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200827 chunk_printf(&trash,
828 " %5d : st=0x%02x(R:%c%c%c W:%c%c%c) ev=0x%02x(%c%c%c%c%c) [%c%c%c%c] cache=%u owner=%p iocb=%p(%s)",
829 fd,
830 fdt.state,
831 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
832 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
833 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
834 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
835 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
836 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
837 fdt.ev,
838 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
839 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
840 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
841 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
842 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
843 fdt.new ? 'N' : 'n',
844 fdt.updated ? 'U' : 'u',
845 fdt.linger_risk ? 'L' : 'l',
846 fdt.cloned ? 'C' : 'c',
847 fdt.cache,
848 fdt.owner,
849 fdt.iocb,
850 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
851 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
852 (fdt.iocb == listener_accept) ? "listener_accept" :
853 "unknown");
854
855 if (fdt.iocb == conn_fd_handler) {
856 chunk_appendf(&trash, " cflg=0x%08x", conn_flags);
857 if (px)
858 chunk_appendf(&trash, " px=%s", px->id);
859 else if (sv)
860 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
861 else if (li)
862 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
863 }
864 else if (fdt.iocb == listener_accept) {
865 chunk_appendf(&trash, " l.st=%s fe=%s",
866 listener_state_str(li),
867 li->bind_conf->frontend->id);
868 }
869
870 chunk_appendf(&trash, "\n");
871
Willy Tarreau06d80a92017-10-19 14:32:15 +0200872 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200873 si_applet_cant_put(si);
874 return 0;
875 }
876 skip:
877 if (appctx->st2 == STAT_ST_END)
878 break;
879
880 fd++;
881 appctx->ctx.cli.i0 = fd;
882 }
883
884 /* dump complete */
885 return 1;
886}
887
William Lallemandeceddf72016-12-15 18:06:44 +0100888/*
Willy Tarreau3af9d832016-12-16 12:58:09 +0100889 * CLI IO handler for `show cli sockets`.
890 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +0100891 */
892static int cli_io_handler_show_cli_sock(struct appctx *appctx)
893{
894 struct bind_conf *bind_conf;
895 struct stream_interface *si = appctx->owner;
896
897 chunk_reset(&trash);
898
899 switch (appctx->st2) {
900 case STAT_ST_INIT:
901 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +0200902 if (ci_putchk(si_ic(si), &trash) == -1) {
William Lallemandeceddf72016-12-15 18:06:44 +0100903 si_applet_cant_put(si);
904 return 0;
905 }
William Lallemandeceddf72016-12-15 18:06:44 +0100906 appctx->st2 = STAT_ST_LIST;
907
908 case STAT_ST_LIST:
909 if (global.stats_fe) {
910 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
911 struct listener *l;
912
913 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +0100914 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +0100915 * if the current node is the first of the list
916 */
917
Willy Tarreau3af9d832016-12-16 12:58:09 +0100918 if (appctx->ctx.cli.p0 &&
919 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +0100920 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +0100921 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +0100922 continue;
923 }
924
925 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
926
927 char addr[46];
928 char port[6];
929
930 if (l->addr.ss_family == AF_UNIX) {
931 const struct sockaddr_un *un;
932
933 un = (struct sockaddr_un *)&l->addr;
934 chunk_appendf(&trash, "%s ", un->sun_path);
935 } else if (l->addr.ss_family == AF_INET) {
936 addr_to_str(&l->addr, addr, sizeof(addr));
937 port_to_str(&l->addr, port, sizeof(port));
938 chunk_appendf(&trash, "%s:%s ", addr, port);
939 } else if (l->addr.ss_family == AF_INET6) {
940 addr_to_str(&l->addr, addr, sizeof(addr));
941 port_to_str(&l->addr, port, sizeof(port));
942 chunk_appendf(&trash, "[%s]:%s ", addr, port);
943 } else
944 continue;
945
William Lallemand07a62f72017-05-24 00:57:40 +0200946 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +0100947 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +0200948 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
949 chunk_appendf(&trash, "operator ");
950 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
951 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +0100952 else
953 chunk_appendf(&trash, " ");
954
955 if (bind_conf->bind_proc != 0) {
956 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +0100957 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +0100958 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +0100959 chunk_appendf(&trash, "%d,", pos+1);
960 }
961 }
962 /* replace the latest comma by a newline */
963 trash.str[trash.len-1] = '\n';
964
965 } else {
966 chunk_appendf(&trash, "all\n");
967 }
968
Willy Tarreau06d80a92017-10-19 14:32:15 +0200969 if (ci_putchk(si_ic(si), &trash) == -1) {
William Lallemandeceddf72016-12-15 18:06:44 +0100970 si_applet_cant_put(si);
971 return 0;
972 }
973 }
Willy Tarreau3af9d832016-12-16 12:58:09 +0100974 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +0100975 }
976 }
977 default:
978 appctx->st2 = STAT_ST_FIN;
979 return 1;
980 }
981}
982
983
Willy Tarreau0a739292016-11-22 20:21:23 +0100984/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +0100985 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
986 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +0100987 */
988static int cli_parse_show_env(char **args, struct appctx *appctx, void *private)
989{
990 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100991 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +0100992
993 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
994 return 1;
995
Willy Tarreauf6710f82016-12-16 17:45:44 +0100996 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +0100997
998 if (*args[2]) {
999 int len = strlen(args[2]);
1000
Willy Tarreauf6710f82016-12-16 17:45:44 +01001001 for (; *var; var++) {
1002 if (strncmp(*var, args[2], len) == 0 &&
1003 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001004 break;
1005 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001006 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001007 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001008 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001009 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001010 return 1;
1011 }
1012 appctx->st2 = STAT_ST_END;
1013 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001014 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001015 return 0;
1016}
1017
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001018/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1019 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1020 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1021 */
1022static int cli_parse_show_fd(char **args, struct appctx *appctx, void *private)
1023{
1024 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1025 return 1;
1026
1027 appctx->ctx.cli.i0 = 0;
1028
1029 if (*args[2]) {
1030 appctx->ctx.cli.i0 = atoi(args[2]);
1031 appctx->st2 = STAT_ST_END;
1032 }
1033 return 0;
1034}
1035
Willy Tarreau599852e2016-11-22 20:33:32 +01001036/* parse a "set timeout" CLI request. It always returns 1. */
1037static int cli_parse_set_timeout(char **args, struct appctx *appctx, void *private)
1038{
1039 struct stream_interface *si = appctx->owner;
1040 struct stream *s = si_strm(si);
1041
1042 if (strcmp(args[2], "cli") == 0) {
1043 unsigned timeout;
1044 const char *res;
1045
1046 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001047 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001048 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001049 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001050 return 1;
1051 }
1052
1053 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1054 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001055 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001056 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001057 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001058 return 1;
1059 }
1060
1061 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1062 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1063 return 1;
1064 }
1065 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001066 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001067 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001068 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001069 return 1;
1070 }
1071}
1072
Willy Tarreau2af99412016-11-23 11:10:59 +01001073/* parse a "set maxconn global" command. It always returns 1. */
1074static int cli_parse_set_maxconn_global(char **args, struct appctx *appctx, void *private)
1075{
1076 int v;
1077
1078 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1079 return 1;
1080
1081 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001082 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001083 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001084 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001085 return 1;
1086 }
1087
1088 v = atoi(args[3]);
1089 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001090 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001091 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001092 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001093 return 1;
1094 }
1095
1096 /* check for unlimited values */
1097 if (v <= 0)
1098 v = global.hardmaxconn;
1099
1100 global.maxconn = v;
1101
1102 /* Dequeues all of the listeners waiting for a resource */
1103 if (!LIST_ISEMPTY(&global_listener_queue))
1104 dequeue_all_listeners(&global_listener_queue);
1105
1106 return 1;
1107}
1108
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001109static int set_severity_output(int *target, char *argument)
1110{
1111 if (!strcmp(argument, "none")) {
1112 *target = CLI_SEVERITY_NONE;
1113 return 1;
1114 }
1115 else if (!strcmp(argument, "number")) {
1116 *target = CLI_SEVERITY_NUMBER;
1117 return 1;
1118 }
1119 else if (!strcmp(argument, "string")) {
1120 *target = CLI_SEVERITY_STRING;
1121 return 1;
1122 }
1123 return 0;
1124}
1125
1126/* parse a "set severity-output" command. */
1127static int cli_parse_set_severity_output(char **args, struct appctx *appctx, void *private)
1128{
1129 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1130 return 0;
1131
1132 appctx->ctx.cli.severity = LOG_ERR;
1133 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument";
1134 appctx->st0 = CLI_ST_PRINT;
1135 return 1;
1136}
William Lallemandeceddf72016-12-15 18:06:44 +01001137
1138int cli_parse_default(char **args, struct appctx *appctx, void *private)
1139{
1140 return 0;
1141}
1142
Willy Tarreau45c742b2016-11-24 14:51:17 +01001143/* parse a "set rate-limit" command. It always returns 1. */
1144static int cli_parse_set_ratelimit(char **args, struct appctx *appctx, void *private)
1145{
1146 int v;
1147 int *res;
1148 int mul = 1;
1149
1150 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1151 return 1;
1152
1153 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1154 res = &global.cps_lim;
1155 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1156 res = &global.sps_lim;
1157#ifdef USE_OPENSSL
1158 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1159 res = &global.ssl_lim;
1160#endif
1161 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1162 res = &global.comp_rate_lim;
1163 mul = 1024;
1164 }
1165 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001166 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001167 appctx->ctx.cli.msg =
1168 "'set rate-limit' only supports :\n"
1169 " - 'connections global' to set the per-process maximum connection rate\n"
1170 " - 'sessions global' to set the per-process maximum session rate\n"
1171#ifdef USE_OPENSSL
1172 " - 'ssl-session global' to set the per-process maximum SSL session rate\n"
1173#endif
1174 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001175 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001176 return 1;
1177 }
1178
1179 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001180 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001181 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001182 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001183 return 1;
1184 }
1185
1186 v = atoi(args[4]);
1187 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001188 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001189 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001190 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001191 return 1;
1192 }
1193
1194 *res = v * mul;
1195
1196 /* Dequeues all of the listeners waiting for a resource */
1197 if (!LIST_ISEMPTY(&global_listener_queue))
1198 dequeue_all_listeners(&global_listener_queue);
1199
1200 return 1;
1201}
1202
William Lallemandf6975e92017-05-26 17:42:10 +02001203/* parse the "expose-fd" argument on the bind lines */
1204static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1205{
1206 if (!*args[cur_arg + 1]) {
1207 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1208 return ERR_ALERT | ERR_FATAL;
1209 }
1210 if (!strcmp(args[cur_arg+1], "listeners")) {
1211 conf->level |= ACCESS_FD_LISTENERS;
1212 } else {
1213 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1214 args[cur_arg], args[cur_arg+1]);
1215 return ERR_ALERT | ERR_FATAL;
1216 }
1217
1218 return 0;
1219}
1220
William Lallemand74c24fb2016-11-21 17:18:36 +01001221/* parse the "level" argument on the bind lines */
1222static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1223{
1224 if (!*args[cur_arg + 1]) {
1225 memprintf(err, "'%s' : missing level", args[cur_arg]);
1226 return ERR_ALERT | ERR_FATAL;
1227 }
1228
William Lallemand07a62f72017-05-24 00:57:40 +02001229 if (!strcmp(args[cur_arg+1], "user")) {
1230 conf->level &= ~ACCESS_LVL_MASK;
1231 conf->level |= ACCESS_LVL_USER;
1232 } else if (!strcmp(args[cur_arg+1], "operator")) {
1233 conf->level &= ~ACCESS_LVL_MASK;
1234 conf->level |= ACCESS_LVL_OPER;
1235 } else if (!strcmp(args[cur_arg+1], "admin")) {
1236 conf->level &= ~ACCESS_LVL_MASK;
1237 conf->level |= ACCESS_LVL_ADMIN;
1238 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001239 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1240 args[cur_arg], args[cur_arg+1]);
1241 return ERR_ALERT | ERR_FATAL;
1242 }
1243
1244 return 0;
1245}
1246
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001247static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1248{
1249 if (!*args[cur_arg + 1]) {
1250 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1251 return ERR_ALERT | ERR_FATAL;
1252 }
1253
1254 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1255 return 0;
1256 else {
1257 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1258 args[cur_arg], args[cur_arg+1]);
1259 return ERR_ALERT | ERR_FATAL;
1260 }
1261}
1262
Olivier Houchardf886e342017-04-05 22:24:59 +02001263/* Send all the bound sockets, always returns 1 */
1264static int _getsocks(char **args, struct appctx *appctx, void *private)
1265{
1266 char *cmsgbuf = NULL;
1267 unsigned char *tmpbuf = NULL;
1268 struct cmsghdr *cmsg;
1269 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001270 struct stream *s = si_strm(si);
Olivier Houchardf886e342017-04-05 22:24:59 +02001271 struct connection *remote = objt_conn(si_opposite(si)->end);
1272 struct msghdr msghdr;
1273 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001274 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001275 int *tmpfd;
1276 int tot_fd_nb = 0;
1277 struct proxy *px;
1278 int i = 0;
Willy Tarreau585744b2017-08-24 14:31:19 +02001279 int fd = remote->handle.fd;
Olivier Houchardf886e342017-04-05 22:24:59 +02001280 int curoff = 0;
1281 int old_fcntl;
1282 int ret;
1283
1284 /* Temporary set the FD in blocking mode, that will make our life easier */
1285 old_fcntl = fcntl(fd, F_GETFL);
1286 if (old_fcntl < 0) {
1287 Warning("Couldn't get the flags for the unix socket\n");
1288 goto out;
1289 }
1290 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1291 if (!cmsgbuf) {
1292 Warning("Failed to allocate memory to send sockets\n");
1293 goto out;
1294 }
1295 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
1296 Warning("Cannot make the unix socket blocking\n");
1297 goto out;
1298 }
Olivier Houchard54740872017-04-06 14:45:14 +02001299 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001300 iov.iov_base = &tot_fd_nb;
1301 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001302 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001303 goto out;
1304 memset(&msghdr, 0, sizeof(msghdr));
1305 /*
1306 * First, calculates the total number of FD, so that we can let
1307 * the caller know how much he should expects.
1308 */
1309 px = proxy;
1310 while (px) {
1311 struct listener *l;
1312
1313 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001314 /* Only transfer IPv4/IPv6/UNIX sockets */
1315 if (l->state >= LI_ZOMBIE &&
1316 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001317 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001318 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001319 tot_fd_nb++;
1320 }
1321 px = px->next;
1322 }
1323 if (tot_fd_nb == 0)
1324 goto out;
1325
1326 /* First send the total number of file descriptors, so that the
1327 * receiving end knows what to expect.
1328 */
1329 msghdr.msg_iov = &iov;
1330 msghdr.msg_iovlen = 1;
1331 ret = sendmsg(fd, &msghdr, 0);
1332 if (ret != sizeof(tot_fd_nb)) {
1333 Warning("Failed to send the number of sockets to send\n");
1334 goto out;
1335 }
1336
1337 /* Now send the fds */
1338 msghdr.msg_control = cmsgbuf;
1339 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1340 cmsg = CMSG_FIRSTHDR(&msghdr);
1341 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1342 cmsg->cmsg_level = SOL_SOCKET;
1343 cmsg->cmsg_type = SCM_RIGHTS;
1344 tmpfd = (int *)CMSG_DATA(cmsg);
1345
1346 px = proxy;
1347 /* For each socket, e message is sent, containing the following :
1348 * Size of the namespace name (or 0 if none), as an unsigned char.
1349 * The namespace name, if any
1350 * Size of the interface name (or 0 if none), as an unsigned char
1351 * The interface name, if any
1352 * Listener options, as an int.
1353 */
1354 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1355 * buffer big enough to store the socket informations.
1356 */
1357 tmpbuf = malloc(MAX_SEND_FD * (1 + NAME_MAX + 1 + IFNAMSIZ + sizeof(int)));
1358 if (tmpbuf == NULL) {
1359 Warning("Failed to allocate memory to transfer socket informations\n");
1360 goto out;
1361 }
1362 iov.iov_base = tmpbuf;
1363 while (px) {
1364 struct listener *l;
1365
1366 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1367 int ret;
1368 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001369 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001370 (l->proto->sock_family == AF_INET ||
1371 l->proto->sock_family == AF_INET6 ||
1372 l->proto->sock_family == AF_UNIX)) {
1373 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1374 if (!l->netns)
1375 tmpbuf[curoff++] = 0;
1376#ifdef CONFIG_HAP_NS
1377 else {
1378 char *name = l->netns->node.key;
1379 unsigned char len = l->netns->name_len;
1380 tmpbuf[curoff++] = len;
1381 memcpy(tmpbuf + curoff, name, len);
1382 curoff += len;
1383 }
1384#endif
1385 if (l->interface) {
1386 unsigned char len = strlen(l->interface);
1387 tmpbuf[curoff++] = len;
1388 memcpy(tmpbuf + curoff, l->interface, len);
1389 curoff += len;
1390 } else
1391 tmpbuf[curoff++] = 0;
1392 memcpy(tmpbuf + curoff, &l->options,
1393 sizeof(l->options));
1394 curoff += sizeof(l->options);
1395
1396
1397 i++;
1398 } else
1399 continue;
1400 if ((!(i % MAX_SEND_FD))) {
1401 iov.iov_len = curoff;
1402 if (sendmsg(fd, &msghdr, 0) != curoff) {
1403 Warning("Failed to transfer sockets\n");
1404 printf("errno %d\n", errno);
1405 goto out;
1406 }
1407 /* Wait for an ack */
1408 do {
1409 ret = recv(fd, &tot_fd_nb,
1410 sizeof(tot_fd_nb), 0);
1411 } while (ret == -1 && errno == EINTR);
1412 if (ret <= 0) {
1413 Warning("Unexpected error while transferring sockets\n");
1414 goto out;
1415 }
1416 curoff = 0;
1417 }
1418
1419 }
1420 px = px->next;
1421 }
1422 if (i % MAX_SEND_FD) {
1423 iov.iov_len = curoff;
1424 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1425 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1426 if (sendmsg(fd, &msghdr, 0) != curoff) {
1427 Warning("Failed to transfer sockets\n");
1428 goto out;
1429 }
1430 }
1431
1432out:
1433 if (old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
1434 Warning("Cannot make the unix socket non-blocking\n");
1435 goto out;
1436 }
1437 appctx->st0 = CLI_ST_END;
1438 free(cmsgbuf);
1439 free(tmpbuf);
1440 return 1;
1441}
1442
1443
1444
William Lallemand74c24fb2016-11-21 17:18:36 +01001445static struct applet cli_applet = {
1446 .obj_type = OBJ_TYPE_APPLET,
1447 .name = "<CLI>", /* used for logging */
1448 .fct = cli_io_handler,
1449 .release = cli_release_handler,
1450};
1451
Willy Tarreau0a739292016-11-22 20:21:23 +01001452/* register cli keywords */
1453static struct cli_kw_list cli_kws = {{ },{
Willy Tarreau2af99412016-11-23 11:10:59 +01001454 { { "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 +01001455 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001456 { { "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 +01001457 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01001458 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
William Lallemandeceddf72016-12-15 18:06:44 +01001459 { { "show", "cli", "sockets", NULL }, "show cli sockets : dump list of cli sockets", cli_parse_default, cli_io_handler_show_cli_sock, NULL },
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001460 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
Olivier Houchardf886e342017-04-05 22:24:59 +02001461 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01001462 {{},}
1463}};
1464
William Lallemand74c24fb2016-11-21 17:18:36 +01001465static struct cfg_kw_list cfg_kws = {ILH, {
1466 { CFG_GLOBAL, "stats", stats_parse_global },
1467 { 0, NULL, NULL },
1468}};
1469
1470static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02001471 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
1472 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001473 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01001474 { NULL, NULL, 0 },
1475}};
1476
1477__attribute__((constructor))
1478static void __dumpstats_module_init(void)
1479{
1480 cfg_register_keywords(&cfg_kws);
Willy Tarreau0a739292016-11-22 20:21:23 +01001481 cli_register_kw(&cli_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01001482 bind_register_keywords(&bind_kws);
1483}
1484
1485/*
1486 * Local variables:
1487 * c-indent-level: 8
1488 * c-basic-offset: 8
1489 * End:
1490 */