blob: df016b446859681aa630660a2ea5c291e5015598 [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;
William Lallemande58915f2019-04-01 11:30:05 +02001081 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001082 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001083 } else {
1084 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1085 }
William Lallemandeceddf72016-12-15 18:06:44 +01001086 } else if (l->addr.ss_family == AF_INET) {
1087 addr_to_str(&l->addr, addr, sizeof(addr));
1088 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001089 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001090 } else if (l->addr.ss_family == AF_INET6) {
1091 addr_to_str(&l->addr, addr, sizeof(addr));
1092 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001093 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001094 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1095 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001096 } else
William Lallemand26314342018-10-26 14:47:41 +02001097 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001098
William Lallemand07a62f72017-05-24 00:57:40 +02001099 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001100 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001101 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1102 chunk_appendf(&trash, "operator ");
1103 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1104 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001105 else
1106 chunk_appendf(&trash, " ");
1107
1108 if (bind_conf->bind_proc != 0) {
1109 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001110 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001111 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001112 chunk_appendf(&trash, "%d,", pos+1);
1113 }
1114 }
1115 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001116 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001117
1118 } else {
1119 chunk_appendf(&trash, "all\n");
1120 }
1121
Willy Tarreau06d80a92017-10-19 14:32:15 +02001122 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001123 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001124 return 0;
1125 }
1126 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001127 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001128 }
1129 }
1130 default:
1131 appctx->st2 = STAT_ST_FIN;
1132 return 1;
1133 }
1134}
1135
1136
Willy Tarreau0a739292016-11-22 20:21:23 +01001137/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001138 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1139 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001140 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001141static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001142{
1143 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001144 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001145
1146 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1147 return 1;
1148
Willy Tarreauf6710f82016-12-16 17:45:44 +01001149 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001150
1151 if (*args[2]) {
1152 int len = strlen(args[2]);
1153
Willy Tarreauf6710f82016-12-16 17:45:44 +01001154 for (; *var; var++) {
1155 if (strncmp(*var, args[2], len) == 0 &&
1156 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001157 break;
1158 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001159 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001160 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001161 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001162 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001163 return 1;
1164 }
1165 appctx->st2 = STAT_ST_END;
1166 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001167 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001168 return 0;
1169}
1170
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001171/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1172 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1173 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1174 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001175static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001176{
1177 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1178 return 1;
1179
1180 appctx->ctx.cli.i0 = 0;
1181
1182 if (*args[2]) {
1183 appctx->ctx.cli.i0 = atoi(args[2]);
1184 appctx->st2 = STAT_ST_END;
1185 }
1186 return 0;
1187}
1188
Willy Tarreau599852e2016-11-22 20:33:32 +01001189/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001190static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001191{
1192 struct stream_interface *si = appctx->owner;
1193 struct stream *s = si_strm(si);
1194
1195 if (strcmp(args[2], "cli") == 0) {
1196 unsigned timeout;
1197 const char *res;
1198
1199 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001200 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001201 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001202 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001203 return 1;
1204 }
1205
1206 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1207 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001208 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001209 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001210 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001211 return 1;
1212 }
1213
1214 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1215 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1216 return 1;
1217 }
1218 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001219 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001220 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001221 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001222 return 1;
1223 }
1224}
1225
Willy Tarreau2af99412016-11-23 11:10:59 +01001226/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001227static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001228{
1229 int v;
1230
1231 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1232 return 1;
1233
1234 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001235 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001236 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001237 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001238 return 1;
1239 }
1240
1241 v = atoi(args[3]);
1242 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001243 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001244 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001245 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001246 return 1;
1247 }
1248
1249 /* check for unlimited values */
1250 if (v <= 0)
1251 v = global.hardmaxconn;
1252
1253 global.maxconn = v;
1254
1255 /* Dequeues all of the listeners waiting for a resource */
1256 if (!LIST_ISEMPTY(&global_listener_queue))
1257 dequeue_all_listeners(&global_listener_queue);
1258
1259 return 1;
1260}
1261
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001262static int set_severity_output(int *target, char *argument)
1263{
1264 if (!strcmp(argument, "none")) {
1265 *target = CLI_SEVERITY_NONE;
1266 return 1;
1267 }
1268 else if (!strcmp(argument, "number")) {
1269 *target = CLI_SEVERITY_NUMBER;
1270 return 1;
1271 }
1272 else if (!strcmp(argument, "string")) {
1273 *target = CLI_SEVERITY_STRING;
1274 return 1;
1275 }
1276 return 0;
1277}
1278
1279/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001280static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001281{
1282 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1283 return 0;
1284
1285 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001286 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001287 appctx->st0 = CLI_ST_PRINT;
1288 return 1;
1289}
William Lallemandeceddf72016-12-15 18:06:44 +01001290
William Lallemand67a234f2018-12-13 09:05:45 +01001291
1292/* show the level of the current CLI session */
1293static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1294{
1295
1296 appctx->ctx.cli.severity = LOG_INFO;
1297 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1298 appctx->ctx.cli.msg = "admin\n";
1299 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1300 appctx->ctx.cli.msg = "operator\n";
1301 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1302 appctx->ctx.cli.msg = "user\n";
1303 else
1304 appctx->ctx.cli.msg = "unknown\n";
1305
1306 appctx->st0 = CLI_ST_PRINT;
1307 return 1;
1308
1309}
1310
1311/* parse and set the CLI level dynamically */
1312static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1313{
1314 if (!strcmp(args[0], "operator")) {
1315 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1316 return 1;
1317 }
1318 appctx->cli_level &= ~ACCESS_LVL_MASK;
1319 appctx->cli_level |= ACCESS_LVL_OPER;
1320
1321 } else if (!strcmp(args[0], "user")) {
1322 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1323 return 1;
1324 }
1325 appctx->cli_level &= ~ACCESS_LVL_MASK;
1326 appctx->cli_level |= ACCESS_LVL_USER;
1327 }
1328 return 1;
1329}
1330
William Lallemanda57b7e32018-12-14 21:11:31 +01001331
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001332int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001333{
1334 return 0;
1335}
1336
Willy Tarreau45c742b2016-11-24 14:51:17 +01001337/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001338static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001339{
1340 int v;
1341 int *res;
1342 int mul = 1;
1343
1344 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1345 return 1;
1346
1347 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1348 res = &global.cps_lim;
1349 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1350 res = &global.sps_lim;
1351#ifdef USE_OPENSSL
1352 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1353 res = &global.ssl_lim;
1354#endif
1355 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1356 res = &global.comp_rate_lim;
1357 mul = 1024;
1358 }
1359 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001360 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001361 appctx->ctx.cli.msg =
1362 "'set rate-limit' only supports :\n"
1363 " - 'connections global' to set the per-process maximum connection rate\n"
1364 " - 'sessions global' to set the per-process maximum session rate\n"
1365#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001366 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001367#endif
1368 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001369 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001370 return 1;
1371 }
1372
1373 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001374 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001375 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001376 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001377 return 1;
1378 }
1379
1380 v = atoi(args[4]);
1381 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001382 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001383 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001384 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001385 return 1;
1386 }
1387
1388 *res = v * mul;
1389
1390 /* Dequeues all of the listeners waiting for a resource */
1391 if (!LIST_ISEMPTY(&global_listener_queue))
1392 dequeue_all_listeners(&global_listener_queue);
1393
1394 return 1;
1395}
1396
William Lallemandf6975e92017-05-26 17:42:10 +02001397/* parse the "expose-fd" argument on the bind lines */
1398static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1399{
1400 if (!*args[cur_arg + 1]) {
1401 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1402 return ERR_ALERT | ERR_FATAL;
1403 }
1404 if (!strcmp(args[cur_arg+1], "listeners")) {
1405 conf->level |= ACCESS_FD_LISTENERS;
1406 } else {
1407 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1408 args[cur_arg], args[cur_arg+1]);
1409 return ERR_ALERT | ERR_FATAL;
1410 }
1411
1412 return 0;
1413}
1414
William Lallemand74c24fb2016-11-21 17:18:36 +01001415/* parse the "level" argument on the bind lines */
1416static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1417{
1418 if (!*args[cur_arg + 1]) {
1419 memprintf(err, "'%s' : missing level", args[cur_arg]);
1420 return ERR_ALERT | ERR_FATAL;
1421 }
1422
William Lallemand07a62f72017-05-24 00:57:40 +02001423 if (!strcmp(args[cur_arg+1], "user")) {
1424 conf->level &= ~ACCESS_LVL_MASK;
1425 conf->level |= ACCESS_LVL_USER;
1426 } else if (!strcmp(args[cur_arg+1], "operator")) {
1427 conf->level &= ~ACCESS_LVL_MASK;
1428 conf->level |= ACCESS_LVL_OPER;
1429 } else if (!strcmp(args[cur_arg+1], "admin")) {
1430 conf->level &= ~ACCESS_LVL_MASK;
1431 conf->level |= ACCESS_LVL_ADMIN;
1432 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001433 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1434 args[cur_arg], args[cur_arg+1]);
1435 return ERR_ALERT | ERR_FATAL;
1436 }
1437
1438 return 0;
1439}
1440
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001441static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1442{
1443 if (!*args[cur_arg + 1]) {
1444 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1445 return ERR_ALERT | ERR_FATAL;
1446 }
1447
1448 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1449 return 0;
1450 else {
1451 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1452 args[cur_arg], args[cur_arg+1]);
1453 return ERR_ALERT | ERR_FATAL;
1454 }
1455}
1456
William Lallemand16dd1b32018-11-19 18:46:18 +01001457
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001458
Olivier Houchardf886e342017-04-05 22:24:59 +02001459/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001460static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001461{
1462 char *cmsgbuf = NULL;
1463 unsigned char *tmpbuf = NULL;
1464 struct cmsghdr *cmsg;
1465 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001466 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001467 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001468 struct msghdr msghdr;
1469 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001470 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001471 int *tmpfd;
1472 int tot_fd_nb = 0;
1473 struct proxy *px;
1474 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001475 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001476 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001477 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001478 int ret;
1479
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001480 if (!remote) {
1481 ha_warning("Only works on real connections\n");
1482 goto out;
1483 }
1484
1485 fd = remote->handle.fd;
1486
Olivier Houchardf886e342017-04-05 22:24:59 +02001487 /* Temporary set the FD in blocking mode, that will make our life easier */
1488 old_fcntl = fcntl(fd, F_GETFL);
1489 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001490 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001491 goto out;
1492 }
1493 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1494 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001495 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001496 goto out;
1497 }
1498 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001499 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001500 goto out;
1501 }
Olivier Houchard54740872017-04-06 14:45:14 +02001502 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001503 iov.iov_base = &tot_fd_nb;
1504 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001505 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001506 goto out;
1507 memset(&msghdr, 0, sizeof(msghdr));
1508 /*
1509 * First, calculates the total number of FD, so that we can let
1510 * the caller know how much he should expects.
1511 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001512 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001513 while (px) {
1514 struct listener *l;
1515
1516 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001517 /* Only transfer IPv4/IPv6/UNIX sockets */
1518 if (l->state >= LI_ZOMBIE &&
1519 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001520 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001521 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001522 tot_fd_nb++;
1523 }
1524 px = px->next;
1525 }
1526 if (tot_fd_nb == 0)
1527 goto out;
1528
1529 /* First send the total number of file descriptors, so that the
1530 * receiving end knows what to expect.
1531 */
1532 msghdr.msg_iov = &iov;
1533 msghdr.msg_iovlen = 1;
1534 ret = sendmsg(fd, &msghdr, 0);
1535 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001536 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001537 goto out;
1538 }
1539
1540 /* Now send the fds */
1541 msghdr.msg_control = cmsgbuf;
1542 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1543 cmsg = CMSG_FIRSTHDR(&msghdr);
1544 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1545 cmsg->cmsg_level = SOL_SOCKET;
1546 cmsg->cmsg_type = SCM_RIGHTS;
1547 tmpfd = (int *)CMSG_DATA(cmsg);
1548
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001549 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001550 /* For each socket, e message is sent, containing the following :
1551 * Size of the namespace name (or 0 if none), as an unsigned char.
1552 * The namespace name, if any
1553 * Size of the interface name (or 0 if none), as an unsigned char
1554 * The interface name, if any
1555 * Listener options, as an int.
1556 */
1557 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1558 * buffer big enough to store the socket informations.
1559 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001560 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001561 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001562 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001563 goto out;
1564 }
1565 iov.iov_base = tmpbuf;
1566 while (px) {
1567 struct listener *l;
1568
1569 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1570 int ret;
1571 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001572 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001573 (l->proto->sock_family == AF_INET ||
1574 l->proto->sock_family == AF_INET6 ||
1575 l->proto->sock_family == AF_UNIX)) {
1576 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1577 if (!l->netns)
1578 tmpbuf[curoff++] = 0;
1579#ifdef CONFIG_HAP_NS
1580 else {
1581 char *name = l->netns->node.key;
1582 unsigned char len = l->netns->name_len;
1583 tmpbuf[curoff++] = len;
1584 memcpy(tmpbuf + curoff, name, len);
1585 curoff += len;
1586 }
1587#endif
1588 if (l->interface) {
1589 unsigned char len = strlen(l->interface);
1590 tmpbuf[curoff++] = len;
1591 memcpy(tmpbuf + curoff, l->interface, len);
1592 curoff += len;
1593 } else
1594 tmpbuf[curoff++] = 0;
1595 memcpy(tmpbuf + curoff, &l->options,
1596 sizeof(l->options));
1597 curoff += sizeof(l->options);
1598
1599
1600 i++;
1601 } else
1602 continue;
1603 if ((!(i % MAX_SEND_FD))) {
1604 iov.iov_len = curoff;
1605 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001606 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001607 goto out;
1608 }
1609 /* Wait for an ack */
1610 do {
1611 ret = recv(fd, &tot_fd_nb,
1612 sizeof(tot_fd_nb), 0);
1613 } while (ret == -1 && errno == EINTR);
1614 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001615 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001616 goto out;
1617 }
1618 curoff = 0;
1619 }
1620
1621 }
1622 px = px->next;
1623 }
1624 if (i % MAX_SEND_FD) {
1625 iov.iov_len = curoff;
1626 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1627 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1628 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001629 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001630 goto out;
1631 }
1632 }
1633
1634out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001635 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001636 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001637 goto out;
1638 }
1639 appctx->st0 = CLI_ST_END;
1640 free(cmsgbuf);
1641 free(tmpbuf);
1642 return 1;
1643}
1644
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001645static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1646{
1647 if (*args[0] == 'h')
1648 /* help */
1649 cli_gen_usage_msg(appctx);
1650 else if (*args[0] == 'p')
1651 /* prompt */
1652 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1653 else if (*args[0] == 'q')
1654 /* quit */
1655 appctx->st0 = CLI_ST_END;
1656
1657 return 1;
1658}
Olivier Houchardf886e342017-04-05 22:24:59 +02001659
William Lallemand2f4ce202018-10-26 14:47:47 +02001660void pcli_write_prompt(struct stream *s)
1661{
1662 struct buffer *msg = get_trash_chunk();
1663 struct channel *oc = si_oc(&s->si[0]);
1664
William Lallemanddc12c2e2018-12-13 09:05:46 +01001665 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001666 return;
1667
William Lallemanddc12c2e2018-12-13 09:05:46 +01001668 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001669 chunk_appendf(msg, "+ ");
1670 } else {
1671 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001672 chunk_appendf(msg, "master%s> ",
1673 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001674 else
1675 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1676 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001677 co_inject(oc, msg->area, msg->data);
1678}
1679
William Lallemand291810d2018-10-26 14:47:38 +02001680
William Lallemandcf62f7e2018-10-26 14:47:40 +02001681/* The pcli_* functions are used for the CLI proxy in the master */
1682
William Lallemanddeeaa592018-10-26 14:47:48 +02001683void pcli_reply_and_close(struct stream *s, const char *msg)
1684{
1685 struct buffer *buf = get_trash_chunk();
1686
1687 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001688 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001689}
1690
William Lallemand291810d2018-10-26 14:47:38 +02001691static enum obj_type *pcli_pid_to_server(int proc_pid)
1692{
1693 struct mworker_proc *child;
1694
William Lallemandbddd33a2018-12-11 16:10:53 +01001695 /* return the CLI applet of the master */
1696 if (proc_pid == 0)
1697 return &cli_applet.obj_type;
1698
William Lallemand291810d2018-10-26 14:47:38 +02001699 list_for_each_entry(child, &proc_list, list) {
1700 if (child->pid == proc_pid){
1701 return &child->srv->obj_type;
1702 }
1703 }
1704 return NULL;
1705}
1706
1707/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1708 * Return:
1709 * 0: master
1710 * > 0: pid of a worker
1711 * < 0: didn't find a worker
1712 */
1713static int pcli_prefix_to_pid(const char *prefix)
1714{
1715 int proc_pid;
1716 struct mworker_proc *child;
1717 char *errtol = NULL;
1718
1719 if (*prefix != '@') /* not a prefix, should not happen */
1720 return -1;
1721
1722 prefix++;
1723 if (!*prefix) /* sent @ alone, return the master */
1724 return 0;
1725
1726 if (strcmp("master", prefix) == 0) {
1727 return 0;
1728 } else if (*prefix == '!') {
1729 prefix++;
1730 if (!*prefix)
1731 return -1;
1732
1733 proc_pid = strtol(prefix, &errtol, 10);
1734 if (*errtol != '\0')
1735 return -1;
1736 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001737 if (child->type != 'w')
1738 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001739 if (child->pid == proc_pid){
1740 return child->pid;
1741 }
1742 }
1743 } else {
1744 struct mworker_proc *chosen = NULL;
1745 /* this is a relative pid */
1746
1747 proc_pid = strtol(prefix, &errtol, 10);
1748 if (*errtol != '\0')
1749 return -1;
1750
1751 if (proc_pid == 0) /* return the master */
1752 return 0;
1753
1754 /* chose the right process, the current one is the one with the
1755 least number of reloads */
1756 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001757 if (child->type != 'w')
1758 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001759 if (child->relative_pid == proc_pid){
1760 if (child->reloads == 0)
1761 return child->pid;
1762 else if (chosen == NULL || child->reloads < chosen->reloads)
1763 chosen = child;
1764 }
1765 }
1766 if (chosen)
1767 return chosen->pid;
1768 }
1769 return -1;
1770}
1771
William Lallemandbddd33a2018-12-11 16:10:53 +01001772/* Return::
1773 * >= 0 : number of words to escape
1774 * = -1 : error
1775 */
1776
1777int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1778{
1779 if (argl < 1)
1780 return 0;
1781
1782 /* there is a prefix */
1783 if (args[0][0] == '@') {
1784 int target_pid = pcli_prefix_to_pid(args[0]);
1785
1786 if (target_pid == -1) {
1787 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1788 return -1;
1789 }
1790
1791 /* if the prefix is alone, define a default target */
1792 if (argl == 1)
1793 s->pcli_next_pid = target_pid;
1794 else
1795 *next_pid = target_pid;
1796 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001797 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001798 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001799 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001800
1801 } else if (!strcmp("quit", args[0])) {
1802 channel_shutr_now(&s->req);
1803 channel_shutw_now(&s->res);
1804 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001805 } else if (!strcmp(args[0], "operator")) {
1806 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1807 memprintf(errmsg, "Permission denied!\n");
1808 return -1;
1809 }
1810 s->pcli_flags &= ~ACCESS_LVL_MASK;
1811 s->pcli_flags |= ACCESS_LVL_OPER;
1812 return argl;
1813
1814 } else if (!strcmp(args[0], "user")) {
1815 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1816 memprintf(errmsg, "Permission denied!\n");
1817 return -1;
1818 }
1819 s->pcli_flags &= ~ACCESS_LVL_MASK;
1820 s->pcli_flags |= ACCESS_LVL_USER;
1821 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001822 }
1823
1824 return 0;
1825}
1826
1827/*
1828 * Parse the CLI request:
1829 * - It does basically the same as the cli_io_handler, but as a proxy
1830 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001831 *
1832 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01001833 * - the number of characters to forward or
1834 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02001835 */
William Lallemandbddd33a2018-12-11 16:10:53 +01001836int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001837{
William Lallemandbddd33a2018-12-11 16:10:53 +01001838 char *str = (char *)ci_head(req);
1839 char *end = (char *)ci_stop(req);
1840 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
1841 int argl; /* number of args */
1842 char *p;
1843 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01001844 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01001845 int wtrim = 0; /* number of words to trim */
1846 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01001847 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01001848 int i = 0;
1849
1850 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001851
William Lallemanddc12c2e2018-12-13 09:05:46 +01001852 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01001853
1854 /* Looks for the end of one command */
1855 while (p+reql < end) {
1856 /* handle escaping */
1857 if (p[reql] == '\\') {
1858 reql++;
1859 continue;
1860 }
1861 if (p[reql] == ';' || p[reql] == '\n') {
1862 /* found the end of the command */
1863 p[reql] = '\n';
1864 reql++;
1865 break;
1866 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001867 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001868 }
William Lallemandebf61802018-12-11 16:10:57 +01001869 } else {
1870 while (p+reql < end) {
1871 if (p[reql] == '\n') {
1872 /* found the end of the line */
1873 reql++;
1874 break;
1875 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001876 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001877 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001878 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001879
William Lallemandbddd33a2018-12-11 16:10:53 +01001880 /* set end to first byte after the end of the command */
1881 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001882
William Lallemandbddd33a2018-12-11 16:10:53 +01001883 /* there is no end to this command, need more to parse ! */
1884 if (*(end-1) != '\n') {
1885 return -1;
1886 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001887
William Lallemand3301f3e2018-12-13 09:05:48 +01001888 if (s->pcli_flags & PCLI_F_PAYLOAD) {
1889 if (reql == 1) /* last line of the payload */
1890 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01001891 return reql;
1892 }
1893
William Lallemandbddd33a2018-12-11 16:10:53 +01001894 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001895
William Lallemandbddd33a2018-12-11 16:10:53 +01001896 /* splits the command in words */
1897 while (i < MAX_STATS_ARGS && p < end) {
1898 int j, k;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001899
William Lallemandbddd33a2018-12-11 16:10:53 +01001900 /* skip leading spaces/tabs */
1901 p += strspn(p, " \t");
1902 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001903 break;
1904
William Lallemandbddd33a2018-12-11 16:10:53 +01001905 args[i] = p;
1906 p += strcspn(p, " \t");
1907 *p++ = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001908
William Lallemandbddd33a2018-12-11 16:10:53 +01001909 /* unescape backslashes (\) */
1910 for (j = 0, k = 0; args[i][k]; k++) {
1911 if (args[i][k] == '\\') {
1912 if (args[i][k + 1] == '\\')
1913 k++;
1914 else
1915 continue;
1916 }
1917 args[i][j] = args[i][k];
1918 j++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001919 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001920 args[i][j] = 0;
1921 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001922 }
1923
William Lallemandbddd33a2018-12-11 16:10:53 +01001924 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001925
William Lallemandbddd33a2018-12-11 16:10:53 +01001926 for (; i < MAX_STATS_ARGS + 1; i++)
1927 args[i] = NULL;
1928
1929 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
1930
1931 /* End of words are ending by \0, we need to replace the \0s by spaces
19321 before forwarding them */
1933 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01001934 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01001935 if (*p == '\0')
1936 *p = ' ';
1937 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001938 }
1939
William Lallemand3301f3e2018-12-13 09:05:48 +01001940 payload = strstr(str, PAYLOAD_PATTERN);
1941 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
1942 /* if the payload pattern is at the end */
1943 s->pcli_flags |= PCLI_F_PAYLOAD;
1944 ret = reql;
1945 }
1946
William Lallemandbddd33a2018-12-11 16:10:53 +01001947 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001948
William Lallemandbddd33a2018-12-11 16:10:53 +01001949 if (wtrim > 0) {
1950 trim = &args[wtrim][0];
1951 if (trim == NULL) /* if this was the last word in the table */
1952 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001953
William Lallemandbddd33a2018-12-11 16:10:53 +01001954 b_del(&req->buf, trim - str);
1955
William Lallemandb7ea1412018-12-13 09:05:47 +01001956 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01001957 } else if (wtrim < 0) {
1958 /* parsing error */
1959 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01001960 } else {
1961 /* the whole string */
1962 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01001963 }
1964
William Lallemandb7ea1412018-12-13 09:05:47 +01001965 if (ret > 1) {
1966 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
1967 goto end;
1968 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
1969 ci_insert_line2(req, 0, "operator", strlen("operator"));
1970 ret += strlen("operator") + 2;
1971 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
1972 ci_insert_line2(req, 0, "user", strlen("user"));
1973 ret += strlen("user") + 2;
1974 }
1975 }
1976end:
William Lallemandbddd33a2018-12-11 16:10:53 +01001977
William Lallemandb7ea1412018-12-13 09:05:47 +01001978 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001979}
1980
1981int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
1982{
William Lallemandbddd33a2018-12-11 16:10:53 +01001983 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001984 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01001985 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001986
William Lallemandb7ea1412018-12-13 09:05:47 +01001987 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
1988 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
1989
William Lallemandcf62f7e2018-10-26 14:47:40 +02001990read_again:
1991 /* if the channel is closed for read, we won't receive any more data
1992 from the client, but we don't want to forward this close to the
1993 server */
1994 channel_dont_close(req);
1995
1996 /* We don't know yet to which server we will connect */
1997 channel_dont_connect(req);
1998
1999
2000 /* we are not waiting for a response, there is no more request and we
2001 * receive a close from the client, we can leave */
2002 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2003 channel_shutw_now(&s->res);
2004 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2005 return 1;
2006 }
2007
2008 req->flags |= CF_READ_DONTWAIT;
2009
2010 /* need more data */
2011 if (!ci_data(req))
2012 return 0;
2013
2014 /* If there is data available for analysis, log the end of the idle time. */
2015 if (c_data(req) && s->logs.t_idle == -1)
2016 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2017
William Lallemandbddd33a2018-12-11 16:10:53 +01002018 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002019 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002020 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002021 /* enough data */
2022
William Lallemandcf62f7e2018-10-26 14:47:40 +02002023 /* forward only 1 command */
2024 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002025
William Lallemanddc12c2e2018-12-13 09:05:46 +01002026 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002027 /* we send only 1 command per request, and we write close after it */
2028 channel_shutw_now(req);
2029 } else {
2030 pcli_write_prompt(s);
2031 }
2032
2033 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002034
2035 /* remove the XFER_DATA analysers, which forwards all
2036 * the data, we don't want to forward the next requests
2037 * We need to add CF_FLT_ANALYZE to abort the forward too.
2038 */
2039 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2040 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2041 s->res.analysers |= AN_RES_WAIT_CLI;
2042
William Lallemandebf61802018-12-11 16:10:57 +01002043 if (!(s->flags & SF_ASSIGNED)) {
2044 if (next_pid > -1)
2045 target_pid = next_pid;
2046 else
2047 target_pid = s->pcli_next_pid;
2048 /* we can connect now */
2049 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002050
William Lallemandebf61802018-12-11 16:10:57 +01002051 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2052 channel_auto_connect(req);
2053 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002054
2055 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002056 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002057 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002058 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002059 } else if (to_forward == -1 && errmsg) {
2060 /* there was an error during the parsing */
2061 pcli_reply_and_close(s, errmsg);
2062 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002063 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2064 /* buffer is full and we didn't catch the end of a command */
2065 goto send_help;
2066 }
2067
2068 return 0;
2069
2070send_help:
2071 b_reset(&req->buf);
2072 b_putblk(&req->buf, "help\n", 5);
2073 goto read_again;
2074}
2075
2076int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2077{
2078 struct proxy *fe = strm_fe(s);
2079 struct proxy *be = s->be;
2080
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002081 if (rep->flags & CF_READ_ERROR) {
2082 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2083 s->res.analysers &= ~AN_RES_WAIT_CLI;
2084 return 0;
2085 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002086 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2087 rep->flags |= CF_NEVER_WAIT;
2088
2089 /* don't forward the close */
2090 channel_dont_close(&s->res);
2091 channel_dont_close(&s->req);
2092
William Lallemanddc12c2e2018-12-13 09:05:46 +01002093 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002094 s->req.analysers |= AN_REQ_WAIT_CLI;
2095 s->res.analysers &= ~AN_RES_WAIT_CLI;
2096 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2097 return 0;
2098 }
2099
William Lallemandcf62f7e2018-10-26 14:47:40 +02002100 /* forward the data */
2101 if (ci_data(rep)) {
2102 c_adv(rep, ci_data(rep));
2103 return 0;
2104 }
2105
2106 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2107 /* stream cleanup */
2108
William Lallemand2f4ce202018-10-26 14:47:47 +02002109 pcli_write_prompt(s);
2110
William Lallemandcf62f7e2018-10-26 14:47:40 +02002111 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2112 si_shutr(&s->si[1]);
2113 si_shutw(&s->si[1]);
2114
2115 /*
2116 * starting from there this the same code as
2117 * http_end_txn_clean_session().
2118 *
2119 * It allows to do frontend keepalive while reconnecting to a
2120 * new server for each request.
2121 */
2122
2123 if (s->flags & SF_BE_ASSIGNED) {
2124 HA_ATOMIC_SUB(&be->beconn, 1);
2125 if (unlikely(s->srv_conn))
2126 sess_change_server(s, NULL);
2127 }
2128
2129 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2130 stream_process_counters(s);
2131
2132 /* don't count other requests' data */
2133 s->logs.bytes_in -= ci_data(&s->req);
2134 s->logs.bytes_out -= ci_data(&s->res);
2135
2136 /* we may need to know the position in the queue */
2137 pendconn_free(s);
2138
2139 /* let's do a final log if we need it */
2140 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2141 !(s->flags & SF_MONITOR) &&
2142 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2143 s->do_log(s);
2144 }
2145
2146 /* stop tracking content-based counters */
2147 stream_stop_content_counters(s);
2148 stream_update_time_stats(s);
2149
2150 s->logs.accept_date = date; /* user-visible date for logging */
2151 s->logs.tv_accept = now; /* corrected date for internal use */
2152 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2153 s->logs.t_idle = -1;
2154 tv_zero(&s->logs.tv_request);
2155 s->logs.t_queue = -1;
2156 s->logs.t_connect = -1;
2157 s->logs.t_data = -1;
2158 s->logs.t_close = 0;
2159 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2160 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2161
2162 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2163 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2164
2165 stream_del_srv_conn(s);
2166 if (objt_server(s->target)) {
2167 if (s->flags & SF_CURR_SESS) {
2168 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002169 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002170 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002171 if (may_dequeue_tasks(__objt_server(s->target), be))
2172 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002173 }
2174
2175 s->target = NULL;
2176
2177 /* only release our endpoint if we don't intend to reuse the
2178 * connection.
2179 */
2180 if (!si_conn_ready(&s->si[1])) {
2181 si_release_endpoint(&s->si[1]);
2182 s->srv_conn = NULL;
2183 }
2184
2185 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2186 s->si[1].err_type = SI_ET_NONE;
2187 s->si[1].conn_retries = 0; /* used for logging too */
2188 s->si[1].exp = TICK_ETERNITY;
2189 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2190 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);
2191 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);
2192 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2193 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2194 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2195 /* reinitialise the current rule list pointer to NULL. We are sure that
2196 * any rulelist match the NULL pointer.
2197 */
2198 s->current_rule_list = NULL;
2199
2200 s->be = strm_fe(s);
2201 s->logs.logwait = strm_fe(s)->to_log;
2202 s->logs.level = 0;
2203 stream_del_srv_conn(s);
2204 s->target = NULL;
2205 /* re-init store persistence */
2206 s->store_count = 0;
2207 s->uniq_id = global.req_count++;
2208
2209 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2210
2211 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2212
2213 s->req.analysers |= AN_REQ_WAIT_CLI;
2214 s->res.analysers &= ~AN_RES_WAIT_CLI;
2215
2216 /* We must trim any excess data from the response buffer, because we
2217 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002218 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002219 * we want those data to come along with next response. A typical
2220 * example of such data would be from a buggy server responding to
2221 * a HEAD with some data, or sending more than the advertised
2222 * content-length.
2223 */
2224 if (unlikely(ci_data(&s->res)))
2225 b_set_data(&s->res.buf, co_data(&s->res));
2226
2227 /* Now we can realign the response buffer */
2228 c_realign_if_empty(&s->res);
2229
2230 s->req.rto = strm_fe(s)->timeout.client;
2231 s->req.wto = TICK_ETERNITY;
2232
2233 s->res.rto = TICK_ETERNITY;
2234 s->res.wto = strm_fe(s)->timeout.client;
2235
2236 s->req.rex = TICK_ETERNITY;
2237 s->req.wex = TICK_ETERNITY;
2238 s->req.analyse_exp = TICK_ETERNITY;
2239 s->res.rex = TICK_ETERNITY;
2240 s->res.wex = TICK_ETERNITY;
2241 s->res.analyse_exp = TICK_ETERNITY;
2242 s->si[1].hcto = TICK_ETERNITY;
2243
2244 /* we're removing the analysers, we MUST re-enable events detection.
2245 * We don't enable close on the response channel since it's either
2246 * already closed, or in keep-alive with an idle connection handler.
2247 */
2248 channel_auto_read(&s->req);
2249 channel_auto_close(&s->req);
2250 channel_auto_read(&s->res);
2251
2252
2253 return 1;
2254 }
2255 return 0;
2256}
2257
William Lallemand8a022572018-10-26 14:47:35 +02002258/*
2259 * The mworker functions are used to initialize the CLI in the master process
2260 */
2261
William Lallemand309dc9a2018-10-26 14:47:45 +02002262 /*
2263 * Stop the mworker proxy
2264 */
2265void mworker_cli_proxy_stop()
2266{
William Lallemand550db6d2018-11-06 17:37:12 +01002267 if (mworker_proxy)
2268 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002269}
2270
William Lallemand8a022572018-10-26 14:47:35 +02002271/*
2272 * Create the mworker CLI proxy
2273 */
2274int mworker_cli_proxy_create()
2275{
2276 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002277 char *msg = NULL;
2278 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002279
2280 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2281 if (!mworker_proxy)
2282 return -1;
2283
2284 init_new_proxy(mworker_proxy);
2285 mworker_proxy->next = proxies_list;
2286 proxies_list = mworker_proxy;
2287 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002288 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002289 mworker_proxy->state = PR_STNEW;
2290 mworker_proxy->last_change = now.tv_sec;
2291 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2292 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2293 mworker_proxy->timeout.client = 0; /* no timeout */
2294 mworker_proxy->conf.file = strdup("MASTER");
2295 mworker_proxy->conf.line = 0;
2296 mworker_proxy->accept = frontend_accept;
2297 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2298
2299 /* Does not init the default target the CLI applet, but must be done in
2300 * the request parsing code */
2301 mworker_proxy->default_target = NULL;
2302
2303 /* the check_config_validity() will get an ID for the proxy */
2304 mworker_proxy->uuid = -1;
2305
2306 proxy_store_name(mworker_proxy);
2307
2308 /* create all servers using the mworker_proc list */
2309 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002310 struct server *newsrv = NULL;
2311 struct sockaddr_storage *sk;
2312 int port1, port2, port;
2313 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002314
2315 newsrv = new_server(mworker_proxy);
2316 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002317 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002318
2319 /* we don't know the new pid yet */
2320 if (child->pid == -1)
2321 memprintf(&msg, "cur-%d", child->relative_pid);
2322 else
2323 memprintf(&msg, "old-%d", child->pid);
2324
2325 newsrv->next = mworker_proxy->srv;
2326 mworker_proxy->srv = newsrv;
2327 newsrv->conf.file = strdup(msg);
2328 newsrv->id = strdup(msg);
2329 newsrv->conf.line = 0;
2330
2331 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002332 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002333 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002334 }
2335 free(msg);
2336 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002337
2338 proto = protocol_by_family(sk->ss_family);
2339 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002340 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002341 }
2342
2343 /* no port specified */
2344 newsrv->flags |= SRV_F_MAPPORTS;
2345 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002346 /* don't let the server participate to load balancing */
2347 newsrv->iweight = 0;
2348 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002349 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002350
2351 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002352 }
2353 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002354
2355error:
2356 ha_alert("%s\n", errmsg);
2357
2358 list_for_each_entry(child, &proc_list, list) {
2359 free((char *)child->srv->conf.file); /* cast because of const char * */
2360 free(child->srv->id);
2361 free(child->srv);
2362 child->srv = NULL;
2363 }
2364 free(mworker_proxy->id);
2365 free(mworker_proxy->conf.file);
2366 free(mworker_proxy);
2367 mworker_proxy = NULL;
2368 free(errmsg);
2369 free(msg);
2370
2371 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002372}
Olivier Houchardf886e342017-04-05 22:24:59 +02002373
William Lallemandce83b4a2018-10-26 14:47:30 +02002374/*
William Lallemande7361152018-10-26 14:47:36 +02002375 * Create a new listener for the master CLI proxy
2376 */
2377int mworker_cli_proxy_new_listener(char *line)
2378{
2379 struct bind_conf *bind_conf;
2380 struct listener *l;
2381 char *err = NULL;
2382 char *args[MAX_LINE_ARGS + 1];
2383 int arg;
2384 int cur_arg;
2385
2386 arg = 0;
2387 args[0] = line;
2388
2389 /* args is a bind configuration with spaces replaced by commas */
2390 while (*line && arg < MAX_LINE_ARGS) {
2391
2392 if (*line == ',') {
2393 *line++ = '\0';
2394 while (*line == ',')
2395 line++;
2396 args[++arg] = line;
2397 }
2398 line++;
2399 }
2400
2401 args[++arg] = "\0";
2402
2403 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002404 if (!bind_conf)
2405 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002406
2407 bind_conf->level &= ~ACCESS_LVL_MASK;
2408 bind_conf->level |= ACCESS_LVL_ADMIN;
2409
2410 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2411 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002412 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002413 }
2414
2415 cur_arg = 1;
2416
2417 while (*args[cur_arg]) {
2418 static int bind_dumped;
2419 struct bind_kw *kw;
2420
2421 kw = bind_find_kw(args[cur_arg]);
2422 if (kw) {
2423 if (!kw->parse) {
2424 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2425 args[0], args[1], args[cur_arg]);
2426 goto err;
2427 }
2428
2429 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2430 if (err)
2431 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2432 else
2433 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2434 args[0], args[1], args[cur_arg]);
2435 goto err;
2436 }
2437
2438 cur_arg += 1 + kw->skip;
2439 continue;
2440 }
2441
2442 if (!bind_dumped) {
2443 bind_dump_kws(&err);
2444 indent_msg(&err, 4);
2445 bind_dumped = 1;
2446 }
2447
2448 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2449 args[0], args[1], args[cur_arg],
2450 err ? " Registered keywords :" : "", err ? err : "");
2451 goto err;
2452 }
2453
2454
2455 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002456 l->accept = session_accept_fd;
2457 l->default_target = mworker_proxy->default_target;
2458 /* don't make the peers subject to global limits and don't close it in the master */
2459 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2460 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002461 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002462 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002463 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002464
2465 return 0;
2466
2467err:
2468 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002469 free(err);
2470 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002471 return -1;
2472
2473}
2474
2475/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002476 * Create a new CLI socket using a socketpair for a worker process
2477 * <mworker_proc> is the process structure, and <proc> is the process number
2478 */
2479int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2480{
2481 struct bind_conf *bind_conf;
2482 struct listener *l;
2483 char *path = NULL;
2484 char *err = NULL;
2485
2486 /* master pipe to ensure the master is still alive */
2487 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2488 ha_alert("Cannot create worker socketpair.\n");
2489 return -1;
2490 }
2491
2492 /* XXX: we might want to use a separate frontend at some point */
2493 if (!global.stats_fe) {
2494 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2495 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002496 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002497 }
2498 }
2499
2500 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002501 if (!bind_conf)
2502 goto error;
2503
William Lallemandce83b4a2018-10-26 14:47:30 +02002504 bind_conf->level &= ~ACCESS_LVL_MASK;
2505 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2506
2507 bind_conf->bind_proc = 1UL << proc;
2508 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2509
2510 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2511 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002512 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002513 }
2514
2515 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002516 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002517 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002518 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002519 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002520 free(path);
2521 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002522
2523 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002524 l->accept = session_accept_fd;
2525 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002526 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002527 /* it's a sockpair but we don't want to keep the fd in the master */
2528 l->options &= ~LI_O_INHERITED;
2529 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002530 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002531 }
2532
2533 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002534
2535error:
2536 close(mworker_proc->ipc_fd[0]);
2537 close(mworker_proc->ipc_fd[1]);
2538 free(err);
2539
2540 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002541}
2542
William Lallemand74c24fb2016-11-21 17:18:36 +01002543static struct applet cli_applet = {
2544 .obj_type = OBJ_TYPE_APPLET,
2545 .name = "<CLI>", /* used for logging */
2546 .fct = cli_io_handler,
2547 .release = cli_release_handler,
2548};
2549
Willy Tarreau0a739292016-11-22 20:21:23 +01002550/* register cli keywords */
2551static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002552 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2553 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2554 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002555 { { "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 +01002556 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002557 { { "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 +01002558 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002559 { { "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 +02002560 { { "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 +01002561 { { "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 +02002562 { { "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 +01002563 { { "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 +01002564 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2565 { { "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 +02002566 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002567 {{},}
2568}};
2569
Willy Tarreau0108d902018-11-25 19:14:37 +01002570INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2571
William Lallemand74c24fb2016-11-21 17:18:36 +01002572static struct cfg_kw_list cfg_kws = {ILH, {
2573 { CFG_GLOBAL, "stats", stats_parse_global },
2574 { 0, NULL, NULL },
2575}};
2576
Willy Tarreau0108d902018-11-25 19:14:37 +01002577INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2578
William Lallemand74c24fb2016-11-21 17:18:36 +01002579static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002580 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2581 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002582 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002583 { NULL, NULL, 0 },
2584}};
2585
Willy Tarreau0108d902018-11-25 19:14:37 +01002586INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002587
2588/*
2589 * Local variables:
2590 * c-indent-level: 8
2591 * c-basic-offset: 8
2592 * End:
2593 */