blob: 38c178dc24e8ba49e701ba36399760c227258973 [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) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100300 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100301 l->default_target = global.stats_fe->default_target;
302 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
303 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100304 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100305 }
306 }
307 else if (!strcmp(args[1], "timeout")) {
308 unsigned timeout;
309 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
310
311 if (res) {
312 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
313 return -1;
314 }
315
316 if (!timeout) {
317 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
318 return -1;
319 }
320 if (!global.stats_fe) {
321 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
322 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
323 return -1;
324 }
325 }
326 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
327 }
328 else if (!strcmp(args[1], "maxconn")) {
329 int maxconn = atol(args[2]);
330
331 if (maxconn <= 0) {
332 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
333 return -1;
334 }
335
336 if (!global.stats_fe) {
337 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
338 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
339 return -1;
340 }
341 }
342 global.stats_fe->maxconn = maxconn;
343 }
344 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
345 int cur_arg = 2;
346 unsigned long set = 0;
347
348 if (!global.stats_fe) {
349 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
350 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
351 return -1;
352 }
353 }
354
355 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100356 if (strcmp(args[cur_arg], "all") == 0) {
357 set = 0;
358 break;
359 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100360 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100361 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100362 return -1;
363 }
364 cur_arg++;
365 }
366 global.stats_fe->bind_proc = set;
367 }
368 else {
369 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
370 return -1;
371 }
372 return 0;
373}
374
Willy Tarreaude57a572016-11-23 17:01:39 +0100375/* Verifies that the CLI at least has a level at least as high as <level>
376 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
377 * failure, an error message is prepared and the appctx's state is adjusted
378 * to print it so that a return 1 is enough to abort any processing.
379 */
380int cli_has_level(struct appctx *appctx, int level)
381{
Willy Tarreaude57a572016-11-23 17:01:39 +0100382
William Lallemandf630d012018-12-13 09:05:44 +0100383 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200384 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100385 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100386 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100387 return 0;
388 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100389 return 1;
390}
391
William Lallemandb7ea1412018-12-13 09:05:47 +0100392/* same as cli_has_level but for the CLI proxy and without error message */
393int pcli_has_level(struct stream *s, int level)
394{
395 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
396 return 0;
397 }
398 return 1;
399}
400
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200401/* Returns severity_output for the current session if set, or default for the socket */
402static int cli_get_severity_output(struct appctx *appctx)
403{
404 if (appctx->cli_severity_output)
405 return appctx->cli_severity_output;
406 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
407}
William Lallemand74c24fb2016-11-21 17:18:36 +0100408
Willy Tarreau41908562016-11-24 16:23:38 +0100409/* Processes the CLI interpreter on the stats socket. This function is called
410 * from the CLI's IO handler running in an appctx context. The function returns 1
411 * if the request was understood, otherwise zero. It is called with appctx->st0
412 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
413 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
414 * have its own I/O handler called again. Most of the time, parsers will only
415 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100416 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
417 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100418 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200419static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100420{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200421 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
422 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100423 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100424
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200425 appctx->st2 = 0;
426 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100427
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200428 p = appctx->chunk->area;
429 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100430
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200431 /*
432 * Get the payload start if there is one.
433 * For the sake of simplicity, the payload pattern is looked up
434 * everywhere from the start of the input but it can only be found
435 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
436 *
437 * The input string was zero terminated so it is safe to use
438 * the str*() functions throughout the parsing
439 */
440 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
441 payload = strstr(p, PAYLOAD_PATTERN);
442 end = payload;
443 /* skip the pattern */
444 payload += strlen(PAYLOAD_PATTERN);
445 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100446
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200447 /*
448 * Get pointers on words.
449 * One extra slot is reserved to store a pointer on a null byte.
450 */
451 while (i < MAX_STATS_ARGS && p < end) {
452 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100453
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200454 /* skip leading spaces/tabs */
455 p += strspn(p, " \t");
456 if (!*p)
457 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100458
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200459 args[i] = p;
460 p += strcspn(p, " \t");
461 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100462
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200463 /* unescape backslashes (\) */
464 for (j = 0, k = 0; args[i][k]; k++) {
465 if (args[i][k] == '\\') {
466 if (args[i][k + 1] == '\\')
467 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100468 else
469 continue;
470 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200471 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100472 j++;
473 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200474 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100475
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200476 i++;
477 }
478 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200479 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200480 for (; i < MAX_STATS_ARGS + 1; i++)
481 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100482
483 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100484 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100485 return 0;
486
William Lallemand14721be2018-10-26 14:47:37 +0200487 /* in a worker or normal process, don't display master only commands */
488 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
489 return 0;
490
491 /* in master don't displays if we don't have the master bits */
492 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
493 return 0;
494
Willy Tarreau41908562016-11-24 16:23:38 +0100495 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200496 appctx->io_release = kw->io_release;
497 /* kw->parse could set its own io_handler or ip_release handler */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200498 if ((!kw->parse || kw->parse(args, payload, appctx, kw->private) == 0) && appctx->io_handler) {
Willy Tarreau41908562016-11-24 16:23:38 +0100499 appctx->st0 = CLI_ST_CALLBACK;
William Lallemand74c24fb2016-11-21 17:18:36 +0100500 }
Willy Tarreau41908562016-11-24 16:23:38 +0100501 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100502}
503
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200504/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
505static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
506{
Willy Tarreau83061a82018-07-13 11:56:34 +0200507 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200508
509 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200510 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200511
512 tmp = get_trash_chunk();
513 chunk_reset(tmp);
514
515 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100516 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200517 chunk_printf(tmp, "[%d]: ", severity);
518 }
519 else {
520 switch (severity_output) {
521 case CLI_SEVERITY_NUMBER:
522 chunk_printf(tmp, "[%d]: ", severity);
523 break;
524 case CLI_SEVERITY_STRING:
525 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
526 break;
527 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100528 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200529 }
530 }
531 chunk_appendf(tmp, "%s", msg);
532
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200533 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200534}
535
William Lallemand74c24fb2016-11-21 17:18:36 +0100536/* This I/O handler runs as an applet embedded in a stream interface. It is
537 * used to processes I/O from/to the stats unix socket. The system relies on a
538 * state machine handling requests and various responses. We read a request,
539 * then we process it and send the response, and we possibly display a prompt.
540 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100541 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 * or not.
543 */
544static void cli_io_handler(struct appctx *appctx)
545{
546 struct stream_interface *si = appctx->owner;
547 struct channel *req = si_oc(si);
548 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200549 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100550 int reql;
551 int len;
552
553 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
554 goto out;
555
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800556 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200557 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100558 /* buf.size==0 means we failed to get a buffer and were
559 * already subscribed to a wait list to get a buffer.
560 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100561 goto out;
562 }
563
William Lallemand74c24fb2016-11-21 17:18:36 +0100564 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100565 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100566 /* Stats output not initialized yet */
567 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200568 /* reset severity to default at init */
569 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100570 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100571 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100572 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100573 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100574 /* Let's close for real now. We just close the request
575 * side, the conditions below will complete if needed.
576 */
577 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200578 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100579 break;
580 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100581 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200582 char *str;
583
584 /* use a trash chunk to store received data */
585 if (!appctx->chunk) {
586 appctx->chunk = alloc_trash_chunk();
587 if (!appctx->chunk) {
588 appctx->st0 = CLI_ST_END;
589 continue;
590 }
591 }
592
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200593 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200594
William Lallemand74c24fb2016-11-21 17:18:36 +0100595 /* ensure we have some output room left in the event we
596 * would want to return some info right after parsing.
597 */
598 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100599 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100600 break;
601 }
602
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200603 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200604 reql = co_getline(si_oc(si), str,
605 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100606 if (reql <= 0) { /* closed or EOL not found */
607 if (reql == 0)
608 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100609 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100610 continue;
611 }
612
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200613 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
614 /* seek for a possible unescaped semi-colon. If we find
615 * one, we replace it with an LF and skip only this part.
616 */
617 for (len = 0; len < reql; len++) {
618 if (str[len] == '\\') {
619 len++;
620 continue;
621 }
622 if (str[len] == ';') {
623 str[len] = '\n';
624 reql = len + 1;
625 break;
626 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100627 }
628 }
629
630 /* now it is time to check that we have a full line,
631 * remove the trailing \n and possibly \r, then cut the
632 * line.
633 */
634 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200635 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100636 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100637 continue;
638 }
639
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200640 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100641 len--;
642
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200643 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200644 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200645
646 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200647 appctx->chunk->area[appctx->chunk->data] = '\n';
648 appctx->chunk->area[appctx->chunk->data + 1] = 0;
649 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200650 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100651
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100652 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200653
654 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
655 /* empty line */
656 if (!len) {
657 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200658 appctx->chunk->data -= 2;
659 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200660
661 if (!cli_parse_request(appctx))
662 cli_gen_usage_msg(appctx);
663
664 chunk_reset(appctx->chunk);
665 /* NB: cli_sock_parse_request() may have put
666 * another CLI_ST_O_* into appctx->st0.
667 */
668
669 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100670 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100671 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200672 else {
673 /*
674 * Look for the "payload start" pattern at the end of a line
675 * Its location is not remembered here, this is just to switch
676 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100677 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200678 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200679 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200680 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200681 /* no payload, the command is complete: parse the request */
682 if (!cli_parse_request(appctx))
683 cli_gen_usage_msg(appctx);
684
685 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200686 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100687 }
688
689 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200690 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100691 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
692 }
693 else { /* output functions */
694 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100695 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100696 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100697 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200698 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
699 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100700 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100701 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100702 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100703 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200704 case CLI_ST_PRINT_FREE: {
705 const char *msg = appctx->ctx.cli.err;
706
707 if (!msg)
708 msg = "Out of memory.\n";
709
710 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100711 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100712 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100713 }
714 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100715 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100716 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200717 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100718 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100719 if (appctx->io_handler)
720 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100721 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100722 if (appctx->io_release) {
723 appctx->io_release(appctx);
724 appctx->io_release = NULL;
725 }
726 }
727 break;
728 default: /* abnormal state */
729 si->flags |= SI_FL_ERR;
730 break;
731 }
732
733 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100734 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200735 const char *prompt = "";
736
737 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
738 /*
739 * when entering a payload with interactive mode, change the prompt
740 * to emphasize that more data can still be sent
741 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200742 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 prompt = "+ ";
744 else
745 prompt = "\n> ";
746 }
747 else {
748 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))
749 prompt = "\n";
750 }
751
752 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100753 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100754 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100755 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100756 }
757
758 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100759 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100760 break;
761
762 /* Now we close the output if one of the writers did so,
763 * or if we're not in interactive mode and the request
764 * buffer is empty. This still allows pipelined requests
765 * to be sent in non-interactive mode.
766 */
William Lallemand3de09d52018-12-11 16:10:56 +0100767 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
768 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100769 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100770 continue;
771 }
772
773 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100774 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100775 }
776 }
777
778 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
779 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
780 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
781 /* Other side has closed, let's abort if we have no more processing to do
782 * and nothing more to consume. This is comparable to a broken pipe, so
783 * we forward the close to the request side so that it flows upstream to
784 * the client.
785 */
786 si_shutw(si);
787 }
788
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100789 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100790 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
791 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
792 /* We have no more processing to do, and nothing more to send, and
793 * the client side has closed. So we'll forward this state downstream
794 * on the response buffer.
795 */
796 si_shutr(si);
797 res->flags |= CF_READ_NULL;
798 }
799
800 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200801 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 +0100802 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200803 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 +0100804}
805
William Lallemand74c24fb2016-11-21 17:18:36 +0100806/* This is called when the stream interface is closed. For instance, upon an
807 * external abort, we won't call the i/o handler anymore so we may need to
808 * remove back references to the stream currently being dumped.
809 */
810static void cli_release_handler(struct appctx *appctx)
811{
812 if (appctx->io_release) {
813 appctx->io_release(appctx);
814 appctx->io_release = NULL;
815 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100816 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100817 free(appctx->ctx.cli.err);
818 appctx->ctx.cli.err = NULL;
819 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100820}
821
822/* This function dumps all environmnent variables to the buffer. It returns 0
823 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100824 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
825 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100827static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100828{
Willy Tarreau0a739292016-11-22 20:21:23 +0100829 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100830 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100831
832 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
833 return 1;
834
835 chunk_reset(&trash);
836
837 /* we have two inner loops here, one for the proxy, the other one for
838 * the buffer.
839 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100840 while (*var) {
841 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100842
Willy Tarreau06d80a92017-10-19 14:32:15 +0200843 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100844 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100845 return 0;
846 }
847 if (appctx->st2 == STAT_ST_END)
848 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100849 var++;
850 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100851 }
852
853 /* dump complete */
854 return 1;
855}
856
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200857/* This function dumps all file descriptors states (or the requested one) to
858 * the buffer. It returns 0 if the output buffer is full and it needs to be
859 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
860 * It uses cli.i0 as the fd number to restart from.
861 */
862static int cli_io_handler_show_fd(struct appctx *appctx)
863{
864 struct stream_interface *si = appctx->owner;
865 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100866 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200867
868 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100869 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200870
871 chunk_reset(&trash);
872
Willy Tarreauca1b1572018-12-18 15:45:11 +0100873 /* isolate the threads once per round. We're limited to a buffer worth
874 * of output anyway, it cannot last very long.
875 */
876 thread_isolate();
877
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200878 /* we have two inner loops here, one for the proxy, the other one for
879 * the buffer.
880 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100881 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200882 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200883 struct listener *li = NULL;
884 struct server *sv = NULL;
885 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200886 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200887 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +0200888 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100889 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200890
891 fdt = fdtab[fd];
892
Willy Tarreauca1b1572018-12-18 15:45:11 +0100893 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +0200894 goto skip; // closed
895
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200896 if (fdt.iocb == conn_fd_handler) {
897 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200898 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100899 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200900 li = objt_listener(((struct connection *)fdt.owner)->target);
901 sv = objt_server(((struct connection *)fdt.owner)->target);
902 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100903 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200904 }
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) {
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100939 chunk_appendf(&trash, " back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200940 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 Tarreau8a034082019-02-27 10:45:55 +01001020 chunk_appendf(&trash, "\naccq_pushed:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].accq_pushed);
1021 chunk_appendf(&trash, "\naccq_full:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].accq_full);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001022
1023 chunk_appendf(&trash, "\n");
1024
1025 if (ci_putchk(si_ic(si), &trash) == -1) {
1026 chunk_reset(&trash);
1027 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001028 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001029 }
1030
1031 /* dump complete */
1032 return 1;
1033}
1034
William Lallemandeceddf72016-12-15 18:06:44 +01001035/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001036 * CLI IO handler for `show cli sockets`.
1037 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001038 */
1039static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1040{
1041 struct bind_conf *bind_conf;
1042 struct stream_interface *si = appctx->owner;
1043
1044 chunk_reset(&trash);
1045
1046 switch (appctx->st2) {
1047 case STAT_ST_INIT:
1048 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001049 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001050 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001051 return 0;
1052 }
William Lallemandeceddf72016-12-15 18:06:44 +01001053 appctx->st2 = STAT_ST_LIST;
1054
1055 case STAT_ST_LIST:
1056 if (global.stats_fe) {
1057 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1058 struct listener *l;
1059
1060 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001061 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001062 * if the current node is the first of the list
1063 */
1064
Willy Tarreau3af9d832016-12-16 12:58:09 +01001065 if (appctx->ctx.cli.p0 &&
1066 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001067 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001068 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001069 continue;
1070 }
1071
1072 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1073
1074 char addr[46];
1075 char port[6];
1076
1077 if (l->addr.ss_family == AF_UNIX) {
1078 const struct sockaddr_un *un;
1079
1080 un = (struct sockaddr_un *)&l->addr;
1081 chunk_appendf(&trash, "%s ", un->sun_path);
1082 } else if (l->addr.ss_family == AF_INET) {
1083 addr_to_str(&l->addr, addr, sizeof(addr));
1084 port_to_str(&l->addr, port, sizeof(port));
1085 chunk_appendf(&trash, "%s:%s ", addr, port);
1086 } else if (l->addr.ss_family == AF_INET6) {
1087 addr_to_str(&l->addr, addr, sizeof(addr));
1088 port_to_str(&l->addr, port, sizeof(port));
1089 chunk_appendf(&trash, "[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001090 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1091 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001092 } else
William Lallemand26314342018-10-26 14:47:41 +02001093 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001094
William Lallemand07a62f72017-05-24 00:57:40 +02001095 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001096 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001097 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1098 chunk_appendf(&trash, "operator ");
1099 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1100 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001101 else
1102 chunk_appendf(&trash, " ");
1103
1104 if (bind_conf->bind_proc != 0) {
1105 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001106 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001107 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001108 chunk_appendf(&trash, "%d,", pos+1);
1109 }
1110 }
1111 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001112 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001113
1114 } else {
1115 chunk_appendf(&trash, "all\n");
1116 }
1117
Willy Tarreau06d80a92017-10-19 14:32:15 +02001118 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001119 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001120 return 0;
1121 }
1122 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001123 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001124 }
1125 }
1126 default:
1127 appctx->st2 = STAT_ST_FIN;
1128 return 1;
1129 }
1130}
1131
1132
Willy Tarreau0a739292016-11-22 20:21:23 +01001133/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001134 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1135 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001136 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001137static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001138{
1139 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001140 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001141
1142 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1143 return 1;
1144
Willy Tarreauf6710f82016-12-16 17:45:44 +01001145 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001146
1147 if (*args[2]) {
1148 int len = strlen(args[2]);
1149
Willy Tarreauf6710f82016-12-16 17:45:44 +01001150 for (; *var; var++) {
1151 if (strncmp(*var, args[2], len) == 0 &&
1152 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001153 break;
1154 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001155 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001156 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001157 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001158 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001159 return 1;
1160 }
1161 appctx->st2 = STAT_ST_END;
1162 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001163 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001164 return 0;
1165}
1166
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001167/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1168 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1169 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1170 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001171static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001172{
1173 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1174 return 1;
1175
1176 appctx->ctx.cli.i0 = 0;
1177
1178 if (*args[2]) {
1179 appctx->ctx.cli.i0 = atoi(args[2]);
1180 appctx->st2 = STAT_ST_END;
1181 }
1182 return 0;
1183}
1184
Willy Tarreau599852e2016-11-22 20:33:32 +01001185/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001186static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001187{
1188 struct stream_interface *si = appctx->owner;
1189 struct stream *s = si_strm(si);
1190
1191 if (strcmp(args[2], "cli") == 0) {
1192 unsigned timeout;
1193 const char *res;
1194
1195 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001196 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001197 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001198 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001199 return 1;
1200 }
1201
1202 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1203 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001204 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001205 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001206 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001207 return 1;
1208 }
1209
1210 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1211 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1212 return 1;
1213 }
1214 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001215 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001216 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001217 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001218 return 1;
1219 }
1220}
1221
Willy Tarreau2af99412016-11-23 11:10:59 +01001222/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001223static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001224{
1225 int v;
1226
1227 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1228 return 1;
1229
1230 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001231 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001232 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001233 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001234 return 1;
1235 }
1236
1237 v = atoi(args[3]);
1238 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001239 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001240 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001241 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001242 return 1;
1243 }
1244
1245 /* check for unlimited values */
1246 if (v <= 0)
1247 v = global.hardmaxconn;
1248
1249 global.maxconn = v;
1250
1251 /* Dequeues all of the listeners waiting for a resource */
1252 if (!LIST_ISEMPTY(&global_listener_queue))
1253 dequeue_all_listeners(&global_listener_queue);
1254
1255 return 1;
1256}
1257
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001258static int set_severity_output(int *target, char *argument)
1259{
1260 if (!strcmp(argument, "none")) {
1261 *target = CLI_SEVERITY_NONE;
1262 return 1;
1263 }
1264 else if (!strcmp(argument, "number")) {
1265 *target = CLI_SEVERITY_NUMBER;
1266 return 1;
1267 }
1268 else if (!strcmp(argument, "string")) {
1269 *target = CLI_SEVERITY_STRING;
1270 return 1;
1271 }
1272 return 0;
1273}
1274
1275/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001276static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001277{
1278 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1279 return 0;
1280
1281 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001282 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001283 appctx->st0 = CLI_ST_PRINT;
1284 return 1;
1285}
William Lallemandeceddf72016-12-15 18:06:44 +01001286
William Lallemand67a234f2018-12-13 09:05:45 +01001287
1288/* show the level of the current CLI session */
1289static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1290{
1291
1292 appctx->ctx.cli.severity = LOG_INFO;
1293 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1294 appctx->ctx.cli.msg = "admin\n";
1295 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1296 appctx->ctx.cli.msg = "operator\n";
1297 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1298 appctx->ctx.cli.msg = "user\n";
1299 else
1300 appctx->ctx.cli.msg = "unknown\n";
1301
1302 appctx->st0 = CLI_ST_PRINT;
1303 return 1;
1304
1305}
1306
1307/* parse and set the CLI level dynamically */
1308static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1309{
1310 if (!strcmp(args[0], "operator")) {
1311 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1312 return 1;
1313 }
1314 appctx->cli_level &= ~ACCESS_LVL_MASK;
1315 appctx->cli_level |= ACCESS_LVL_OPER;
1316
1317 } else if (!strcmp(args[0], "user")) {
1318 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1319 return 1;
1320 }
1321 appctx->cli_level &= ~ACCESS_LVL_MASK;
1322 appctx->cli_level |= ACCESS_LVL_USER;
1323 }
1324 return 1;
1325}
1326
William Lallemanda57b7e32018-12-14 21:11:31 +01001327
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001328int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001329{
1330 return 0;
1331}
1332
Willy Tarreau45c742b2016-11-24 14:51:17 +01001333/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001334static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001335{
1336 int v;
1337 int *res;
1338 int mul = 1;
1339
1340 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1341 return 1;
1342
1343 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1344 res = &global.cps_lim;
1345 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1346 res = &global.sps_lim;
1347#ifdef USE_OPENSSL
1348 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1349 res = &global.ssl_lim;
1350#endif
1351 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1352 res = &global.comp_rate_lim;
1353 mul = 1024;
1354 }
1355 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001356 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001357 appctx->ctx.cli.msg =
1358 "'set rate-limit' only supports :\n"
1359 " - 'connections global' to set the per-process maximum connection rate\n"
1360 " - 'sessions global' to set the per-process maximum session rate\n"
1361#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001362 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001363#endif
1364 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001365 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001366 return 1;
1367 }
1368
1369 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001370 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001371 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001372 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001373 return 1;
1374 }
1375
1376 v = atoi(args[4]);
1377 if (v < 0) {
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 = "Value out of range.\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 *res = v * mul;
1385
1386 /* Dequeues all of the listeners waiting for a resource */
1387 if (!LIST_ISEMPTY(&global_listener_queue))
1388 dequeue_all_listeners(&global_listener_queue);
1389
1390 return 1;
1391}
1392
William Lallemandf6975e92017-05-26 17:42:10 +02001393/* parse the "expose-fd" argument on the bind lines */
1394static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1395{
1396 if (!*args[cur_arg + 1]) {
1397 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1398 return ERR_ALERT | ERR_FATAL;
1399 }
1400 if (!strcmp(args[cur_arg+1], "listeners")) {
1401 conf->level |= ACCESS_FD_LISTENERS;
1402 } else {
1403 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1404 args[cur_arg], args[cur_arg+1]);
1405 return ERR_ALERT | ERR_FATAL;
1406 }
1407
1408 return 0;
1409}
1410
William Lallemand74c24fb2016-11-21 17:18:36 +01001411/* parse the "level" argument on the bind lines */
1412static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1413{
1414 if (!*args[cur_arg + 1]) {
1415 memprintf(err, "'%s' : missing level", args[cur_arg]);
1416 return ERR_ALERT | ERR_FATAL;
1417 }
1418
William Lallemand07a62f72017-05-24 00:57:40 +02001419 if (!strcmp(args[cur_arg+1], "user")) {
1420 conf->level &= ~ACCESS_LVL_MASK;
1421 conf->level |= ACCESS_LVL_USER;
1422 } else if (!strcmp(args[cur_arg+1], "operator")) {
1423 conf->level &= ~ACCESS_LVL_MASK;
1424 conf->level |= ACCESS_LVL_OPER;
1425 } else if (!strcmp(args[cur_arg+1], "admin")) {
1426 conf->level &= ~ACCESS_LVL_MASK;
1427 conf->level |= ACCESS_LVL_ADMIN;
1428 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001429 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1430 args[cur_arg], args[cur_arg+1]);
1431 return ERR_ALERT | ERR_FATAL;
1432 }
1433
1434 return 0;
1435}
1436
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001437static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1438{
1439 if (!*args[cur_arg + 1]) {
1440 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1441 return ERR_ALERT | ERR_FATAL;
1442 }
1443
1444 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1445 return 0;
1446 else {
1447 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1448 args[cur_arg], args[cur_arg+1]);
1449 return ERR_ALERT | ERR_FATAL;
1450 }
1451}
1452
William Lallemand16dd1b32018-11-19 18:46:18 +01001453
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001454
Olivier Houchardf886e342017-04-05 22:24:59 +02001455/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001456static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001457{
1458 char *cmsgbuf = NULL;
1459 unsigned char *tmpbuf = NULL;
1460 struct cmsghdr *cmsg;
1461 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001462 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001463 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001464 struct msghdr msghdr;
1465 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001466 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001467 int *tmpfd;
1468 int tot_fd_nb = 0;
1469 struct proxy *px;
1470 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001471 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001472 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001473 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001474 int ret;
1475
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001476 if (!remote) {
1477 ha_warning("Only works on real connections\n");
1478 goto out;
1479 }
1480
1481 fd = remote->handle.fd;
1482
Olivier Houchardf886e342017-04-05 22:24:59 +02001483 /* Temporary set the FD in blocking mode, that will make our life easier */
1484 old_fcntl = fcntl(fd, F_GETFL);
1485 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001486 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001487 goto out;
1488 }
1489 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1490 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001491 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001492 goto out;
1493 }
1494 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001495 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001496 goto out;
1497 }
Olivier Houchard54740872017-04-06 14:45:14 +02001498 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001499 iov.iov_base = &tot_fd_nb;
1500 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001501 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001502 goto out;
1503 memset(&msghdr, 0, sizeof(msghdr));
1504 /*
1505 * First, calculates the total number of FD, so that we can let
1506 * the caller know how much he should expects.
1507 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001508 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001509 while (px) {
1510 struct listener *l;
1511
1512 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001513 /* Only transfer IPv4/IPv6/UNIX sockets */
1514 if (l->state >= LI_ZOMBIE &&
1515 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001516 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001517 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001518 tot_fd_nb++;
1519 }
1520 px = px->next;
1521 }
1522 if (tot_fd_nb == 0)
1523 goto out;
1524
1525 /* First send the total number of file descriptors, so that the
1526 * receiving end knows what to expect.
1527 */
1528 msghdr.msg_iov = &iov;
1529 msghdr.msg_iovlen = 1;
1530 ret = sendmsg(fd, &msghdr, 0);
1531 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001532 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001533 goto out;
1534 }
1535
1536 /* Now send the fds */
1537 msghdr.msg_control = cmsgbuf;
1538 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1539 cmsg = CMSG_FIRSTHDR(&msghdr);
1540 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1541 cmsg->cmsg_level = SOL_SOCKET;
1542 cmsg->cmsg_type = SCM_RIGHTS;
1543 tmpfd = (int *)CMSG_DATA(cmsg);
1544
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001545 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001546 /* For each socket, e message is sent, containing the following :
1547 * Size of the namespace name (or 0 if none), as an unsigned char.
1548 * The namespace name, if any
1549 * Size of the interface name (or 0 if none), as an unsigned char
1550 * The interface name, if any
1551 * Listener options, as an int.
1552 */
1553 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1554 * buffer big enough to store the socket informations.
1555 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001556 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001557 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001558 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001559 goto out;
1560 }
1561 iov.iov_base = tmpbuf;
1562 while (px) {
1563 struct listener *l;
1564
1565 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1566 int ret;
1567 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001568 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001569 (l->proto->sock_family == AF_INET ||
1570 l->proto->sock_family == AF_INET6 ||
1571 l->proto->sock_family == AF_UNIX)) {
1572 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1573 if (!l->netns)
1574 tmpbuf[curoff++] = 0;
1575#ifdef CONFIG_HAP_NS
1576 else {
1577 char *name = l->netns->node.key;
1578 unsigned char len = l->netns->name_len;
1579 tmpbuf[curoff++] = len;
1580 memcpy(tmpbuf + curoff, name, len);
1581 curoff += len;
1582 }
1583#endif
1584 if (l->interface) {
1585 unsigned char len = strlen(l->interface);
1586 tmpbuf[curoff++] = len;
1587 memcpy(tmpbuf + curoff, l->interface, len);
1588 curoff += len;
1589 } else
1590 tmpbuf[curoff++] = 0;
1591 memcpy(tmpbuf + curoff, &l->options,
1592 sizeof(l->options));
1593 curoff += sizeof(l->options);
1594
1595
1596 i++;
1597 } else
1598 continue;
1599 if ((!(i % MAX_SEND_FD))) {
1600 iov.iov_len = curoff;
1601 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001602 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001603 goto out;
1604 }
1605 /* Wait for an ack */
1606 do {
1607 ret = recv(fd, &tot_fd_nb,
1608 sizeof(tot_fd_nb), 0);
1609 } while (ret == -1 && errno == EINTR);
1610 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001611 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001612 goto out;
1613 }
1614 curoff = 0;
1615 }
1616
1617 }
1618 px = px->next;
1619 }
1620 if (i % MAX_SEND_FD) {
1621 iov.iov_len = curoff;
1622 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1623 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1624 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001625 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001626 goto out;
1627 }
1628 }
1629
1630out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001631 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001632 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001633 goto out;
1634 }
1635 appctx->st0 = CLI_ST_END;
1636 free(cmsgbuf);
1637 free(tmpbuf);
1638 return 1;
1639}
1640
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001641static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1642{
1643 if (*args[0] == 'h')
1644 /* help */
1645 cli_gen_usage_msg(appctx);
1646 else if (*args[0] == 'p')
1647 /* prompt */
1648 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1649 else if (*args[0] == 'q')
1650 /* quit */
1651 appctx->st0 = CLI_ST_END;
1652
1653 return 1;
1654}
Olivier Houchardf886e342017-04-05 22:24:59 +02001655
William Lallemand2f4ce202018-10-26 14:47:47 +02001656void pcli_write_prompt(struct stream *s)
1657{
1658 struct buffer *msg = get_trash_chunk();
1659 struct channel *oc = si_oc(&s->si[0]);
1660
William Lallemanddc12c2e2018-12-13 09:05:46 +01001661 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001662 return;
1663
William Lallemanddc12c2e2018-12-13 09:05:46 +01001664 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001665 chunk_appendf(msg, "+ ");
1666 } else {
1667 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001668 chunk_appendf(msg, "master%s> ",
1669 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001670 else
1671 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1672 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001673 co_inject(oc, msg->area, msg->data);
1674}
1675
William Lallemand291810d2018-10-26 14:47:38 +02001676
William Lallemandcf62f7e2018-10-26 14:47:40 +02001677/* The pcli_* functions are used for the CLI proxy in the master */
1678
William Lallemanddeeaa592018-10-26 14:47:48 +02001679void pcli_reply_and_close(struct stream *s, const char *msg)
1680{
1681 struct buffer *buf = get_trash_chunk();
1682
1683 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001684 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001685}
1686
William Lallemand291810d2018-10-26 14:47:38 +02001687static enum obj_type *pcli_pid_to_server(int proc_pid)
1688{
1689 struct mworker_proc *child;
1690
William Lallemandbddd33a2018-12-11 16:10:53 +01001691 /* return the CLI applet of the master */
1692 if (proc_pid == 0)
1693 return &cli_applet.obj_type;
1694
William Lallemand291810d2018-10-26 14:47:38 +02001695 list_for_each_entry(child, &proc_list, list) {
1696 if (child->pid == proc_pid){
1697 return &child->srv->obj_type;
1698 }
1699 }
1700 return NULL;
1701}
1702
1703/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1704 * Return:
1705 * 0: master
1706 * > 0: pid of a worker
1707 * < 0: didn't find a worker
1708 */
1709static int pcli_prefix_to_pid(const char *prefix)
1710{
1711 int proc_pid;
1712 struct mworker_proc *child;
1713 char *errtol = NULL;
1714
1715 if (*prefix != '@') /* not a prefix, should not happen */
1716 return -1;
1717
1718 prefix++;
1719 if (!*prefix) /* sent @ alone, return the master */
1720 return 0;
1721
1722 if (strcmp("master", prefix) == 0) {
1723 return 0;
1724 } else if (*prefix == '!') {
1725 prefix++;
1726 if (!*prefix)
1727 return -1;
1728
1729 proc_pid = strtol(prefix, &errtol, 10);
1730 if (*errtol != '\0')
1731 return -1;
1732 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001733 if (child->type != 'w')
1734 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001735 if (child->pid == proc_pid){
1736 return child->pid;
1737 }
1738 }
1739 } else {
1740 struct mworker_proc *chosen = NULL;
1741 /* this is a relative pid */
1742
1743 proc_pid = strtol(prefix, &errtol, 10);
1744 if (*errtol != '\0')
1745 return -1;
1746
1747 if (proc_pid == 0) /* return the master */
1748 return 0;
1749
1750 /* chose the right process, the current one is the one with the
1751 least number of reloads */
1752 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001753 if (child->type != 'w')
1754 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001755 if (child->relative_pid == proc_pid){
1756 if (child->reloads == 0)
1757 return child->pid;
1758 else if (chosen == NULL || child->reloads < chosen->reloads)
1759 chosen = child;
1760 }
1761 }
1762 if (chosen)
1763 return chosen->pid;
1764 }
1765 return -1;
1766}
1767
William Lallemandbddd33a2018-12-11 16:10:53 +01001768/* Return::
1769 * >= 0 : number of words to escape
1770 * = -1 : error
1771 */
1772
1773int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1774{
1775 if (argl < 1)
1776 return 0;
1777
1778 /* there is a prefix */
1779 if (args[0][0] == '@') {
1780 int target_pid = pcli_prefix_to_pid(args[0]);
1781
1782 if (target_pid == -1) {
1783 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1784 return -1;
1785 }
1786
1787 /* if the prefix is alone, define a default target */
1788 if (argl == 1)
1789 s->pcli_next_pid = target_pid;
1790 else
1791 *next_pid = target_pid;
1792 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001793 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001794 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001795 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001796
1797 } else if (!strcmp("quit", args[0])) {
1798 channel_shutr_now(&s->req);
1799 channel_shutw_now(&s->res);
1800 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001801 } else if (!strcmp(args[0], "operator")) {
1802 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1803 memprintf(errmsg, "Permission denied!\n");
1804 return -1;
1805 }
1806 s->pcli_flags &= ~ACCESS_LVL_MASK;
1807 s->pcli_flags |= ACCESS_LVL_OPER;
1808 return argl;
1809
1810 } else if (!strcmp(args[0], "user")) {
1811 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1812 memprintf(errmsg, "Permission denied!\n");
1813 return -1;
1814 }
1815 s->pcli_flags &= ~ACCESS_LVL_MASK;
1816 s->pcli_flags |= ACCESS_LVL_USER;
1817 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001818 }
1819
1820 return 0;
1821}
1822
1823/*
1824 * Parse the CLI request:
1825 * - It does basically the same as the cli_io_handler, but as a proxy
1826 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001827 *
1828 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01001829 * - the number of characters to forward or
1830 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02001831 */
William Lallemandbddd33a2018-12-11 16:10:53 +01001832int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001833{
William Lallemandbddd33a2018-12-11 16:10:53 +01001834 char *str = (char *)ci_head(req);
1835 char *end = (char *)ci_stop(req);
1836 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
1837 int argl; /* number of args */
1838 char *p;
1839 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01001840 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01001841 int wtrim = 0; /* number of words to trim */
1842 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01001843 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01001844 int i = 0;
1845
1846 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001847
William Lallemanddc12c2e2018-12-13 09:05:46 +01001848 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01001849
1850 /* Looks for the end of one command */
1851 while (p+reql < end) {
1852 /* handle escaping */
1853 if (p[reql] == '\\') {
1854 reql++;
1855 continue;
1856 }
1857 if (p[reql] == ';' || p[reql] == '\n') {
1858 /* found the end of the command */
1859 p[reql] = '\n';
1860 reql++;
1861 break;
1862 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001863 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001864 }
William Lallemandebf61802018-12-11 16:10:57 +01001865 } else {
1866 while (p+reql < end) {
1867 if (p[reql] == '\n') {
1868 /* found the end of the line */
1869 reql++;
1870 break;
1871 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001872 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001873 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001874 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001875
William Lallemandbddd33a2018-12-11 16:10:53 +01001876 /* set end to first byte after the end of the command */
1877 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001878
William Lallemandbddd33a2018-12-11 16:10:53 +01001879 /* there is no end to this command, need more to parse ! */
1880 if (*(end-1) != '\n') {
1881 return -1;
1882 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001883
William Lallemand3301f3e2018-12-13 09:05:48 +01001884 if (s->pcli_flags & PCLI_F_PAYLOAD) {
1885 if (reql == 1) /* last line of the payload */
1886 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01001887 return reql;
1888 }
1889
William Lallemandbddd33a2018-12-11 16:10:53 +01001890 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001891
William Lallemandbddd33a2018-12-11 16:10:53 +01001892 /* splits the command in words */
1893 while (i < MAX_STATS_ARGS && p < end) {
1894 int j, k;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001895
William Lallemandbddd33a2018-12-11 16:10:53 +01001896 /* skip leading spaces/tabs */
1897 p += strspn(p, " \t");
1898 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001899 break;
1900
William Lallemandbddd33a2018-12-11 16:10:53 +01001901 args[i] = p;
1902 p += strcspn(p, " \t");
1903 *p++ = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001904
William Lallemandbddd33a2018-12-11 16:10:53 +01001905 /* unescape backslashes (\) */
1906 for (j = 0, k = 0; args[i][k]; k++) {
1907 if (args[i][k] == '\\') {
1908 if (args[i][k + 1] == '\\')
1909 k++;
1910 else
1911 continue;
1912 }
1913 args[i][j] = args[i][k];
1914 j++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001915 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001916 args[i][j] = 0;
1917 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001918 }
1919
William Lallemandbddd33a2018-12-11 16:10:53 +01001920 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001921
William Lallemandbddd33a2018-12-11 16:10:53 +01001922 for (; i < MAX_STATS_ARGS + 1; i++)
1923 args[i] = NULL;
1924
1925 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
1926
1927 /* End of words are ending by \0, we need to replace the \0s by spaces
19281 before forwarding them */
1929 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01001930 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01001931 if (*p == '\0')
1932 *p = ' ';
1933 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001934 }
1935
William Lallemand3301f3e2018-12-13 09:05:48 +01001936 payload = strstr(str, PAYLOAD_PATTERN);
1937 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
1938 /* if the payload pattern is at the end */
1939 s->pcli_flags |= PCLI_F_PAYLOAD;
1940 ret = reql;
1941 }
1942
William Lallemandbddd33a2018-12-11 16:10:53 +01001943 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001944
William Lallemandbddd33a2018-12-11 16:10:53 +01001945 if (wtrim > 0) {
1946 trim = &args[wtrim][0];
1947 if (trim == NULL) /* if this was the last word in the table */
1948 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001949
William Lallemandbddd33a2018-12-11 16:10:53 +01001950 b_del(&req->buf, trim - str);
1951
William Lallemandb7ea1412018-12-13 09:05:47 +01001952 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01001953 } else if (wtrim < 0) {
1954 /* parsing error */
1955 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01001956 } else {
1957 /* the whole string */
1958 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01001959 }
1960
William Lallemandb7ea1412018-12-13 09:05:47 +01001961 if (ret > 1) {
1962 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
1963 goto end;
1964 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
1965 ci_insert_line2(req, 0, "operator", strlen("operator"));
1966 ret += strlen("operator") + 2;
1967 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
1968 ci_insert_line2(req, 0, "user", strlen("user"));
1969 ret += strlen("user") + 2;
1970 }
1971 }
1972end:
William Lallemandbddd33a2018-12-11 16:10:53 +01001973
William Lallemandb7ea1412018-12-13 09:05:47 +01001974 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001975}
1976
1977int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
1978{
William Lallemandbddd33a2018-12-11 16:10:53 +01001979 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001980 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01001981 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001982
William Lallemandb7ea1412018-12-13 09:05:47 +01001983 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
1984 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
1985
William Lallemandcf62f7e2018-10-26 14:47:40 +02001986read_again:
1987 /* if the channel is closed for read, we won't receive any more data
1988 from the client, but we don't want to forward this close to the
1989 server */
1990 channel_dont_close(req);
1991
1992 /* We don't know yet to which server we will connect */
1993 channel_dont_connect(req);
1994
1995
1996 /* we are not waiting for a response, there is no more request and we
1997 * receive a close from the client, we can leave */
1998 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
1999 channel_shutw_now(&s->res);
2000 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2001 return 1;
2002 }
2003
2004 req->flags |= CF_READ_DONTWAIT;
2005
2006 /* need more data */
2007 if (!ci_data(req))
2008 return 0;
2009
2010 /* If there is data available for analysis, log the end of the idle time. */
2011 if (c_data(req) && s->logs.t_idle == -1)
2012 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2013
William Lallemandbddd33a2018-12-11 16:10:53 +01002014 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002015 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002016 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002017 /* enough data */
2018
William Lallemandcf62f7e2018-10-26 14:47:40 +02002019 /* forward only 1 command */
2020 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002021
William Lallemanddc12c2e2018-12-13 09:05:46 +01002022 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002023 /* we send only 1 command per request, and we write close after it */
2024 channel_shutw_now(req);
2025 } else {
2026 pcli_write_prompt(s);
2027 }
2028
2029 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002030
2031 /* remove the XFER_DATA analysers, which forwards all
2032 * the data, we don't want to forward the next requests
2033 * We need to add CF_FLT_ANALYZE to abort the forward too.
2034 */
2035 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2036 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2037 s->res.analysers |= AN_RES_WAIT_CLI;
2038
William Lallemandebf61802018-12-11 16:10:57 +01002039 if (!(s->flags & SF_ASSIGNED)) {
2040 if (next_pid > -1)
2041 target_pid = next_pid;
2042 else
2043 target_pid = s->pcli_next_pid;
2044 /* we can connect now */
2045 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002046
William Lallemandebf61802018-12-11 16:10:57 +01002047 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2048 channel_auto_connect(req);
2049 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002050
2051 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002052 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002053 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002054 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002055 } else if (to_forward == -1 && errmsg) {
2056 /* there was an error during the parsing */
2057 pcli_reply_and_close(s, errmsg);
2058 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002059 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2060 /* buffer is full and we didn't catch the end of a command */
2061 goto send_help;
2062 }
2063
2064 return 0;
2065
2066send_help:
2067 b_reset(&req->buf);
2068 b_putblk(&req->buf, "help\n", 5);
2069 goto read_again;
2070}
2071
2072int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2073{
2074 struct proxy *fe = strm_fe(s);
2075 struct proxy *be = s->be;
2076
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002077 if (rep->flags & CF_READ_ERROR) {
2078 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2079 s->res.analysers &= ~AN_RES_WAIT_CLI;
2080 return 0;
2081 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002082 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2083 rep->flags |= CF_NEVER_WAIT;
2084
2085 /* don't forward the close */
2086 channel_dont_close(&s->res);
2087 channel_dont_close(&s->req);
2088
William Lallemanddc12c2e2018-12-13 09:05:46 +01002089 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002090 s->req.analysers |= AN_REQ_WAIT_CLI;
2091 s->res.analysers &= ~AN_RES_WAIT_CLI;
2092 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2093 return 0;
2094 }
2095
William Lallemandcf62f7e2018-10-26 14:47:40 +02002096 /* forward the data */
2097 if (ci_data(rep)) {
2098 c_adv(rep, ci_data(rep));
2099 return 0;
2100 }
2101
2102 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2103 /* stream cleanup */
2104
William Lallemand2f4ce202018-10-26 14:47:47 +02002105 pcli_write_prompt(s);
2106
William Lallemandcf62f7e2018-10-26 14:47:40 +02002107 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2108 si_shutr(&s->si[1]);
2109 si_shutw(&s->si[1]);
2110
2111 /*
2112 * starting from there this the same code as
2113 * http_end_txn_clean_session().
2114 *
2115 * It allows to do frontend keepalive while reconnecting to a
2116 * new server for each request.
2117 */
2118
2119 if (s->flags & SF_BE_ASSIGNED) {
2120 HA_ATOMIC_SUB(&be->beconn, 1);
2121 if (unlikely(s->srv_conn))
2122 sess_change_server(s, NULL);
2123 }
2124
2125 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2126 stream_process_counters(s);
2127
2128 /* don't count other requests' data */
2129 s->logs.bytes_in -= ci_data(&s->req);
2130 s->logs.bytes_out -= ci_data(&s->res);
2131
2132 /* we may need to know the position in the queue */
2133 pendconn_free(s);
2134
2135 /* let's do a final log if we need it */
2136 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2137 !(s->flags & SF_MONITOR) &&
2138 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2139 s->do_log(s);
2140 }
2141
2142 /* stop tracking content-based counters */
2143 stream_stop_content_counters(s);
2144 stream_update_time_stats(s);
2145
2146 s->logs.accept_date = date; /* user-visible date for logging */
2147 s->logs.tv_accept = now; /* corrected date for internal use */
2148 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2149 s->logs.t_idle = -1;
2150 tv_zero(&s->logs.tv_request);
2151 s->logs.t_queue = -1;
2152 s->logs.t_connect = -1;
2153 s->logs.t_data = -1;
2154 s->logs.t_close = 0;
2155 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2156 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2157
2158 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2159 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2160
2161 stream_del_srv_conn(s);
2162 if (objt_server(s->target)) {
2163 if (s->flags & SF_CURR_SESS) {
2164 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002165 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002166 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002167 if (may_dequeue_tasks(__objt_server(s->target), be))
2168 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002169 }
2170
2171 s->target = NULL;
2172
2173 /* only release our endpoint if we don't intend to reuse the
2174 * connection.
2175 */
2176 if (!si_conn_ready(&s->si[1])) {
2177 si_release_endpoint(&s->si[1]);
2178 s->srv_conn = NULL;
2179 }
2180
2181 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2182 s->si[1].err_type = SI_ET_NONE;
2183 s->si[1].conn_retries = 0; /* used for logging too */
2184 s->si[1].exp = TICK_ETERNITY;
2185 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2186 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);
2187 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);
2188 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2189 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2190 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2191 /* reinitialise the current rule list pointer to NULL. We are sure that
2192 * any rulelist match the NULL pointer.
2193 */
2194 s->current_rule_list = NULL;
2195
2196 s->be = strm_fe(s);
2197 s->logs.logwait = strm_fe(s)->to_log;
2198 s->logs.level = 0;
2199 stream_del_srv_conn(s);
2200 s->target = NULL;
2201 /* re-init store persistence */
2202 s->store_count = 0;
2203 s->uniq_id = global.req_count++;
2204
2205 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2206
2207 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2208
2209 s->req.analysers |= AN_REQ_WAIT_CLI;
2210 s->res.analysers &= ~AN_RES_WAIT_CLI;
2211
2212 /* We must trim any excess data from the response buffer, because we
2213 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002214 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002215 * we want those data to come along with next response. A typical
2216 * example of such data would be from a buggy server responding to
2217 * a HEAD with some data, or sending more than the advertised
2218 * content-length.
2219 */
2220 if (unlikely(ci_data(&s->res)))
2221 b_set_data(&s->res.buf, co_data(&s->res));
2222
2223 /* Now we can realign the response buffer */
2224 c_realign_if_empty(&s->res);
2225
2226 s->req.rto = strm_fe(s)->timeout.client;
2227 s->req.wto = TICK_ETERNITY;
2228
2229 s->res.rto = TICK_ETERNITY;
2230 s->res.wto = strm_fe(s)->timeout.client;
2231
2232 s->req.rex = TICK_ETERNITY;
2233 s->req.wex = TICK_ETERNITY;
2234 s->req.analyse_exp = TICK_ETERNITY;
2235 s->res.rex = TICK_ETERNITY;
2236 s->res.wex = TICK_ETERNITY;
2237 s->res.analyse_exp = TICK_ETERNITY;
2238 s->si[1].hcto = TICK_ETERNITY;
2239
2240 /* we're removing the analysers, we MUST re-enable events detection.
2241 * We don't enable close on the response channel since it's either
2242 * already closed, or in keep-alive with an idle connection handler.
2243 */
2244 channel_auto_read(&s->req);
2245 channel_auto_close(&s->req);
2246 channel_auto_read(&s->res);
2247
2248
2249 return 1;
2250 }
2251 return 0;
2252}
2253
William Lallemand8a022572018-10-26 14:47:35 +02002254/*
2255 * The mworker functions are used to initialize the CLI in the master process
2256 */
2257
William Lallemand309dc9a2018-10-26 14:47:45 +02002258 /*
2259 * Stop the mworker proxy
2260 */
2261void mworker_cli_proxy_stop()
2262{
William Lallemand550db6d2018-11-06 17:37:12 +01002263 if (mworker_proxy)
2264 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002265}
2266
William Lallemand8a022572018-10-26 14:47:35 +02002267/*
2268 * Create the mworker CLI proxy
2269 */
2270int mworker_cli_proxy_create()
2271{
2272 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002273 char *msg = NULL;
2274 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002275
2276 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2277 if (!mworker_proxy)
2278 return -1;
2279
2280 init_new_proxy(mworker_proxy);
2281 mworker_proxy->next = proxies_list;
2282 proxies_list = mworker_proxy;
2283 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002284 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002285 mworker_proxy->state = PR_STNEW;
2286 mworker_proxy->last_change = now.tv_sec;
2287 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2288 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2289 mworker_proxy->timeout.client = 0; /* no timeout */
2290 mworker_proxy->conf.file = strdup("MASTER");
2291 mworker_proxy->conf.line = 0;
2292 mworker_proxy->accept = frontend_accept;
2293 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2294
2295 /* Does not init the default target the CLI applet, but must be done in
2296 * the request parsing code */
2297 mworker_proxy->default_target = NULL;
2298
2299 /* the check_config_validity() will get an ID for the proxy */
2300 mworker_proxy->uuid = -1;
2301
2302 proxy_store_name(mworker_proxy);
2303
2304 /* create all servers using the mworker_proc list */
2305 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002306 struct server *newsrv = NULL;
2307 struct sockaddr_storage *sk;
2308 int port1, port2, port;
2309 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002310
2311 newsrv = new_server(mworker_proxy);
2312 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002313 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002314
2315 /* we don't know the new pid yet */
2316 if (child->pid == -1)
2317 memprintf(&msg, "cur-%d", child->relative_pid);
2318 else
2319 memprintf(&msg, "old-%d", child->pid);
2320
2321 newsrv->next = mworker_proxy->srv;
2322 mworker_proxy->srv = newsrv;
2323 newsrv->conf.file = strdup(msg);
2324 newsrv->id = strdup(msg);
2325 newsrv->conf.line = 0;
2326
2327 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002328 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002329 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002330 }
2331 free(msg);
2332 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002333
2334 proto = protocol_by_family(sk->ss_family);
2335 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002336 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002337 }
2338
2339 /* no port specified */
2340 newsrv->flags |= SRV_F_MAPPORTS;
2341 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002342 /* don't let the server participate to load balancing */
2343 newsrv->iweight = 0;
2344 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002345 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002346
2347 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002348 }
2349 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002350
2351error:
2352 ha_alert("%s\n", errmsg);
2353
2354 list_for_each_entry(child, &proc_list, list) {
2355 free((char *)child->srv->conf.file); /* cast because of const char * */
2356 free(child->srv->id);
2357 free(child->srv);
2358 child->srv = NULL;
2359 }
2360 free(mworker_proxy->id);
2361 free(mworker_proxy->conf.file);
2362 free(mworker_proxy);
2363 mworker_proxy = NULL;
2364 free(errmsg);
2365 free(msg);
2366
2367 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002368}
Olivier Houchardf886e342017-04-05 22:24:59 +02002369
William Lallemandce83b4a2018-10-26 14:47:30 +02002370/*
William Lallemande7361152018-10-26 14:47:36 +02002371 * Create a new listener for the master CLI proxy
2372 */
2373int mworker_cli_proxy_new_listener(char *line)
2374{
2375 struct bind_conf *bind_conf;
2376 struct listener *l;
2377 char *err = NULL;
2378 char *args[MAX_LINE_ARGS + 1];
2379 int arg;
2380 int cur_arg;
2381
2382 arg = 0;
2383 args[0] = line;
2384
2385 /* args is a bind configuration with spaces replaced by commas */
2386 while (*line && arg < MAX_LINE_ARGS) {
2387
2388 if (*line == ',') {
2389 *line++ = '\0';
2390 while (*line == ',')
2391 line++;
2392 args[++arg] = line;
2393 }
2394 line++;
2395 }
2396
2397 args[++arg] = "\0";
2398
2399 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002400 if (!bind_conf)
2401 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002402
2403 bind_conf->level &= ~ACCESS_LVL_MASK;
2404 bind_conf->level |= ACCESS_LVL_ADMIN;
2405
2406 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2407 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002408 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002409 }
2410
2411 cur_arg = 1;
2412
2413 while (*args[cur_arg]) {
2414 static int bind_dumped;
2415 struct bind_kw *kw;
2416
2417 kw = bind_find_kw(args[cur_arg]);
2418 if (kw) {
2419 if (!kw->parse) {
2420 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2421 args[0], args[1], args[cur_arg]);
2422 goto err;
2423 }
2424
2425 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2426 if (err)
2427 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2428 else
2429 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2430 args[0], args[1], args[cur_arg]);
2431 goto err;
2432 }
2433
2434 cur_arg += 1 + kw->skip;
2435 continue;
2436 }
2437
2438 if (!bind_dumped) {
2439 bind_dump_kws(&err);
2440 indent_msg(&err, 4);
2441 bind_dumped = 1;
2442 }
2443
2444 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2445 args[0], args[1], args[cur_arg],
2446 err ? " Registered keywords :" : "", err ? err : "");
2447 goto err;
2448 }
2449
2450
2451 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002452 l->accept = session_accept_fd;
2453 l->default_target = mworker_proxy->default_target;
2454 /* don't make the peers subject to global limits and don't close it in the master */
2455 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2456 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002457 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002458 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002459 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002460
2461 return 0;
2462
2463err:
2464 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002465 free(err);
2466 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002467 return -1;
2468
2469}
2470
2471/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002472 * Create a new CLI socket using a socketpair for a worker process
2473 * <mworker_proc> is the process structure, and <proc> is the process number
2474 */
2475int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2476{
2477 struct bind_conf *bind_conf;
2478 struct listener *l;
2479 char *path = NULL;
2480 char *err = NULL;
2481
2482 /* master pipe to ensure the master is still alive */
2483 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2484 ha_alert("Cannot create worker socketpair.\n");
2485 return -1;
2486 }
2487
2488 /* XXX: we might want to use a separate frontend at some point */
2489 if (!global.stats_fe) {
2490 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2491 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002492 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002493 }
2494 }
2495
2496 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002497 if (!bind_conf)
2498 goto error;
2499
William Lallemandce83b4a2018-10-26 14:47:30 +02002500 bind_conf->level &= ~ACCESS_LVL_MASK;
2501 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2502
2503 bind_conf->bind_proc = 1UL << proc;
2504 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2505
2506 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2507 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002508 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002509 }
2510
2511 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002512 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002513 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002514 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002515 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002516 free(path);
2517 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002518
2519 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002520 l->accept = session_accept_fd;
2521 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002522 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002523 /* it's a sockpair but we don't want to keep the fd in the master */
2524 l->options &= ~LI_O_INHERITED;
2525 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002526 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002527 }
2528
2529 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002530
2531error:
2532 close(mworker_proc->ipc_fd[0]);
2533 close(mworker_proc->ipc_fd[1]);
2534 free(err);
2535
2536 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002537}
2538
William Lallemand74c24fb2016-11-21 17:18:36 +01002539static struct applet cli_applet = {
2540 .obj_type = OBJ_TYPE_APPLET,
2541 .name = "<CLI>", /* used for logging */
2542 .fct = cli_io_handler,
2543 .release = cli_release_handler,
2544};
2545
Willy Tarreau0a739292016-11-22 20:21:23 +01002546/* register cli keywords */
2547static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002548 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2549 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2550 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002551 { { "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 +01002552 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002553 { { "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 +01002554 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002555 { { "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 +02002556 { { "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 +01002557 { { "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 +02002558 { { "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 +01002559 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemand67a234f2018-12-13 09:05:45 +01002560 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2561 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Olivier Houchardf886e342017-04-05 22:24:59 +02002562 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002563 {{},}
2564}};
2565
Willy Tarreau0108d902018-11-25 19:14:37 +01002566INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2567
William Lallemand74c24fb2016-11-21 17:18:36 +01002568static struct cfg_kw_list cfg_kws = {ILH, {
2569 { CFG_GLOBAL, "stats", stats_parse_global },
2570 { 0, NULL, NULL },
2571}};
2572
Willy Tarreau0108d902018-11-25 19:14:37 +01002573INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2574
William Lallemand74c24fb2016-11-21 17:18:36 +01002575static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002576 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2577 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002578 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002579 { NULL, NULL, 0 },
2580}};
2581
Willy Tarreau0108d902018-11-25 19:14:37 +01002582INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002583
2584/*
2585 * Local variables:
2586 * c-indent-level: 8
2587 * c-basic-offset: 8
2588 * End:
2589 */