blob: 6e7c3d0c9be0e78daa81663d060b44fd6b866e9f [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>
William Lallemandce83b4a2018-10-26 14:47:30 +020059#include <proto/protocol.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010060#include <proto/listener.h>
61#include <proto/map.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010062#include <proto/proxy.h>
63#include <proto/sample.h>
64#include <proto/session.h>
65#include <proto/stream.h>
66#include <proto/server.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010067#include <proto/stream_interface.h>
68#include <proto/task.h>
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +020069#include <proto/proto_udp.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010070
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020071#define PAYLOAD_PATTERN "<<"
72
William Lallemand74c24fb2016-11-21 17:18:36 +010073static struct applet cli_applet;
74
75static const char stats_sock_usage_msg[] =
76 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010077 " help : this message\n"
78 " prompt : toggle interactive mode with prompt\n"
79 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010080 "";
81
82static const char stats_permission_denied_msg[] =
83 "Permission denied\n"
84 "";
85
86
Christopher Faulet1bc04c72017-10-29 20:14:08 +010087static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010088
89/* List head of cli keywords */
90static struct cli_kw_list cli_keywords = {
91 .list = LIST_HEAD_INIT(cli_keywords.list)
92};
93
94extern const char *stat_status_codes[];
95
William Lallemand14721be2018-10-26 14:47:37 +020096extern int master;
97
William Lallemand8a022572018-10-26 14:47:35 +020098static struct proxy *mworker_proxy; /* CLI proxy of the master */
99
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200100static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100101{
102 struct cli_kw_list *kw_list;
103 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200104 struct buffer *tmp = get_trash_chunk();
105 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100106
107 free(dynamic_usage_msg);
108 dynamic_usage_msg = NULL;
109
110 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200111 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100112
113 chunk_reset(tmp);
114 chunk_strcat(tmp, stats_sock_usage_msg);
115 list_for_each_entry(kw_list, &cli_keywords.list, list) {
116 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200117 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200118
119 /* in a worker or normal process, don't display master only commands */
120 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
121 goto next_kw;
122
123 /* in master don't displays if we don't have the master bits */
124 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
125 goto next_kw;
126
William Lallemand0154edc2018-05-15 11:50:04 +0200127 if (kw->usage)
128 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200129
130next_kw:
131
William Lallemand74c24fb2016-11-21 17:18:36 +0100132 kw++;
133 }
134 }
135 chunk_init(&out, NULL, 0);
136 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200137 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200138
139end:
140 if (dynamic_usage_msg) {
141 appctx->ctx.cli.severity = LOG_INFO;
142 appctx->ctx.cli.msg = dynamic_usage_msg;
143 }
144 else {
145 appctx->ctx.cli.severity = LOG_INFO;
146 appctx->ctx.cli.msg = stats_sock_usage_msg;
147 }
148 appctx->st0 = CLI_ST_PRINT;
149
William Lallemand74c24fb2016-11-21 17:18:36 +0100150 return dynamic_usage_msg;
151}
152
153struct cli_kw* cli_find_kw(char **args)
154{
155 struct cli_kw_list *kw_list;
156 struct cli_kw *kw;/* current cli_kw */
157 char **tmp_args;
158 const char **tmp_str_kw;
159 int found = 0;
160
161 if (LIST_ISEMPTY(&cli_keywords.list))
162 return NULL;
163
164 list_for_each_entry(kw_list, &cli_keywords.list, list) {
165 kw = &kw_list->kw[0];
166 while (*kw->str_kw) {
167 tmp_args = args;
168 tmp_str_kw = kw->str_kw;
169 while (*tmp_str_kw) {
170 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
171 found = 1;
172 } else {
173 found = 0;
174 break;
175 }
176 tmp_args++;
177 tmp_str_kw++;
178 }
179 if (found)
180 return (kw);
181 kw++;
182 }
183 }
184 return NULL;
185}
186
187void cli_register_kw(struct cli_kw_list *kw_list)
188{
189 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
190}
191
192
193/* allocate a new stats frontend named <name>, and return it
194 * (or NULL in case of lack of memory).
195 */
196static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
197{
198 struct proxy *fe;
199
200 fe = calloc(1, sizeof(*fe));
201 if (!fe)
202 return NULL;
203
204 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100205 fe->next = proxies_list;
206 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100207 fe->last_change = now.tv_sec;
208 fe->id = strdup("GLOBAL");
209 fe->cap = PR_CAP_FE;
210 fe->maxconn = 10; /* default to 10 concurrent connections */
211 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
212 fe->conf.file = strdup(file);
213 fe->conf.line = line;
214 fe->accept = frontend_accept;
215 fe->default_target = &cli_applet.obj_type;
216
217 /* the stats frontend is the only one able to assign ID #0 */
218 fe->conf.id.key = fe->uuid = 0;
219 eb32_insert(&used_proxy_id, &fe->conf.id);
220 return fe;
221}
222
223/* This function parses a "stats" statement in the "global" section. It returns
224 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
225 * error message into the <err> buffer which will be preallocated. The trailing
226 * '\n' must not be written. The function must be called with <args> pointing to
227 * the first word after "stats".
228 */
229static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
230 struct proxy *defpx, const char *file, int line,
231 char **err)
232{
233 struct bind_conf *bind_conf;
234 struct listener *l;
235
236 if (!strcmp(args[1], "socket")) {
237 int cur_arg;
238
239 if (*args[2] == 0) {
240 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
241 return -1;
242 }
243
244 if (!global.stats_fe) {
245 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
246 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
247 return -1;
248 }
249 }
250
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100251 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200252 bind_conf->level &= ~ACCESS_LVL_MASK;
253 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100254
255 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
256 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
257 file, line, args[0], args[1], err && *err ? *err : "error");
258 return -1;
259 }
260
261 cur_arg = 3;
262 while (*args[cur_arg]) {
263 static int bind_dumped;
264 struct bind_kw *kw;
265
266 kw = bind_find_kw(args[cur_arg]);
267 if (kw) {
268 if (!kw->parse) {
269 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
270 args[0], args[1], args[cur_arg]);
271 return -1;
272 }
273
274 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
275 if (err && *err)
276 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
277 else
278 memprintf(err, "'%s %s' : error encountered while processing '%s'",
279 args[0], args[1], args[cur_arg]);
280 return -1;
281 }
282
283 cur_arg += 1 + kw->skip;
284 continue;
285 }
286
287 if (!bind_dumped) {
288 bind_dump_kws(err);
289 indent_msg(err, 4);
290 bind_dumped = 1;
291 }
292
293 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
294 args[0], args[1], args[cur_arg],
295 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
296 return -1;
297 }
298
299 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
300 l->maxconn = global.stats_fe->maxconn;
301 l->backlog = global.stats_fe->backlog;
302 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100303 l->default_target = global.stats_fe->default_target;
304 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
305 l->nice = -64; /* we want to boost priority for local stats */
306 global.maxsock += l->maxconn;
307 }
308 }
309 else if (!strcmp(args[1], "timeout")) {
310 unsigned timeout;
311 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
312
313 if (res) {
314 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
315 return -1;
316 }
317
318 if (!timeout) {
319 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
320 return -1;
321 }
322 if (!global.stats_fe) {
323 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
324 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
325 return -1;
326 }
327 }
328 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
329 }
330 else if (!strcmp(args[1], "maxconn")) {
331 int maxconn = atol(args[2]);
332
333 if (maxconn <= 0) {
334 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
335 return -1;
336 }
337
338 if (!global.stats_fe) {
339 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
340 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
341 return -1;
342 }
343 }
344 global.stats_fe->maxconn = maxconn;
345 }
346 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
347 int cur_arg = 2;
348 unsigned long set = 0;
349
350 if (!global.stats_fe) {
351 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
352 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
353 return -1;
354 }
355 }
356
357 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100358 if (strcmp(args[cur_arg], "all") == 0) {
359 set = 0;
360 break;
361 }
Christopher Faulet26028f62017-11-22 15:01:51 +0100362 if (parse_process_number(args[cur_arg], &set, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100363 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100364 return -1;
365 }
366 cur_arg++;
367 }
368 global.stats_fe->bind_proc = set;
369 }
370 else {
371 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
372 return -1;
373 }
374 return 0;
375}
376
Willy Tarreaude57a572016-11-23 17:01:39 +0100377/* Verifies that the CLI at least has a level at least as high as <level>
378 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
379 * failure, an error message is prepared and the appctx's state is adjusted
380 * to print it so that a return 1 is enough to abort any processing.
381 */
382int cli_has_level(struct appctx *appctx, int level)
383{
384 struct stream_interface *si = appctx->owner;
385 struct stream *s = si_strm(si);
386
William Lallemand07a62f72017-05-24 00:57:40 +0200387 if ((strm_li(s)->bind_conf->level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200388 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100389 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100390 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100391 return 0;
392 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100393 return 1;
394}
395
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200396/* Returns severity_output for the current session if set, or default for the socket */
397static int cli_get_severity_output(struct appctx *appctx)
398{
399 if (appctx->cli_severity_output)
400 return appctx->cli_severity_output;
401 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
402}
William Lallemand74c24fb2016-11-21 17:18:36 +0100403
Willy Tarreau41908562016-11-24 16:23:38 +0100404/* Processes the CLI interpreter on the stats socket. This function is called
405 * from the CLI's IO handler running in an appctx context. The function returns 1
406 * if the request was understood, otherwise zero. It is called with appctx->st0
407 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
408 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
409 * have its own I/O handler called again. Most of the time, parsers will only
410 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100411 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
412 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100413 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200414static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100415{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200416 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
417 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100418 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100419
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200420 appctx->st2 = 0;
421 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100422
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200423 p = appctx->chunk->area;
424 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100425
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200426 /*
427 * Get the payload start if there is one.
428 * For the sake of simplicity, the payload pattern is looked up
429 * everywhere from the start of the input but it can only be found
430 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
431 *
432 * The input string was zero terminated so it is safe to use
433 * the str*() functions throughout the parsing
434 */
435 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
436 payload = strstr(p, PAYLOAD_PATTERN);
437 end = payload;
438 /* skip the pattern */
439 payload += strlen(PAYLOAD_PATTERN);
440 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100441
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200442 /*
443 * Get pointers on words.
444 * One extra slot is reserved to store a pointer on a null byte.
445 */
446 while (i < MAX_STATS_ARGS && p < end) {
447 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100448
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200449 /* skip leading spaces/tabs */
450 p += strspn(p, " \t");
451 if (!*p)
452 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100453
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200454 args[i] = p;
455 p += strcspn(p, " \t");
456 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100457
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200458 /* unescape backslashes (\) */
459 for (j = 0, k = 0; args[i][k]; k++) {
460 if (args[i][k] == '\\') {
461 if (args[i][k + 1] == '\\')
462 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100463 else
464 continue;
465 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200466 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100467 j++;
468 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200469 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100470
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200471 i++;
472 }
473 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200474 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200475 for (; i < MAX_STATS_ARGS + 1; i++)
476 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100477
478 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100479 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100480 return 0;
481
William Lallemand14721be2018-10-26 14:47:37 +0200482 /* in a worker or normal process, don't display master only commands */
483 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
484 return 0;
485
486 /* in master don't displays if we don't have the master bits */
487 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
488 return 0;
489
Willy Tarreau41908562016-11-24 16:23:38 +0100490 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200491 appctx->io_release = kw->io_release;
492 /* kw->parse could set its own io_handler or ip_release handler */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200493 if ((!kw->parse || kw->parse(args, payload, appctx, kw->private) == 0) && appctx->io_handler) {
Willy Tarreau41908562016-11-24 16:23:38 +0100494 appctx->st0 = CLI_ST_CALLBACK;
William Lallemand74c24fb2016-11-21 17:18:36 +0100495 }
Willy Tarreau41908562016-11-24 16:23:38 +0100496 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100497}
498
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200499/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
500static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
501{
Willy Tarreau83061a82018-07-13 11:56:34 +0200502 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200503
504 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200505 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200506
507 tmp = get_trash_chunk();
508 chunk_reset(tmp);
509
510 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100511 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200512 chunk_printf(tmp, "[%d]: ", severity);
513 }
514 else {
515 switch (severity_output) {
516 case CLI_SEVERITY_NUMBER:
517 chunk_printf(tmp, "[%d]: ", severity);
518 break;
519 case CLI_SEVERITY_STRING:
520 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
521 break;
522 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100523 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200524 }
525 }
526 chunk_appendf(tmp, "%s", msg);
527
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200528 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200529}
530
William Lallemand74c24fb2016-11-21 17:18:36 +0100531/* This I/O handler runs as an applet embedded in a stream interface. It is
532 * used to processes I/O from/to the stats unix socket. The system relies on a
533 * state machine handling requests and various responses. We read a request,
534 * then we process it and send the response, and we possibly display a prompt.
535 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100536 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100537 * or not.
538 */
539static void cli_io_handler(struct appctx *appctx)
540{
541 struct stream_interface *si = appctx->owner;
542 struct channel *req = si_oc(si);
543 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200544 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100545 int reql;
546 int len;
547
548 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
549 goto out;
550
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100551 /* Check if the input buffer is avalaible. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200552 if (res->buf.size == 0) {
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100553 si_applet_cant_put(si);
554 goto out;
555 }
556
William Lallemand74c24fb2016-11-21 17:18:36 +0100557 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100558 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100559 /* Stats output not initialized yet */
560 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200561 /* reset severity to default at init */
562 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100563 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100564 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100565 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100566 /* Let's close for real now. We just close the request
567 * side, the conditions below will complete if needed.
568 */
569 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200570 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100571 break;
572 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100573 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200574 char *str;
575
576 /* use a trash chunk to store received data */
577 if (!appctx->chunk) {
578 appctx->chunk = alloc_trash_chunk();
579 if (!appctx->chunk) {
580 appctx->st0 = CLI_ST_END;
581 continue;
582 }
583 }
584
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200585 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200586
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 /* ensure we have some output room left in the event we
588 * would want to return some info right after parsing.
589 */
590 if (buffer_almost_full(si_ib(si))) {
591 si_applet_cant_put(si);
592 break;
593 }
594
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200595 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200596 reql = co_getline(si_oc(si), str,
597 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100598 if (reql <= 0) { /* closed or EOL not found */
599 if (reql == 0)
600 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100601 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 continue;
603 }
604
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200605 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
606 /* seek for a possible unescaped semi-colon. If we find
607 * one, we replace it with an LF and skip only this part.
608 */
609 for (len = 0; len < reql; len++) {
610 if (str[len] == '\\') {
611 len++;
612 continue;
613 }
614 if (str[len] == ';') {
615 str[len] = '\n';
616 reql = len + 1;
617 break;
618 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100619 }
620 }
621
622 /* now it is time to check that we have a full line,
623 * remove the trailing \n and possibly \r, then cut the
624 * line.
625 */
626 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200627 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100628 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100629 continue;
630 }
631
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200632 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100633 len--;
634
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200635 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200636 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200637
638 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200639 appctx->chunk->area[appctx->chunk->data] = '\n';
640 appctx->chunk->area[appctx->chunk->data + 1] = 0;
641 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200642 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100643
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100644 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200645
646 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
647 /* empty line */
648 if (!len) {
649 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200650 appctx->chunk->data -= 2;
651 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200652
653 if (!cli_parse_request(appctx))
654 cli_gen_usage_msg(appctx);
655
656 chunk_reset(appctx->chunk);
657 /* NB: cli_sock_parse_request() may have put
658 * another CLI_ST_O_* into appctx->st0.
659 */
660
661 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100662 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100663 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200664 else {
665 /*
666 * Look for the "payload start" pattern at the end of a line
667 * Its location is not remembered here, this is just to switch
668 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100669 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200670 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200671 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200672 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200673 /* no payload, the command is complete: parse the request */
674 if (!cli_parse_request(appctx))
675 cli_gen_usage_msg(appctx);
676
677 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200678 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100679 }
680
681 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200682 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100683 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
684 }
685 else { /* output functions */
686 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100687 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100688 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100689 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200690 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
691 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100692 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 else
694 si_applet_cant_put(si);
695 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200696 case CLI_ST_PRINT_FREE: {
697 const char *msg = appctx->ctx.cli.err;
698
699 if (!msg)
700 msg = "Out of memory.\n";
701
702 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100703 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100704 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100705 }
706 else
707 si_applet_cant_put(si);
708 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200709 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100710 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100711 if (appctx->io_handler)
712 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100713 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100714 if (appctx->io_release) {
715 appctx->io_release(appctx);
716 appctx->io_release = NULL;
717 }
718 }
719 break;
720 default: /* abnormal state */
721 si->flags |= SI_FL_ERR;
722 break;
723 }
724
725 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100726 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200727 const char *prompt = "";
728
729 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
730 /*
731 * when entering a payload with interactive mode, change the prompt
732 * to emphasize that more data can still be sent
733 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200734 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200735 prompt = "+ ";
736 else
737 prompt = "\n> ";
738 }
739 else {
740 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))
741 prompt = "\n";
742 }
743
744 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100745 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100746 else
747 si_applet_cant_put(si);
748 }
749
750 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100751 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100752 break;
753
754 /* Now we close the output if one of the writers did so,
755 * or if we're not in interactive mode and the request
756 * buffer is empty. This still allows pipelined requests
757 * to be sent in non-interactive mode.
758 */
Willy Tarreau851d12c2018-06-19 07:01:36 +0200759 if ((res->flags & (CF_SHUTW|CF_SHUTW_NOW)) || (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100760 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100761 continue;
762 }
763
764 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100765 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100766 }
767 }
768
769 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
770 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
771 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
772 /* Other side has closed, let's abort if we have no more processing to do
773 * and nothing more to consume. This is comparable to a broken pipe, so
774 * we forward the close to the request side so that it flows upstream to
775 * the client.
776 */
777 si_shutw(si);
778 }
779
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100780 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100781 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
782 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
783 /* We have no more processing to do, and nothing more to send, and
784 * the client side has closed. So we'll forward this state downstream
785 * on the response buffer.
786 */
787 si_shutr(si);
788 res->flags |= CF_READ_NULL;
789 }
790
791 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200792 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 +0100793 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200794 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 +0100795}
796
William Lallemand74c24fb2016-11-21 17:18:36 +0100797/* This is called when the stream interface is closed. For instance, upon an
798 * external abort, we won't call the i/o handler anymore so we may need to
799 * remove back references to the stream currently being dumped.
800 */
801static void cli_release_handler(struct appctx *appctx)
802{
803 if (appctx->io_release) {
804 appctx->io_release(appctx);
805 appctx->io_release = NULL;
806 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100807 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100808 free(appctx->ctx.cli.err);
809 appctx->ctx.cli.err = NULL;
810 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100811}
812
813/* This function dumps all environmnent variables to the buffer. It returns 0
814 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100815 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
816 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100817 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100818static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100819{
Willy Tarreau0a739292016-11-22 20:21:23 +0100820 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100821 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100822
823 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
824 return 1;
825
826 chunk_reset(&trash);
827
828 /* we have two inner loops here, one for the proxy, the other one for
829 * the buffer.
830 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100831 while (*var) {
832 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100833
Willy Tarreau06d80a92017-10-19 14:32:15 +0200834 if (ci_putchk(si_ic(si), &trash) == -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100835 si_applet_cant_put(si);
836 return 0;
837 }
838 if (appctx->st2 == STAT_ST_END)
839 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100840 var++;
841 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100842 }
843
844 /* dump complete */
845 return 1;
846}
847
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200848/* This function dumps all file descriptors states (or the requested one) to
849 * the buffer. It returns 0 if the output buffer is full and it needs to be
850 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
851 * It uses cli.i0 as the fd number to restart from.
852 */
853static int cli_io_handler_show_fd(struct appctx *appctx)
854{
855 struct stream_interface *si = appctx->owner;
856 int fd = appctx->ctx.cli.i0;
857
858 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
859 return 1;
860
861 chunk_reset(&trash);
862
863 /* we have two inner loops here, one for the proxy, the other one for
864 * the buffer.
865 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100866 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200867 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200868 struct listener *li = NULL;
869 struct server *sv = NULL;
870 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200871 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200872 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +0200873 uint32_t conn_flags = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200874
Willy Tarreaubf9fd652018-08-02 11:05:48 +0200875 thread_isolate();
876
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200877 fdt = fdtab[fd];
878
Willy Tarreaubf9fd652018-08-02 11:05:48 +0200879 if (!fdt.owner) {
880 thread_release();
Willy Tarreau017af242017-10-04 20:24:54 +0200881 goto skip; // closed
Willy Tarreaubf9fd652018-08-02 11:05:48 +0200882 }
Willy Tarreau017af242017-10-04 20:24:54 +0200883
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200884 if (fdt.iocb == conn_fd_handler) {
885 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200886 mux = ((struct connection *)fdt.owner)->mux;
887 ctx = ((struct connection *)fdt.owner)->mux_ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200888 li = objt_listener(((struct connection *)fdt.owner)->target);
889 sv = objt_server(((struct connection *)fdt.owner)->target);
890 px = objt_proxy(((struct connection *)fdt.owner)->target);
891 }
892 else if (fdt.iocb == listener_accept)
893 li = fdt.owner;
894
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200895 chunk_printf(&trash,
Willy Tarreauc754b342018-03-30 15:00:15 +0200896 " %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 +0200897 fd,
898 fdt.state,
899 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
900 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
901 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
902 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
903 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
904 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
905 fdt.ev,
906 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
907 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
908 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
909 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
910 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200911 fdt.linger_risk ? 'L' : 'l',
912 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +0200913 fdt.cache.next,
914 fdt.cache.prev,
915 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200916 fdt.owner,
917 fdt.iocb,
918 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
919 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
920 (fdt.iocb == listener_accept) ? "listener_accept" :
Olivier Houchard79321b92018-07-26 17:55:11 +0200921 (fdt.iocb == poller_pipe_io_handler) ? "poller_pipe_io_handler" :
Willy Tarreauc754b342018-03-30 15:00:15 +0200922 "unknown");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200923
924 if (fdt.iocb == conn_fd_handler) {
925 chunk_appendf(&trash, " cflg=0x%08x", conn_flags);
926 if (px)
927 chunk_appendf(&trash, " px=%s", px->id);
928 else if (sv)
929 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
930 else if (li)
931 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +0200932
Willy Tarreaub011d8f2018-03-30 14:41:19 +0200933 if (mux) {
Willy Tarreau35b1b482018-03-28 18:41:30 +0200934 chunk_appendf(&trash, " mux=%s mux_ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +0200935 if (mux->show_fd)
936 mux->show_fd(&trash, fdt.owner);
937 }
Willy Tarreau35b1b482018-03-28 18:41:30 +0200938 else
939 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200940 }
941 else if (fdt.iocb == listener_accept) {
942 chunk_appendf(&trash, " l.st=%s fe=%s",
943 listener_state_str(li),
944 li->bind_conf->frontend->id);
945 }
946
Willy Tarreaubf9fd652018-08-02 11:05:48 +0200947 thread_release();
948
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200949 chunk_appendf(&trash, "\n");
950
Willy Tarreau06d80a92017-10-19 14:32:15 +0200951 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200952 si_applet_cant_put(si);
953 return 0;
954 }
955 skip:
956 if (appctx->st2 == STAT_ST_END)
957 break;
958
959 fd++;
960 appctx->ctx.cli.i0 = fd;
961 }
962
963 /* dump complete */
964 return 1;
965}
966
Willy Tarreaud80cb4e2018-01-20 19:30:13 +0100967/* This function dumps some activity counters used by developers and support to
968 * rule out some hypothesis during bug reports. It returns 0 if the output
969 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
970 * everything at once in the buffer and is not designed to do it in multiple
971 * passes.
972 */
973static int cli_io_handler_show_activity(struct appctx *appctx)
974{
975 struct stream_interface *si = appctx->owner;
976 int thr;
977
978 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
979 return 1;
980
981 chunk_reset(&trash);
982
983 chunk_appendf(&trash, "thread_id: %u", tid);
984 chunk_appendf(&trash, "\ndate_now: %lu.%06lu", (long)now.tv_sec, (long)now.tv_usec);
985 chunk_appendf(&trash, "\nloops:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].loops);
986 chunk_appendf(&trash, "\nwake_cache:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_cache);
987 chunk_appendf(&trash, "\nwake_tasks:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_tasks);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +0100988 chunk_appendf(&trash, "\nwake_signal:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_signal);
989 chunk_appendf(&trash, "\npoll_exp:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_exp);
990 chunk_appendf(&trash, "\npoll_drop:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_drop);
991 chunk_appendf(&trash, "\npoll_dead:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_dead);
992 chunk_appendf(&trash, "\npoll_skip:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_skip);
993 chunk_appendf(&trash, "\nfd_skip:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_skip);
994 chunk_appendf(&trash, "\nfd_lock:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_lock);
995 chunk_appendf(&trash, "\nfd_del:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_del);
996 chunk_appendf(&trash, "\nconn_dead:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].conn_dead);
997 chunk_appendf(&trash, "\nstream:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].stream);
998 chunk_appendf(&trash, "\nempty_rq:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].empty_rq);
999 chunk_appendf(&trash, "\nlong_rq:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].long_rq);
Willy Tarreaued72d822018-10-17 19:01:24 +02001000 chunk_appendf(&trash, "\ncpust_tot:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].cpust_total/2);
1001 chunk_appendf(&trash, "\ncpust_1s:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", read_freq_ctr(&activity[thr].cpust_1s)/2);
1002 chunk_appendf(&trash, "\ncpust_15s:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", read_freq_ctr_period(&activity[thr].cpust_15s, 15000)/2);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001003
1004 chunk_appendf(&trash, "\n");
1005
1006 if (ci_putchk(si_ic(si), &trash) == -1) {
1007 chunk_reset(&trash);
1008 chunk_printf(&trash, "[output too large, cannot dump]\n");
1009 si_applet_cant_put(si);
1010 }
1011
1012 /* dump complete */
1013 return 1;
1014}
1015
William Lallemandeceddf72016-12-15 18:06:44 +01001016/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001017 * CLI IO handler for `show cli sockets`.
1018 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001019 */
1020static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1021{
1022 struct bind_conf *bind_conf;
1023 struct stream_interface *si = appctx->owner;
1024
1025 chunk_reset(&trash);
1026
1027 switch (appctx->st2) {
1028 case STAT_ST_INIT:
1029 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001030 if (ci_putchk(si_ic(si), &trash) == -1) {
William Lallemandeceddf72016-12-15 18:06:44 +01001031 si_applet_cant_put(si);
1032 return 0;
1033 }
William Lallemandeceddf72016-12-15 18:06:44 +01001034 appctx->st2 = STAT_ST_LIST;
1035
1036 case STAT_ST_LIST:
1037 if (global.stats_fe) {
1038 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1039 struct listener *l;
1040
1041 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001042 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001043 * if the current node is the first of the list
1044 */
1045
Willy Tarreau3af9d832016-12-16 12:58:09 +01001046 if (appctx->ctx.cli.p0 &&
1047 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001048 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001049 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001050 continue;
1051 }
1052
1053 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1054
1055 char addr[46];
1056 char port[6];
1057
1058 if (l->addr.ss_family == AF_UNIX) {
1059 const struct sockaddr_un *un;
1060
1061 un = (struct sockaddr_un *)&l->addr;
1062 chunk_appendf(&trash, "%s ", un->sun_path);
1063 } else if (l->addr.ss_family == AF_INET) {
1064 addr_to_str(&l->addr, addr, sizeof(addr));
1065 port_to_str(&l->addr, port, sizeof(port));
1066 chunk_appendf(&trash, "%s:%s ", addr, port);
1067 } else if (l->addr.ss_family == AF_INET6) {
1068 addr_to_str(&l->addr, addr, sizeof(addr));
1069 port_to_str(&l->addr, port, sizeof(port));
1070 chunk_appendf(&trash, "[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001071 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1072 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001073 } else
William Lallemand26314342018-10-26 14:47:41 +02001074 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001075
William Lallemand07a62f72017-05-24 00:57:40 +02001076 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001077 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001078 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1079 chunk_appendf(&trash, "operator ");
1080 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1081 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001082 else
1083 chunk_appendf(&trash, " ");
1084
1085 if (bind_conf->bind_proc != 0) {
1086 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001087 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001088 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001089 chunk_appendf(&trash, "%d,", pos+1);
1090 }
1091 }
1092 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001093 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001094
1095 } else {
1096 chunk_appendf(&trash, "all\n");
1097 }
1098
Willy Tarreau06d80a92017-10-19 14:32:15 +02001099 if (ci_putchk(si_ic(si), &trash) == -1) {
William Lallemandeceddf72016-12-15 18:06:44 +01001100 si_applet_cant_put(si);
1101 return 0;
1102 }
1103 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001104 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001105 }
1106 }
1107 default:
1108 appctx->st2 = STAT_ST_FIN;
1109 return 1;
1110 }
1111}
1112
1113
Willy Tarreau0a739292016-11-22 20:21:23 +01001114/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001115 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1116 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001117 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001118static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001119{
1120 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001121 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001122
1123 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1124 return 1;
1125
Willy Tarreauf6710f82016-12-16 17:45:44 +01001126 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001127
1128 if (*args[2]) {
1129 int len = strlen(args[2]);
1130
Willy Tarreauf6710f82016-12-16 17:45:44 +01001131 for (; *var; var++) {
1132 if (strncmp(*var, args[2], len) == 0 &&
1133 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001134 break;
1135 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001136 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001137 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001138 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001139 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001140 return 1;
1141 }
1142 appctx->st2 = STAT_ST_END;
1143 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001144 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001145 return 0;
1146}
1147
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001148/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1149 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1150 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1151 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001152static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001153{
1154 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1155 return 1;
1156
1157 appctx->ctx.cli.i0 = 0;
1158
1159 if (*args[2]) {
1160 appctx->ctx.cli.i0 = atoi(args[2]);
1161 appctx->st2 = STAT_ST_END;
1162 }
1163 return 0;
1164}
1165
Willy Tarreau599852e2016-11-22 20:33:32 +01001166/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001167static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001168{
1169 struct stream_interface *si = appctx->owner;
1170 struct stream *s = si_strm(si);
1171
1172 if (strcmp(args[2], "cli") == 0) {
1173 unsigned timeout;
1174 const char *res;
1175
1176 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001177 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001178 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001179 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001180 return 1;
1181 }
1182
1183 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1184 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001185 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001186 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001187 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001188 return 1;
1189 }
1190
1191 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1192 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1193 return 1;
1194 }
1195 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001196 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001197 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001198 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001199 return 1;
1200 }
1201}
1202
Willy Tarreau2af99412016-11-23 11:10:59 +01001203/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001204static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001205{
1206 int v;
1207
1208 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1209 return 1;
1210
1211 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001212 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001213 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001214 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001215 return 1;
1216 }
1217
1218 v = atoi(args[3]);
1219 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001220 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001221 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001222 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001223 return 1;
1224 }
1225
1226 /* check for unlimited values */
1227 if (v <= 0)
1228 v = global.hardmaxconn;
1229
1230 global.maxconn = v;
1231
1232 /* Dequeues all of the listeners waiting for a resource */
1233 if (!LIST_ISEMPTY(&global_listener_queue))
1234 dequeue_all_listeners(&global_listener_queue);
1235
1236 return 1;
1237}
1238
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001239static int set_severity_output(int *target, char *argument)
1240{
1241 if (!strcmp(argument, "none")) {
1242 *target = CLI_SEVERITY_NONE;
1243 return 1;
1244 }
1245 else if (!strcmp(argument, "number")) {
1246 *target = CLI_SEVERITY_NUMBER;
1247 return 1;
1248 }
1249 else if (!strcmp(argument, "string")) {
1250 *target = CLI_SEVERITY_STRING;
1251 return 1;
1252 }
1253 return 0;
1254}
1255
1256/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001257static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001258{
1259 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1260 return 0;
1261
1262 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001263 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001264 appctx->st0 = CLI_ST_PRINT;
1265 return 1;
1266}
William Lallemandeceddf72016-12-15 18:06:44 +01001267
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001268int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001269{
1270 return 0;
1271}
1272
Willy Tarreau45c742b2016-11-24 14:51:17 +01001273/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001274static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001275{
1276 int v;
1277 int *res;
1278 int mul = 1;
1279
1280 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1281 return 1;
1282
1283 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1284 res = &global.cps_lim;
1285 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1286 res = &global.sps_lim;
1287#ifdef USE_OPENSSL
1288 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1289 res = &global.ssl_lim;
1290#endif
1291 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1292 res = &global.comp_rate_lim;
1293 mul = 1024;
1294 }
1295 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001296 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001297 appctx->ctx.cli.msg =
1298 "'set rate-limit' only supports :\n"
1299 " - 'connections global' to set the per-process maximum connection rate\n"
1300 " - 'sessions global' to set the per-process maximum session rate\n"
1301#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001302 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001303#endif
1304 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001305 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001306 return 1;
1307 }
1308
1309 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001310 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001311 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001312 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001313 return 1;
1314 }
1315
1316 v = atoi(args[4]);
1317 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001318 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001319 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001320 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001321 return 1;
1322 }
1323
1324 *res = v * mul;
1325
1326 /* Dequeues all of the listeners waiting for a resource */
1327 if (!LIST_ISEMPTY(&global_listener_queue))
1328 dequeue_all_listeners(&global_listener_queue);
1329
1330 return 1;
1331}
1332
William Lallemandf6975e92017-05-26 17:42:10 +02001333/* parse the "expose-fd" argument on the bind lines */
1334static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1335{
1336 if (!*args[cur_arg + 1]) {
1337 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1338 return ERR_ALERT | ERR_FATAL;
1339 }
1340 if (!strcmp(args[cur_arg+1], "listeners")) {
1341 conf->level |= ACCESS_FD_LISTENERS;
1342 } else {
1343 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1344 args[cur_arg], args[cur_arg+1]);
1345 return ERR_ALERT | ERR_FATAL;
1346 }
1347
1348 return 0;
1349}
1350
William Lallemand74c24fb2016-11-21 17:18:36 +01001351/* parse the "level" argument on the bind lines */
1352static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1353{
1354 if (!*args[cur_arg + 1]) {
1355 memprintf(err, "'%s' : missing level", args[cur_arg]);
1356 return ERR_ALERT | ERR_FATAL;
1357 }
1358
William Lallemand07a62f72017-05-24 00:57:40 +02001359 if (!strcmp(args[cur_arg+1], "user")) {
1360 conf->level &= ~ACCESS_LVL_MASK;
1361 conf->level |= ACCESS_LVL_USER;
1362 } else if (!strcmp(args[cur_arg+1], "operator")) {
1363 conf->level &= ~ACCESS_LVL_MASK;
1364 conf->level |= ACCESS_LVL_OPER;
1365 } else if (!strcmp(args[cur_arg+1], "admin")) {
1366 conf->level &= ~ACCESS_LVL_MASK;
1367 conf->level |= ACCESS_LVL_ADMIN;
1368 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001369 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1370 args[cur_arg], args[cur_arg+1]);
1371 return ERR_ALERT | ERR_FATAL;
1372 }
1373
1374 return 0;
1375}
1376
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001377static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1378{
1379 if (!*args[cur_arg + 1]) {
1380 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1381 return ERR_ALERT | ERR_FATAL;
1382 }
1383
1384 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1385 return 0;
1386 else {
1387 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1388 args[cur_arg], args[cur_arg+1]);
1389 return ERR_ALERT | ERR_FATAL;
1390 }
1391}
1392
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001393
1394 /* Displays workers and processes */
1395static int cli_io_handler_show_proc(struct appctx *appctx)
1396{
1397 struct stream_interface *si = appctx->owner;
1398 struct mworker_proc *child;
1399
1400 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1401 return 1;
1402
1403 chunk_reset(&trash);
1404
1405 chunk_printf(&trash, "# <PID> <type> <relative PID>\n");
1406 chunk_appendf(&trash, "%u %s %u\n", getpid(), "master", 0);
1407
1408
1409 list_for_each_entry(child, &proc_list, list) {
1410 chunk_appendf(&trash, "%u %s %u\n", child->pid, "worker", child->relative_pid);
1411 }
1412
1413 if (ci_putchk(si_ic(si), &trash) == -1) {
1414 si_applet_cant_put(si);
1415 return 0;
1416 }
1417
1418 /* dump complete */
1419 return 1;
1420}
1421
Olivier Houchardf886e342017-04-05 22:24:59 +02001422/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001423static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001424{
1425 char *cmsgbuf = NULL;
1426 unsigned char *tmpbuf = NULL;
1427 struct cmsghdr *cmsg;
1428 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001429 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001430 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001431 struct msghdr msghdr;
1432 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001433 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001434 int *tmpfd;
1435 int tot_fd_nb = 0;
1436 struct proxy *px;
1437 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001438 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001439 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001440 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001441 int ret;
1442
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001443 if (!remote) {
1444 ha_warning("Only works on real connections\n");
1445 goto out;
1446 }
1447
1448 fd = remote->handle.fd;
1449
Olivier Houchardf886e342017-04-05 22:24:59 +02001450 /* Temporary set the FD in blocking mode, that will make our life easier */
1451 old_fcntl = fcntl(fd, F_GETFL);
1452 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001453 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001454 goto out;
1455 }
1456 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1457 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001458 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001459 goto out;
1460 }
1461 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001462 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001463 goto out;
1464 }
Olivier Houchard54740872017-04-06 14:45:14 +02001465 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001466 iov.iov_base = &tot_fd_nb;
1467 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001468 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001469 goto out;
1470 memset(&msghdr, 0, sizeof(msghdr));
1471 /*
1472 * First, calculates the total number of FD, so that we can let
1473 * the caller know how much he should expects.
1474 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001475 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001476 while (px) {
1477 struct listener *l;
1478
1479 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001480 /* Only transfer IPv4/IPv6/UNIX sockets */
1481 if (l->state >= LI_ZOMBIE &&
1482 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001483 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001484 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001485 tot_fd_nb++;
1486 }
1487 px = px->next;
1488 }
1489 if (tot_fd_nb == 0)
1490 goto out;
1491
1492 /* First send the total number of file descriptors, so that the
1493 * receiving end knows what to expect.
1494 */
1495 msghdr.msg_iov = &iov;
1496 msghdr.msg_iovlen = 1;
1497 ret = sendmsg(fd, &msghdr, 0);
1498 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001499 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001500 goto out;
1501 }
1502
1503 /* Now send the fds */
1504 msghdr.msg_control = cmsgbuf;
1505 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1506 cmsg = CMSG_FIRSTHDR(&msghdr);
1507 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1508 cmsg->cmsg_level = SOL_SOCKET;
1509 cmsg->cmsg_type = SCM_RIGHTS;
1510 tmpfd = (int *)CMSG_DATA(cmsg);
1511
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001512 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001513 /* For each socket, e message is sent, containing the following :
1514 * Size of the namespace name (or 0 if none), as an unsigned char.
1515 * The namespace name, if any
1516 * Size of the interface name (or 0 if none), as an unsigned char
1517 * The interface name, if any
1518 * Listener options, as an int.
1519 */
1520 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1521 * buffer big enough to store the socket informations.
1522 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001523 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001524 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001525 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001526 goto out;
1527 }
1528 iov.iov_base = tmpbuf;
1529 while (px) {
1530 struct listener *l;
1531
1532 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1533 int ret;
1534 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001535 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001536 (l->proto->sock_family == AF_INET ||
1537 l->proto->sock_family == AF_INET6 ||
1538 l->proto->sock_family == AF_UNIX)) {
1539 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1540 if (!l->netns)
1541 tmpbuf[curoff++] = 0;
1542#ifdef CONFIG_HAP_NS
1543 else {
1544 char *name = l->netns->node.key;
1545 unsigned char len = l->netns->name_len;
1546 tmpbuf[curoff++] = len;
1547 memcpy(tmpbuf + curoff, name, len);
1548 curoff += len;
1549 }
1550#endif
1551 if (l->interface) {
1552 unsigned char len = strlen(l->interface);
1553 tmpbuf[curoff++] = len;
1554 memcpy(tmpbuf + curoff, l->interface, len);
1555 curoff += len;
1556 } else
1557 tmpbuf[curoff++] = 0;
1558 memcpy(tmpbuf + curoff, &l->options,
1559 sizeof(l->options));
1560 curoff += sizeof(l->options);
1561
1562
1563 i++;
1564 } else
1565 continue;
1566 if ((!(i % MAX_SEND_FD))) {
1567 iov.iov_len = curoff;
1568 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001569 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001570 goto out;
1571 }
1572 /* Wait for an ack */
1573 do {
1574 ret = recv(fd, &tot_fd_nb,
1575 sizeof(tot_fd_nb), 0);
1576 } while (ret == -1 && errno == EINTR);
1577 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001578 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001579 goto out;
1580 }
1581 curoff = 0;
1582 }
1583
1584 }
1585 px = px->next;
1586 }
1587 if (i % MAX_SEND_FD) {
1588 iov.iov_len = curoff;
1589 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1590 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1591 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001592 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001593 goto out;
1594 }
1595 }
1596
1597out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001598 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001599 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001600 goto out;
1601 }
1602 appctx->st0 = CLI_ST_END;
1603 free(cmsgbuf);
1604 free(tmpbuf);
1605 return 1;
1606}
1607
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001608static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1609{
1610 if (*args[0] == 'h')
1611 /* help */
1612 cli_gen_usage_msg(appctx);
1613 else if (*args[0] == 'p')
1614 /* prompt */
1615 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1616 else if (*args[0] == 'q')
1617 /* quit */
1618 appctx->st0 = CLI_ST_END;
1619
1620 return 1;
1621}
Olivier Houchardf886e342017-04-05 22:24:59 +02001622
William Lallemand291810d2018-10-26 14:47:38 +02001623
William Lallemandcf62f7e2018-10-26 14:47:40 +02001624/* The pcli_* functions are used for the CLI proxy in the master */
1625
William Lallemand291810d2018-10-26 14:47:38 +02001626static enum obj_type *pcli_pid_to_server(int proc_pid)
1627{
1628 struct mworker_proc *child;
1629
1630 list_for_each_entry(child, &proc_list, list) {
1631 if (child->pid == proc_pid){
1632 return &child->srv->obj_type;
1633 }
1634 }
1635 return NULL;
1636}
1637
1638/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1639 * Return:
1640 * 0: master
1641 * > 0: pid of a worker
1642 * < 0: didn't find a worker
1643 */
1644static int pcli_prefix_to_pid(const char *prefix)
1645{
1646 int proc_pid;
1647 struct mworker_proc *child;
1648 char *errtol = NULL;
1649
1650 if (*prefix != '@') /* not a prefix, should not happen */
1651 return -1;
1652
1653 prefix++;
1654 if (!*prefix) /* sent @ alone, return the master */
1655 return 0;
1656
1657 if (strcmp("master", prefix) == 0) {
1658 return 0;
1659 } else if (*prefix == '!') {
1660 prefix++;
1661 if (!*prefix)
1662 return -1;
1663
1664 proc_pid = strtol(prefix, &errtol, 10);
1665 if (*errtol != '\0')
1666 return -1;
1667 list_for_each_entry(child, &proc_list, list) {
1668 if (child->pid == proc_pid){
1669 return child->pid;
1670 }
1671 }
1672 } else {
1673 struct mworker_proc *chosen = NULL;
1674 /* this is a relative pid */
1675
1676 proc_pid = strtol(prefix, &errtol, 10);
1677 if (*errtol != '\0')
1678 return -1;
1679
1680 if (proc_pid == 0) /* return the master */
1681 return 0;
1682
1683 /* chose the right process, the current one is the one with the
1684 least number of reloads */
1685 list_for_each_entry(child, &proc_list, list) {
1686 if (child->relative_pid == proc_pid){
1687 if (child->reloads == 0)
1688 return child->pid;
1689 else if (chosen == NULL || child->reloads < chosen->reloads)
1690 chosen = child;
1691 }
1692 }
1693 if (chosen)
1694 return chosen->pid;
1695 }
1696 return -1;
1697}
1698
William Lallemandcf62f7e2018-10-26 14:47:40 +02001699/* Parse the CLI request:
1700 *
1701 * - it can rewrite the buffer by trimming the prefix
1702 * - fill dst with the destination server if there is one
1703 *
1704 * Return:
1705 * - the amount of data to forward or
1706 * - -1 if there is no end to the command or
1707 * - 0 everything has been trimmed (only a prefix)
1708 */
1709#define PCLI_REQ_INIT 0
1710#define PCLI_REQ_PFX 1
1711#define PCLI_REQ_TRIM 2
1712#define PCLI_REQ_CMD 3
1713
1714int pcli_parse_request(struct channel *req, int *target_pid)
1715{
1716 char *input = (char *)ci_head(req);
1717 const char *end;
1718 char *ptr, *trim = NULL, *pfx_b = NULL, *cmd_b = NULL;
1719 struct buffer *buf = &req->buf;
1720 int ret = 0;
1721 int state = PCLI_REQ_INIT;
1722
1723 ptr = input;
1724 end = b_stop(buf);
1725
1726 /* The while loop condition is checking the end of the command.
1727 It is needed to iterate for each ptr++ done in the parser */
1728 while (ptr < end && *ptr != '\n' && *ptr != '\r' && *ptr != ';') {
1729 switch (state) {
1730 /* The init state only trims the useless chars */
1731 case PCLI_REQ_INIT:
1732
1733 /* skip every spaces at the start of the command */
1734 if (*ptr == ' ') {
1735 ptr++;
1736 continue;
1737 }
1738 pfx_b = ptr; /* this is the start of the command or of the @ prefix */
1739 state = PCLI_REQ_PFX;
1740
1741 /* the atprefix state looks for a @ prefix. If it finds
1742 it, it will check to which server send the request.
1743 It also ajust the trim pointer */
1744 case PCLI_REQ_PFX:
1745
1746 if (*pfx_b != '@') {
1747 /* there is no prefix */
1748 pfx_b = NULL;
1749 cmd_b = ptr;
1750 state = PCLI_REQ_CMD;
1751 continue;
1752 }
1753
1754 if (*ptr != ' ') {
1755 ptr++;
1756 continue;
1757 }
1758 *ptr = '\0'; /* this the end of the prefix */
1759 ptr++;
1760 trim = ptr;
1761 state = PCLI_REQ_TRIM;
1762 break;
1763
1764 /* we really need to trim there because that's the only
1765 way to know if we are going to send a command or if
1766 there is only a prefix */
1767 case PCLI_REQ_TRIM:
1768 if (*ptr == ' ') {
1769 ptr++;
1770 continue;
1771 }
1772 cmd_b = trim = ptr;
1773 state = PCLI_REQ_CMD;
1774
1775 /* just look for the end of the command */
1776 case PCLI_REQ_CMD:
1777 ptr++;
1778 continue;
1779 }
1780 }
1781
1782 /* we didn't find a command separator, not enough data */
1783 if (ptr >= end)
1784 return -1;
1785
1786 if (!pfx_b && !cmd_b) {
1787 /* probably just a \n or a ; */
1788 return 1;
1789 } else if (pfx_b && !cmd_b) {
1790 /* it's only a prefix, we don't want to forward it */
1791 *ptr = '\0';
1792 trim = ptr + 1; /* we want to trim the whole command */
1793 ret = 0;
1794 } else if (cmd_b) {
1795 /* command without a prefix */
1796 *ptr = '\n';
1797 ret = ptr - cmd_b + 1;
1798 }
1799
1800 if (pfx_b)
1801 *target_pid = pcli_prefix_to_pid(pfx_b);
1802
1803 /* trim the useless chars */
1804 if (trim)
1805 b_del(&req->buf, trim - input);
1806
1807 return ret;
1808}
1809
1810int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
1811{
1812 int target_pid;
1813 int to_forward;
1814
1815 target_pid = s->pcli_next_pid;
1816
1817read_again:
1818 /* if the channel is closed for read, we won't receive any more data
1819 from the client, but we don't want to forward this close to the
1820 server */
1821 channel_dont_close(req);
1822
1823 /* We don't know yet to which server we will connect */
1824 channel_dont_connect(req);
1825
1826
1827 /* we are not waiting for a response, there is no more request and we
1828 * receive a close from the client, we can leave */
1829 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
1830 channel_shutw_now(&s->res);
1831 s->req.analysers &= ~AN_REQ_WAIT_CLI;
1832 return 1;
1833 }
1834
1835 req->flags |= CF_READ_DONTWAIT;
1836
1837 /* need more data */
1838 if (!ci_data(req))
1839 return 0;
1840
1841 /* If there is data available for analysis, log the end of the idle time. */
1842 if (c_data(req) && s->logs.t_idle == -1)
1843 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
1844
1845 to_forward = pcli_parse_request(req, &target_pid);
1846 if (to_forward > 0) {
1847 /* enough data */
1848
1849 /* we didn't find the process, send an error and close */
1850 if (target_pid < 0) {
1851 pcli_reply_and_close(s, "Can't find the target CLI!\n");
1852 return 0;
1853 }
1854
1855 /* forward only 1 command */
1856 channel_forward(req, to_forward);
1857 /* we send only 1 command per request, and we write close after it */
1858 channel_shutw_now(req);
1859
1860 /* remove the XFER_DATA analysers, which forwards all
1861 * the data, we don't want to forward the next requests
1862 * We need to add CF_FLT_ANALYZE to abort the forward too.
1863 */
1864 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
1865 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
1866 s->res.analysers |= AN_RES_WAIT_CLI;
1867
1868 /* we can connect now */
1869 s->target = pcli_pid_to_server(target_pid);
1870 if (!s->target) {
1871 s->target = &cli_applet.obj_type;
1872 }
1873
1874 s->flags |= (SF_DIRECT | SF_ASSIGNED);
1875 channel_auto_connect(req);
1876
1877 } else if (to_forward == 0) {
1878 /* we only received a prefix without command, which
1879 mean that we want to store it for every other
1880 command for this session */
1881 if (target_pid > -1) {
1882 s->pcli_next_pid = target_pid;
1883 // TODO: pcli_reply the prompt
1884 } else {
1885 // TODO: pcli_reply() error
1886 s->pcli_next_pid = 0;
1887 }
1888
1889 /* we trimmed things but we might have other commands to consume */
1890 goto read_again;
1891 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
1892 /* buffer is full and we didn't catch the end of a command */
1893 goto send_help;
1894 }
1895
1896 return 0;
1897
1898send_help:
1899 b_reset(&req->buf);
1900 b_putblk(&req->buf, "help\n", 5);
1901 goto read_again;
1902}
1903
1904int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
1905{
1906 struct proxy *fe = strm_fe(s);
1907 struct proxy *be = s->be;
1908
1909 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
1910 rep->flags |= CF_NEVER_WAIT;
1911
1912 /* don't forward the close */
1913 channel_dont_close(&s->res);
1914 channel_dont_close(&s->req);
1915
1916 /* forward the data */
1917 if (ci_data(rep)) {
1918 c_adv(rep, ci_data(rep));
1919 return 0;
1920 }
1921
1922 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
1923 /* stream cleanup */
1924
1925 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
1926 si_shutr(&s->si[1]);
1927 si_shutw(&s->si[1]);
1928
1929 /*
1930 * starting from there this the same code as
1931 * http_end_txn_clean_session().
1932 *
1933 * It allows to do frontend keepalive while reconnecting to a
1934 * new server for each request.
1935 */
1936
1937 if (s->flags & SF_BE_ASSIGNED) {
1938 HA_ATOMIC_SUB(&be->beconn, 1);
1939 if (unlikely(s->srv_conn))
1940 sess_change_server(s, NULL);
1941 }
1942
1943 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
1944 stream_process_counters(s);
1945
1946 /* don't count other requests' data */
1947 s->logs.bytes_in -= ci_data(&s->req);
1948 s->logs.bytes_out -= ci_data(&s->res);
1949
1950 /* we may need to know the position in the queue */
1951 pendconn_free(s);
1952
1953 /* let's do a final log if we need it */
1954 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
1955 !(s->flags & SF_MONITOR) &&
1956 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
1957 s->do_log(s);
1958 }
1959
1960 /* stop tracking content-based counters */
1961 stream_stop_content_counters(s);
1962 stream_update_time_stats(s);
1963
1964 s->logs.accept_date = date; /* user-visible date for logging */
1965 s->logs.tv_accept = now; /* corrected date for internal use */
1966 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
1967 s->logs.t_idle = -1;
1968 tv_zero(&s->logs.tv_request);
1969 s->logs.t_queue = -1;
1970 s->logs.t_connect = -1;
1971 s->logs.t_data = -1;
1972 s->logs.t_close = 0;
1973 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
1974 s->logs.srv_queue_pos = 0; /* we will get this number soon */
1975
1976 s->logs.bytes_in = s->req.total = ci_data(&s->req);
1977 s->logs.bytes_out = s->res.total = ci_data(&s->res);
1978
1979 stream_del_srv_conn(s);
1980 if (objt_server(s->target)) {
1981 if (s->flags & SF_CURR_SESS) {
1982 s->flags &= ~SF_CURR_SESS;
1983 HA_ATOMIC_SUB(&objt_server(s->target)->cur_sess, 1);
1984 }
1985 if (may_dequeue_tasks(objt_server(s->target), be))
1986 process_srv_queue(objt_server(s->target));
1987 }
1988
1989 s->target = NULL;
1990
1991 /* only release our endpoint if we don't intend to reuse the
1992 * connection.
1993 */
1994 if (!si_conn_ready(&s->si[1])) {
1995 si_release_endpoint(&s->si[1]);
1996 s->srv_conn = NULL;
1997 }
1998
1999 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2000 s->si[1].err_type = SI_ET_NONE;
2001 s->si[1].conn_retries = 0; /* used for logging too */
2002 s->si[1].exp = TICK_ETERNITY;
2003 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2004 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);
2005 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);
2006 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2007 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2008 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2009 /* reinitialise the current rule list pointer to NULL. We are sure that
2010 * any rulelist match the NULL pointer.
2011 */
2012 s->current_rule_list = NULL;
2013
2014 s->be = strm_fe(s);
2015 s->logs.logwait = strm_fe(s)->to_log;
2016 s->logs.level = 0;
2017 stream_del_srv_conn(s);
2018 s->target = NULL;
2019 /* re-init store persistence */
2020 s->store_count = 0;
2021 s->uniq_id = global.req_count++;
2022
2023 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2024
2025 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2026
2027 s->req.analysers |= AN_REQ_WAIT_CLI;
2028 s->res.analysers &= ~AN_RES_WAIT_CLI;
2029
2030 /* We must trim any excess data from the response buffer, because we
2031 * may have blocked an invalid response from a server that we don't
2032 * want to accidentely forward once we disable the analysers, nor do
2033 * we want those data to come along with next response. A typical
2034 * example of such data would be from a buggy server responding to
2035 * a HEAD with some data, or sending more than the advertised
2036 * content-length.
2037 */
2038 if (unlikely(ci_data(&s->res)))
2039 b_set_data(&s->res.buf, co_data(&s->res));
2040
2041 /* Now we can realign the response buffer */
2042 c_realign_if_empty(&s->res);
2043
2044 s->req.rto = strm_fe(s)->timeout.client;
2045 s->req.wto = TICK_ETERNITY;
2046
2047 s->res.rto = TICK_ETERNITY;
2048 s->res.wto = strm_fe(s)->timeout.client;
2049
2050 s->req.rex = TICK_ETERNITY;
2051 s->req.wex = TICK_ETERNITY;
2052 s->req.analyse_exp = TICK_ETERNITY;
2053 s->res.rex = TICK_ETERNITY;
2054 s->res.wex = TICK_ETERNITY;
2055 s->res.analyse_exp = TICK_ETERNITY;
2056 s->si[1].hcto = TICK_ETERNITY;
2057
2058 /* we're removing the analysers, we MUST re-enable events detection.
2059 * We don't enable close on the response channel since it's either
2060 * already closed, or in keep-alive with an idle connection handler.
2061 */
2062 channel_auto_read(&s->req);
2063 channel_auto_close(&s->req);
2064 channel_auto_read(&s->res);
2065
2066
2067 return 1;
2068 }
2069 return 0;
2070}
2071
William Lallemand8a022572018-10-26 14:47:35 +02002072/*
2073 * The mworker functions are used to initialize the CLI in the master process
2074 */
2075
William Lallemand309dc9a2018-10-26 14:47:45 +02002076 /*
2077 * Stop the mworker proxy
2078 */
2079void mworker_cli_proxy_stop()
2080{
2081 stop_proxy(mworker_proxy);
2082}
2083
William Lallemand8a022572018-10-26 14:47:35 +02002084/*
2085 * Create the mworker CLI proxy
2086 */
2087int mworker_cli_proxy_create()
2088{
2089 struct mworker_proc *child;
2090
2091 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2092 if (!mworker_proxy)
2093 return -1;
2094
2095 init_new_proxy(mworker_proxy);
2096 mworker_proxy->next = proxies_list;
2097 proxies_list = mworker_proxy;
2098 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002099 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002100 mworker_proxy->state = PR_STNEW;
2101 mworker_proxy->last_change = now.tv_sec;
2102 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2103 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2104 mworker_proxy->timeout.client = 0; /* no timeout */
2105 mworker_proxy->conf.file = strdup("MASTER");
2106 mworker_proxy->conf.line = 0;
2107 mworker_proxy->accept = frontend_accept;
2108 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2109
2110 /* Does not init the default target the CLI applet, but must be done in
2111 * the request parsing code */
2112 mworker_proxy->default_target = NULL;
2113
2114 /* the check_config_validity() will get an ID for the proxy */
2115 mworker_proxy->uuid = -1;
2116
2117 proxy_store_name(mworker_proxy);
2118
2119 /* create all servers using the mworker_proc list */
2120 list_for_each_entry(child, &proc_list, list) {
2121 char *msg = NULL;
2122 struct server *newsrv = NULL;
2123 struct sockaddr_storage *sk;
2124 int port1, port2, port;
2125 struct protocol *proto;
2126 char *errmsg;
2127
2128 newsrv = new_server(mworker_proxy);
2129 if (!newsrv)
2130 return -1;
2131
2132 /* we don't know the new pid yet */
2133 if (child->pid == -1)
2134 memprintf(&msg, "cur-%d", child->relative_pid);
2135 else
2136 memprintf(&msg, "old-%d", child->pid);
2137
2138 newsrv->next = mworker_proxy->srv;
2139 mworker_proxy->srv = newsrv;
2140 newsrv->conf.file = strdup(msg);
2141 newsrv->id = strdup(msg);
2142 newsrv->conf.line = 0;
2143
2144 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
2145 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0)
2146 return -1;
2147
2148 proto = protocol_by_family(sk->ss_family);
2149 if (!proto || !proto->connect) {
2150 return -1;
2151 }
2152
2153 /* no port specified */
2154 newsrv->flags |= SRV_F_MAPPORTS;
2155 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002156 /* don't let the server participate to load balancing */
2157 newsrv->iweight = 0;
2158 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002159 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002160
2161 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002162 }
2163 return 0;
2164}
Olivier Houchardf886e342017-04-05 22:24:59 +02002165
William Lallemandce83b4a2018-10-26 14:47:30 +02002166/*
William Lallemande7361152018-10-26 14:47:36 +02002167 * Create a new listener for the master CLI proxy
2168 */
2169int mworker_cli_proxy_new_listener(char *line)
2170{
2171 struct bind_conf *bind_conf;
2172 struct listener *l;
2173 char *err = NULL;
2174 char *args[MAX_LINE_ARGS + 1];
2175 int arg;
2176 int cur_arg;
2177
2178 arg = 0;
2179 args[0] = line;
2180
2181 /* args is a bind configuration with spaces replaced by commas */
2182 while (*line && arg < MAX_LINE_ARGS) {
2183
2184 if (*line == ',') {
2185 *line++ = '\0';
2186 while (*line == ',')
2187 line++;
2188 args[++arg] = line;
2189 }
2190 line++;
2191 }
2192
2193 args[++arg] = "\0";
2194
2195 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
2196
2197 bind_conf->level &= ~ACCESS_LVL_MASK;
2198 bind_conf->level |= ACCESS_LVL_ADMIN;
2199
2200 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2201 ha_alert("Cannot create the listener of the master CLI\n");
2202 return -1;
2203 }
2204
2205 cur_arg = 1;
2206
2207 while (*args[cur_arg]) {
2208 static int bind_dumped;
2209 struct bind_kw *kw;
2210
2211 kw = bind_find_kw(args[cur_arg]);
2212 if (kw) {
2213 if (!kw->parse) {
2214 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2215 args[0], args[1], args[cur_arg]);
2216 goto err;
2217 }
2218
2219 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2220 if (err)
2221 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2222 else
2223 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2224 args[0], args[1], args[cur_arg]);
2225 goto err;
2226 }
2227
2228 cur_arg += 1 + kw->skip;
2229 continue;
2230 }
2231
2232 if (!bind_dumped) {
2233 bind_dump_kws(&err);
2234 indent_msg(&err, 4);
2235 bind_dumped = 1;
2236 }
2237
2238 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2239 args[0], args[1], args[cur_arg],
2240 err ? " Registered keywords :" : "", err ? err : "");
2241 goto err;
2242 }
2243
2244
2245 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
2246 l->maxconn = 10;
2247 l->backlog = 10;
2248 l->accept = session_accept_fd;
2249 l->default_target = mworker_proxy->default_target;
2250 /* don't make the peers subject to global limits and don't close it in the master */
2251 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2252 l->nice = -64; /* we want to boost priority for local stats */
2253 global.maxsock += l->maxconn;
2254 }
2255
2256 return 0;
2257
2258err:
2259 ha_alert("%s\n", err);
2260 return -1;
2261
2262}
2263
2264/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002265 * Create a new CLI socket using a socketpair for a worker process
2266 * <mworker_proc> is the process structure, and <proc> is the process number
2267 */
2268int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2269{
2270 struct bind_conf *bind_conf;
2271 struct listener *l;
2272 char *path = NULL;
2273 char *err = NULL;
2274
2275 /* master pipe to ensure the master is still alive */
2276 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2277 ha_alert("Cannot create worker socketpair.\n");
2278 return -1;
2279 }
2280
2281 /* XXX: we might want to use a separate frontend at some point */
2282 if (!global.stats_fe) {
2283 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2284 ha_alert("out of memory trying to allocate the stats frontend");
2285 return -1;
2286 }
2287 }
2288
2289 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
2290 bind_conf->level &= ~ACCESS_LVL_MASK;
2291 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2292
2293 bind_conf->bind_proc = 1UL << proc;
2294 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2295
2296 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2297 ha_alert("Cannot allocate listener.\n");
2298 return -1;
2299 }
2300
2301 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
2302 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
2303 return -1;
2304 }
2305
2306 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
2307 l->maxconn = global.stats_fe->maxconn;
2308 l->backlog = global.stats_fe->backlog;
2309 l->accept = session_accept_fd;
2310 l->default_target = global.stats_fe->default_target;
2311 l->options |= LI_O_UNLIMITED;
2312 /* it's a sockpair but we don't want to keep the fd in the master */
2313 l->options &= ~LI_O_INHERITED;
2314 l->nice = -64; /* we want to boost priority for local stats */
2315 global.maxsock += l->maxconn;
2316 }
2317
2318 return 0;
2319}
2320
William Lallemand74c24fb2016-11-21 17:18:36 +01002321static struct applet cli_applet = {
2322 .obj_type = OBJ_TYPE_APPLET,
2323 .name = "<CLI>", /* used for logging */
2324 .fct = cli_io_handler,
2325 .release = cli_release_handler,
2326};
2327
Willy Tarreau0a739292016-11-22 20:21:23 +01002328/* register cli keywords */
2329static struct cli_kw_list cli_kws = {{ },{
William Lallemand4e8450b2018-10-26 14:47:43 +02002330 { { "@<relative pid>", NULL }, "@<relative pid> : send a command to the <relative pid> process", NULL, cli_io_handler_show_proc, NULL, NULL, ACCESS_MASTER_ONLY},
2331 { { "@!<pid>", NULL }, "@!<pid> : send a command to the <pid> process", cli_parse_default, NULL, NULL, NULL, ACCESS_MASTER_ONLY},
2332 { { "@master", NULL }, "@master : send a command to the master process", cli_parse_default, NULL, NULL, NULL, ACCESS_MASTER_ONLY},
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002333 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2334 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2335 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002336 { { "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 +01002337 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002338 { { "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 +01002339 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002340 { { "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 +02002341 { { "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 },
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02002342 { { "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 +01002343 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemandb9f9e3b2018-10-26 14:47:39 +02002344 { { "show", "proc", NULL }, "show proc : show processes status", cli_parse_default, cli_io_handler_show_proc, NULL, NULL, ACCESS_MASTER_ONLY},
Olivier Houchardf886e342017-04-05 22:24:59 +02002345 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002346 {{},}
2347}};
2348
William Lallemand74c24fb2016-11-21 17:18:36 +01002349static struct cfg_kw_list cfg_kws = {ILH, {
2350 { CFG_GLOBAL, "stats", stats_parse_global },
2351 { 0, NULL, NULL },
2352}};
2353
2354static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002355 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2356 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002357 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002358 { NULL, NULL, 0 },
2359}};
2360
2361__attribute__((constructor))
2362static void __dumpstats_module_init(void)
2363{
2364 cfg_register_keywords(&cfg_kws);
Willy Tarreau0a739292016-11-22 20:21:23 +01002365 cli_register_kw(&cli_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002366 bind_register_keywords(&bind_kws);
2367}
2368
2369/*
2370 * Local variables:
2371 * c-indent-level: 8
2372 * c-basic-offset: 8
2373 * End:
2374 */