blob: cc377fc5701ca66ed70c0746d2423a56cd222de5 [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
William Lallemand74c24fb2016-11-21 17:18:36 +010029#include <common/cfgparse.h>
30#include <common/compat.h>
31#include <common/config.h>
32#include <common/debug.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010033#include <common/initcall.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010034#include <common/memory.h>
35#include <common/mini-clist.h>
36#include <common/standard.h>
37#include <common/ticks.h>
38#include <common/time.h>
39#include <common/uri_auth.h>
40#include <common/version.h>
41#include <common/base64.h>
42
43#include <types/applet.h>
William Lallemand9ed62032016-11-21 17:49:11 +010044#include <types/cli.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010045#include <types/global.h>
46#include <types/dns.h>
William Lallemand9ed62032016-11-21 17:49:11 +010047#include <types/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010048
Willy Tarreau609aad92018-11-22 08:31:09 +010049#include <proto/activity.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010050#include <proto/backend.h>
51#include <proto/channel.h>
52#include <proto/checks.h>
53#include <proto/compression.h>
William Lallemand9ed62032016-11-21 17:49:11 +010054#include <proto/stats.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010055#include <proto/fd.h>
56#include <proto/freq_ctr.h>
57#include <proto/frontend.h>
58#include <proto/log.h>
59#include <proto/pattern.h>
60#include <proto/pipe.h>
William Lallemandce83b4a2018-10-26 14:47:30 +020061#include <proto/protocol.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010062#include <proto/listener.h>
63#include <proto/map.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010064#include <proto/proxy.h>
65#include <proto/sample.h>
66#include <proto/session.h>
67#include <proto/stream.h>
68#include <proto/server.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010069#include <proto/stream_interface.h>
70#include <proto/task.h>
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +020071#include <proto/proto_udp.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010072
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020073#define PAYLOAD_PATTERN "<<"
74
William Lallemand74c24fb2016-11-21 17:18:36 +010075static struct applet cli_applet;
76
77static const char stats_sock_usage_msg[] =
78 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010079 " help : this message\n"
80 " prompt : toggle interactive mode with prompt\n"
81 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010082 "";
83
84static const char stats_permission_denied_msg[] =
85 "Permission denied\n"
86 "";
87
88
Christopher Faulet1bc04c72017-10-29 20:14:08 +010089static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010090
91/* List head of cli keywords */
92static struct cli_kw_list cli_keywords = {
93 .list = LIST_HEAD_INIT(cli_keywords.list)
94};
95
96extern const char *stat_status_codes[];
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{
Willy Tarreaude57a572016-11-23 17:01:39 +0100384
William Lallemandf630d012018-12-13 09:05:44 +0100385 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200386 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100387 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100388 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100389 return 0;
390 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100391 return 1;
392}
393
William Lallemandb7ea1412018-12-13 09:05:47 +0100394/* same as cli_has_level but for the CLI proxy and without error message */
395int pcli_has_level(struct stream *s, int level)
396{
397 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
398 return 0;
399 }
400 return 1;
401}
402
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200403/* Returns severity_output for the current session if set, or default for the socket */
404static int cli_get_severity_output(struct appctx *appctx)
405{
406 if (appctx->cli_severity_output)
407 return appctx->cli_severity_output;
408 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
409}
William Lallemand74c24fb2016-11-21 17:18:36 +0100410
Willy Tarreau41908562016-11-24 16:23:38 +0100411/* Processes the CLI interpreter on the stats socket. This function is called
412 * from the CLI's IO handler running in an appctx context. The function returns 1
413 * if the request was understood, otherwise zero. It is called with appctx->st0
414 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
415 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
416 * have its own I/O handler called again. Most of the time, parsers will only
417 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100418 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
419 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100420 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200421static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100422{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200423 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
424 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100425 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100426
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200427 appctx->st2 = 0;
428 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100429
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200430 p = appctx->chunk->area;
431 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100432
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200433 /*
434 * Get the payload start if there is one.
435 * For the sake of simplicity, the payload pattern is looked up
436 * everywhere from the start of the input but it can only be found
437 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
438 *
439 * The input string was zero terminated so it is safe to use
440 * the str*() functions throughout the parsing
441 */
442 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
443 payload = strstr(p, PAYLOAD_PATTERN);
444 end = payload;
445 /* skip the pattern */
446 payload += strlen(PAYLOAD_PATTERN);
447 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100448
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200449 /*
450 * Get pointers on words.
451 * One extra slot is reserved to store a pointer on a null byte.
452 */
453 while (i < MAX_STATS_ARGS && p < end) {
454 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100455
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200456 /* skip leading spaces/tabs */
457 p += strspn(p, " \t");
458 if (!*p)
459 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100460
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200461 args[i] = p;
462 p += strcspn(p, " \t");
463 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100464
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200465 /* unescape backslashes (\) */
466 for (j = 0, k = 0; args[i][k]; k++) {
467 if (args[i][k] == '\\') {
468 if (args[i][k + 1] == '\\')
469 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100470 else
471 continue;
472 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200473 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100474 j++;
475 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200476 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100477
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200478 i++;
479 }
480 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200481 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200482 for (; i < MAX_STATS_ARGS + 1; i++)
483 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100484
485 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100486 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100487 return 0;
488
William Lallemand14721be2018-10-26 14:47:37 +0200489 /* in a worker or normal process, don't display master only commands */
490 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
491 return 0;
492
493 /* in master don't displays if we don't have the master bits */
494 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
495 return 0;
496
Willy Tarreau41908562016-11-24 16:23:38 +0100497 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200498 appctx->io_release = kw->io_release;
499 /* kw->parse could set its own io_handler or ip_release handler */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200500 if ((!kw->parse || kw->parse(args, payload, appctx, kw->private) == 0) && appctx->io_handler) {
Willy Tarreau41908562016-11-24 16:23:38 +0100501 appctx->st0 = CLI_ST_CALLBACK;
William Lallemand74c24fb2016-11-21 17:18:36 +0100502 }
Willy Tarreau41908562016-11-24 16:23:38 +0100503 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100504}
505
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200506/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
507static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
508{
Willy Tarreau83061a82018-07-13 11:56:34 +0200509 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200510
511 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200512 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200513
514 tmp = get_trash_chunk();
515 chunk_reset(tmp);
516
517 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100518 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200519 chunk_printf(tmp, "[%d]: ", severity);
520 }
521 else {
522 switch (severity_output) {
523 case CLI_SEVERITY_NUMBER:
524 chunk_printf(tmp, "[%d]: ", severity);
525 break;
526 case CLI_SEVERITY_STRING:
527 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
528 break;
529 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100530 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200531 }
532 }
533 chunk_appendf(tmp, "%s", msg);
534
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200535 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200536}
537
William Lallemand74c24fb2016-11-21 17:18:36 +0100538/* This I/O handler runs as an applet embedded in a stream interface. It is
539 * used to processes I/O from/to the stats unix socket. The system relies on a
540 * state machine handling requests and various responses. We read a request,
541 * then we process it and send the response, and we possibly display a prompt.
542 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100543 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100544 * or not.
545 */
546static void cli_io_handler(struct appctx *appctx)
547{
548 struct stream_interface *si = appctx->owner;
549 struct channel *req = si_oc(si);
550 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200551 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100552 int reql;
553 int len;
554
555 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
556 goto out;
557
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800558 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200559 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100560 /* buf.size==0 means we failed to get a buffer and were
561 * already subscribed to a wait list to get a buffer.
562 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100563 goto out;
564 }
565
William Lallemand74c24fb2016-11-21 17:18:36 +0100566 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100567 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100568 /* Stats output not initialized yet */
569 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200570 /* reset severity to default at init */
571 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100572 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100573 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100574 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100575 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100576 /* Let's close for real now. We just close the request
577 * side, the conditions below will complete if needed.
578 */
579 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200580 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100581 break;
582 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100583 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200584 char *str;
585
586 /* use a trash chunk to store received data */
587 if (!appctx->chunk) {
588 appctx->chunk = alloc_trash_chunk();
589 if (!appctx->chunk) {
590 appctx->st0 = CLI_ST_END;
591 continue;
592 }
593 }
594
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200595 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200596
William Lallemand74c24fb2016-11-21 17:18:36 +0100597 /* ensure we have some output room left in the event we
598 * would want to return some info right after parsing.
599 */
600 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100601 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 break;
603 }
604
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200605 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200606 reql = co_getline(si_oc(si), str,
607 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100608 if (reql <= 0) { /* closed or EOL not found */
609 if (reql == 0)
610 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100611 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100612 continue;
613 }
614
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200615 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
616 /* seek for a possible unescaped semi-colon. If we find
617 * one, we replace it with an LF and skip only this part.
618 */
619 for (len = 0; len < reql; len++) {
620 if (str[len] == '\\') {
621 len++;
622 continue;
623 }
624 if (str[len] == ';') {
625 str[len] = '\n';
626 reql = len + 1;
627 break;
628 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100629 }
630 }
631
632 /* now it is time to check that we have a full line,
633 * remove the trailing \n and possibly \r, then cut the
634 * line.
635 */
636 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200637 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100638 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100639 continue;
640 }
641
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200642 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100643 len--;
644
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200645 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200646 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200647
648 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200649 appctx->chunk->area[appctx->chunk->data] = '\n';
650 appctx->chunk->area[appctx->chunk->data + 1] = 0;
651 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200652 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100653
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100654 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200655
656 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
657 /* empty line */
658 if (!len) {
659 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200660 appctx->chunk->data -= 2;
661 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200662
663 if (!cli_parse_request(appctx))
664 cli_gen_usage_msg(appctx);
665
666 chunk_reset(appctx->chunk);
667 /* NB: cli_sock_parse_request() may have put
668 * another CLI_ST_O_* into appctx->st0.
669 */
670
671 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100672 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100673 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200674 else {
675 /*
676 * Look for the "payload start" pattern at the end of a line
677 * Its location is not remembered here, this is just to switch
678 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100679 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200680 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200681 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200682 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200683 /* no payload, the command is complete: parse the request */
684 if (!cli_parse_request(appctx))
685 cli_gen_usage_msg(appctx);
686
687 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200688 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100689 }
690
691 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200692 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
694 }
695 else { /* output functions */
696 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100697 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100698 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100699 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200700 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
701 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100702 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100703 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100704 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100705 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200706 case CLI_ST_PRINT_FREE: {
707 const char *msg = appctx->ctx.cli.err;
708
709 if (!msg)
710 msg = "Out of memory.\n";
711
712 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100713 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100714 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100715 }
716 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100717 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100718 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200719 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100720 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100721 if (appctx->io_handler)
722 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100723 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100724 if (appctx->io_release) {
725 appctx->io_release(appctx);
726 appctx->io_release = NULL;
727 }
728 }
729 break;
730 default: /* abnormal state */
731 si->flags |= SI_FL_ERR;
732 break;
733 }
734
735 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100736 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 const char *prompt = "";
738
739 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
740 /*
741 * when entering a payload with interactive mode, change the prompt
742 * to emphasize that more data can still be sent
743 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200744 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200745 prompt = "+ ";
746 else
747 prompt = "\n> ";
748 }
749 else {
750 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))
751 prompt = "\n";
752 }
753
754 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100755 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100756 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100757 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100758 }
759
760 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100761 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100762 break;
763
764 /* Now we close the output if one of the writers did so,
765 * or if we're not in interactive mode and the request
766 * buffer is empty. This still allows pipelined requests
767 * to be sent in non-interactive mode.
768 */
William Lallemand3de09d52018-12-11 16:10:56 +0100769 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
770 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100771 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100772 continue;
773 }
774
775 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100776 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100777 }
778 }
779
780 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
781 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
782 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
783 /* Other side has closed, let's abort if we have no more processing to do
784 * and nothing more to consume. This is comparable to a broken pipe, so
785 * we forward the close to the request side so that it flows upstream to
786 * the client.
787 */
788 si_shutw(si);
789 }
790
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100791 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100792 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
793 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
794 /* We have no more processing to do, and nothing more to send, and
795 * the client side has closed. So we'll forward this state downstream
796 * on the response buffer.
797 */
798 si_shutr(si);
799 res->flags |= CF_READ_NULL;
800 }
801
802 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200803 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 +0100804 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200805 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 +0100806}
807
William Lallemand74c24fb2016-11-21 17:18:36 +0100808/* This is called when the stream interface is closed. For instance, upon an
809 * external abort, we won't call the i/o handler anymore so we may need to
810 * remove back references to the stream currently being dumped.
811 */
812static void cli_release_handler(struct appctx *appctx)
813{
814 if (appctx->io_release) {
815 appctx->io_release(appctx);
816 appctx->io_release = NULL;
817 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100818 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100819 free(appctx->ctx.cli.err);
820 appctx->ctx.cli.err = NULL;
821 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100822}
823
824/* This function dumps all environmnent variables to the buffer. It returns 0
825 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100826 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
827 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100828 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100829static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100830{
Willy Tarreau0a739292016-11-22 20:21:23 +0100831 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100832 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100833
834 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
835 return 1;
836
837 chunk_reset(&trash);
838
839 /* we have two inner loops here, one for the proxy, the other one for
840 * the buffer.
841 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100842 while (*var) {
843 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100844
Willy Tarreau06d80a92017-10-19 14:32:15 +0200845 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100846 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100847 return 0;
848 }
849 if (appctx->st2 == STAT_ST_END)
850 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100851 var++;
852 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100853 }
854
855 /* dump complete */
856 return 1;
857}
858
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200859/* This function dumps all file descriptors states (or the requested one) to
860 * the buffer. It returns 0 if the output buffer is full and it needs to be
861 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
862 * It uses cli.i0 as the fd number to restart from.
863 */
864static int cli_io_handler_show_fd(struct appctx *appctx)
865{
866 struct stream_interface *si = appctx->owner;
867 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100868 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200869
870 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100871 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200872
873 chunk_reset(&trash);
874
Willy Tarreauca1b1572018-12-18 15:45:11 +0100875 /* isolate the threads once per round. We're limited to a buffer worth
876 * of output anyway, it cannot last very long.
877 */
878 thread_isolate();
879
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200880 /* we have two inner loops here, one for the proxy, the other one for
881 * the buffer.
882 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100883 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200884 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200885 struct listener *li = NULL;
886 struct server *sv = NULL;
887 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200888 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200889 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +0200890 uint32_t conn_flags = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200891
892 fdt = fdtab[fd];
893
Willy Tarreauca1b1572018-12-18 15:45:11 +0100894 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +0200895 goto skip; // closed
896
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200897 if (fdt.iocb == conn_fd_handler) {
898 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200899 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100900 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200901 li = objt_listener(((struct connection *)fdt.owner)->target);
902 sv = objt_server(((struct connection *)fdt.owner)->target);
903 px = objt_proxy(((struct connection *)fdt.owner)->target);
904 }
905 else if (fdt.iocb == listener_accept)
906 li = fdt.owner;
907
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200908 chunk_printf(&trash,
Willy Tarreauc754b342018-03-30 15:00:15 +0200909 " %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 +0200910 fd,
911 fdt.state,
912 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
913 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
914 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
915 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
916 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
917 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
918 fdt.ev,
919 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
920 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
921 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
922 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
923 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200924 fdt.linger_risk ? 'L' : 'l',
925 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +0200926 fdt.cache.next,
927 fdt.cache.prev,
928 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200929 fdt.owner,
930 fdt.iocb,
931 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
932 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
933 (fdt.iocb == listener_accept) ? "listener_accept" :
Olivier Houchard79321b92018-07-26 17:55:11 +0200934 (fdt.iocb == poller_pipe_io_handler) ? "poller_pipe_io_handler" :
William Lallemanddb6bdfb2018-11-20 17:36:51 +0100935 (fdt.iocb == mworker_accept_wrapper) ? "mworker_accept_wrapper" :
Willy Tarreauc754b342018-03-30 15:00:15 +0200936 "unknown");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200937
938 if (fdt.iocb == conn_fd_handler) {
939 chunk_appendf(&trash, " cflg=0x%08x", conn_flags);
940 if (px)
941 chunk_appendf(&trash, " px=%s", px->id);
942 else if (sv)
943 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
944 else if (li)
945 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +0200946
Willy Tarreaub011d8f2018-03-30 14:41:19 +0200947 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100948 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +0200949 if (mux->show_fd)
950 mux->show_fd(&trash, fdt.owner);
951 }
Willy Tarreau35b1b482018-03-28 18:41:30 +0200952 else
953 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200954 }
955 else if (fdt.iocb == listener_accept) {
956 chunk_appendf(&trash, " l.st=%s fe=%s",
957 listener_state_str(li),
958 li->bind_conf->frontend->id);
959 }
960
961 chunk_appendf(&trash, "\n");
962
Willy Tarreau06d80a92017-10-19 14:32:15 +0200963 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100964 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +0100965 appctx->ctx.cli.i0 = fd;
966 ret = 0;
967 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200968 }
969 skip:
970 if (appctx->st2 == STAT_ST_END)
971 break;
972
973 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200974 }
975
Willy Tarreauca1b1572018-12-18 15:45:11 +0100976 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200977 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +0100978
979 thread_release();
980 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200981}
982
Willy Tarreaud80cb4e2018-01-20 19:30:13 +0100983/* This function dumps some activity counters used by developers and support to
984 * rule out some hypothesis during bug reports. It returns 0 if the output
985 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
986 * everything at once in the buffer and is not designed to do it in multiple
987 * passes.
988 */
989static int cli_io_handler_show_activity(struct appctx *appctx)
990{
991 struct stream_interface *si = appctx->owner;
992 int thr;
993
994 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
995 return 1;
996
997 chunk_reset(&trash);
998
999 chunk_appendf(&trash, "thread_id: %u", tid);
1000 chunk_appendf(&trash, "\ndate_now: %lu.%06lu", (long)now.tv_sec, (long)now.tv_usec);
1001 chunk_appendf(&trash, "\nloops:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].loops);
1002 chunk_appendf(&trash, "\nwake_cache:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_cache);
1003 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 +01001004 chunk_appendf(&trash, "\nwake_signal:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_signal);
1005 chunk_appendf(&trash, "\npoll_exp:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_exp);
1006 chunk_appendf(&trash, "\npoll_drop:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_drop);
1007 chunk_appendf(&trash, "\npoll_dead:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_dead);
1008 chunk_appendf(&trash, "\npoll_skip:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_skip);
1009 chunk_appendf(&trash, "\nfd_skip:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_skip);
1010 chunk_appendf(&trash, "\nfd_lock:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_lock);
1011 chunk_appendf(&trash, "\nfd_del:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_del);
1012 chunk_appendf(&trash, "\nconn_dead:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].conn_dead);
1013 chunk_appendf(&trash, "\nstream:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].stream);
1014 chunk_appendf(&trash, "\nempty_rq:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].empty_rq);
1015 chunk_appendf(&trash, "\nlong_rq:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].long_rq);
Willy Tarreau4f93e0c2018-11-22 16:13:17 +01001016 chunk_appendf(&trash, "\ncpust_ms_tot:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].cpust_total/2);
1017 chunk_appendf(&trash, "\ncpust_ms_1s:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", read_freq_ctr(&activity[thr].cpust_1s)/2);
1018 chunk_appendf(&trash, "\ncpust_ms_15s:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", read_freq_ctr_period(&activity[thr].cpust_15s, 15000)/2);
Willy Tarreaubaba82f2018-11-22 08:42:42 +01001019 chunk_appendf(&trash, "\navg_loop_us:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001020
1021 chunk_appendf(&trash, "\n");
1022
1023 if (ci_putchk(si_ic(si), &trash) == -1) {
1024 chunk_reset(&trash);
1025 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001026 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001027 }
1028
1029 /* dump complete */
1030 return 1;
1031}
1032
William Lallemandeceddf72016-12-15 18:06:44 +01001033/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001034 * CLI IO handler for `show cli sockets`.
1035 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001036 */
1037static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1038{
1039 struct bind_conf *bind_conf;
1040 struct stream_interface *si = appctx->owner;
1041
1042 chunk_reset(&trash);
1043
1044 switch (appctx->st2) {
1045 case STAT_ST_INIT:
1046 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001047 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001048 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001049 return 0;
1050 }
William Lallemandeceddf72016-12-15 18:06:44 +01001051 appctx->st2 = STAT_ST_LIST;
1052
1053 case STAT_ST_LIST:
1054 if (global.stats_fe) {
1055 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1056 struct listener *l;
1057
1058 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001059 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001060 * if the current node is the first of the list
1061 */
1062
Willy Tarreau3af9d832016-12-16 12:58:09 +01001063 if (appctx->ctx.cli.p0 &&
1064 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001065 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001066 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001067 continue;
1068 }
1069
1070 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1071
1072 char addr[46];
1073 char port[6];
1074
1075 if (l->addr.ss_family == AF_UNIX) {
1076 const struct sockaddr_un *un;
1077
1078 un = (struct sockaddr_un *)&l->addr;
1079 chunk_appendf(&trash, "%s ", un->sun_path);
1080 } else if (l->addr.ss_family == AF_INET) {
1081 addr_to_str(&l->addr, addr, sizeof(addr));
1082 port_to_str(&l->addr, port, sizeof(port));
1083 chunk_appendf(&trash, "%s:%s ", addr, port);
1084 } else if (l->addr.ss_family == AF_INET6) {
1085 addr_to_str(&l->addr, addr, sizeof(addr));
1086 port_to_str(&l->addr, port, sizeof(port));
1087 chunk_appendf(&trash, "[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001088 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1089 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001090 } else
William Lallemand26314342018-10-26 14:47:41 +02001091 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001092
William Lallemand07a62f72017-05-24 00:57:40 +02001093 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001094 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001095 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1096 chunk_appendf(&trash, "operator ");
1097 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1098 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001099 else
1100 chunk_appendf(&trash, " ");
1101
1102 if (bind_conf->bind_proc != 0) {
1103 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001104 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001105 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001106 chunk_appendf(&trash, "%d,", pos+1);
1107 }
1108 }
1109 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001110 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001111
1112 } else {
1113 chunk_appendf(&trash, "all\n");
1114 }
1115
Willy Tarreau06d80a92017-10-19 14:32:15 +02001116 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001117 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001118 return 0;
1119 }
1120 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001121 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001122 }
1123 }
1124 default:
1125 appctx->st2 = STAT_ST_FIN;
1126 return 1;
1127 }
1128}
1129
1130
Willy Tarreau0a739292016-11-22 20:21:23 +01001131/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001132 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1133 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001134 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001135static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001136{
1137 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001138 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001139
1140 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1141 return 1;
1142
Willy Tarreauf6710f82016-12-16 17:45:44 +01001143 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001144
1145 if (*args[2]) {
1146 int len = strlen(args[2]);
1147
Willy Tarreauf6710f82016-12-16 17:45:44 +01001148 for (; *var; var++) {
1149 if (strncmp(*var, args[2], len) == 0 &&
1150 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001151 break;
1152 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001153 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001154 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001155 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001156 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001157 return 1;
1158 }
1159 appctx->st2 = STAT_ST_END;
1160 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001161 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001162 return 0;
1163}
1164
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001165/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1166 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1167 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1168 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001169static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001170{
1171 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1172 return 1;
1173
1174 appctx->ctx.cli.i0 = 0;
1175
1176 if (*args[2]) {
1177 appctx->ctx.cli.i0 = atoi(args[2]);
1178 appctx->st2 = STAT_ST_END;
1179 }
1180 return 0;
1181}
1182
Willy Tarreau599852e2016-11-22 20:33:32 +01001183/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001184static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001185{
1186 struct stream_interface *si = appctx->owner;
1187 struct stream *s = si_strm(si);
1188
1189 if (strcmp(args[2], "cli") == 0) {
1190 unsigned timeout;
1191 const char *res;
1192
1193 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001194 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001195 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001196 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001197 return 1;
1198 }
1199
1200 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1201 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001202 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001203 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001204 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001205 return 1;
1206 }
1207
1208 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1209 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1210 return 1;
1211 }
1212 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001213 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001214 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001215 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001216 return 1;
1217 }
1218}
1219
Willy Tarreau2af99412016-11-23 11:10:59 +01001220/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001221static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001222{
1223 int v;
1224
1225 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1226 return 1;
1227
1228 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001229 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001230 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001231 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001232 return 1;
1233 }
1234
1235 v = atoi(args[3]);
1236 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001237 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001238 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001239 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001240 return 1;
1241 }
1242
1243 /* check for unlimited values */
1244 if (v <= 0)
1245 v = global.hardmaxconn;
1246
1247 global.maxconn = v;
1248
1249 /* Dequeues all of the listeners waiting for a resource */
1250 if (!LIST_ISEMPTY(&global_listener_queue))
1251 dequeue_all_listeners(&global_listener_queue);
1252
1253 return 1;
1254}
1255
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001256static int set_severity_output(int *target, char *argument)
1257{
1258 if (!strcmp(argument, "none")) {
1259 *target = CLI_SEVERITY_NONE;
1260 return 1;
1261 }
1262 else if (!strcmp(argument, "number")) {
1263 *target = CLI_SEVERITY_NUMBER;
1264 return 1;
1265 }
1266 else if (!strcmp(argument, "string")) {
1267 *target = CLI_SEVERITY_STRING;
1268 return 1;
1269 }
1270 return 0;
1271}
1272
1273/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001274static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001275{
1276 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1277 return 0;
1278
1279 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001280 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001281 appctx->st0 = CLI_ST_PRINT;
1282 return 1;
1283}
William Lallemandeceddf72016-12-15 18:06:44 +01001284
William Lallemand67a234f2018-12-13 09:05:45 +01001285
1286/* show the level of the current CLI session */
1287static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1288{
1289
1290 appctx->ctx.cli.severity = LOG_INFO;
1291 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1292 appctx->ctx.cli.msg = "admin\n";
1293 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1294 appctx->ctx.cli.msg = "operator\n";
1295 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1296 appctx->ctx.cli.msg = "user\n";
1297 else
1298 appctx->ctx.cli.msg = "unknown\n";
1299
1300 appctx->st0 = CLI_ST_PRINT;
1301 return 1;
1302
1303}
1304
1305/* parse and set the CLI level dynamically */
1306static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1307{
1308 if (!strcmp(args[0], "operator")) {
1309 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1310 return 1;
1311 }
1312 appctx->cli_level &= ~ACCESS_LVL_MASK;
1313 appctx->cli_level |= ACCESS_LVL_OPER;
1314
1315 } else if (!strcmp(args[0], "user")) {
1316 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1317 return 1;
1318 }
1319 appctx->cli_level &= ~ACCESS_LVL_MASK;
1320 appctx->cli_level |= ACCESS_LVL_USER;
1321 }
1322 return 1;
1323}
1324
William Lallemanda57b7e32018-12-14 21:11:31 +01001325/* reload the master process */
1326static int cli_parse_reload(char **args, char *payload, struct appctx *appctx, void *private)
1327{
1328 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1329 return 1;
1330
1331 mworker_reload();
1332
1333 return 1;
1334}
1335
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001336int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001337{
1338 return 0;
1339}
1340
Willy Tarreau45c742b2016-11-24 14:51:17 +01001341/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001342static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001343{
1344 int v;
1345 int *res;
1346 int mul = 1;
1347
1348 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1349 return 1;
1350
1351 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1352 res = &global.cps_lim;
1353 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1354 res = &global.sps_lim;
1355#ifdef USE_OPENSSL
1356 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1357 res = &global.ssl_lim;
1358#endif
1359 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1360 res = &global.comp_rate_lim;
1361 mul = 1024;
1362 }
1363 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001364 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001365 appctx->ctx.cli.msg =
1366 "'set rate-limit' only supports :\n"
1367 " - 'connections global' to set the per-process maximum connection rate\n"
1368 " - 'sessions global' to set the per-process maximum session rate\n"
1369#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001370 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001371#endif
1372 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001373 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001374 return 1;
1375 }
1376
1377 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001378 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001379 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001380 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001381 return 1;
1382 }
1383
1384 v = atoi(args[4]);
1385 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001386 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001387 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001388 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001389 return 1;
1390 }
1391
1392 *res = v * mul;
1393
1394 /* Dequeues all of the listeners waiting for a resource */
1395 if (!LIST_ISEMPTY(&global_listener_queue))
1396 dequeue_all_listeners(&global_listener_queue);
1397
1398 return 1;
1399}
1400
William Lallemandf6975e92017-05-26 17:42:10 +02001401/* parse the "expose-fd" argument on the bind lines */
1402static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1403{
1404 if (!*args[cur_arg + 1]) {
1405 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1406 return ERR_ALERT | ERR_FATAL;
1407 }
1408 if (!strcmp(args[cur_arg+1], "listeners")) {
1409 conf->level |= ACCESS_FD_LISTENERS;
1410 } else {
1411 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1412 args[cur_arg], args[cur_arg+1]);
1413 return ERR_ALERT | ERR_FATAL;
1414 }
1415
1416 return 0;
1417}
1418
William Lallemand74c24fb2016-11-21 17:18:36 +01001419/* parse the "level" argument on the bind lines */
1420static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1421{
1422 if (!*args[cur_arg + 1]) {
1423 memprintf(err, "'%s' : missing level", args[cur_arg]);
1424 return ERR_ALERT | ERR_FATAL;
1425 }
1426
William Lallemand07a62f72017-05-24 00:57:40 +02001427 if (!strcmp(args[cur_arg+1], "user")) {
1428 conf->level &= ~ACCESS_LVL_MASK;
1429 conf->level |= ACCESS_LVL_USER;
1430 } else if (!strcmp(args[cur_arg+1], "operator")) {
1431 conf->level &= ~ACCESS_LVL_MASK;
1432 conf->level |= ACCESS_LVL_OPER;
1433 } else if (!strcmp(args[cur_arg+1], "admin")) {
1434 conf->level &= ~ACCESS_LVL_MASK;
1435 conf->level |= ACCESS_LVL_ADMIN;
1436 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001437 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1438 args[cur_arg], args[cur_arg+1]);
1439 return ERR_ALERT | ERR_FATAL;
1440 }
1441
1442 return 0;
1443}
1444
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001445static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1446{
1447 if (!*args[cur_arg + 1]) {
1448 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1449 return ERR_ALERT | ERR_FATAL;
1450 }
1451
1452 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1453 return 0;
1454 else {
1455 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1456 args[cur_arg], args[cur_arg+1]);
1457 return ERR_ALERT | ERR_FATAL;
1458 }
1459}
1460
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001461
1462 /* Displays workers and processes */
1463static int cli_io_handler_show_proc(struct appctx *appctx)
1464{
1465 struct stream_interface *si = appctx->owner;
1466 struct mworker_proc *child;
William Lallemande09cdc62018-11-19 18:46:16 +01001467 int old = 0;
William Lallemand16dd1b32018-11-19 18:46:18 +01001468 int up = now.tv_sec - proc_self->timestamp;
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001469
1470 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1471 return 1;
1472
1473 chunk_reset(&trash);
1474
William Lallemande3683302018-11-19 18:46:17 +01001475 chunk_printf(&trash, "#%-14s %-15s %-15s %-15s %s\n", "<PID>", "<type>", "<relative PID>", "<reloads>", "<uptime>");
William Lallemand16dd1b32018-11-19 18:46:18 +01001476 chunk_appendf(&trash, "%-15u %-15s %-15u %-15d %dd %02dh%02dm%02ds\n", getpid(), "master", 0, proc_self->reloads, up / 86400, (up % 86400) / 3600, (up % 3600) / 60, (up % 60));
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001477
William Lallemande09cdc62018-11-19 18:46:16 +01001478 /* displays current processes */
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001479
William Lallemande09cdc62018-11-19 18:46:16 +01001480 chunk_appendf(&trash, "# workers\n");
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001481 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001482 up = now.tv_sec - child->timestamp;
1483
1484 if (child->type != 'w')
1485 continue;
William Lallemande09cdc62018-11-19 18:46:16 +01001486
1487 if (child->reloads > 0) {
1488 old++;
1489 continue;
1490 }
William Lallemande3683302018-11-19 18:46:17 +01001491 chunk_appendf(&trash, "%-15u %-15s %-15u %-15d %dd %02dh%02dm%02ds\n", child->pid, "worker", child->relative_pid, child->reloads, up / 86400, (up % 86400) / 3600, (up % 3600) / 60, (up % 60));
William Lallemand256bf0d2018-12-12 13:45:57 +01001492 }
William Lallemande09cdc62018-11-19 18:46:16 +01001493
1494 /* displays old processes */
1495
1496 if (old) {
William Lallemand256bf0d2018-12-12 13:45:57 +01001497 char *msg = NULL;
1498
William Lallemande09cdc62018-11-19 18:46:16 +01001499 chunk_appendf(&trash, "# old workers\n");
1500 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001501 up = now.tv_sec - child->timestamp;
1502
1503 if (child->type != 'w')
1504 continue;
1505
William Lallemand256bf0d2018-12-12 13:45:57 +01001506 if (child->reloads > 0) {
1507 memprintf(&msg, "[was: %u]", child->relative_pid);
1508 chunk_appendf(&trash, "%-15u %-15s %-15s %-15d %dd %02dh%02dm%02ds\n", child->pid, "worker", msg, child->reloads, up / 86400, (up % 86400) / 3600, (up % 3600) / 60, (up % 60));
1509 }
William Lallemande09cdc62018-11-19 18:46:16 +01001510 }
William Lallemand256bf0d2018-12-12 13:45:57 +01001511 free(msg);
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001512 }
1513
1514 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001515 si_rx_room_blk(si);
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001516 return 0;
1517 }
1518
1519 /* dump complete */
1520 return 1;
1521}
1522
Olivier Houchardf886e342017-04-05 22:24:59 +02001523/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001524static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001525{
1526 char *cmsgbuf = NULL;
1527 unsigned char *tmpbuf = NULL;
1528 struct cmsghdr *cmsg;
1529 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001530 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001531 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001532 struct msghdr msghdr;
1533 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001534 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001535 int *tmpfd;
1536 int tot_fd_nb = 0;
1537 struct proxy *px;
1538 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001539 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001540 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001541 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001542 int ret;
1543
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001544 if (!remote) {
1545 ha_warning("Only works on real connections\n");
1546 goto out;
1547 }
1548
1549 fd = remote->handle.fd;
1550
Olivier Houchardf886e342017-04-05 22:24:59 +02001551 /* Temporary set the FD in blocking mode, that will make our life easier */
1552 old_fcntl = fcntl(fd, F_GETFL);
1553 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001554 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001555 goto out;
1556 }
1557 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1558 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001559 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001560 goto out;
1561 }
1562 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001563 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001564 goto out;
1565 }
Olivier Houchard54740872017-04-06 14:45:14 +02001566 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001567 iov.iov_base = &tot_fd_nb;
1568 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001569 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001570 goto out;
1571 memset(&msghdr, 0, sizeof(msghdr));
1572 /*
1573 * First, calculates the total number of FD, so that we can let
1574 * the caller know how much he should expects.
1575 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001576 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001577 while (px) {
1578 struct listener *l;
1579
1580 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001581 /* Only transfer IPv4/IPv6/UNIX sockets */
1582 if (l->state >= LI_ZOMBIE &&
1583 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001584 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001585 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001586 tot_fd_nb++;
1587 }
1588 px = px->next;
1589 }
1590 if (tot_fd_nb == 0)
1591 goto out;
1592
1593 /* First send the total number of file descriptors, so that the
1594 * receiving end knows what to expect.
1595 */
1596 msghdr.msg_iov = &iov;
1597 msghdr.msg_iovlen = 1;
1598 ret = sendmsg(fd, &msghdr, 0);
1599 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001600 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001601 goto out;
1602 }
1603
1604 /* Now send the fds */
1605 msghdr.msg_control = cmsgbuf;
1606 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1607 cmsg = CMSG_FIRSTHDR(&msghdr);
1608 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1609 cmsg->cmsg_level = SOL_SOCKET;
1610 cmsg->cmsg_type = SCM_RIGHTS;
1611 tmpfd = (int *)CMSG_DATA(cmsg);
1612
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001613 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001614 /* For each socket, e message is sent, containing the following :
1615 * Size of the namespace name (or 0 if none), as an unsigned char.
1616 * The namespace name, if any
1617 * Size of the interface name (or 0 if none), as an unsigned char
1618 * The interface name, if any
1619 * Listener options, as an int.
1620 */
1621 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1622 * buffer big enough to store the socket informations.
1623 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001624 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001625 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001626 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001627 goto out;
1628 }
1629 iov.iov_base = tmpbuf;
1630 while (px) {
1631 struct listener *l;
1632
1633 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1634 int ret;
1635 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001636 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001637 (l->proto->sock_family == AF_INET ||
1638 l->proto->sock_family == AF_INET6 ||
1639 l->proto->sock_family == AF_UNIX)) {
1640 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1641 if (!l->netns)
1642 tmpbuf[curoff++] = 0;
1643#ifdef CONFIG_HAP_NS
1644 else {
1645 char *name = l->netns->node.key;
1646 unsigned char len = l->netns->name_len;
1647 tmpbuf[curoff++] = len;
1648 memcpy(tmpbuf + curoff, name, len);
1649 curoff += len;
1650 }
1651#endif
1652 if (l->interface) {
1653 unsigned char len = strlen(l->interface);
1654 tmpbuf[curoff++] = len;
1655 memcpy(tmpbuf + curoff, l->interface, len);
1656 curoff += len;
1657 } else
1658 tmpbuf[curoff++] = 0;
1659 memcpy(tmpbuf + curoff, &l->options,
1660 sizeof(l->options));
1661 curoff += sizeof(l->options);
1662
1663
1664 i++;
1665 } else
1666 continue;
1667 if ((!(i % MAX_SEND_FD))) {
1668 iov.iov_len = curoff;
1669 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001670 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001671 goto out;
1672 }
1673 /* Wait for an ack */
1674 do {
1675 ret = recv(fd, &tot_fd_nb,
1676 sizeof(tot_fd_nb), 0);
1677 } while (ret == -1 && errno == EINTR);
1678 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001679 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001680 goto out;
1681 }
1682 curoff = 0;
1683 }
1684
1685 }
1686 px = px->next;
1687 }
1688 if (i % MAX_SEND_FD) {
1689 iov.iov_len = curoff;
1690 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1691 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1692 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001693 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001694 goto out;
1695 }
1696 }
1697
1698out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001699 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001700 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001701 goto out;
1702 }
1703 appctx->st0 = CLI_ST_END;
1704 free(cmsgbuf);
1705 free(tmpbuf);
1706 return 1;
1707}
1708
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001709static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1710{
1711 if (*args[0] == 'h')
1712 /* help */
1713 cli_gen_usage_msg(appctx);
1714 else if (*args[0] == 'p')
1715 /* prompt */
1716 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1717 else if (*args[0] == 'q')
1718 /* quit */
1719 appctx->st0 = CLI_ST_END;
1720
1721 return 1;
1722}
Olivier Houchardf886e342017-04-05 22:24:59 +02001723
William Lallemand2f4ce202018-10-26 14:47:47 +02001724void pcli_write_prompt(struct stream *s)
1725{
1726 struct buffer *msg = get_trash_chunk();
1727 struct channel *oc = si_oc(&s->si[0]);
1728
William Lallemanddc12c2e2018-12-13 09:05:46 +01001729 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001730 return;
1731
William Lallemanddc12c2e2018-12-13 09:05:46 +01001732 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001733 chunk_appendf(msg, "+ ");
1734 } else {
1735 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001736 chunk_appendf(msg, "master%s> ",
1737 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001738 else
1739 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1740 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001741 co_inject(oc, msg->area, msg->data);
1742}
1743
William Lallemand291810d2018-10-26 14:47:38 +02001744
William Lallemandcf62f7e2018-10-26 14:47:40 +02001745/* The pcli_* functions are used for the CLI proxy in the master */
1746
William Lallemanddeeaa592018-10-26 14:47:48 +02001747void pcli_reply_and_close(struct stream *s, const char *msg)
1748{
1749 struct buffer *buf = get_trash_chunk();
1750
1751 chunk_initstr(buf, msg);
1752 stream_int_retnclose(&s->si[0], buf);
1753}
1754
William Lallemand291810d2018-10-26 14:47:38 +02001755static enum obj_type *pcli_pid_to_server(int proc_pid)
1756{
1757 struct mworker_proc *child;
1758
William Lallemandbddd33a2018-12-11 16:10:53 +01001759 /* return the CLI applet of the master */
1760 if (proc_pid == 0)
1761 return &cli_applet.obj_type;
1762
William Lallemand291810d2018-10-26 14:47:38 +02001763 list_for_each_entry(child, &proc_list, list) {
1764 if (child->pid == proc_pid){
1765 return &child->srv->obj_type;
1766 }
1767 }
1768 return NULL;
1769}
1770
1771/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1772 * Return:
1773 * 0: master
1774 * > 0: pid of a worker
1775 * < 0: didn't find a worker
1776 */
1777static int pcli_prefix_to_pid(const char *prefix)
1778{
1779 int proc_pid;
1780 struct mworker_proc *child;
1781 char *errtol = NULL;
1782
1783 if (*prefix != '@') /* not a prefix, should not happen */
1784 return -1;
1785
1786 prefix++;
1787 if (!*prefix) /* sent @ alone, return the master */
1788 return 0;
1789
1790 if (strcmp("master", prefix) == 0) {
1791 return 0;
1792 } else if (*prefix == '!') {
1793 prefix++;
1794 if (!*prefix)
1795 return -1;
1796
1797 proc_pid = strtol(prefix, &errtol, 10);
1798 if (*errtol != '\0')
1799 return -1;
1800 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001801 if (child->type != 'w')
1802 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001803 if (child->pid == proc_pid){
1804 return child->pid;
1805 }
1806 }
1807 } else {
1808 struct mworker_proc *chosen = NULL;
1809 /* this is a relative pid */
1810
1811 proc_pid = strtol(prefix, &errtol, 10);
1812 if (*errtol != '\0')
1813 return -1;
1814
1815 if (proc_pid == 0) /* return the master */
1816 return 0;
1817
1818 /* chose the right process, the current one is the one with the
1819 least number of reloads */
1820 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001821 if (child->type != 'w')
1822 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001823 if (child->relative_pid == proc_pid){
1824 if (child->reloads == 0)
1825 return child->pid;
1826 else if (chosen == NULL || child->reloads < chosen->reloads)
1827 chosen = child;
1828 }
1829 }
1830 if (chosen)
1831 return chosen->pid;
1832 }
1833 return -1;
1834}
1835
William Lallemandbddd33a2018-12-11 16:10:53 +01001836/* Return::
1837 * >= 0 : number of words to escape
1838 * = -1 : error
1839 */
1840
1841int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1842{
1843 if (argl < 1)
1844 return 0;
1845
1846 /* there is a prefix */
1847 if (args[0][0] == '@') {
1848 int target_pid = pcli_prefix_to_pid(args[0]);
1849
1850 if (target_pid == -1) {
1851 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1852 return -1;
1853 }
1854
1855 /* if the prefix is alone, define a default target */
1856 if (argl == 1)
1857 s->pcli_next_pid = target_pid;
1858 else
1859 *next_pid = target_pid;
1860 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001861 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001862 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001863 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001864
1865 } else if (!strcmp("quit", args[0])) {
1866 channel_shutr_now(&s->req);
1867 channel_shutw_now(&s->res);
1868 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001869 } else if (!strcmp(args[0], "operator")) {
1870 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1871 memprintf(errmsg, "Permission denied!\n");
1872 return -1;
1873 }
1874 s->pcli_flags &= ~ACCESS_LVL_MASK;
1875 s->pcli_flags |= ACCESS_LVL_OPER;
1876 return argl;
1877
1878 } else if (!strcmp(args[0], "user")) {
1879 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1880 memprintf(errmsg, "Permission denied!\n");
1881 return -1;
1882 }
1883 s->pcli_flags &= ~ACCESS_LVL_MASK;
1884 s->pcli_flags |= ACCESS_LVL_USER;
1885 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001886 }
1887
1888 return 0;
1889}
1890
1891/*
1892 * Parse the CLI request:
1893 * - It does basically the same as the cli_io_handler, but as a proxy
1894 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001895 *
1896 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01001897 * - the number of characters to forward or
1898 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02001899 */
William Lallemandbddd33a2018-12-11 16:10:53 +01001900int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001901{
William Lallemandbddd33a2018-12-11 16:10:53 +01001902 char *str = (char *)ci_head(req);
1903 char *end = (char *)ci_stop(req);
1904 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
1905 int argl; /* number of args */
1906 char *p;
1907 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01001908 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01001909 int wtrim = 0; /* number of words to trim */
1910 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01001911 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01001912 int i = 0;
1913
1914 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001915
William Lallemanddc12c2e2018-12-13 09:05:46 +01001916 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01001917
1918 /* Looks for the end of one command */
1919 while (p+reql < end) {
1920 /* handle escaping */
1921 if (p[reql] == '\\') {
1922 reql++;
1923 continue;
1924 }
1925 if (p[reql] == ';' || p[reql] == '\n') {
1926 /* found the end of the command */
1927 p[reql] = '\n';
1928 reql++;
1929 break;
1930 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001931 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001932 }
William Lallemandebf61802018-12-11 16:10:57 +01001933 } else {
1934 while (p+reql < end) {
1935 if (p[reql] == '\n') {
1936 /* found the end of the line */
1937 reql++;
1938 break;
1939 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001940 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001941 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001942 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001943
William Lallemandbddd33a2018-12-11 16:10:53 +01001944 /* set end to first byte after the end of the command */
1945 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001946
William Lallemandbddd33a2018-12-11 16:10:53 +01001947 /* there is no end to this command, need more to parse ! */
1948 if (*(end-1) != '\n') {
1949 return -1;
1950 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001951
William Lallemand3301f3e2018-12-13 09:05:48 +01001952 if (s->pcli_flags & PCLI_F_PAYLOAD) {
1953 if (reql == 1) /* last line of the payload */
1954 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01001955 return reql;
1956 }
1957
William Lallemandbddd33a2018-12-11 16:10:53 +01001958 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001959
William Lallemandbddd33a2018-12-11 16:10:53 +01001960 /* splits the command in words */
1961 while (i < MAX_STATS_ARGS && p < end) {
1962 int j, k;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001963
William Lallemandbddd33a2018-12-11 16:10:53 +01001964 /* skip leading spaces/tabs */
1965 p += strspn(p, " \t");
1966 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001967 break;
1968
William Lallemandbddd33a2018-12-11 16:10:53 +01001969 args[i] = p;
1970 p += strcspn(p, " \t");
1971 *p++ = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001972
William Lallemandbddd33a2018-12-11 16:10:53 +01001973 /* unescape backslashes (\) */
1974 for (j = 0, k = 0; args[i][k]; k++) {
1975 if (args[i][k] == '\\') {
1976 if (args[i][k + 1] == '\\')
1977 k++;
1978 else
1979 continue;
1980 }
1981 args[i][j] = args[i][k];
1982 j++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001983 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001984 args[i][j] = 0;
1985 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001986 }
1987
William Lallemandbddd33a2018-12-11 16:10:53 +01001988 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001989
William Lallemandbddd33a2018-12-11 16:10:53 +01001990 for (; i < MAX_STATS_ARGS + 1; i++)
1991 args[i] = NULL;
1992
1993 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
1994
1995 /* End of words are ending by \0, we need to replace the \0s by spaces
19961 before forwarding them */
1997 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01001998 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01001999 if (*p == '\0')
2000 *p = ' ';
2001 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002002 }
2003
William Lallemand3301f3e2018-12-13 09:05:48 +01002004 payload = strstr(str, PAYLOAD_PATTERN);
2005 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2006 /* if the payload pattern is at the end */
2007 s->pcli_flags |= PCLI_F_PAYLOAD;
2008 ret = reql;
2009 }
2010
William Lallemandbddd33a2018-12-11 16:10:53 +01002011 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002012
William Lallemandbddd33a2018-12-11 16:10:53 +01002013 if (wtrim > 0) {
2014 trim = &args[wtrim][0];
2015 if (trim == NULL) /* if this was the last word in the table */
2016 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002017
William Lallemandbddd33a2018-12-11 16:10:53 +01002018 b_del(&req->buf, trim - str);
2019
William Lallemandb7ea1412018-12-13 09:05:47 +01002020 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002021 } else if (wtrim < 0) {
2022 /* parsing error */
2023 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002024 } else {
2025 /* the whole string */
2026 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002027 }
2028
William Lallemandb7ea1412018-12-13 09:05:47 +01002029 if (ret > 1) {
2030 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2031 goto end;
2032 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
2033 ci_insert_line2(req, 0, "operator", strlen("operator"));
2034 ret += strlen("operator") + 2;
2035 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
2036 ci_insert_line2(req, 0, "user", strlen("user"));
2037 ret += strlen("user") + 2;
2038 }
2039 }
2040end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002041
William Lallemandb7ea1412018-12-13 09:05:47 +01002042 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002043}
2044
2045int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2046{
William Lallemandbddd33a2018-12-11 16:10:53 +01002047 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002048 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002049 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002050
William Lallemandb7ea1412018-12-13 09:05:47 +01002051 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2052 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2053
William Lallemandcf62f7e2018-10-26 14:47:40 +02002054read_again:
2055 /* if the channel is closed for read, we won't receive any more data
2056 from the client, but we don't want to forward this close to the
2057 server */
2058 channel_dont_close(req);
2059
2060 /* We don't know yet to which server we will connect */
2061 channel_dont_connect(req);
2062
2063
2064 /* we are not waiting for a response, there is no more request and we
2065 * receive a close from the client, we can leave */
2066 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2067 channel_shutw_now(&s->res);
2068 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2069 return 1;
2070 }
2071
2072 req->flags |= CF_READ_DONTWAIT;
2073
2074 /* need more data */
2075 if (!ci_data(req))
2076 return 0;
2077
2078 /* If there is data available for analysis, log the end of the idle time. */
2079 if (c_data(req) && s->logs.t_idle == -1)
2080 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2081
William Lallemandbddd33a2018-12-11 16:10:53 +01002082 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002083 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002084 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002085 /* enough data */
2086
William Lallemandcf62f7e2018-10-26 14:47:40 +02002087 /* forward only 1 command */
2088 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002089
William Lallemanddc12c2e2018-12-13 09:05:46 +01002090 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002091 /* we send only 1 command per request, and we write close after it */
2092 channel_shutw_now(req);
2093 } else {
2094 pcli_write_prompt(s);
2095 }
2096
2097 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002098
2099 /* remove the XFER_DATA analysers, which forwards all
2100 * the data, we don't want to forward the next requests
2101 * We need to add CF_FLT_ANALYZE to abort the forward too.
2102 */
2103 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2104 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2105 s->res.analysers |= AN_RES_WAIT_CLI;
2106
William Lallemandebf61802018-12-11 16:10:57 +01002107 if (!(s->flags & SF_ASSIGNED)) {
2108 if (next_pid > -1)
2109 target_pid = next_pid;
2110 else
2111 target_pid = s->pcli_next_pid;
2112 /* we can connect now */
2113 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002114
William Lallemandebf61802018-12-11 16:10:57 +01002115 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2116 channel_auto_connect(req);
2117 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002118
2119 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002120 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002121 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002122 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002123 } else if (to_forward == -1 && errmsg) {
2124 /* there was an error during the parsing */
2125 pcli_reply_and_close(s, errmsg);
2126 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002127 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2128 /* buffer is full and we didn't catch the end of a command */
2129 goto send_help;
2130 }
2131
2132 return 0;
2133
2134send_help:
2135 b_reset(&req->buf);
2136 b_putblk(&req->buf, "help\n", 5);
2137 goto read_again;
2138}
2139
2140int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2141{
2142 struct proxy *fe = strm_fe(s);
2143 struct proxy *be = s->be;
2144
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002145 if (rep->flags & CF_READ_ERROR) {
2146 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2147 s->res.analysers &= ~AN_RES_WAIT_CLI;
2148 return 0;
2149 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002150 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2151 rep->flags |= CF_NEVER_WAIT;
2152
2153 /* don't forward the close */
2154 channel_dont_close(&s->res);
2155 channel_dont_close(&s->req);
2156
William Lallemanddc12c2e2018-12-13 09:05:46 +01002157 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002158 s->req.analysers |= AN_REQ_WAIT_CLI;
2159 s->res.analysers &= ~AN_RES_WAIT_CLI;
2160 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2161 return 0;
2162 }
2163
William Lallemandcf62f7e2018-10-26 14:47:40 +02002164 /* forward the data */
2165 if (ci_data(rep)) {
2166 c_adv(rep, ci_data(rep));
2167 return 0;
2168 }
2169
2170 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2171 /* stream cleanup */
2172
William Lallemand2f4ce202018-10-26 14:47:47 +02002173 pcli_write_prompt(s);
2174
William Lallemandcf62f7e2018-10-26 14:47:40 +02002175 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2176 si_shutr(&s->si[1]);
2177 si_shutw(&s->si[1]);
2178
2179 /*
2180 * starting from there this the same code as
2181 * http_end_txn_clean_session().
2182 *
2183 * It allows to do frontend keepalive while reconnecting to a
2184 * new server for each request.
2185 */
2186
2187 if (s->flags & SF_BE_ASSIGNED) {
2188 HA_ATOMIC_SUB(&be->beconn, 1);
2189 if (unlikely(s->srv_conn))
2190 sess_change_server(s, NULL);
2191 }
2192
2193 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2194 stream_process_counters(s);
2195
2196 /* don't count other requests' data */
2197 s->logs.bytes_in -= ci_data(&s->req);
2198 s->logs.bytes_out -= ci_data(&s->res);
2199
2200 /* we may need to know the position in the queue */
2201 pendconn_free(s);
2202
2203 /* let's do a final log if we need it */
2204 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2205 !(s->flags & SF_MONITOR) &&
2206 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2207 s->do_log(s);
2208 }
2209
2210 /* stop tracking content-based counters */
2211 stream_stop_content_counters(s);
2212 stream_update_time_stats(s);
2213
2214 s->logs.accept_date = date; /* user-visible date for logging */
2215 s->logs.tv_accept = now; /* corrected date for internal use */
2216 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2217 s->logs.t_idle = -1;
2218 tv_zero(&s->logs.tv_request);
2219 s->logs.t_queue = -1;
2220 s->logs.t_connect = -1;
2221 s->logs.t_data = -1;
2222 s->logs.t_close = 0;
2223 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2224 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2225
2226 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2227 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2228
2229 stream_del_srv_conn(s);
2230 if (objt_server(s->target)) {
2231 if (s->flags & SF_CURR_SESS) {
2232 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002233 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002234 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002235 if (may_dequeue_tasks(__objt_server(s->target), be))
2236 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002237 }
2238
2239 s->target = NULL;
2240
2241 /* only release our endpoint if we don't intend to reuse the
2242 * connection.
2243 */
2244 if (!si_conn_ready(&s->si[1])) {
2245 si_release_endpoint(&s->si[1]);
2246 s->srv_conn = NULL;
2247 }
2248
2249 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2250 s->si[1].err_type = SI_ET_NONE;
2251 s->si[1].conn_retries = 0; /* used for logging too */
2252 s->si[1].exp = TICK_ETERNITY;
2253 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2254 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);
2255 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);
2256 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2257 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2258 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2259 /* reinitialise the current rule list pointer to NULL. We are sure that
2260 * any rulelist match the NULL pointer.
2261 */
2262 s->current_rule_list = NULL;
2263
2264 s->be = strm_fe(s);
2265 s->logs.logwait = strm_fe(s)->to_log;
2266 s->logs.level = 0;
2267 stream_del_srv_conn(s);
2268 s->target = NULL;
2269 /* re-init store persistence */
2270 s->store_count = 0;
2271 s->uniq_id = global.req_count++;
2272
2273 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2274
2275 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2276
2277 s->req.analysers |= AN_REQ_WAIT_CLI;
2278 s->res.analysers &= ~AN_RES_WAIT_CLI;
2279
2280 /* We must trim any excess data from the response buffer, because we
2281 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002282 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002283 * we want those data to come along with next response. A typical
2284 * example of such data would be from a buggy server responding to
2285 * a HEAD with some data, or sending more than the advertised
2286 * content-length.
2287 */
2288 if (unlikely(ci_data(&s->res)))
2289 b_set_data(&s->res.buf, co_data(&s->res));
2290
2291 /* Now we can realign the response buffer */
2292 c_realign_if_empty(&s->res);
2293
2294 s->req.rto = strm_fe(s)->timeout.client;
2295 s->req.wto = TICK_ETERNITY;
2296
2297 s->res.rto = TICK_ETERNITY;
2298 s->res.wto = strm_fe(s)->timeout.client;
2299
2300 s->req.rex = TICK_ETERNITY;
2301 s->req.wex = TICK_ETERNITY;
2302 s->req.analyse_exp = TICK_ETERNITY;
2303 s->res.rex = TICK_ETERNITY;
2304 s->res.wex = TICK_ETERNITY;
2305 s->res.analyse_exp = TICK_ETERNITY;
2306 s->si[1].hcto = TICK_ETERNITY;
2307
2308 /* we're removing the analysers, we MUST re-enable events detection.
2309 * We don't enable close on the response channel since it's either
2310 * already closed, or in keep-alive with an idle connection handler.
2311 */
2312 channel_auto_read(&s->req);
2313 channel_auto_close(&s->req);
2314 channel_auto_read(&s->res);
2315
2316
2317 return 1;
2318 }
2319 return 0;
2320}
2321
William Lallemand8a022572018-10-26 14:47:35 +02002322/*
2323 * The mworker functions are used to initialize the CLI in the master process
2324 */
2325
William Lallemand309dc9a2018-10-26 14:47:45 +02002326 /*
2327 * Stop the mworker proxy
2328 */
2329void mworker_cli_proxy_stop()
2330{
William Lallemand550db6d2018-11-06 17:37:12 +01002331 if (mworker_proxy)
2332 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002333}
2334
William Lallemand8a022572018-10-26 14:47:35 +02002335/*
2336 * Create the mworker CLI proxy
2337 */
2338int mworker_cli_proxy_create()
2339{
2340 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002341 char *msg = NULL;
2342 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002343
2344 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2345 if (!mworker_proxy)
2346 return -1;
2347
2348 init_new_proxy(mworker_proxy);
2349 mworker_proxy->next = proxies_list;
2350 proxies_list = mworker_proxy;
2351 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002352 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002353 mworker_proxy->state = PR_STNEW;
2354 mworker_proxy->last_change = now.tv_sec;
2355 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2356 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2357 mworker_proxy->timeout.client = 0; /* no timeout */
2358 mworker_proxy->conf.file = strdup("MASTER");
2359 mworker_proxy->conf.line = 0;
2360 mworker_proxy->accept = frontend_accept;
2361 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2362
2363 /* Does not init the default target the CLI applet, but must be done in
2364 * the request parsing code */
2365 mworker_proxy->default_target = NULL;
2366
2367 /* the check_config_validity() will get an ID for the proxy */
2368 mworker_proxy->uuid = -1;
2369
2370 proxy_store_name(mworker_proxy);
2371
2372 /* create all servers using the mworker_proc list */
2373 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002374 struct server *newsrv = NULL;
2375 struct sockaddr_storage *sk;
2376 int port1, port2, port;
2377 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002378
2379 newsrv = new_server(mworker_proxy);
2380 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002381 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002382
2383 /* we don't know the new pid yet */
2384 if (child->pid == -1)
2385 memprintf(&msg, "cur-%d", child->relative_pid);
2386 else
2387 memprintf(&msg, "old-%d", child->pid);
2388
2389 newsrv->next = mworker_proxy->srv;
2390 mworker_proxy->srv = newsrv;
2391 newsrv->conf.file = strdup(msg);
2392 newsrv->id = strdup(msg);
2393 newsrv->conf.line = 0;
2394
2395 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002396 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002397 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002398 }
2399 free(msg);
2400 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002401
2402 proto = protocol_by_family(sk->ss_family);
2403 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002404 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002405 }
2406
2407 /* no port specified */
2408 newsrv->flags |= SRV_F_MAPPORTS;
2409 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002410 /* don't let the server participate to load balancing */
2411 newsrv->iweight = 0;
2412 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002413 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002414
2415 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002416 }
2417 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002418
2419error:
2420 ha_alert("%s\n", errmsg);
2421
2422 list_for_each_entry(child, &proc_list, list) {
2423 free((char *)child->srv->conf.file); /* cast because of const char * */
2424 free(child->srv->id);
2425 free(child->srv);
2426 child->srv = NULL;
2427 }
2428 free(mworker_proxy->id);
2429 free(mworker_proxy->conf.file);
2430 free(mworker_proxy);
2431 mworker_proxy = NULL;
2432 free(errmsg);
2433 free(msg);
2434
2435 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002436}
Olivier Houchardf886e342017-04-05 22:24:59 +02002437
William Lallemandce83b4a2018-10-26 14:47:30 +02002438/*
William Lallemande7361152018-10-26 14:47:36 +02002439 * Create a new listener for the master CLI proxy
2440 */
2441int mworker_cli_proxy_new_listener(char *line)
2442{
2443 struct bind_conf *bind_conf;
2444 struct listener *l;
2445 char *err = NULL;
2446 char *args[MAX_LINE_ARGS + 1];
2447 int arg;
2448 int cur_arg;
2449
2450 arg = 0;
2451 args[0] = line;
2452
2453 /* args is a bind configuration with spaces replaced by commas */
2454 while (*line && arg < MAX_LINE_ARGS) {
2455
2456 if (*line == ',') {
2457 *line++ = '\0';
2458 while (*line == ',')
2459 line++;
2460 args[++arg] = line;
2461 }
2462 line++;
2463 }
2464
2465 args[++arg] = "\0";
2466
2467 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002468 if (!bind_conf)
2469 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002470
2471 bind_conf->level &= ~ACCESS_LVL_MASK;
2472 bind_conf->level |= ACCESS_LVL_ADMIN;
2473
2474 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2475 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002476 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002477 }
2478
2479 cur_arg = 1;
2480
2481 while (*args[cur_arg]) {
2482 static int bind_dumped;
2483 struct bind_kw *kw;
2484
2485 kw = bind_find_kw(args[cur_arg]);
2486 if (kw) {
2487 if (!kw->parse) {
2488 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2489 args[0], args[1], args[cur_arg]);
2490 goto err;
2491 }
2492
2493 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2494 if (err)
2495 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2496 else
2497 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2498 args[0], args[1], args[cur_arg]);
2499 goto err;
2500 }
2501
2502 cur_arg += 1 + kw->skip;
2503 continue;
2504 }
2505
2506 if (!bind_dumped) {
2507 bind_dump_kws(&err);
2508 indent_msg(&err, 4);
2509 bind_dumped = 1;
2510 }
2511
2512 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2513 args[0], args[1], args[cur_arg],
2514 err ? " Registered keywords :" : "", err ? err : "");
2515 goto err;
2516 }
2517
2518
2519 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
2520 l->maxconn = 10;
2521 l->backlog = 10;
2522 l->accept = session_accept_fd;
2523 l->default_target = mworker_proxy->default_target;
2524 /* don't make the peers subject to global limits and don't close it in the master */
2525 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2526 l->nice = -64; /* we want to boost priority for local stats */
2527 global.maxsock += l->maxconn;
2528 }
2529
2530 return 0;
2531
2532err:
2533 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002534 free(err);
2535 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002536 return -1;
2537
2538}
2539
2540/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002541 * Create a new CLI socket using a socketpair for a worker process
2542 * <mworker_proc> is the process structure, and <proc> is the process number
2543 */
2544int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2545{
2546 struct bind_conf *bind_conf;
2547 struct listener *l;
2548 char *path = NULL;
2549 char *err = NULL;
2550
2551 /* master pipe to ensure the master is still alive */
2552 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2553 ha_alert("Cannot create worker socketpair.\n");
2554 return -1;
2555 }
2556
2557 /* XXX: we might want to use a separate frontend at some point */
2558 if (!global.stats_fe) {
2559 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2560 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002561 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002562 }
2563 }
2564
2565 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002566 if (!bind_conf)
2567 goto error;
2568
William Lallemandce83b4a2018-10-26 14:47:30 +02002569 bind_conf->level &= ~ACCESS_LVL_MASK;
2570 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2571
2572 bind_conf->bind_proc = 1UL << proc;
2573 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2574
2575 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2576 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002577 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002578 }
2579
2580 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002581 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002582 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002583 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002584 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002585 free(path);
2586 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002587
2588 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
2589 l->maxconn = global.stats_fe->maxconn;
2590 l->backlog = global.stats_fe->backlog;
2591 l->accept = session_accept_fd;
2592 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002593 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002594 /* it's a sockpair but we don't want to keep the fd in the master */
2595 l->options &= ~LI_O_INHERITED;
2596 l->nice = -64; /* we want to boost priority for local stats */
2597 global.maxsock += l->maxconn;
2598 }
2599
2600 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002601
2602error:
2603 close(mworker_proc->ipc_fd[0]);
2604 close(mworker_proc->ipc_fd[1]);
2605 free(err);
2606
2607 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002608}
2609
William Lallemand74c24fb2016-11-21 17:18:36 +01002610static struct applet cli_applet = {
2611 .obj_type = OBJ_TYPE_APPLET,
2612 .name = "<CLI>", /* used for logging */
2613 .fct = cli_io_handler,
2614 .release = cli_release_handler,
2615};
2616
Willy Tarreau0a739292016-11-22 20:21:23 +01002617/* register cli keywords */
2618static struct cli_kw_list cli_kws = {{ },{
William Lallemand4e8450b2018-10-26 14:47:43 +02002619 { { "@<relative pid>", NULL }, "@<relative pid> : send a command to the <relative pid> process", NULL, cli_io_handler_show_proc, NULL, NULL, ACCESS_MASTER_ONLY},
2620 { { "@!<pid>", NULL }, "@!<pid> : send a command to the <pid> process", cli_parse_default, NULL, NULL, NULL, ACCESS_MASTER_ONLY},
2621 { { "@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 +02002622 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2623 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2624 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002625 { { "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 +01002626 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002627 { { "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 +01002628 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002629 { { "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 +02002630 { { "show", "cli", "sockets", NULL }, "show cli sockets : dump list of cli sockets", cli_parse_default, cli_io_handler_show_cli_sock, NULL, NULL, ACCESS_MASTER },
William Lallemand67a234f2018-12-13 09:05:45 +01002631 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02002632 { { "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 +01002633 { { "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 +02002634 { { "show", "proc", NULL }, "show proc : show processes status", cli_parse_default, cli_io_handler_show_proc, NULL, NULL, ACCESS_MASTER_ONLY},
William Lallemand67a234f2018-12-13 09:05:45 +01002635 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2636 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
William Lallemanda57b7e32018-12-14 21:11:31 +01002637 { { "reload", NULL }, "reload : reload haproxy", cli_parse_reload, NULL, NULL, NULL, ACCESS_MASTER_ONLY},
Olivier Houchardf886e342017-04-05 22:24:59 +02002638 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002639 {{},}
2640}};
2641
Willy Tarreau0108d902018-11-25 19:14:37 +01002642INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2643
William Lallemand74c24fb2016-11-21 17:18:36 +01002644static struct cfg_kw_list cfg_kws = {ILH, {
2645 { CFG_GLOBAL, "stats", stats_parse_global },
2646 { 0, NULL, NULL },
2647}};
2648
Willy Tarreau0108d902018-11-25 19:14:37 +01002649INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2650
William Lallemand74c24fb2016-11-21 17:18:36 +01002651static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002652 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2653 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002654 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002655 { NULL, NULL, 0 },
2656}};
2657
Willy Tarreau0108d902018-11-25 19:14:37 +01002658INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002659
2660/*
2661 * Local variables:
2662 * c-indent-level: 8
2663 * c-basic-offset: 8
2664 * End:
2665 */