blob: 96b59e0f4ea7ef4187d06faf143b8a41a79ec1f6 [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
William Lallemand33d29e22019-04-01 11:30:06 +0200375/*
376 * This function put a list of stats socket separated by a semicolon in the
377 * "HAPROXY_CLI" environment variable
378 */
379int cli_socket_setenv()
380{
381 struct buffer *trash = get_trash_chunk();
382 struct bind_conf *bind_conf;
383
384 if (global.stats_fe) {
385 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
386 struct listener *l;
387
388 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
389 char addr[46];
390 char port[6];
391
392 if (l->addr.ss_family == AF_UNIX) {
393 const struct sockaddr_un *un;
394
395 un = (struct sockaddr_un *)&l->addr;
396 if (un->sun_path[0] == '\0') {
397 chunk_appendf(trash, "abns@%s", un->sun_path+1);
398 } else {
399 chunk_appendf(trash, "unix@%s", un->sun_path);
400 }
401 } else if (l->addr.ss_family == AF_INET) {
402 addr_to_str(&l->addr, addr, sizeof(addr));
403 port_to_str(&l->addr, port, sizeof(port));
404 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
405 } else if (l->addr.ss_family == AF_INET6) {
406 addr_to_str(&l->addr, addr, sizeof(addr));
407 port_to_str(&l->addr, port, sizeof(port));
408 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
409 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
410 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
411 }
412 /* separate listener by semicolons */
413 trash->area[trash->data++] = ';';
414 }
415 }
416 trash->area[trash->data++] = '\0';
417 if (setenv("HAPROXY_CLI", trash->area, 1) < 0)
418 return -1;
419 }
420
421 return 0;
422}
423
424REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
425
Willy Tarreaude57a572016-11-23 17:01:39 +0100426/* Verifies that the CLI at least has a level at least as high as <level>
427 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
428 * failure, an error message is prepared and the appctx's state is adjusted
429 * to print it so that a return 1 is enough to abort any processing.
430 */
431int cli_has_level(struct appctx *appctx, int level)
432{
Willy Tarreaude57a572016-11-23 17:01:39 +0100433
William Lallemandf630d012018-12-13 09:05:44 +0100434 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200435 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100436 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100437 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100438 return 0;
439 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100440 return 1;
441}
442
William Lallemandb7ea1412018-12-13 09:05:47 +0100443/* same as cli_has_level but for the CLI proxy and without error message */
444int pcli_has_level(struct stream *s, int level)
445{
446 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
447 return 0;
448 }
449 return 1;
450}
451
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200452/* Returns severity_output for the current session if set, or default for the socket */
453static int cli_get_severity_output(struct appctx *appctx)
454{
455 if (appctx->cli_severity_output)
456 return appctx->cli_severity_output;
457 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
458}
William Lallemand74c24fb2016-11-21 17:18:36 +0100459
Willy Tarreau41908562016-11-24 16:23:38 +0100460/* Processes the CLI interpreter on the stats socket. This function is called
461 * from the CLI's IO handler running in an appctx context. The function returns 1
462 * if the request was understood, otherwise zero. It is called with appctx->st0
463 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
464 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
465 * have its own I/O handler called again. Most of the time, parsers will only
466 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100467 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
468 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100469 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200470static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100471{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200472 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
473 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100474 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100475
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200476 appctx->st2 = 0;
477 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100478
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200479 p = appctx->chunk->area;
480 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100481
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200482 /*
483 * Get the payload start if there is one.
484 * For the sake of simplicity, the payload pattern is looked up
485 * everywhere from the start of the input but it can only be found
486 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
487 *
488 * The input string was zero terminated so it is safe to use
489 * the str*() functions throughout the parsing
490 */
491 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
492 payload = strstr(p, PAYLOAD_PATTERN);
493 end = payload;
494 /* skip the pattern */
495 payload += strlen(PAYLOAD_PATTERN);
496 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100497
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200498 /*
499 * Get pointers on words.
500 * One extra slot is reserved to store a pointer on a null byte.
501 */
502 while (i < MAX_STATS_ARGS && p < end) {
503 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100504
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200505 /* skip leading spaces/tabs */
506 p += strspn(p, " \t");
507 if (!*p)
508 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100509
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200510 args[i] = p;
511 p += strcspn(p, " \t");
512 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100513
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200514 /* unescape backslashes (\) */
515 for (j = 0, k = 0; args[i][k]; k++) {
516 if (args[i][k] == '\\') {
517 if (args[i][k + 1] == '\\')
518 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100519 else
520 continue;
521 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200522 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100523 j++;
524 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200525 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100526
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200527 i++;
528 }
529 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200530 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200531 for (; i < MAX_STATS_ARGS + 1; i++)
532 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100533
534 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100535 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100536 return 0;
537
William Lallemand14721be2018-10-26 14:47:37 +0200538 /* in a worker or normal process, don't display master only commands */
539 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
540 return 0;
541
542 /* in master don't displays if we don't have the master bits */
543 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
544 return 0;
545
Willy Tarreau41908562016-11-24 16:23:38 +0100546 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200547 appctx->io_release = kw->io_release;
548 /* kw->parse could set its own io_handler or ip_release handler */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200549 if ((!kw->parse || kw->parse(args, payload, appctx, kw->private) == 0) && appctx->io_handler) {
Willy Tarreau41908562016-11-24 16:23:38 +0100550 appctx->st0 = CLI_ST_CALLBACK;
William Lallemand74c24fb2016-11-21 17:18:36 +0100551 }
Willy Tarreau41908562016-11-24 16:23:38 +0100552 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100553}
554
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200555/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
556static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
557{
Willy Tarreau83061a82018-07-13 11:56:34 +0200558 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200559
560 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200561 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200562
563 tmp = get_trash_chunk();
564 chunk_reset(tmp);
565
566 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100567 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200568 chunk_printf(tmp, "[%d]: ", severity);
569 }
570 else {
571 switch (severity_output) {
572 case CLI_SEVERITY_NUMBER:
573 chunk_printf(tmp, "[%d]: ", severity);
574 break;
575 case CLI_SEVERITY_STRING:
576 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
577 break;
578 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100579 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200580 }
581 }
582 chunk_appendf(tmp, "%s", msg);
583
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200584 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200585}
586
William Lallemand74c24fb2016-11-21 17:18:36 +0100587/* This I/O handler runs as an applet embedded in a stream interface. It is
588 * used to processes I/O from/to the stats unix socket. The system relies on a
589 * state machine handling requests and various responses. We read a request,
590 * then we process it and send the response, and we possibly display a prompt.
591 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100592 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100593 * or not.
594 */
595static void cli_io_handler(struct appctx *appctx)
596{
597 struct stream_interface *si = appctx->owner;
598 struct channel *req = si_oc(si);
599 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200600 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100601 int reql;
602 int len;
603
604 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
605 goto out;
606
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800607 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200608 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100609 /* buf.size==0 means we failed to get a buffer and were
610 * already subscribed to a wait list to get a buffer.
611 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100612 goto out;
613 }
614
William Lallemand74c24fb2016-11-21 17:18:36 +0100615 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100616 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100617 /* Stats output not initialized yet */
618 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200619 /* reset severity to default at init */
620 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100621 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100622 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100623 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100624 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100625 /* Let's close for real now. We just close the request
626 * side, the conditions below will complete if needed.
627 */
628 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200629 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100630 break;
631 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100632 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200633 char *str;
634
635 /* use a trash chunk to store received data */
636 if (!appctx->chunk) {
637 appctx->chunk = alloc_trash_chunk();
638 if (!appctx->chunk) {
639 appctx->st0 = CLI_ST_END;
640 continue;
641 }
642 }
643
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200644 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200645
William Lallemand74c24fb2016-11-21 17:18:36 +0100646 /* ensure we have some output room left in the event we
647 * would want to return some info right after parsing.
648 */
649 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100650 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100651 break;
652 }
653
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200654 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200655 reql = co_getline(si_oc(si), str,
656 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100657 if (reql <= 0) { /* closed or EOL not found */
658 if (reql == 0)
659 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100660 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100661 continue;
662 }
663
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200664 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
665 /* seek for a possible unescaped semi-colon. If we find
666 * one, we replace it with an LF and skip only this part.
667 */
668 for (len = 0; len < reql; len++) {
669 if (str[len] == '\\') {
670 len++;
671 continue;
672 }
673 if (str[len] == ';') {
674 str[len] = '\n';
675 reql = len + 1;
676 break;
677 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100678 }
679 }
680
681 /* now it is time to check that we have a full line,
682 * remove the trailing \n and possibly \r, then cut the
683 * line.
684 */
685 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200686 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100687 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100688 continue;
689 }
690
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200691 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100692 len--;
693
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200694 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200695 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200696
697 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200698 appctx->chunk->area[appctx->chunk->data] = '\n';
699 appctx->chunk->area[appctx->chunk->data + 1] = 0;
700 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200701 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100702
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100703 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200704
705 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
706 /* empty line */
707 if (!len) {
708 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200709 appctx->chunk->data -= 2;
710 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200711
712 if (!cli_parse_request(appctx))
713 cli_gen_usage_msg(appctx);
714
715 chunk_reset(appctx->chunk);
716 /* NB: cli_sock_parse_request() may have put
717 * another CLI_ST_O_* into appctx->st0.
718 */
719
720 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100721 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100722 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200723 else {
724 /*
725 * Look for the "payload start" pattern at the end of a line
726 * Its location is not remembered here, this is just to switch
727 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100728 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200729 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200731 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200732 /* no payload, the command is complete: parse the request */
733 if (!cli_parse_request(appctx))
734 cli_gen_usage_msg(appctx);
735
736 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200737 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100738 }
739
740 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200741 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100742 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
743 }
744 else { /* output functions */
745 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100746 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100747 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100748 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200749 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
750 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100751 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100752 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100753 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100754 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200755 case CLI_ST_PRINT_FREE: {
756 const char *msg = appctx->ctx.cli.err;
757
758 if (!msg)
759 msg = "Out of memory.\n";
760
761 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100762 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100763 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100764 }
765 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100766 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100767 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200768 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100769 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100770 if (appctx->io_handler)
771 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100772 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100773 if (appctx->io_release) {
774 appctx->io_release(appctx);
775 appctx->io_release = NULL;
776 }
777 }
778 break;
779 default: /* abnormal state */
780 si->flags |= SI_FL_ERR;
781 break;
782 }
783
784 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100785 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200786 const char *prompt = "";
787
788 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
789 /*
790 * when entering a payload with interactive mode, change the prompt
791 * to emphasize that more data can still be sent
792 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200793 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200794 prompt = "+ ";
795 else
796 prompt = "\n> ";
797 }
798 else {
799 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))
800 prompt = "\n";
801 }
802
803 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100804 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100805 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100806 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100807 }
808
809 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100810 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100811 break;
812
813 /* Now we close the output if one of the writers did so,
814 * or if we're not in interactive mode and the request
815 * buffer is empty. This still allows pipelined requests
816 * to be sent in non-interactive mode.
817 */
William Lallemand3de09d52018-12-11 16:10:56 +0100818 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
819 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100820 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100821 continue;
822 }
823
824 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100825 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 }
827 }
828
829 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
830 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
831 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
832 /* Other side has closed, let's abort if we have no more processing to do
833 * and nothing more to consume. This is comparable to a broken pipe, so
834 * we forward the close to the request side so that it flows upstream to
835 * the client.
836 */
837 si_shutw(si);
838 }
839
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100840 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100841 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
842 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
843 /* We have no more processing to do, and nothing more to send, and
844 * the client side has closed. So we'll forward this state downstream
845 * on the response buffer.
846 */
847 si_shutr(si);
848 res->flags |= CF_READ_NULL;
849 }
850
851 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200852 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 +0100853 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200854 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 +0100855}
856
William Lallemand74c24fb2016-11-21 17:18:36 +0100857/* This is called when the stream interface is closed. For instance, upon an
858 * external abort, we won't call the i/o handler anymore so we may need to
859 * remove back references to the stream currently being dumped.
860 */
861static void cli_release_handler(struct appctx *appctx)
862{
863 if (appctx->io_release) {
864 appctx->io_release(appctx);
865 appctx->io_release = NULL;
866 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100867 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100868 free(appctx->ctx.cli.err);
869 appctx->ctx.cli.err = NULL;
870 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100871}
872
873/* This function dumps all environmnent variables to the buffer. It returns 0
874 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100875 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
876 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100877 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100878static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100879{
Willy Tarreau0a739292016-11-22 20:21:23 +0100880 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100881 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100882
883 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
884 return 1;
885
886 chunk_reset(&trash);
887
888 /* we have two inner loops here, one for the proxy, the other one for
889 * the buffer.
890 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100891 while (*var) {
892 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100893
Willy Tarreau06d80a92017-10-19 14:32:15 +0200894 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100895 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100896 return 0;
897 }
898 if (appctx->st2 == STAT_ST_END)
899 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100900 var++;
901 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100902 }
903
904 /* dump complete */
905 return 1;
906}
907
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200908/* This function dumps all file descriptors states (or the requested one) to
909 * the buffer. It returns 0 if the output buffer is full and it needs to be
910 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
911 * It uses cli.i0 as the fd number to restart from.
912 */
913static int cli_io_handler_show_fd(struct appctx *appctx)
914{
915 struct stream_interface *si = appctx->owner;
916 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100917 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200918
919 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100920 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200921
922 chunk_reset(&trash);
923
Willy Tarreauca1b1572018-12-18 15:45:11 +0100924 /* isolate the threads once per round. We're limited to a buffer worth
925 * of output anyway, it cannot last very long.
926 */
927 thread_isolate();
928
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200929 /* we have two inner loops here, one for the proxy, the other one for
930 * the buffer.
931 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100932 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200933 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200934 struct listener *li = NULL;
935 struct server *sv = NULL;
936 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200937 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200938 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +0200939 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100940 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200941
942 fdt = fdtab[fd];
943
Willy Tarreauca1b1572018-12-18 15:45:11 +0100944 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +0200945 goto skip; // closed
946
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200947 if (fdt.iocb == conn_fd_handler) {
948 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200949 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100950 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200951 li = objt_listener(((struct connection *)fdt.owner)->target);
952 sv = objt_server(((struct connection *)fdt.owner)->target);
953 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100954 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200955 }
956 else if (fdt.iocb == listener_accept)
957 li = fdt.owner;
958
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200959 chunk_printf(&trash,
Willy Tarreauc754b342018-03-30 15:00:15 +0200960 " %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 +0200961 fd,
962 fdt.state,
963 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
964 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
965 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
966 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
967 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
968 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
969 fdt.ev,
970 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
971 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
972 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
973 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
974 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200975 fdt.linger_risk ? 'L' : 'l',
976 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +0200977 fdt.cache.next,
978 fdt.cache.prev,
979 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200980 fdt.owner,
981 fdt.iocb,
982 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
983 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
984 (fdt.iocb == listener_accept) ? "listener_accept" :
Olivier Houchard79321b92018-07-26 17:55:11 +0200985 (fdt.iocb == poller_pipe_io_handler) ? "poller_pipe_io_handler" :
William Lallemanddb6bdfb2018-11-20 17:36:51 +0100986 (fdt.iocb == mworker_accept_wrapper) ? "mworker_accept_wrapper" :
Willy Tarreauc754b342018-03-30 15:00:15 +0200987 "unknown");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200988
989 if (fdt.iocb == conn_fd_handler) {
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100990 chunk_appendf(&trash, " back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200991 if (px)
992 chunk_appendf(&trash, " px=%s", px->id);
993 else if (sv)
994 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
995 else if (li)
996 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +0200997
Willy Tarreaub011d8f2018-03-30 14:41:19 +0200998 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +0100999 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001000 if (mux->show_fd)
1001 mux->show_fd(&trash, fdt.owner);
1002 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001003 else
1004 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001005 }
1006 else if (fdt.iocb == listener_accept) {
1007 chunk_appendf(&trash, " l.st=%s fe=%s",
1008 listener_state_str(li),
1009 li->bind_conf->frontend->id);
1010 }
1011
1012 chunk_appendf(&trash, "\n");
1013
Willy Tarreau06d80a92017-10-19 14:32:15 +02001014 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001015 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001016 appctx->ctx.cli.i0 = fd;
1017 ret = 0;
1018 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001019 }
1020 skip:
1021 if (appctx->st2 == STAT_ST_END)
1022 break;
1023
1024 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001025 }
1026
Willy Tarreauca1b1572018-12-18 15:45:11 +01001027 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001028 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001029
1030 thread_release();
1031 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001032}
1033
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001034/* This function dumps some activity counters used by developers and support to
1035 * rule out some hypothesis during bug reports. It returns 0 if the output
1036 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1037 * everything at once in the buffer and is not designed to do it in multiple
1038 * passes.
1039 */
1040static int cli_io_handler_show_activity(struct appctx *appctx)
1041{
1042 struct stream_interface *si = appctx->owner;
1043 int thr;
1044
1045 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1046 return 1;
1047
1048 chunk_reset(&trash);
1049
1050 chunk_appendf(&trash, "thread_id: %u", tid);
1051 chunk_appendf(&trash, "\ndate_now: %lu.%06lu", (long)now.tv_sec, (long)now.tv_usec);
1052 chunk_appendf(&trash, "\nloops:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].loops);
1053 chunk_appendf(&trash, "\nwake_cache:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_cache);
1054 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 +01001055 chunk_appendf(&trash, "\nwake_signal:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].wake_signal);
1056 chunk_appendf(&trash, "\npoll_exp:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_exp);
1057 chunk_appendf(&trash, "\npoll_drop:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_drop);
1058 chunk_appendf(&trash, "\npoll_dead:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_dead);
1059 chunk_appendf(&trash, "\npoll_skip:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].poll_skip);
1060 chunk_appendf(&trash, "\nfd_skip:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_skip);
1061 chunk_appendf(&trash, "\nfd_lock:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_lock);
1062 chunk_appendf(&trash, "\nfd_del:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].fd_del);
1063 chunk_appendf(&trash, "\nconn_dead:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].conn_dead);
1064 chunk_appendf(&trash, "\nstream:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].stream);
1065 chunk_appendf(&trash, "\nempty_rq:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].empty_rq);
1066 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 +01001067 chunk_appendf(&trash, "\ncpust_ms_tot:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].cpust_total/2);
1068 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);
1069 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 +01001070 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 +01001071 chunk_appendf(&trash, "\naccq_pushed:"); for (thr = 0; thr < global.nbthread; thr++) chunk_appendf(&trash, " %u", activity[thr].accq_pushed);
1072 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 +01001073
1074 chunk_appendf(&trash, "\n");
1075
1076 if (ci_putchk(si_ic(si), &trash) == -1) {
1077 chunk_reset(&trash);
1078 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001079 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001080 }
1081
1082 /* dump complete */
1083 return 1;
1084}
1085
William Lallemandeceddf72016-12-15 18:06:44 +01001086/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001087 * CLI IO handler for `show cli sockets`.
1088 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001089 */
1090static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1091{
1092 struct bind_conf *bind_conf;
1093 struct stream_interface *si = appctx->owner;
1094
1095 chunk_reset(&trash);
1096
1097 switch (appctx->st2) {
1098 case STAT_ST_INIT:
1099 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001100 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001101 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001102 return 0;
1103 }
William Lallemandeceddf72016-12-15 18:06:44 +01001104 appctx->st2 = STAT_ST_LIST;
1105
1106 case STAT_ST_LIST:
1107 if (global.stats_fe) {
1108 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1109 struct listener *l;
1110
1111 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001112 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001113 * if the current node is the first of the list
1114 */
1115
Willy Tarreau3af9d832016-12-16 12:58:09 +01001116 if (appctx->ctx.cli.p0 &&
1117 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001118 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001119 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001120 continue;
1121 }
1122
1123 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1124
1125 char addr[46];
1126 char port[6];
1127
1128 if (l->addr.ss_family == AF_UNIX) {
1129 const struct sockaddr_un *un;
1130
1131 un = (struct sockaddr_un *)&l->addr;
William Lallemande58915f2019-04-01 11:30:05 +02001132 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001133 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001134 } else {
1135 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1136 }
William Lallemandeceddf72016-12-15 18:06:44 +01001137 } else if (l->addr.ss_family == AF_INET) {
1138 addr_to_str(&l->addr, addr, sizeof(addr));
1139 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001140 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001141 } else if (l->addr.ss_family == AF_INET6) {
1142 addr_to_str(&l->addr, addr, sizeof(addr));
1143 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001144 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001145 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1146 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001147 } else
William Lallemand26314342018-10-26 14:47:41 +02001148 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001149
William Lallemand07a62f72017-05-24 00:57:40 +02001150 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001151 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001152 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1153 chunk_appendf(&trash, "operator ");
1154 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1155 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001156 else
1157 chunk_appendf(&trash, " ");
1158
1159 if (bind_conf->bind_proc != 0) {
1160 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001161 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001162 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001163 chunk_appendf(&trash, "%d,", pos+1);
1164 }
1165 }
1166 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001167 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001168
1169 } else {
1170 chunk_appendf(&trash, "all\n");
1171 }
1172
Willy Tarreau06d80a92017-10-19 14:32:15 +02001173 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001174 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001175 return 0;
1176 }
1177 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001178 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001179 }
1180 }
1181 default:
1182 appctx->st2 = STAT_ST_FIN;
1183 return 1;
1184 }
1185}
1186
1187
Willy Tarreau0a739292016-11-22 20:21:23 +01001188/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001189 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1190 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001191 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001192static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001193{
1194 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001195 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001196
1197 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1198 return 1;
1199
Willy Tarreauf6710f82016-12-16 17:45:44 +01001200 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001201
1202 if (*args[2]) {
1203 int len = strlen(args[2]);
1204
Willy Tarreauf6710f82016-12-16 17:45:44 +01001205 for (; *var; var++) {
1206 if (strncmp(*var, args[2], len) == 0 &&
1207 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001208 break;
1209 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001210 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001211 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001212 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001213 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001214 return 1;
1215 }
1216 appctx->st2 = STAT_ST_END;
1217 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001218 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001219 return 0;
1220}
1221
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001222/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1223 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1224 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1225 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001226static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001227{
1228 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1229 return 1;
1230
1231 appctx->ctx.cli.i0 = 0;
1232
1233 if (*args[2]) {
1234 appctx->ctx.cli.i0 = atoi(args[2]);
1235 appctx->st2 = STAT_ST_END;
1236 }
1237 return 0;
1238}
1239
Willy Tarreau599852e2016-11-22 20:33:32 +01001240/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001241static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001242{
1243 struct stream_interface *si = appctx->owner;
1244 struct stream *s = si_strm(si);
1245
1246 if (strcmp(args[2], "cli") == 0) {
1247 unsigned timeout;
1248 const char *res;
1249
1250 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001251 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001252 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001253 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001254 return 1;
1255 }
1256
1257 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1258 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001259 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001260 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001261 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001262 return 1;
1263 }
1264
1265 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1266 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1267 return 1;
1268 }
1269 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001270 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001271 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001272 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001273 return 1;
1274 }
1275}
1276
Willy Tarreau2af99412016-11-23 11:10:59 +01001277/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001278static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001279{
1280 int v;
1281
1282 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1283 return 1;
1284
1285 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001286 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001287 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001288 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001289 return 1;
1290 }
1291
1292 v = atoi(args[3]);
1293 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001294 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001295 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001296 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001297 return 1;
1298 }
1299
1300 /* check for unlimited values */
1301 if (v <= 0)
1302 v = global.hardmaxconn;
1303
1304 global.maxconn = v;
1305
1306 /* Dequeues all of the listeners waiting for a resource */
1307 if (!LIST_ISEMPTY(&global_listener_queue))
1308 dequeue_all_listeners(&global_listener_queue);
1309
1310 return 1;
1311}
1312
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001313static int set_severity_output(int *target, char *argument)
1314{
1315 if (!strcmp(argument, "none")) {
1316 *target = CLI_SEVERITY_NONE;
1317 return 1;
1318 }
1319 else if (!strcmp(argument, "number")) {
1320 *target = CLI_SEVERITY_NUMBER;
1321 return 1;
1322 }
1323 else if (!strcmp(argument, "string")) {
1324 *target = CLI_SEVERITY_STRING;
1325 return 1;
1326 }
1327 return 0;
1328}
1329
1330/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001331static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001332{
1333 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1334 return 0;
1335
1336 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001337 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001338 appctx->st0 = CLI_ST_PRINT;
1339 return 1;
1340}
William Lallemandeceddf72016-12-15 18:06:44 +01001341
William Lallemand67a234f2018-12-13 09:05:45 +01001342
1343/* show the level of the current CLI session */
1344static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1345{
1346
1347 appctx->ctx.cli.severity = LOG_INFO;
1348 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1349 appctx->ctx.cli.msg = "admin\n";
1350 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1351 appctx->ctx.cli.msg = "operator\n";
1352 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1353 appctx->ctx.cli.msg = "user\n";
1354 else
1355 appctx->ctx.cli.msg = "unknown\n";
1356
1357 appctx->st0 = CLI_ST_PRINT;
1358 return 1;
1359
1360}
1361
1362/* parse and set the CLI level dynamically */
1363static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1364{
1365 if (!strcmp(args[0], "operator")) {
1366 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1367 return 1;
1368 }
1369 appctx->cli_level &= ~ACCESS_LVL_MASK;
1370 appctx->cli_level |= ACCESS_LVL_OPER;
1371
1372 } else if (!strcmp(args[0], "user")) {
1373 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1374 return 1;
1375 }
1376 appctx->cli_level &= ~ACCESS_LVL_MASK;
1377 appctx->cli_level |= ACCESS_LVL_USER;
1378 }
1379 return 1;
1380}
1381
William Lallemanda57b7e32018-12-14 21:11:31 +01001382
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001383int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001384{
1385 return 0;
1386}
1387
Willy Tarreau45c742b2016-11-24 14:51:17 +01001388/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001389static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001390{
1391 int v;
1392 int *res;
1393 int mul = 1;
1394
1395 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1396 return 1;
1397
1398 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1399 res = &global.cps_lim;
1400 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1401 res = &global.sps_lim;
1402#ifdef USE_OPENSSL
1403 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1404 res = &global.ssl_lim;
1405#endif
1406 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1407 res = &global.comp_rate_lim;
1408 mul = 1024;
1409 }
1410 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001411 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001412 appctx->ctx.cli.msg =
1413 "'set rate-limit' only supports :\n"
1414 " - 'connections global' to set the per-process maximum connection rate\n"
1415 " - 'sessions global' to set the per-process maximum session rate\n"
1416#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001417 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001418#endif
1419 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001420 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001421 return 1;
1422 }
1423
1424 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001425 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001426 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001427 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001428 return 1;
1429 }
1430
1431 v = atoi(args[4]);
1432 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001433 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001434 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001435 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001436 return 1;
1437 }
1438
1439 *res = v * mul;
1440
1441 /* Dequeues all of the listeners waiting for a resource */
1442 if (!LIST_ISEMPTY(&global_listener_queue))
1443 dequeue_all_listeners(&global_listener_queue);
1444
1445 return 1;
1446}
1447
William Lallemandf6975e92017-05-26 17:42:10 +02001448/* parse the "expose-fd" argument on the bind lines */
1449static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1450{
1451 if (!*args[cur_arg + 1]) {
1452 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1453 return ERR_ALERT | ERR_FATAL;
1454 }
1455 if (!strcmp(args[cur_arg+1], "listeners")) {
1456 conf->level |= ACCESS_FD_LISTENERS;
1457 } else {
1458 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1459 args[cur_arg], args[cur_arg+1]);
1460 return ERR_ALERT | ERR_FATAL;
1461 }
1462
1463 return 0;
1464}
1465
William Lallemand74c24fb2016-11-21 17:18:36 +01001466/* parse the "level" argument on the bind lines */
1467static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1468{
1469 if (!*args[cur_arg + 1]) {
1470 memprintf(err, "'%s' : missing level", args[cur_arg]);
1471 return ERR_ALERT | ERR_FATAL;
1472 }
1473
William Lallemand07a62f72017-05-24 00:57:40 +02001474 if (!strcmp(args[cur_arg+1], "user")) {
1475 conf->level &= ~ACCESS_LVL_MASK;
1476 conf->level |= ACCESS_LVL_USER;
1477 } else if (!strcmp(args[cur_arg+1], "operator")) {
1478 conf->level &= ~ACCESS_LVL_MASK;
1479 conf->level |= ACCESS_LVL_OPER;
1480 } else if (!strcmp(args[cur_arg+1], "admin")) {
1481 conf->level &= ~ACCESS_LVL_MASK;
1482 conf->level |= ACCESS_LVL_ADMIN;
1483 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001484 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1485 args[cur_arg], args[cur_arg+1]);
1486 return ERR_ALERT | ERR_FATAL;
1487 }
1488
1489 return 0;
1490}
1491
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001492static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1493{
1494 if (!*args[cur_arg + 1]) {
1495 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1496 return ERR_ALERT | ERR_FATAL;
1497 }
1498
1499 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1500 return 0;
1501 else {
1502 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1503 args[cur_arg], args[cur_arg+1]);
1504 return ERR_ALERT | ERR_FATAL;
1505 }
1506}
1507
William Lallemand16dd1b32018-11-19 18:46:18 +01001508
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001509
Olivier Houchardf886e342017-04-05 22:24:59 +02001510/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001511static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001512{
1513 char *cmsgbuf = NULL;
1514 unsigned char *tmpbuf = NULL;
1515 struct cmsghdr *cmsg;
1516 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001517 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001518 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001519 struct msghdr msghdr;
1520 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001521 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001522 int *tmpfd;
1523 int tot_fd_nb = 0;
1524 struct proxy *px;
1525 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001526 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001527 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001528 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001529 int ret;
1530
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001531 if (!remote) {
1532 ha_warning("Only works on real connections\n");
1533 goto out;
1534 }
1535
1536 fd = remote->handle.fd;
1537
Olivier Houchardf886e342017-04-05 22:24:59 +02001538 /* Temporary set the FD in blocking mode, that will make our life easier */
1539 old_fcntl = fcntl(fd, F_GETFL);
1540 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001541 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001542 goto out;
1543 }
1544 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1545 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001546 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001547 goto out;
1548 }
1549 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001550 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001551 goto out;
1552 }
Olivier Houchard54740872017-04-06 14:45:14 +02001553 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001554 iov.iov_base = &tot_fd_nb;
1555 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001556 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001557 goto out;
1558 memset(&msghdr, 0, sizeof(msghdr));
1559 /*
1560 * First, calculates the total number of FD, so that we can let
1561 * the caller know how much he should expects.
1562 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001563 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001564 while (px) {
1565 struct listener *l;
1566
1567 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001568 /* Only transfer IPv4/IPv6/UNIX sockets */
1569 if (l->state >= LI_ZOMBIE &&
1570 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001571 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001572 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001573 tot_fd_nb++;
1574 }
1575 px = px->next;
1576 }
1577 if (tot_fd_nb == 0)
1578 goto out;
1579
1580 /* First send the total number of file descriptors, so that the
1581 * receiving end knows what to expect.
1582 */
1583 msghdr.msg_iov = &iov;
1584 msghdr.msg_iovlen = 1;
1585 ret = sendmsg(fd, &msghdr, 0);
1586 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001587 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001588 goto out;
1589 }
1590
1591 /* Now send the fds */
1592 msghdr.msg_control = cmsgbuf;
1593 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1594 cmsg = CMSG_FIRSTHDR(&msghdr);
1595 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1596 cmsg->cmsg_level = SOL_SOCKET;
1597 cmsg->cmsg_type = SCM_RIGHTS;
1598 tmpfd = (int *)CMSG_DATA(cmsg);
1599
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001600 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001601 /* For each socket, e message is sent, containing the following :
1602 * Size of the namespace name (or 0 if none), as an unsigned char.
1603 * The namespace name, if any
1604 * Size of the interface name (or 0 if none), as an unsigned char
1605 * The interface name, if any
1606 * Listener options, as an int.
1607 */
1608 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1609 * buffer big enough to store the socket informations.
1610 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001611 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001612 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001613 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001614 goto out;
1615 }
1616 iov.iov_base = tmpbuf;
1617 while (px) {
1618 struct listener *l;
1619
1620 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1621 int ret;
1622 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001623 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001624 (l->proto->sock_family == AF_INET ||
1625 l->proto->sock_family == AF_INET6 ||
1626 l->proto->sock_family == AF_UNIX)) {
1627 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1628 if (!l->netns)
1629 tmpbuf[curoff++] = 0;
1630#ifdef CONFIG_HAP_NS
1631 else {
1632 char *name = l->netns->node.key;
1633 unsigned char len = l->netns->name_len;
1634 tmpbuf[curoff++] = len;
1635 memcpy(tmpbuf + curoff, name, len);
1636 curoff += len;
1637 }
1638#endif
1639 if (l->interface) {
1640 unsigned char len = strlen(l->interface);
1641 tmpbuf[curoff++] = len;
1642 memcpy(tmpbuf + curoff, l->interface, len);
1643 curoff += len;
1644 } else
1645 tmpbuf[curoff++] = 0;
1646 memcpy(tmpbuf + curoff, &l->options,
1647 sizeof(l->options));
1648 curoff += sizeof(l->options);
1649
1650
1651 i++;
1652 } else
1653 continue;
1654 if ((!(i % MAX_SEND_FD))) {
1655 iov.iov_len = curoff;
1656 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001657 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001658 goto out;
1659 }
1660 /* Wait for an ack */
1661 do {
1662 ret = recv(fd, &tot_fd_nb,
1663 sizeof(tot_fd_nb), 0);
1664 } while (ret == -1 && errno == EINTR);
1665 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001666 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001667 goto out;
1668 }
1669 curoff = 0;
1670 }
1671
1672 }
1673 px = px->next;
1674 }
1675 if (i % MAX_SEND_FD) {
1676 iov.iov_len = curoff;
1677 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1678 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1679 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001680 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001681 goto out;
1682 }
1683 }
1684
1685out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001686 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001687 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001688 goto out;
1689 }
1690 appctx->st0 = CLI_ST_END;
1691 free(cmsgbuf);
1692 free(tmpbuf);
1693 return 1;
1694}
1695
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001696static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1697{
1698 if (*args[0] == 'h')
1699 /* help */
1700 cli_gen_usage_msg(appctx);
1701 else if (*args[0] == 'p')
1702 /* prompt */
1703 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1704 else if (*args[0] == 'q')
1705 /* quit */
1706 appctx->st0 = CLI_ST_END;
1707
1708 return 1;
1709}
Olivier Houchardf886e342017-04-05 22:24:59 +02001710
William Lallemand2f4ce202018-10-26 14:47:47 +02001711void pcli_write_prompt(struct stream *s)
1712{
1713 struct buffer *msg = get_trash_chunk();
1714 struct channel *oc = si_oc(&s->si[0]);
1715
William Lallemanddc12c2e2018-12-13 09:05:46 +01001716 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001717 return;
1718
William Lallemanddc12c2e2018-12-13 09:05:46 +01001719 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001720 chunk_appendf(msg, "+ ");
1721 } else {
1722 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001723 chunk_appendf(msg, "master%s> ",
1724 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001725 else
1726 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1727 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001728 co_inject(oc, msg->area, msg->data);
1729}
1730
William Lallemand291810d2018-10-26 14:47:38 +02001731
William Lallemandcf62f7e2018-10-26 14:47:40 +02001732/* The pcli_* functions are used for the CLI proxy in the master */
1733
William Lallemanddeeaa592018-10-26 14:47:48 +02001734void pcli_reply_and_close(struct stream *s, const char *msg)
1735{
1736 struct buffer *buf = get_trash_chunk();
1737
1738 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001739 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001740}
1741
William Lallemand291810d2018-10-26 14:47:38 +02001742static enum obj_type *pcli_pid_to_server(int proc_pid)
1743{
1744 struct mworker_proc *child;
1745
William Lallemandbddd33a2018-12-11 16:10:53 +01001746 /* return the CLI applet of the master */
1747 if (proc_pid == 0)
1748 return &cli_applet.obj_type;
1749
William Lallemand291810d2018-10-26 14:47:38 +02001750 list_for_each_entry(child, &proc_list, list) {
1751 if (child->pid == proc_pid){
1752 return &child->srv->obj_type;
1753 }
1754 }
1755 return NULL;
1756}
1757
1758/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1759 * Return:
1760 * 0: master
1761 * > 0: pid of a worker
1762 * < 0: didn't find a worker
1763 */
1764static int pcli_prefix_to_pid(const char *prefix)
1765{
1766 int proc_pid;
1767 struct mworker_proc *child;
1768 char *errtol = NULL;
1769
1770 if (*prefix != '@') /* not a prefix, should not happen */
1771 return -1;
1772
1773 prefix++;
1774 if (!*prefix) /* sent @ alone, return the master */
1775 return 0;
1776
1777 if (strcmp("master", prefix) == 0) {
1778 return 0;
1779 } else if (*prefix == '!') {
1780 prefix++;
1781 if (!*prefix)
1782 return -1;
1783
1784 proc_pid = strtol(prefix, &errtol, 10);
1785 if (*errtol != '\0')
1786 return -1;
1787 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001788 if (child->type != 'w')
1789 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001790 if (child->pid == proc_pid){
1791 return child->pid;
1792 }
1793 }
1794 } else {
1795 struct mworker_proc *chosen = NULL;
1796 /* this is a relative pid */
1797
1798 proc_pid = strtol(prefix, &errtol, 10);
1799 if (*errtol != '\0')
1800 return -1;
1801
1802 if (proc_pid == 0) /* return the master */
1803 return 0;
1804
1805 /* chose the right process, the current one is the one with the
1806 least number of reloads */
1807 list_for_each_entry(child, &proc_list, list) {
William Lallemand16dd1b32018-11-19 18:46:18 +01001808 if (child->type != 'w')
1809 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001810 if (child->relative_pid == proc_pid){
1811 if (child->reloads == 0)
1812 return child->pid;
1813 else if (chosen == NULL || child->reloads < chosen->reloads)
1814 chosen = child;
1815 }
1816 }
1817 if (chosen)
1818 return chosen->pid;
1819 }
1820 return -1;
1821}
1822
William Lallemandbddd33a2018-12-11 16:10:53 +01001823/* Return::
1824 * >= 0 : number of words to escape
1825 * = -1 : error
1826 */
1827
1828int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1829{
1830 if (argl < 1)
1831 return 0;
1832
1833 /* there is a prefix */
1834 if (args[0][0] == '@') {
1835 int target_pid = pcli_prefix_to_pid(args[0]);
1836
1837 if (target_pid == -1) {
1838 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1839 return -1;
1840 }
1841
1842 /* if the prefix is alone, define a default target */
1843 if (argl == 1)
1844 s->pcli_next_pid = target_pid;
1845 else
1846 *next_pid = target_pid;
1847 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001848 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001849 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001850 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001851
1852 } else if (!strcmp("quit", args[0])) {
1853 channel_shutr_now(&s->req);
1854 channel_shutw_now(&s->res);
1855 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001856 } else if (!strcmp(args[0], "operator")) {
1857 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1858 memprintf(errmsg, "Permission denied!\n");
1859 return -1;
1860 }
1861 s->pcli_flags &= ~ACCESS_LVL_MASK;
1862 s->pcli_flags |= ACCESS_LVL_OPER;
1863 return argl;
1864
1865 } else if (!strcmp(args[0], "user")) {
1866 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1867 memprintf(errmsg, "Permission denied!\n");
1868 return -1;
1869 }
1870 s->pcli_flags &= ~ACCESS_LVL_MASK;
1871 s->pcli_flags |= ACCESS_LVL_USER;
1872 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001873 }
1874
1875 return 0;
1876}
1877
1878/*
1879 * Parse the CLI request:
1880 * - It does basically the same as the cli_io_handler, but as a proxy
1881 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001882 *
1883 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01001884 * - the number of characters to forward or
1885 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02001886 */
William Lallemandbddd33a2018-12-11 16:10:53 +01001887int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001888{
William Lallemandbddd33a2018-12-11 16:10:53 +01001889 char *str = (char *)ci_head(req);
1890 char *end = (char *)ci_stop(req);
1891 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
1892 int argl; /* number of args */
1893 char *p;
1894 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01001895 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01001896 int wtrim = 0; /* number of words to trim */
1897 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01001898 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01001899 int i = 0;
1900
1901 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001902
William Lallemanddc12c2e2018-12-13 09:05:46 +01001903 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01001904
1905 /* Looks for the end of one command */
1906 while (p+reql < end) {
1907 /* handle escaping */
1908 if (p[reql] == '\\') {
1909 reql++;
1910 continue;
1911 }
1912 if (p[reql] == ';' || p[reql] == '\n') {
1913 /* found the end of the command */
1914 p[reql] = '\n';
1915 reql++;
1916 break;
1917 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001918 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001919 }
William Lallemandebf61802018-12-11 16:10:57 +01001920 } else {
1921 while (p+reql < end) {
1922 if (p[reql] == '\n') {
1923 /* found the end of the line */
1924 reql++;
1925 break;
1926 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001927 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01001928 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001929 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001930
William Lallemandbddd33a2018-12-11 16:10:53 +01001931 /* set end to first byte after the end of the command */
1932 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001933
William Lallemandbddd33a2018-12-11 16:10:53 +01001934 /* there is no end to this command, need more to parse ! */
1935 if (*(end-1) != '\n') {
1936 return -1;
1937 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02001938
William Lallemand3301f3e2018-12-13 09:05:48 +01001939 if (s->pcli_flags & PCLI_F_PAYLOAD) {
1940 if (reql == 1) /* last line of the payload */
1941 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01001942 return reql;
1943 }
1944
William Lallemandbddd33a2018-12-11 16:10:53 +01001945 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001946
William Lallemandbddd33a2018-12-11 16:10:53 +01001947 /* splits the command in words */
1948 while (i < MAX_STATS_ARGS && p < end) {
1949 int j, k;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001950
William Lallemandbddd33a2018-12-11 16:10:53 +01001951 /* skip leading spaces/tabs */
1952 p += strspn(p, " \t");
1953 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02001954 break;
1955
William Lallemandbddd33a2018-12-11 16:10:53 +01001956 args[i] = p;
1957 p += strcspn(p, " \t");
1958 *p++ = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001959
William Lallemandbddd33a2018-12-11 16:10:53 +01001960 /* unescape backslashes (\) */
1961 for (j = 0, k = 0; args[i][k]; k++) {
1962 if (args[i][k] == '\\') {
1963 if (args[i][k + 1] == '\\')
1964 k++;
1965 else
1966 continue;
1967 }
1968 args[i][j] = args[i][k];
1969 j++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001970 }
William Lallemandbddd33a2018-12-11 16:10:53 +01001971 args[i][j] = 0;
1972 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001973 }
1974
William Lallemandbddd33a2018-12-11 16:10:53 +01001975 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001976
William Lallemandbddd33a2018-12-11 16:10:53 +01001977 for (; i < MAX_STATS_ARGS + 1; i++)
1978 args[i] = NULL;
1979
1980 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
1981
1982 /* End of words are ending by \0, we need to replace the \0s by spaces
19831 before forwarding them */
1984 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01001985 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01001986 if (*p == '\0')
1987 *p = ' ';
1988 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02001989 }
1990
William Lallemand3301f3e2018-12-13 09:05:48 +01001991 payload = strstr(str, PAYLOAD_PATTERN);
1992 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
1993 /* if the payload pattern is at the end */
1994 s->pcli_flags |= PCLI_F_PAYLOAD;
1995 ret = reql;
1996 }
1997
William Lallemandbddd33a2018-12-11 16:10:53 +01001998 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02001999
William Lallemandbddd33a2018-12-11 16:10:53 +01002000 if (wtrim > 0) {
2001 trim = &args[wtrim][0];
2002 if (trim == NULL) /* if this was the last word in the table */
2003 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002004
William Lallemandbddd33a2018-12-11 16:10:53 +01002005 b_del(&req->buf, trim - str);
2006
William Lallemandb7ea1412018-12-13 09:05:47 +01002007 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002008 } else if (wtrim < 0) {
2009 /* parsing error */
2010 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002011 } else {
2012 /* the whole string */
2013 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002014 }
2015
William Lallemandb7ea1412018-12-13 09:05:47 +01002016 if (ret > 1) {
2017 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2018 goto end;
2019 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
2020 ci_insert_line2(req, 0, "operator", strlen("operator"));
2021 ret += strlen("operator") + 2;
2022 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
2023 ci_insert_line2(req, 0, "user", strlen("user"));
2024 ret += strlen("user") + 2;
2025 }
2026 }
2027end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002028
William Lallemandb7ea1412018-12-13 09:05:47 +01002029 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002030}
2031
2032int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2033{
William Lallemandbddd33a2018-12-11 16:10:53 +01002034 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002035 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002036 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002037
William Lallemandb7ea1412018-12-13 09:05:47 +01002038 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2039 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2040
William Lallemandcf62f7e2018-10-26 14:47:40 +02002041read_again:
2042 /* if the channel is closed for read, we won't receive any more data
2043 from the client, but we don't want to forward this close to the
2044 server */
2045 channel_dont_close(req);
2046
2047 /* We don't know yet to which server we will connect */
2048 channel_dont_connect(req);
2049
2050
2051 /* we are not waiting for a response, there is no more request and we
2052 * receive a close from the client, we can leave */
2053 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2054 channel_shutw_now(&s->res);
2055 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2056 return 1;
2057 }
2058
2059 req->flags |= CF_READ_DONTWAIT;
2060
2061 /* need more data */
2062 if (!ci_data(req))
2063 return 0;
2064
2065 /* If there is data available for analysis, log the end of the idle time. */
2066 if (c_data(req) && s->logs.t_idle == -1)
2067 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2068
William Lallemandbddd33a2018-12-11 16:10:53 +01002069 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002070 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002071 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002072 /* enough data */
2073
William Lallemandcf62f7e2018-10-26 14:47:40 +02002074 /* forward only 1 command */
2075 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002076
William Lallemanddc12c2e2018-12-13 09:05:46 +01002077 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002078 /* we send only 1 command per request, and we write close after it */
2079 channel_shutw_now(req);
2080 } else {
2081 pcli_write_prompt(s);
2082 }
2083
2084 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002085
2086 /* remove the XFER_DATA analysers, which forwards all
2087 * the data, we don't want to forward the next requests
2088 * We need to add CF_FLT_ANALYZE to abort the forward too.
2089 */
2090 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2091 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2092 s->res.analysers |= AN_RES_WAIT_CLI;
2093
William Lallemandebf61802018-12-11 16:10:57 +01002094 if (!(s->flags & SF_ASSIGNED)) {
2095 if (next_pid > -1)
2096 target_pid = next_pid;
2097 else
2098 target_pid = s->pcli_next_pid;
2099 /* we can connect now */
2100 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002101
William Lallemandebf61802018-12-11 16:10:57 +01002102 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2103 channel_auto_connect(req);
2104 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002105
2106 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002107 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002108 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002109 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002110 } else if (to_forward == -1 && errmsg) {
2111 /* there was an error during the parsing */
2112 pcli_reply_and_close(s, errmsg);
2113 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002114 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2115 /* buffer is full and we didn't catch the end of a command */
2116 goto send_help;
2117 }
2118
2119 return 0;
2120
2121send_help:
2122 b_reset(&req->buf);
2123 b_putblk(&req->buf, "help\n", 5);
2124 goto read_again;
2125}
2126
2127int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2128{
2129 struct proxy *fe = strm_fe(s);
2130 struct proxy *be = s->be;
2131
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002132 if (rep->flags & CF_READ_ERROR) {
2133 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2134 s->res.analysers &= ~AN_RES_WAIT_CLI;
2135 return 0;
2136 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002137 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2138 rep->flags |= CF_NEVER_WAIT;
2139
2140 /* don't forward the close */
2141 channel_dont_close(&s->res);
2142 channel_dont_close(&s->req);
2143
William Lallemanddc12c2e2018-12-13 09:05:46 +01002144 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002145 s->req.analysers |= AN_REQ_WAIT_CLI;
2146 s->res.analysers &= ~AN_RES_WAIT_CLI;
2147 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2148 return 0;
2149 }
2150
William Lallemandcf62f7e2018-10-26 14:47:40 +02002151 /* forward the data */
2152 if (ci_data(rep)) {
2153 c_adv(rep, ci_data(rep));
2154 return 0;
2155 }
2156
2157 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2158 /* stream cleanup */
2159
William Lallemand2f4ce202018-10-26 14:47:47 +02002160 pcli_write_prompt(s);
2161
William Lallemandcf62f7e2018-10-26 14:47:40 +02002162 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2163 si_shutr(&s->si[1]);
2164 si_shutw(&s->si[1]);
2165
2166 /*
2167 * starting from there this the same code as
2168 * http_end_txn_clean_session().
2169 *
2170 * It allows to do frontend keepalive while reconnecting to a
2171 * new server for each request.
2172 */
2173
2174 if (s->flags & SF_BE_ASSIGNED) {
2175 HA_ATOMIC_SUB(&be->beconn, 1);
2176 if (unlikely(s->srv_conn))
2177 sess_change_server(s, NULL);
2178 }
2179
2180 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2181 stream_process_counters(s);
2182
2183 /* don't count other requests' data */
2184 s->logs.bytes_in -= ci_data(&s->req);
2185 s->logs.bytes_out -= ci_data(&s->res);
2186
2187 /* we may need to know the position in the queue */
2188 pendconn_free(s);
2189
2190 /* let's do a final log if we need it */
2191 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2192 !(s->flags & SF_MONITOR) &&
2193 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2194 s->do_log(s);
2195 }
2196
2197 /* stop tracking content-based counters */
2198 stream_stop_content_counters(s);
2199 stream_update_time_stats(s);
2200
2201 s->logs.accept_date = date; /* user-visible date for logging */
2202 s->logs.tv_accept = now; /* corrected date for internal use */
2203 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2204 s->logs.t_idle = -1;
2205 tv_zero(&s->logs.tv_request);
2206 s->logs.t_queue = -1;
2207 s->logs.t_connect = -1;
2208 s->logs.t_data = -1;
2209 s->logs.t_close = 0;
2210 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2211 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2212
2213 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2214 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2215
2216 stream_del_srv_conn(s);
2217 if (objt_server(s->target)) {
2218 if (s->flags & SF_CURR_SESS) {
2219 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002220 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002221 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002222 if (may_dequeue_tasks(__objt_server(s->target), be))
2223 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002224 }
2225
2226 s->target = NULL;
2227
2228 /* only release our endpoint if we don't intend to reuse the
2229 * connection.
2230 */
2231 if (!si_conn_ready(&s->si[1])) {
2232 si_release_endpoint(&s->si[1]);
2233 s->srv_conn = NULL;
2234 }
2235
2236 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2237 s->si[1].err_type = SI_ET_NONE;
2238 s->si[1].conn_retries = 0; /* used for logging too */
2239 s->si[1].exp = TICK_ETERNITY;
2240 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2241 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);
2242 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);
2243 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2244 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2245 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2246 /* reinitialise the current rule list pointer to NULL. We are sure that
2247 * any rulelist match the NULL pointer.
2248 */
2249 s->current_rule_list = NULL;
2250
2251 s->be = strm_fe(s);
2252 s->logs.logwait = strm_fe(s)->to_log;
2253 s->logs.level = 0;
2254 stream_del_srv_conn(s);
2255 s->target = NULL;
2256 /* re-init store persistence */
2257 s->store_count = 0;
2258 s->uniq_id = global.req_count++;
2259
2260 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2261
2262 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2263
2264 s->req.analysers |= AN_REQ_WAIT_CLI;
2265 s->res.analysers &= ~AN_RES_WAIT_CLI;
2266
2267 /* We must trim any excess data from the response buffer, because we
2268 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002269 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002270 * we want those data to come along with next response. A typical
2271 * example of such data would be from a buggy server responding to
2272 * a HEAD with some data, or sending more than the advertised
2273 * content-length.
2274 */
2275 if (unlikely(ci_data(&s->res)))
2276 b_set_data(&s->res.buf, co_data(&s->res));
2277
2278 /* Now we can realign the response buffer */
2279 c_realign_if_empty(&s->res);
2280
2281 s->req.rto = strm_fe(s)->timeout.client;
2282 s->req.wto = TICK_ETERNITY;
2283
2284 s->res.rto = TICK_ETERNITY;
2285 s->res.wto = strm_fe(s)->timeout.client;
2286
2287 s->req.rex = TICK_ETERNITY;
2288 s->req.wex = TICK_ETERNITY;
2289 s->req.analyse_exp = TICK_ETERNITY;
2290 s->res.rex = TICK_ETERNITY;
2291 s->res.wex = TICK_ETERNITY;
2292 s->res.analyse_exp = TICK_ETERNITY;
2293 s->si[1].hcto = TICK_ETERNITY;
2294
2295 /* we're removing the analysers, we MUST re-enable events detection.
2296 * We don't enable close on the response channel since it's either
2297 * already closed, or in keep-alive with an idle connection handler.
2298 */
2299 channel_auto_read(&s->req);
2300 channel_auto_close(&s->req);
2301 channel_auto_read(&s->res);
2302
2303
2304 return 1;
2305 }
2306 return 0;
2307}
2308
William Lallemand8a022572018-10-26 14:47:35 +02002309/*
2310 * The mworker functions are used to initialize the CLI in the master process
2311 */
2312
William Lallemand309dc9a2018-10-26 14:47:45 +02002313 /*
2314 * Stop the mworker proxy
2315 */
2316void mworker_cli_proxy_stop()
2317{
William Lallemand550db6d2018-11-06 17:37:12 +01002318 if (mworker_proxy)
2319 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002320}
2321
William Lallemand8a022572018-10-26 14:47:35 +02002322/*
2323 * Create the mworker CLI proxy
2324 */
2325int mworker_cli_proxy_create()
2326{
2327 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002328 char *msg = NULL;
2329 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002330
2331 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2332 if (!mworker_proxy)
2333 return -1;
2334
2335 init_new_proxy(mworker_proxy);
2336 mworker_proxy->next = proxies_list;
2337 proxies_list = mworker_proxy;
2338 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002339 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002340 mworker_proxy->state = PR_STNEW;
2341 mworker_proxy->last_change = now.tv_sec;
2342 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2343 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2344 mworker_proxy->timeout.client = 0; /* no timeout */
2345 mworker_proxy->conf.file = strdup("MASTER");
2346 mworker_proxy->conf.line = 0;
2347 mworker_proxy->accept = frontend_accept;
2348 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2349
2350 /* Does not init the default target the CLI applet, but must be done in
2351 * the request parsing code */
2352 mworker_proxy->default_target = NULL;
2353
2354 /* the check_config_validity() will get an ID for the proxy */
2355 mworker_proxy->uuid = -1;
2356
2357 proxy_store_name(mworker_proxy);
2358
2359 /* create all servers using the mworker_proc list */
2360 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002361 struct server *newsrv = NULL;
2362 struct sockaddr_storage *sk;
2363 int port1, port2, port;
2364 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002365
2366 newsrv = new_server(mworker_proxy);
2367 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002368 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002369
2370 /* we don't know the new pid yet */
2371 if (child->pid == -1)
2372 memprintf(&msg, "cur-%d", child->relative_pid);
2373 else
2374 memprintf(&msg, "old-%d", child->pid);
2375
2376 newsrv->next = mworker_proxy->srv;
2377 mworker_proxy->srv = newsrv;
2378 newsrv->conf.file = strdup(msg);
2379 newsrv->id = strdup(msg);
2380 newsrv->conf.line = 0;
2381
2382 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002383 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002384 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002385 }
2386 free(msg);
2387 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002388
2389 proto = protocol_by_family(sk->ss_family);
2390 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002391 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002392 }
2393
2394 /* no port specified */
2395 newsrv->flags |= SRV_F_MAPPORTS;
2396 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002397 /* don't let the server participate to load balancing */
2398 newsrv->iweight = 0;
2399 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002400 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002401
2402 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002403 }
2404 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002405
2406error:
2407 ha_alert("%s\n", errmsg);
2408
2409 list_for_each_entry(child, &proc_list, list) {
2410 free((char *)child->srv->conf.file); /* cast because of const char * */
2411 free(child->srv->id);
2412 free(child->srv);
2413 child->srv = NULL;
2414 }
2415 free(mworker_proxy->id);
2416 free(mworker_proxy->conf.file);
2417 free(mworker_proxy);
2418 mworker_proxy = NULL;
2419 free(errmsg);
2420 free(msg);
2421
2422 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002423}
Olivier Houchardf886e342017-04-05 22:24:59 +02002424
William Lallemandce83b4a2018-10-26 14:47:30 +02002425/*
William Lallemande7361152018-10-26 14:47:36 +02002426 * Create a new listener for the master CLI proxy
2427 */
2428int mworker_cli_proxy_new_listener(char *line)
2429{
2430 struct bind_conf *bind_conf;
2431 struct listener *l;
2432 char *err = NULL;
2433 char *args[MAX_LINE_ARGS + 1];
2434 int arg;
2435 int cur_arg;
2436
2437 arg = 0;
2438 args[0] = line;
2439
2440 /* args is a bind configuration with spaces replaced by commas */
2441 while (*line && arg < MAX_LINE_ARGS) {
2442
2443 if (*line == ',') {
2444 *line++ = '\0';
2445 while (*line == ',')
2446 line++;
2447 args[++arg] = line;
2448 }
2449 line++;
2450 }
2451
2452 args[++arg] = "\0";
2453
2454 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002455 if (!bind_conf)
2456 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002457
2458 bind_conf->level &= ~ACCESS_LVL_MASK;
2459 bind_conf->level |= ACCESS_LVL_ADMIN;
2460
2461 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2462 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002463 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002464 }
2465
2466 cur_arg = 1;
2467
2468 while (*args[cur_arg]) {
2469 static int bind_dumped;
2470 struct bind_kw *kw;
2471
2472 kw = bind_find_kw(args[cur_arg]);
2473 if (kw) {
2474 if (!kw->parse) {
2475 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2476 args[0], args[1], args[cur_arg]);
2477 goto err;
2478 }
2479
2480 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2481 if (err)
2482 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2483 else
2484 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2485 args[0], args[1], args[cur_arg]);
2486 goto err;
2487 }
2488
2489 cur_arg += 1 + kw->skip;
2490 continue;
2491 }
2492
2493 if (!bind_dumped) {
2494 bind_dump_kws(&err);
2495 indent_msg(&err, 4);
2496 bind_dumped = 1;
2497 }
2498
2499 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2500 args[0], args[1], args[cur_arg],
2501 err ? " Registered keywords :" : "", err ? err : "");
2502 goto err;
2503 }
2504
2505
2506 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002507 l->accept = session_accept_fd;
2508 l->default_target = mworker_proxy->default_target;
2509 /* don't make the peers subject to global limits and don't close it in the master */
2510 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2511 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002512 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002513 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002514 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002515
2516 return 0;
2517
2518err:
2519 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002520 free(err);
2521 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002522 return -1;
2523
2524}
2525
2526/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002527 * Create a new CLI socket using a socketpair for a worker process
2528 * <mworker_proc> is the process structure, and <proc> is the process number
2529 */
2530int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2531{
2532 struct bind_conf *bind_conf;
2533 struct listener *l;
2534 char *path = NULL;
2535 char *err = NULL;
2536
2537 /* master pipe to ensure the master is still alive */
2538 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2539 ha_alert("Cannot create worker socketpair.\n");
2540 return -1;
2541 }
2542
2543 /* XXX: we might want to use a separate frontend at some point */
2544 if (!global.stats_fe) {
2545 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2546 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002547 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002548 }
2549 }
2550
2551 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002552 if (!bind_conf)
2553 goto error;
2554
William Lallemandce83b4a2018-10-26 14:47:30 +02002555 bind_conf->level &= ~ACCESS_LVL_MASK;
2556 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2557
2558 bind_conf->bind_proc = 1UL << proc;
2559 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2560
2561 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2562 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002563 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002564 }
2565
2566 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002567 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002568 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002569 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002570 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002571 free(path);
2572 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002573
2574 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002575 l->accept = session_accept_fd;
2576 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002577 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002578 /* it's a sockpair but we don't want to keep the fd in the master */
2579 l->options &= ~LI_O_INHERITED;
2580 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002581 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002582 }
2583
2584 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002585
2586error:
2587 close(mworker_proc->ipc_fd[0]);
2588 close(mworker_proc->ipc_fd[1]);
2589 free(err);
2590
2591 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002592}
2593
William Lallemand74c24fb2016-11-21 17:18:36 +01002594static struct applet cli_applet = {
2595 .obj_type = OBJ_TYPE_APPLET,
2596 .name = "<CLI>", /* used for logging */
2597 .fct = cli_io_handler,
2598 .release = cli_release_handler,
2599};
2600
Willy Tarreau0a739292016-11-22 20:21:23 +01002601/* register cli keywords */
2602static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002603 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2604 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2605 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002606 { { "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 +01002607 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002608 { { "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 +01002609 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002610 { { "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 +02002611 { { "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 +01002612 { { "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 +02002613 { { "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 +01002614 { { "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 +01002615 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2616 { { "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 +02002617 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002618 {{},}
2619}};
2620
Willy Tarreau0108d902018-11-25 19:14:37 +01002621INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2622
William Lallemand74c24fb2016-11-21 17:18:36 +01002623static struct cfg_kw_list cfg_kws = {ILH, {
2624 { CFG_GLOBAL, "stats", stats_parse_global },
2625 { 0, NULL, NULL },
2626}};
2627
Willy Tarreau0108d902018-11-25 19:14:37 +01002628INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2629
William Lallemand74c24fb2016-11-21 17:18:36 +01002630static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002631 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2632 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002633 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002634 { NULL, NULL, 0 },
2635}};
2636
Willy Tarreau0108d902018-11-25 19:14:37 +01002637INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002638
2639/*
2640 * Local variables:
2641 * c-indent-level: 8
2642 * c-basic-offset: 8
2643 * End:
2644 */