blob: 4ae2cfdf04aa086ba728efb5a7a66d70d3f2a652 [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>
Willy Tarreauc125cef2019-05-10 09:58:43 +020069#include <proto/ssl_sock.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010070#include <proto/stream_interface.h>
71#include <proto/task.h>
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +020072#include <proto/proto_udp.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010073
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020074#define PAYLOAD_PATTERN "<<"
75
William Lallemand74c24fb2016-11-21 17:18:36 +010076static struct applet cli_applet;
77
78static const char stats_sock_usage_msg[] =
79 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010080 " help : this message\n"
81 " prompt : toggle interactive mode with prompt\n"
82 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010083 "";
84
85static const char stats_permission_denied_msg[] =
86 "Permission denied\n"
87 "";
88
89
Christopher Faulet1bc04c72017-10-29 20:14:08 +010090static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010091
92/* List head of cli keywords */
93static struct cli_kw_list cli_keywords = {
94 .list = LIST_HEAD_INIT(cli_keywords.list)
95};
96
97extern const char *stat_status_codes[];
98
William Lallemand8a022572018-10-26 14:47:35 +020099static struct proxy *mworker_proxy; /* CLI proxy of the master */
100
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200101static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100102{
103 struct cli_kw_list *kw_list;
104 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200105 struct buffer *tmp = get_trash_chunk();
106 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +0100107
108 free(dynamic_usage_msg);
109 dynamic_usage_msg = NULL;
110
111 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200112 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100113
114 chunk_reset(tmp);
115 chunk_strcat(tmp, stats_sock_usage_msg);
116 list_for_each_entry(kw_list, &cli_keywords.list, list) {
117 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200118 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200119
120 /* in a worker or normal process, don't display master only commands */
121 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
122 goto next_kw;
123
124 /* in master don't displays if we don't have the master bits */
125 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
126 goto next_kw;
127
William Lallemand0154edc2018-05-15 11:50:04 +0200128 if (kw->usage)
129 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200130
131next_kw:
132
William Lallemand74c24fb2016-11-21 17:18:36 +0100133 kw++;
134 }
135 }
136 chunk_init(&out, NULL, 0);
137 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200138 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200139
140end:
141 if (dynamic_usage_msg) {
142 appctx->ctx.cli.severity = LOG_INFO;
143 appctx->ctx.cli.msg = dynamic_usage_msg;
144 }
145 else {
146 appctx->ctx.cli.severity = LOG_INFO;
147 appctx->ctx.cli.msg = stats_sock_usage_msg;
148 }
149 appctx->st0 = CLI_ST_PRINT;
150
William Lallemand74c24fb2016-11-21 17:18:36 +0100151 return dynamic_usage_msg;
152}
153
154struct cli_kw* cli_find_kw(char **args)
155{
156 struct cli_kw_list *kw_list;
157 struct cli_kw *kw;/* current cli_kw */
158 char **tmp_args;
159 const char **tmp_str_kw;
160 int found = 0;
161
162 if (LIST_ISEMPTY(&cli_keywords.list))
163 return NULL;
164
165 list_for_each_entry(kw_list, &cli_keywords.list, list) {
166 kw = &kw_list->kw[0];
167 while (*kw->str_kw) {
168 tmp_args = args;
169 tmp_str_kw = kw->str_kw;
170 while (*tmp_str_kw) {
171 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
172 found = 1;
173 } else {
174 found = 0;
175 break;
176 }
177 tmp_args++;
178 tmp_str_kw++;
179 }
180 if (found)
181 return (kw);
182 kw++;
183 }
184 }
185 return NULL;
186}
187
Thierry Fournier5622e162020-11-28 20:10:08 +0100188struct cli_kw* cli_find_kw_exact(char **args)
189{
190 struct cli_kw_list *kw_list;
191 int found = 0;
192 int i;
193 int j;
194
195 if (LIST_ISEMPTY(&cli_keywords.list))
196 return NULL;
197
198 list_for_each_entry(kw_list, &cli_keywords.list, list) {
199 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
200 found = 1;
201 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
202 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
203 break;
204 }
205 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
206 found = 0;
207 break;
208 }
209 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
210 found = 0;
211 break;
212 }
213 }
214 if (found)
215 return &kw_list->kw[i];
216 }
217 }
218 return NULL;
219}
220
William Lallemand74c24fb2016-11-21 17:18:36 +0100221void cli_register_kw(struct cli_kw_list *kw_list)
222{
223 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
224}
225
226
227/* allocate a new stats frontend named <name>, and return it
228 * (or NULL in case of lack of memory).
229 */
230static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
231{
232 struct proxy *fe;
233
234 fe = calloc(1, sizeof(*fe));
235 if (!fe)
236 return NULL;
237
238 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100239 fe->next = proxies_list;
240 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100241 fe->last_change = now.tv_sec;
242 fe->id = strdup("GLOBAL");
243 fe->cap = PR_CAP_FE;
244 fe->maxconn = 10; /* default to 10 concurrent connections */
245 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
246 fe->conf.file = strdup(file);
247 fe->conf.line = line;
248 fe->accept = frontend_accept;
249 fe->default_target = &cli_applet.obj_type;
250
251 /* the stats frontend is the only one able to assign ID #0 */
252 fe->conf.id.key = fe->uuid = 0;
253 eb32_insert(&used_proxy_id, &fe->conf.id);
254 return fe;
255}
256
257/* This function parses a "stats" statement in the "global" section. It returns
258 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
259 * error message into the <err> buffer which will be preallocated. The trailing
260 * '\n' must not be written. The function must be called with <args> pointing to
261 * the first word after "stats".
262 */
263static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
264 struct proxy *defpx, const char *file, int line,
265 char **err)
266{
267 struct bind_conf *bind_conf;
268 struct listener *l;
269
270 if (!strcmp(args[1], "socket")) {
271 int cur_arg;
272
273 if (*args[2] == 0) {
274 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
275 return -1;
276 }
277
278 if (!global.stats_fe) {
279 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
280 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
281 return -1;
282 }
283 }
284
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100285 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200286 bind_conf->level &= ~ACCESS_LVL_MASK;
287 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100288
289 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
290 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
291 file, line, args[0], args[1], err && *err ? *err : "error");
292 return -1;
293 }
294
295 cur_arg = 3;
296 while (*args[cur_arg]) {
297 static int bind_dumped;
298 struct bind_kw *kw;
299
300 kw = bind_find_kw(args[cur_arg]);
301 if (kw) {
302 if (!kw->parse) {
303 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
304 args[0], args[1], args[cur_arg]);
305 return -1;
306 }
307
308 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
309 if (err && *err)
310 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
311 else
312 memprintf(err, "'%s %s' : error encountered while processing '%s'",
313 args[0], args[1], args[cur_arg]);
314 return -1;
315 }
316
317 cur_arg += 1 + kw->skip;
318 continue;
319 }
320
321 if (!bind_dumped) {
322 bind_dump_kws(err);
323 indent_msg(err, 4);
324 bind_dumped = 1;
325 }
326
327 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
328 args[0], args[1], args[cur_arg],
329 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
330 return -1;
331 }
332
333 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100334 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100335 l->default_target = global.stats_fe->default_target;
336 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
337 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100338 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100339 }
340 }
341 else if (!strcmp(args[1], "timeout")) {
342 unsigned timeout;
343 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
344
Willy Tarreau9faebe32019-06-07 19:00:37 +0200345 if (res == PARSE_TIME_OVER) {
346 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
347 args[2], args[0], args[1]);
348 return -1;
349 }
350 else if (res == PARSE_TIME_UNDER) {
351 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
352 args[2], args[0], args[1]);
353 return -1;
354 }
355 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100356 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
357 return -1;
358 }
359
360 if (!timeout) {
361 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
362 return -1;
363 }
364 if (!global.stats_fe) {
365 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
366 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
367 return -1;
368 }
369 }
370 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
371 }
372 else if (!strcmp(args[1], "maxconn")) {
373 int maxconn = atol(args[2]);
374
375 if (maxconn <= 0) {
376 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
377 return -1;
378 }
379
380 if (!global.stats_fe) {
381 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
382 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
383 return -1;
384 }
385 }
386 global.stats_fe->maxconn = maxconn;
387 }
388 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
389 int cur_arg = 2;
390 unsigned long set = 0;
391
392 if (!global.stats_fe) {
393 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
394 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
395 return -1;
396 }
397 }
398
399 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100400 if (strcmp(args[cur_arg], "all") == 0) {
401 set = 0;
402 break;
403 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100404 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100405 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100406 return -1;
407 }
408 cur_arg++;
409 }
410 global.stats_fe->bind_proc = set;
411 }
412 else {
413 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
414 return -1;
415 }
416 return 0;
417}
418
William Lallemand33d29e22019-04-01 11:30:06 +0200419/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200420 * This function exports the bound addresses of a <frontend> in the environment
421 * variable <varname>. Those addresses are separated by semicolons and prefixed
422 * with their type (abns@, unix@, sockpair@ etc)
423 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200424 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200425int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200426{
427 struct buffer *trash = get_trash_chunk();
428 struct bind_conf *bind_conf;
429
William Lallemand9a37fd02019-04-12 16:09:24 +0200430 if (frontend) {
431 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200432 struct listener *l;
433
434 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
435 char addr[46];
436 char port[6];
437
William Lallemand620072b2019-04-12 16:09:25 +0200438 /* separate listener by semicolons */
439 if (trash->data)
440 chunk_appendf(trash, ";");
441
William Lallemand33d29e22019-04-01 11:30:06 +0200442 if (l->addr.ss_family == AF_UNIX) {
443 const struct sockaddr_un *un;
444
445 un = (struct sockaddr_un *)&l->addr;
446 if (un->sun_path[0] == '\0') {
447 chunk_appendf(trash, "abns@%s", un->sun_path+1);
448 } else {
449 chunk_appendf(trash, "unix@%s", un->sun_path);
450 }
451 } else if (l->addr.ss_family == AF_INET) {
452 addr_to_str(&l->addr, addr, sizeof(addr));
453 port_to_str(&l->addr, port, sizeof(port));
454 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
455 } else if (l->addr.ss_family == AF_INET6) {
456 addr_to_str(&l->addr, addr, sizeof(addr));
457 port_to_str(&l->addr, port, sizeof(port));
458 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
459 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
460 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
461 }
William Lallemand33d29e22019-04-01 11:30:06 +0200462 }
463 }
464 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200465 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200466 return -1;
467 }
468
469 return 0;
470}
471
William Lallemand9a37fd02019-04-12 16:09:24 +0200472int cli_socket_setenv()
473{
474 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
475 return -1;
476 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
477 return -1;
478
479 return 0;
480}
481
William Lallemand33d29e22019-04-01 11:30:06 +0200482REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
483
Willy Tarreaude57a572016-11-23 17:01:39 +0100484/* Verifies that the CLI at least has a level at least as high as <level>
485 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
486 * failure, an error message is prepared and the appctx's state is adjusted
487 * to print it so that a return 1 is enough to abort any processing.
488 */
489int cli_has_level(struct appctx *appctx, int level)
490{
Willy Tarreaude57a572016-11-23 17:01:39 +0100491
William Lallemandf630d012018-12-13 09:05:44 +0100492 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200493 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreaude57a572016-11-23 17:01:39 +0100494 appctx->ctx.cli.msg = stats_permission_denied_msg;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100495 appctx->st0 = CLI_ST_PRINT;
Willy Tarreaude57a572016-11-23 17:01:39 +0100496 return 0;
497 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100498 return 1;
499}
500
William Lallemandb7ea1412018-12-13 09:05:47 +0100501/* same as cli_has_level but for the CLI proxy and without error message */
502int pcli_has_level(struct stream *s, int level)
503{
504 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
505 return 0;
506 }
507 return 1;
508}
509
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200510/* Returns severity_output for the current session if set, or default for the socket */
511static int cli_get_severity_output(struct appctx *appctx)
512{
513 if (appctx->cli_severity_output)
514 return appctx->cli_severity_output;
515 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
516}
William Lallemand74c24fb2016-11-21 17:18:36 +0100517
Willy Tarreau41908562016-11-24 16:23:38 +0100518/* Processes the CLI interpreter on the stats socket. This function is called
519 * from the CLI's IO handler running in an appctx context. The function returns 1
520 * if the request was understood, otherwise zero. It is called with appctx->st0
521 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
522 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
523 * have its own I/O handler called again. Most of the time, parsers will only
524 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100525 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
526 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100527 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200528static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100529{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200530 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
531 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100532 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100533
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200534 appctx->st2 = 0;
535 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100536
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200537 p = appctx->chunk->area;
538 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100539
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200540 /*
541 * Get the payload start if there is one.
542 * For the sake of simplicity, the payload pattern is looked up
543 * everywhere from the start of the input but it can only be found
544 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
545 *
546 * The input string was zero terminated so it is safe to use
547 * the str*() functions throughout the parsing
548 */
549 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
550 payload = strstr(p, PAYLOAD_PATTERN);
551 end = payload;
552 /* skip the pattern */
553 payload += strlen(PAYLOAD_PATTERN);
554 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100555
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200556 /*
557 * Get pointers on words.
558 * One extra slot is reserved to store a pointer on a null byte.
559 */
560 while (i < MAX_STATS_ARGS && p < end) {
561 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100562
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200563 /* skip leading spaces/tabs */
564 p += strspn(p, " \t");
565 if (!*p)
566 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100567
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200568 args[i] = p;
Yves Lafon7ed43aa2020-06-08 16:08:06 +0200569 while (1) {
570 p += strcspn(p, " \t\\");
571 /* escaped chars using backlashes (\) */
572 if (*p == '\\') {
573 if (!*++p)
574 break;
575 if (!*++p)
576 break;
577 } else {
578 break;
579 }
580 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200581 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100582
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200583 /* unescape backslashes (\) */
584 for (j = 0, k = 0; args[i][k]; k++) {
585 if (args[i][k] == '\\') {
586 if (args[i][k + 1] == '\\')
587 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100588 else
589 continue;
590 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200591 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100592 j++;
593 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200594 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100595
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200596 i++;
597 }
598 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200599 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200600 for (; i < MAX_STATS_ARGS + 1; i++)
601 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100602
603 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100604 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100605 return 0;
606
William Lallemand14721be2018-10-26 14:47:37 +0200607 /* in a worker or normal process, don't display master only commands */
608 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
609 return 0;
610
611 /* in master don't displays if we don't have the master bits */
612 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
613 return 0;
614
Willy Tarreau41908562016-11-24 16:23:38 +0100615 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200616 appctx->io_release = kw->io_release;
William Lallemandd4f20fa2019-10-25 21:10:14 +0200617
618 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
619 goto fail;
620
621 /* kw->parse could set its own io_handler or io_release handler */
622 if (!appctx->io_handler)
623 goto fail;
624
625 appctx->st0 = CLI_ST_CALLBACK;
626 return 1;
627fail:
628 appctx->io_handler = NULL;
629 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100630 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100631}
632
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200633/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
634static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
635{
Willy Tarreau83061a82018-07-13 11:56:34 +0200636 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200637
638 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200639 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200640
641 tmp = get_trash_chunk();
642 chunk_reset(tmp);
643
644 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100645 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200646 chunk_printf(tmp, "[%d]: ", severity);
647 }
648 else {
649 switch (severity_output) {
650 case CLI_SEVERITY_NUMBER:
651 chunk_printf(tmp, "[%d]: ", severity);
652 break;
653 case CLI_SEVERITY_STRING:
654 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
655 break;
656 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100657 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200658 }
659 }
660 chunk_appendf(tmp, "%s", msg);
661
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200662 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200663}
664
William Lallemand74c24fb2016-11-21 17:18:36 +0100665/* This I/O handler runs as an applet embedded in a stream interface. It is
666 * used to processes I/O from/to the stats unix socket. The system relies on a
667 * state machine handling requests and various responses. We read a request,
668 * then we process it and send the response, and we possibly display a prompt.
669 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100670 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100671 * or not.
672 */
673static void cli_io_handler(struct appctx *appctx)
674{
675 struct stream_interface *si = appctx->owner;
676 struct channel *req = si_oc(si);
677 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200678 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100679 int reql;
680 int len;
681
682 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
683 goto out;
684
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800685 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200686 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100687 /* buf.size==0 means we failed to get a buffer and were
688 * already subscribed to a wait list to get a buffer.
689 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100690 goto out;
691 }
692
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100694 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100695 /* Stats output not initialized yet */
696 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200697 /* reset severity to default at init */
698 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100699 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100700 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100701 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100702 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100703 /* Let's close for real now. We just close the request
704 * side, the conditions below will complete if needed.
705 */
706 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200707 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100708 break;
709 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100710 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200711 char *str;
712
713 /* use a trash chunk to store received data */
714 if (!appctx->chunk) {
715 appctx->chunk = alloc_trash_chunk();
716 if (!appctx->chunk) {
717 appctx->st0 = CLI_ST_END;
718 continue;
719 }
720 }
721
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200722 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200723
William Lallemand74c24fb2016-11-21 17:18:36 +0100724 /* ensure we have some output room left in the event we
725 * would want to return some info right after parsing.
726 */
727 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100728 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100729 break;
730 }
731
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200732 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200733 reql = co_getline(si_oc(si), str,
734 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100735 if (reql <= 0) { /* closed or EOL not found */
736 if (reql == 0)
737 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100738 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100739 continue;
740 }
741
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
743 /* seek for a possible unescaped semi-colon. If we find
744 * one, we replace it with an LF and skip only this part.
745 */
746 for (len = 0; len < reql; len++) {
747 if (str[len] == '\\') {
748 len++;
749 continue;
750 }
751 if (str[len] == ';') {
752 str[len] = '\n';
753 reql = len + 1;
754 break;
755 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100756 }
757 }
758
759 /* now it is time to check that we have a full line,
760 * remove the trailing \n and possibly \r, then cut the
761 * line.
762 */
763 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200764 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100765 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100766 continue;
767 }
768
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200769 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100770 len--;
771
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200772 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200773 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200774
775 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200776 appctx->chunk->area[appctx->chunk->data] = '\n';
777 appctx->chunk->area[appctx->chunk->data + 1] = 0;
778 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200779 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100780
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100781 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200782
783 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
784 /* empty line */
785 if (!len) {
786 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200787 appctx->chunk->data -= 2;
788 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200789
790 if (!cli_parse_request(appctx))
791 cli_gen_usage_msg(appctx);
792
793 chunk_reset(appctx->chunk);
794 /* NB: cli_sock_parse_request() may have put
795 * another CLI_ST_O_* into appctx->st0.
796 */
797
798 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100799 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100800 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200801 else {
802 /*
803 * Look for the "payload start" pattern at the end of a line
804 * Its location is not remembered here, this is just to switch
805 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100806 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200807 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200808 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200809 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200810 /* no payload, the command is complete: parse the request */
811 if (!cli_parse_request(appctx))
812 cli_gen_usage_msg(appctx);
813
814 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200815 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100816 }
817
818 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200819 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100820 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
821 }
822 else { /* output functions */
823 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100824 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100825 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100826 case CLI_ST_PRINT:
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200827 if (cli_output_msg(res, appctx->ctx.cli.msg, appctx->ctx.cli.severity,
828 cli_get_severity_output(appctx)) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100829 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100830 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100831 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100832 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200833 case CLI_ST_PRINT_FREE: {
834 const char *msg = appctx->ctx.cli.err;
835
836 if (!msg)
837 msg = "Out of memory.\n";
838
839 if (cli_output_msg(res, msg, LOG_ERR, cli_get_severity_output(appctx)) != -1) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100840 free(appctx->ctx.cli.err);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100841 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100842 }
843 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100844 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100845 break;
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200846 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100847 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100848 if (appctx->io_handler)
849 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100850 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100851 if (appctx->io_release) {
852 appctx->io_release(appctx);
853 appctx->io_release = NULL;
854 }
855 }
856 break;
857 default: /* abnormal state */
858 si->flags |= SI_FL_ERR;
859 break;
860 }
861
862 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100863 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200864 const char *prompt = "";
865
866 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
867 /*
868 * when entering a payload with interactive mode, change the prompt
869 * to emphasize that more data can still be sent
870 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200871 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200872 prompt = "+ ";
873 else
874 prompt = "\n> ";
875 }
876 else {
William Lallemand1bd140e2019-07-01 10:56:15 +0200877 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200878 prompt = "\n";
879 }
880
881 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100882 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100883 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100884 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100885 }
886
887 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100888 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100889 break;
890
891 /* Now we close the output if one of the writers did so,
892 * or if we're not in interactive mode and the request
893 * buffer is empty. This still allows pipelined requests
894 * to be sent in non-interactive mode.
895 */
William Lallemand3de09d52018-12-11 16:10:56 +0100896 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
897 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100898 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100899 continue;
900 }
901
902 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100903 appctx->st0 = CLI_ST_GETREQ;
William Lallemand1bd140e2019-07-01 10:56:15 +0200904 /* reactivate the \n at the end of the response for the next command */
905 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100906 }
907 }
908
909 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
910 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
911 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
912 /* Other side has closed, let's abort if we have no more processing to do
913 * and nothing more to consume. This is comparable to a broken pipe, so
914 * we forward the close to the request side so that it flows upstream to
915 * the client.
916 */
917 si_shutw(si);
918 }
919
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100920 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100921 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
922 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
923 /* We have no more processing to do, and nothing more to send, and
924 * the client side has closed. So we'll forward this state downstream
925 * on the response buffer.
926 */
927 si_shutr(si);
928 res->flags |= CF_READ_NULL;
929 }
930
931 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200932 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 +0100933 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200934 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 +0100935}
936
William Lallemand74c24fb2016-11-21 17:18:36 +0100937/* This is called when the stream interface is closed. For instance, upon an
938 * external abort, we won't call the i/o handler anymore so we may need to
939 * remove back references to the stream currently being dumped.
940 */
941static void cli_release_handler(struct appctx *appctx)
942{
943 if (appctx->io_release) {
944 appctx->io_release(appctx);
945 appctx->io_release = NULL;
946 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100947 else if (appctx->st0 == CLI_ST_PRINT_FREE) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100948 free(appctx->ctx.cli.err);
949 appctx->ctx.cli.err = NULL;
950 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100951}
952
953/* This function dumps all environmnent variables to the buffer. It returns 0
954 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100955 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
956 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100957 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100958static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100959{
Willy Tarreau0a739292016-11-22 20:21:23 +0100960 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100961 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100962
963 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
964 return 1;
965
966 chunk_reset(&trash);
967
968 /* we have two inner loops here, one for the proxy, the other one for
969 * the buffer.
970 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100971 while (*var) {
972 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100973
Willy Tarreau06d80a92017-10-19 14:32:15 +0200974 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100975 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100976 return 0;
977 }
978 if (appctx->st2 == STAT_ST_END)
979 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100980 var++;
981 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100982 }
983
984 /* dump complete */
985 return 1;
986}
987
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200988/* This function dumps all file descriptors states (or the requested one) to
989 * the buffer. It returns 0 if the output buffer is full and it needs to be
990 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
991 * It uses cli.i0 as the fd number to restart from.
992 */
993static int cli_io_handler_show_fd(struct appctx *appctx)
994{
995 struct stream_interface *si = appctx->owner;
996 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100997 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200998
999 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001000 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001001
1002 chunk_reset(&trash);
1003
Willy Tarreauca1b1572018-12-18 15:45:11 +01001004 /* isolate the threads once per round. We're limited to a buffer worth
1005 * of output anyway, it cannot last very long.
1006 */
1007 thread_isolate();
1008
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001009 /* we have two inner loops here, one for the proxy, the other one for
1010 * the buffer.
1011 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001012 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001013 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +02001014 struct listener *li = NULL;
1015 struct server *sv = NULL;
1016 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001017 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001018 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001019 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001020 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001021
1022 fdt = fdtab[fd];
1023
Willy Tarreauca1b1572018-12-18 15:45:11 +01001024 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +02001025 goto skip; // closed
1026
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001027 if (fdt.iocb == conn_fd_handler) {
1028 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001029 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001030 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001031 li = objt_listener(((struct connection *)fdt.owner)->target);
1032 sv = objt_server(((struct connection *)fdt.owner)->target);
1033 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001034 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001035 }
1036 else if (fdt.iocb == listener_accept)
1037 li = fdt.owner;
1038
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001039 chunk_printf(&trash,
Willy Tarreauc754b342018-03-30 15:00:15 +02001040 " %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 +02001041 fd,
1042 fdt.state,
1043 (fdt.state & FD_EV_POLLED_R) ? 'P' : 'p',
1044 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1045 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
1046 (fdt.state & FD_EV_POLLED_W) ? 'P' : 'p',
1047 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1048 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1049 fdt.ev,
1050 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1051 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1052 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1053 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1054 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001055 fdt.linger_risk ? 'L' : 'l',
1056 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001057 fdt.cache.next,
1058 fdt.cache.prev,
1059 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001060 fdt.owner,
1061 fdt.iocb,
1062 (fdt.iocb == conn_fd_handler) ? "conn_fd_handler" :
1063 (fdt.iocb == dgram_fd_handler) ? "dgram_fd_handler" :
1064 (fdt.iocb == listener_accept) ? "listener_accept" :
Olivier Houchard79321b92018-07-26 17:55:11 +02001065 (fdt.iocb == poller_pipe_io_handler) ? "poller_pipe_io_handler" :
William Lallemanddb6bdfb2018-11-20 17:36:51 +01001066 (fdt.iocb == mworker_accept_wrapper) ? "mworker_accept_wrapper" :
Emeric Brund0e095c2019-04-19 17:15:28 +02001067#ifdef USE_OPENSSL
Willy Tarreau5db847a2019-05-09 14:13:35 +02001068#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL) && !defined(OPENSSL_NO_ASYNC)
Emeric Brund0e095c2019-04-19 17:15:28 +02001069 (fdt.iocb == ssl_async_fd_free) ? "ssl_async_fd_free" :
1070 (fdt.iocb == ssl_async_fd_handler) ? "ssl_async_fd_handler" :
1071#endif
1072#endif
Willy Tarreauc754b342018-03-30 15:00:15 +02001073 "unknown");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001074
1075 if (fdt.iocb == conn_fd_handler) {
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001076 chunk_appendf(&trash, " back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001077 if (px)
1078 chunk_appendf(&trash, " px=%s", px->id);
1079 else if (sv)
1080 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1081 else if (li)
1082 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001083
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001084 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001085 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001086 if (mux->show_fd)
1087 mux->show_fd(&trash, fdt.owner);
1088 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001089 else
1090 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001091 }
1092 else if (fdt.iocb == listener_accept) {
1093 chunk_appendf(&trash, " l.st=%s fe=%s",
1094 listener_state_str(li),
1095 li->bind_conf->frontend->id);
1096 }
1097
1098 chunk_appendf(&trash, "\n");
1099
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);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001102 appctx->ctx.cli.i0 = fd;
1103 ret = 0;
1104 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001105 }
1106 skip:
1107 if (appctx->st2 == STAT_ST_END)
1108 break;
1109
1110 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001111 }
1112
Willy Tarreauca1b1572018-12-18 15:45:11 +01001113 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001114 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001115
1116 thread_release();
1117 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001118}
1119
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001120/* This function dumps some activity counters used by developers and support to
1121 * rule out some hypothesis during bug reports. It returns 0 if the output
1122 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1123 * everything at once in the buffer and is not designed to do it in multiple
1124 * passes.
1125 */
1126static int cli_io_handler_show_activity(struct appctx *appctx)
1127{
1128 struct stream_interface *si = appctx->owner;
1129 int thr;
1130
1131 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1132 return 1;
1133
1134 chunk_reset(&trash);
1135
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001136#undef SHOW_TOT
1137#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001138 do { \
1139 unsigned int _v[MAX_THREADS]; \
1140 unsigned int _tot; \
1141 const unsigned int _nbt = global.nbthread; \
1142 for (_tot = t = 0; t < _nbt; t++) \
1143 _tot += _v[t] = (x); \
1144 if (_nbt == 1) { \
1145 chunk_appendf(&trash, " %u\n", _tot); \
1146 break; \
1147 } \
1148 chunk_appendf(&trash, " %u [", _tot); \
1149 for (t = 0; t < _nbt; t++) \
1150 chunk_appendf(&trash, " %u", _v[t]); \
1151 chunk_appendf(&trash, " ]\n"); \
1152 } while (0)
1153
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001154#undef SHOW_AVG
1155#define SHOW_AVG(t, x) \
1156 do { \
1157 unsigned int _v[MAX_THREADS]; \
1158 unsigned int _tot; \
1159 const unsigned int _nbt = global.nbthread; \
1160 for (_tot = t = 0; t < _nbt; t++) \
1161 _tot += _v[t] = (x); \
1162 if (_nbt == 1) { \
1163 chunk_appendf(&trash, " %u\n", _tot); \
1164 break; \
1165 } \
1166 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1167 for (t = 0; t < _nbt; t++) \
1168 chunk_appendf(&trash, " %u", _v[t]); \
1169 chunk_appendf(&trash, " ]\n"); \
1170 } while (0)
1171
Willy Tarreaua0211b82019-05-28 15:09:08 +02001172 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1173 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001174 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
1175 chunk_appendf(&trash, "wake_cache:"); SHOW_TOT(thr, activity[thr].wake_cache);
1176 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1177 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
1178 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
1179 chunk_appendf(&trash, "poll_drop:"); SHOW_TOT(thr, activity[thr].poll_drop);
1180 chunk_appendf(&trash, "poll_dead:"); SHOW_TOT(thr, activity[thr].poll_dead);
1181 chunk_appendf(&trash, "poll_skip:"); SHOW_TOT(thr, activity[thr].poll_skip);
1182 chunk_appendf(&trash, "fd_lock:"); SHOW_TOT(thr, activity[thr].fd_lock);
1183 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
1184 chunk_appendf(&trash, "stream:"); SHOW_TOT(thr, activity[thr].stream);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001185 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1186 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001187 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1188 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
1189 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1190 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1191 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1192 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1193 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1194 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1195 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1196 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1197 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001198#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001199 chunk_appendf(&trash, "accq_ring:"); SHOW_TOT(thr, (accept_queue_rings[thr].tail - accept_queue_rings[thr].head + ACCEPT_QUEUE_SIZE) % ACCEPT_QUEUE_SIZE);
Willy Tarreaue6182842019-04-15 18:54:10 +02001200#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001201
Willy Tarreaud6a78502019-05-27 07:03:38 +02001202#if defined(DEBUG_DEV)
1203 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001204 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1205 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1206 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001207#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001208
1209 if (ci_putchk(si_ic(si), &trash) == -1) {
1210 chunk_reset(&trash);
1211 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001212 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001213 }
1214
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001215#undef SHOW_AVG
1216#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001217 /* dump complete */
1218 return 1;
1219}
1220
William Lallemandeceddf72016-12-15 18:06:44 +01001221/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001222 * CLI IO handler for `show cli sockets`.
1223 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001224 */
1225static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1226{
1227 struct bind_conf *bind_conf;
1228 struct stream_interface *si = appctx->owner;
1229
1230 chunk_reset(&trash);
1231
1232 switch (appctx->st2) {
1233 case STAT_ST_INIT:
1234 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001235 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001236 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001237 return 0;
1238 }
William Lallemandeceddf72016-12-15 18:06:44 +01001239 appctx->st2 = STAT_ST_LIST;
1240
1241 case STAT_ST_LIST:
1242 if (global.stats_fe) {
1243 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1244 struct listener *l;
1245
1246 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001247 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001248 * if the current node is the first of the list
1249 */
1250
Willy Tarreau3af9d832016-12-16 12:58:09 +01001251 if (appctx->ctx.cli.p0 &&
1252 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001253 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001254 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001255 continue;
1256 }
1257
1258 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1259
1260 char addr[46];
1261 char port[6];
1262
1263 if (l->addr.ss_family == AF_UNIX) {
1264 const struct sockaddr_un *un;
1265
1266 un = (struct sockaddr_un *)&l->addr;
William Lallemande58915f2019-04-01 11:30:05 +02001267 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001268 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001269 } else {
1270 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1271 }
William Lallemandeceddf72016-12-15 18:06:44 +01001272 } else if (l->addr.ss_family == AF_INET) {
1273 addr_to_str(&l->addr, addr, sizeof(addr));
1274 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001275 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001276 } else if (l->addr.ss_family == AF_INET6) {
1277 addr_to_str(&l->addr, addr, sizeof(addr));
1278 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001279 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001280 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1281 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001282 } else
William Lallemand26314342018-10-26 14:47:41 +02001283 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001284
William Lallemand07a62f72017-05-24 00:57:40 +02001285 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001286 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001287 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1288 chunk_appendf(&trash, "operator ");
1289 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1290 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001291 else
1292 chunk_appendf(&trash, " ");
1293
1294 if (bind_conf->bind_proc != 0) {
1295 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001296 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001297 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001298 chunk_appendf(&trash, "%d,", pos+1);
1299 }
1300 }
1301 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001302 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001303
1304 } else {
1305 chunk_appendf(&trash, "all\n");
1306 }
1307
Willy Tarreau06d80a92017-10-19 14:32:15 +02001308 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001309 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001310 return 0;
1311 }
1312 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001313 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001314 }
1315 }
1316 default:
1317 appctx->st2 = STAT_ST_FIN;
1318 return 1;
1319 }
1320}
1321
1322
Willy Tarreau0a739292016-11-22 20:21:23 +01001323/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001324 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1325 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001326 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001327static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001328{
1329 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001330 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001331
1332 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1333 return 1;
1334
Willy Tarreauf6710f82016-12-16 17:45:44 +01001335 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001336
1337 if (*args[2]) {
1338 int len = strlen(args[2]);
1339
Willy Tarreauf6710f82016-12-16 17:45:44 +01001340 for (; *var; var++) {
1341 if (strncmp(*var, args[2], len) == 0 &&
1342 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001343 break;
1344 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001345 if (!*var) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001346 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau0a739292016-11-22 20:21:23 +01001347 appctx->ctx.cli.msg = "Variable not found\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001348 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau0a739292016-11-22 20:21:23 +01001349 return 1;
1350 }
1351 appctx->st2 = STAT_ST_END;
1352 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001353 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001354 return 0;
1355}
1356
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001357/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1358 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1359 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1360 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001361static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001362{
1363 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1364 return 1;
1365
1366 appctx->ctx.cli.i0 = 0;
1367
1368 if (*args[2]) {
1369 appctx->ctx.cli.i0 = atoi(args[2]);
1370 appctx->st2 = STAT_ST_END;
1371 }
1372 return 0;
1373}
1374
Willy Tarreau599852e2016-11-22 20:33:32 +01001375/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001376static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001377{
1378 struct stream_interface *si = appctx->owner;
1379 struct stream *s = si_strm(si);
1380
1381 if (strcmp(args[2], "cli") == 0) {
1382 unsigned timeout;
1383 const char *res;
1384
1385 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001386 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001387 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001388 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001389 return 1;
1390 }
1391
1392 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
1393 if (res || timeout < 1) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001394 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001395 appctx->ctx.cli.msg = "Invalid timeout value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001396 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001397 return 1;
1398 }
1399
1400 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1401 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1402 return 1;
1403 }
1404 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001405 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau599852e2016-11-22 20:33:32 +01001406 appctx->ctx.cli.msg = "'set timeout' only supports 'cli'.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001407 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau599852e2016-11-22 20:33:32 +01001408 return 1;
1409 }
1410}
1411
Willy Tarreau2af99412016-11-23 11:10:59 +01001412/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001413static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001414{
1415 int v;
1416
1417 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1418 return 1;
1419
1420 if (!*args[3]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001421 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001422 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001423 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001424 return 1;
1425 }
1426
1427 v = atoi(args[3]);
1428 if (v > global.hardmaxconn) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001429 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau2af99412016-11-23 11:10:59 +01001430 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001431 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau2af99412016-11-23 11:10:59 +01001432 return 1;
1433 }
1434
1435 /* check for unlimited values */
1436 if (v <= 0)
1437 v = global.hardmaxconn;
1438
1439 global.maxconn = v;
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
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001448static int set_severity_output(int *target, char *argument)
1449{
1450 if (!strcmp(argument, "none")) {
1451 *target = CLI_SEVERITY_NONE;
1452 return 1;
1453 }
1454 else if (!strcmp(argument, "number")) {
1455 *target = CLI_SEVERITY_NUMBER;
1456 return 1;
1457 }
1458 else if (!strcmp(argument, "string")) {
1459 *target = CLI_SEVERITY_STRING;
1460 return 1;
1461 }
1462 return 0;
1463}
1464
1465/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001466static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001467{
1468 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1469 return 0;
1470
1471 appctx->ctx.cli.severity = LOG_ERR;
Aurélien Nephtali6e8a41d2018-03-15 21:48:50 +01001472 appctx->ctx.cli.msg = "one of 'none', 'number', 'string' is a required argument\n";
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001473 appctx->st0 = CLI_ST_PRINT;
1474 return 1;
1475}
William Lallemandeceddf72016-12-15 18:06:44 +01001476
William Lallemand67a234f2018-12-13 09:05:45 +01001477
1478/* show the level of the current CLI session */
1479static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1480{
1481
1482 appctx->ctx.cli.severity = LOG_INFO;
1483 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1484 appctx->ctx.cli.msg = "admin\n";
1485 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1486 appctx->ctx.cli.msg = "operator\n";
1487 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1488 appctx->ctx.cli.msg = "user\n";
1489 else
1490 appctx->ctx.cli.msg = "unknown\n";
1491
1492 appctx->st0 = CLI_ST_PRINT;
1493 return 1;
1494
1495}
1496
1497/* parse and set the CLI level dynamically */
1498static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1499{
William Lallemand1bd140e2019-07-01 10:56:15 +02001500 /* this will ask the applet to not output a \n after the command */
1501 if (!strcmp(args[1], "-"))
1502 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1503
William Lallemand67a234f2018-12-13 09:05:45 +01001504 if (!strcmp(args[0], "operator")) {
1505 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1506 return 1;
1507 }
1508 appctx->cli_level &= ~ACCESS_LVL_MASK;
1509 appctx->cli_level |= ACCESS_LVL_OPER;
1510
1511 } else if (!strcmp(args[0], "user")) {
1512 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1513 return 1;
1514 }
1515 appctx->cli_level &= ~ACCESS_LVL_MASK;
1516 appctx->cli_level |= ACCESS_LVL_USER;
1517 }
1518 return 1;
1519}
1520
William Lallemanda57b7e32018-12-14 21:11:31 +01001521
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001522int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001523{
1524 return 0;
1525}
1526
Willy Tarreau45c742b2016-11-24 14:51:17 +01001527/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001528static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001529{
1530 int v;
1531 int *res;
1532 int mul = 1;
1533
1534 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1535 return 1;
1536
1537 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1538 res = &global.cps_lim;
1539 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1540 res = &global.sps_lim;
1541#ifdef USE_OPENSSL
1542 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1543 res = &global.ssl_lim;
1544#endif
1545 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1546 res = &global.comp_rate_lim;
1547 mul = 1024;
1548 }
1549 else {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001550 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001551 appctx->ctx.cli.msg =
1552 "'set rate-limit' only supports :\n"
1553 " - 'connections global' to set the per-process maximum connection rate\n"
1554 " - 'sessions global' to set the per-process maximum session rate\n"
1555#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001556 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001557#endif
1558 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001559 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001560 return 1;
1561 }
1562
1563 if (!*args[4]) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001564 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001565 appctx->ctx.cli.msg = "Expects an integer value.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001566 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001567 return 1;
1568 }
1569
1570 v = atoi(args[4]);
1571 if (v < 0) {
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001572 appctx->ctx.cli.severity = LOG_ERR;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001573 appctx->ctx.cli.msg = "Value out of range.\n";
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001574 appctx->st0 = CLI_ST_PRINT;
Willy Tarreau45c742b2016-11-24 14:51:17 +01001575 return 1;
1576 }
1577
1578 *res = v * mul;
1579
1580 /* Dequeues all of the listeners waiting for a resource */
1581 if (!LIST_ISEMPTY(&global_listener_queue))
1582 dequeue_all_listeners(&global_listener_queue);
1583
1584 return 1;
1585}
1586
William Lallemandf6975e92017-05-26 17:42:10 +02001587/* parse the "expose-fd" argument on the bind lines */
1588static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1589{
1590 if (!*args[cur_arg + 1]) {
1591 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1592 return ERR_ALERT | ERR_FATAL;
1593 }
1594 if (!strcmp(args[cur_arg+1], "listeners")) {
1595 conf->level |= ACCESS_FD_LISTENERS;
1596 } else {
1597 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1598 args[cur_arg], args[cur_arg+1]);
1599 return ERR_ALERT | ERR_FATAL;
1600 }
1601
1602 return 0;
1603}
1604
William Lallemand74c24fb2016-11-21 17:18:36 +01001605/* parse the "level" argument on the bind lines */
1606static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1607{
1608 if (!*args[cur_arg + 1]) {
1609 memprintf(err, "'%s' : missing level", args[cur_arg]);
1610 return ERR_ALERT | ERR_FATAL;
1611 }
1612
William Lallemand07a62f72017-05-24 00:57:40 +02001613 if (!strcmp(args[cur_arg+1], "user")) {
1614 conf->level &= ~ACCESS_LVL_MASK;
1615 conf->level |= ACCESS_LVL_USER;
1616 } else if (!strcmp(args[cur_arg+1], "operator")) {
1617 conf->level &= ~ACCESS_LVL_MASK;
1618 conf->level |= ACCESS_LVL_OPER;
1619 } else if (!strcmp(args[cur_arg+1], "admin")) {
1620 conf->level &= ~ACCESS_LVL_MASK;
1621 conf->level |= ACCESS_LVL_ADMIN;
1622 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001623 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1624 args[cur_arg], args[cur_arg+1]);
1625 return ERR_ALERT | ERR_FATAL;
1626 }
1627
1628 return 0;
1629}
1630
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001631static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1632{
1633 if (!*args[cur_arg + 1]) {
1634 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1635 return ERR_ALERT | ERR_FATAL;
1636 }
1637
1638 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1639 return 0;
1640 else {
1641 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1642 args[cur_arg], args[cur_arg+1]);
1643 return ERR_ALERT | ERR_FATAL;
1644 }
1645}
1646
William Lallemand16dd1b32018-11-19 18:46:18 +01001647
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001648
Olivier Houchardf886e342017-04-05 22:24:59 +02001649/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001650static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001651{
1652 char *cmsgbuf = NULL;
1653 unsigned char *tmpbuf = NULL;
1654 struct cmsghdr *cmsg;
1655 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001656 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001657 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001658 struct msghdr msghdr;
1659 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001660 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001661 int *tmpfd;
1662 int tot_fd_nb = 0;
1663 struct proxy *px;
William Lallemand8dc8aec2020-01-16 15:32:08 +01001664 struct peers *prs;
Olivier Houchardf886e342017-04-05 22:24:59 +02001665 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001666 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001667 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001668 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001669 int ret;
1670
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001671 if (!remote) {
1672 ha_warning("Only works on real connections\n");
1673 goto out;
1674 }
1675
1676 fd = remote->handle.fd;
1677
Olivier Houchardf886e342017-04-05 22:24:59 +02001678 /* Temporary set the FD in blocking mode, that will make our life easier */
1679 old_fcntl = fcntl(fd, F_GETFL);
1680 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001681 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001682 goto out;
1683 }
1684 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1685 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001686 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001687 goto out;
1688 }
1689 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001690 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001691 goto out;
1692 }
Olivier Houchard54740872017-04-06 14:45:14 +02001693 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001694 iov.iov_base = &tot_fd_nb;
1695 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001696 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001697 goto out;
1698 memset(&msghdr, 0, sizeof(msghdr));
1699 /*
1700 * First, calculates the total number of FD, so that we can let
1701 * the caller know how much he should expects.
1702 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001703 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001704 while (px) {
1705 struct listener *l;
1706
1707 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001708 /* Only transfer IPv4/IPv6/UNIX sockets */
1709 if (l->state >= LI_ZOMBIE &&
1710 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001711 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001712 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001713 tot_fd_nb++;
1714 }
1715 px = px->next;
1716 }
William Lallemand8dc8aec2020-01-16 15:32:08 +01001717 prs = cfg_peers;
1718 while (prs) {
1719 if (prs->peers_fe) {
1720 struct listener *l;
1721
1722 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1723 /* Only transfer IPv4/IPv6/UNIX sockets */
1724 if (l->state >= LI_ZOMBIE &&
1725 (l->proto->sock_family == AF_INET ||
1726 l->proto->sock_family == AF_INET6 ||
1727 l->proto->sock_family == AF_UNIX))
1728 tot_fd_nb++;
1729 }
1730 }
1731 prs = prs->next;
1732 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001733 if (tot_fd_nb == 0)
1734 goto out;
1735
1736 /* First send the total number of file descriptors, so that the
1737 * receiving end knows what to expect.
1738 */
1739 msghdr.msg_iov = &iov;
1740 msghdr.msg_iovlen = 1;
1741 ret = sendmsg(fd, &msghdr, 0);
1742 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001743 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001744 goto out;
1745 }
1746
1747 /* Now send the fds */
1748 msghdr.msg_control = cmsgbuf;
1749 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1750 cmsg = CMSG_FIRSTHDR(&msghdr);
1751 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1752 cmsg->cmsg_level = SOL_SOCKET;
1753 cmsg->cmsg_type = SCM_RIGHTS;
1754 tmpfd = (int *)CMSG_DATA(cmsg);
1755
Olivier Houchardf886e342017-04-05 22:24:59 +02001756 /* For each socket, e message is sent, containing the following :
1757 * Size of the namespace name (or 0 if none), as an unsigned char.
1758 * The namespace name, if any
1759 * Size of the interface name (or 0 if none), as an unsigned char
1760 * The interface name, if any
1761 * Listener options, as an int.
1762 */
1763 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
1764 * buffer big enough to store the socket informations.
1765 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001766 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001767 if (tmpbuf == NULL) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001768 ha_warning("Failed to allocate memory to transfer socket informations\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001769 goto out;
1770 }
1771 iov.iov_base = tmpbuf;
William Lallemand8dc8aec2020-01-16 15:32:08 +01001772 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001773 while (px) {
1774 struct listener *l;
1775
1776 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1777 int ret;
1778 /* Only transfer IPv4/IPv6 sockets */
Olivier Houchard1fc05162017-04-06 01:05:05 +02001779 if (l->state >= LI_ZOMBIE &&
Olivier Houchardf886e342017-04-05 22:24:59 +02001780 (l->proto->sock_family == AF_INET ||
1781 l->proto->sock_family == AF_INET6 ||
1782 l->proto->sock_family == AF_UNIX)) {
1783 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1784 if (!l->netns)
1785 tmpbuf[curoff++] = 0;
Willy Tarreaue5733232019-05-22 19:24:06 +02001786#ifdef USE_NS
Olivier Houchardf886e342017-04-05 22:24:59 +02001787 else {
1788 char *name = l->netns->node.key;
1789 unsigned char len = l->netns->name_len;
1790 tmpbuf[curoff++] = len;
1791 memcpy(tmpbuf + curoff, name, len);
1792 curoff += len;
1793 }
1794#endif
1795 if (l->interface) {
1796 unsigned char len = strlen(l->interface);
1797 tmpbuf[curoff++] = len;
1798 memcpy(tmpbuf + curoff, l->interface, len);
1799 curoff += len;
1800 } else
1801 tmpbuf[curoff++] = 0;
1802 memcpy(tmpbuf + curoff, &l->options,
1803 sizeof(l->options));
1804 curoff += sizeof(l->options);
1805
Olivier Houchardf886e342017-04-05 22:24:59 +02001806 i++;
1807 } else
1808 continue;
1809 if ((!(i % MAX_SEND_FD))) {
1810 iov.iov_len = curoff;
1811 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001812 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001813 goto out;
1814 }
1815 /* Wait for an ack */
1816 do {
1817 ret = recv(fd, &tot_fd_nb,
1818 sizeof(tot_fd_nb), 0);
1819 } while (ret == -1 && errno == EINTR);
1820 if (ret <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001821 ha_warning("Unexpected error while transferring sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001822 goto out;
1823 }
1824 curoff = 0;
1825 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001826 }
1827 px = px->next;
1828 }
William Lallemand8dc8aec2020-01-16 15:32:08 +01001829 /* should be done for peers too */
1830 prs = cfg_peers;
1831 while (prs) {
1832 if (prs->peers_fe) {
1833 struct listener *l;
1834
1835 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1836 int ret;
1837 /* Only transfer IPv4/IPv6 sockets */
1838 if (l->state >= LI_ZOMBIE &&
1839 (l->proto->sock_family == AF_INET ||
1840 l->proto->sock_family == AF_INET6 ||
1841 l->proto->sock_family == AF_UNIX)) {
1842 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1843 if (!l->netns)
1844 tmpbuf[curoff++] = 0;
1845#ifdef USE_NS
1846 else {
1847 char *name = l->netns->node.key;
1848 unsigned char len = l->netns->name_len;
1849 tmpbuf[curoff++] = len;
1850 memcpy(tmpbuf + curoff, name, len);
1851 curoff += len;
1852 }
1853#endif
1854 if (l->interface) {
1855 unsigned char len = strlen(l->interface);
1856 tmpbuf[curoff++] = len;
1857 memcpy(tmpbuf + curoff, l->interface, len);
1858 curoff += len;
1859 } else
1860 tmpbuf[curoff++] = 0;
1861 memcpy(tmpbuf + curoff, &l->options,
1862 sizeof(l->options));
1863 curoff += sizeof(l->options);
1864
1865 i++;
1866 } else
1867 continue;
1868 if ((!(i % MAX_SEND_FD))) {
1869 iov.iov_len = curoff;
1870 if (sendmsg(fd, &msghdr, 0) != curoff) {
1871 ha_warning("Failed to transfer sockets\n");
1872 goto out;
1873 }
1874 /* Wait for an ack */
1875 do {
1876 ret = recv(fd, &tot_fd_nb,
1877 sizeof(tot_fd_nb), 0);
1878 } while (ret == -1 && errno == EINTR);
1879 if (ret <= 0) {
1880 ha_warning("Unexpected error while transferring sockets\n");
1881 goto out;
1882 }
1883 curoff = 0;
1884 }
1885 }
1886 }
1887 prs = prs->next;
1888 }
1889
Olivier Houchardf886e342017-04-05 22:24:59 +02001890 if (i % MAX_SEND_FD) {
1891 iov.iov_len = curoff;
1892 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1893 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1894 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001895 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001896 goto out;
1897 }
1898 }
1899
1900out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001901 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001902 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001903 goto out;
1904 }
1905 appctx->st0 = CLI_ST_END;
1906 free(cmsgbuf);
1907 free(tmpbuf);
1908 return 1;
1909}
1910
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001911static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1912{
1913 if (*args[0] == 'h')
1914 /* help */
1915 cli_gen_usage_msg(appctx);
1916 else if (*args[0] == 'p')
1917 /* prompt */
1918 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1919 else if (*args[0] == 'q')
1920 /* quit */
1921 appctx->st0 = CLI_ST_END;
1922
1923 return 1;
1924}
Olivier Houchardf886e342017-04-05 22:24:59 +02001925
William Lallemand2f4ce202018-10-26 14:47:47 +02001926void pcli_write_prompt(struct stream *s)
1927{
1928 struct buffer *msg = get_trash_chunk();
1929 struct channel *oc = si_oc(&s->si[0]);
1930
William Lallemanddc12c2e2018-12-13 09:05:46 +01001931 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001932 return;
1933
William Lallemanddc12c2e2018-12-13 09:05:46 +01001934 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001935 chunk_appendf(msg, "+ ");
1936 } else {
1937 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001938 chunk_appendf(msg, "master%s> ",
1939 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001940 else
1941 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1942 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001943 co_inject(oc, msg->area, msg->data);
1944}
1945
William Lallemand291810d2018-10-26 14:47:38 +02001946
William Lallemandcf62f7e2018-10-26 14:47:40 +02001947/* The pcli_* functions are used for the CLI proxy in the master */
1948
William Lallemanddeeaa592018-10-26 14:47:48 +02001949void pcli_reply_and_close(struct stream *s, const char *msg)
1950{
1951 struct buffer *buf = get_trash_chunk();
1952
1953 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001954 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001955}
1956
William Lallemand291810d2018-10-26 14:47:38 +02001957static enum obj_type *pcli_pid_to_server(int proc_pid)
1958{
1959 struct mworker_proc *child;
1960
William Lallemandbddd33a2018-12-11 16:10:53 +01001961 /* return the CLI applet of the master */
1962 if (proc_pid == 0)
1963 return &cli_applet.obj_type;
1964
William Lallemand291810d2018-10-26 14:47:38 +02001965 list_for_each_entry(child, &proc_list, list) {
1966 if (child->pid == proc_pid){
1967 return &child->srv->obj_type;
1968 }
1969 }
1970 return NULL;
1971}
1972
1973/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1974 * Return:
1975 * 0: master
1976 * > 0: pid of a worker
1977 * < 0: didn't find a worker
1978 */
1979static int pcli_prefix_to_pid(const char *prefix)
1980{
1981 int proc_pid;
1982 struct mworker_proc *child;
1983 char *errtol = NULL;
1984
1985 if (*prefix != '@') /* not a prefix, should not happen */
1986 return -1;
1987
1988 prefix++;
1989 if (!*prefix) /* sent @ alone, return the master */
1990 return 0;
1991
1992 if (strcmp("master", prefix) == 0) {
1993 return 0;
1994 } else if (*prefix == '!') {
1995 prefix++;
1996 if (!*prefix)
1997 return -1;
1998
1999 proc_pid = strtol(prefix, &errtol, 10);
2000 if (*errtol != '\0')
2001 return -1;
2002 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002003 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002004 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002005 if (child->pid == proc_pid){
2006 return child->pid;
2007 }
2008 }
2009 } else {
2010 struct mworker_proc *chosen = NULL;
2011 /* this is a relative pid */
2012
2013 proc_pid = strtol(prefix, &errtol, 10);
2014 if (*errtol != '\0')
2015 return -1;
2016
2017 if (proc_pid == 0) /* return the master */
2018 return 0;
2019
2020 /* chose the right process, the current one is the one with the
2021 least number of reloads */
2022 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002023 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002024 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002025 if (child->relative_pid == proc_pid){
2026 if (child->reloads == 0)
2027 return child->pid;
2028 else if (chosen == NULL || child->reloads < chosen->reloads)
2029 chosen = child;
2030 }
2031 }
2032 if (chosen)
2033 return chosen->pid;
2034 }
2035 return -1;
2036}
2037
William Lallemandbddd33a2018-12-11 16:10:53 +01002038/* Return::
2039 * >= 0 : number of words to escape
2040 * = -1 : error
2041 */
2042
2043int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2044{
2045 if (argl < 1)
2046 return 0;
2047
2048 /* there is a prefix */
2049 if (args[0][0] == '@') {
2050 int target_pid = pcli_prefix_to_pid(args[0]);
2051
2052 if (target_pid == -1) {
2053 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2054 return -1;
2055 }
2056
2057 /* if the prefix is alone, define a default target */
2058 if (argl == 1)
2059 s->pcli_next_pid = target_pid;
2060 else
2061 *next_pid = target_pid;
2062 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01002063 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002064 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002065 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002066
2067 } else if (!strcmp("quit", args[0])) {
2068 channel_shutr_now(&s->req);
2069 channel_shutw_now(&s->res);
2070 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01002071 } else if (!strcmp(args[0], "operator")) {
2072 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2073 memprintf(errmsg, "Permission denied!\n");
2074 return -1;
2075 }
2076 s->pcli_flags &= ~ACCESS_LVL_MASK;
2077 s->pcli_flags |= ACCESS_LVL_OPER;
2078 return argl;
2079
2080 } else if (!strcmp(args[0], "user")) {
2081 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2082 memprintf(errmsg, "Permission denied!\n");
2083 return -1;
2084 }
2085 s->pcli_flags &= ~ACCESS_LVL_MASK;
2086 s->pcli_flags |= ACCESS_LVL_USER;
2087 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002088 }
2089
2090 return 0;
2091}
2092
2093/*
2094 * Parse the CLI request:
2095 * - It does basically the same as the cli_io_handler, but as a proxy
2096 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002097 *
2098 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002099 * - the number of characters to forward or
2100 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002101 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002102int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002103{
William Lallemandbddd33a2018-12-11 16:10:53 +01002104 char *str = (char *)ci_head(req);
2105 char *end = (char *)ci_stop(req);
2106 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2107 int argl; /* number of args */
2108 char *p;
2109 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002110 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002111 int wtrim = 0; /* number of words to trim */
2112 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002113 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002114 int i = 0;
2115
2116 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002117
William Lallemanddc12c2e2018-12-13 09:05:46 +01002118 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002119
2120 /* Looks for the end of one command */
2121 while (p+reql < end) {
2122 /* handle escaping */
2123 if (p[reql] == '\\') {
William Lallemandc3a2e352020-06-18 18:45:04 +02002124 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002125 continue;
2126 }
2127 if (p[reql] == ';' || p[reql] == '\n') {
2128 /* found the end of the command */
2129 p[reql] = '\n';
2130 reql++;
2131 break;
2132 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002133 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002134 }
William Lallemandebf61802018-12-11 16:10:57 +01002135 } else {
2136 while (p+reql < end) {
2137 if (p[reql] == '\n') {
2138 /* found the end of the line */
2139 reql++;
2140 break;
2141 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002142 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002143 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002144 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002145
William Lallemandbddd33a2018-12-11 16:10:53 +01002146 /* set end to first byte after the end of the command */
2147 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002148
William Lallemandbddd33a2018-12-11 16:10:53 +01002149 /* there is no end to this command, need more to parse ! */
2150 if (*(end-1) != '\n') {
2151 return -1;
2152 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002153
William Lallemand3301f3e2018-12-13 09:05:48 +01002154 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2155 if (reql == 1) /* last line of the payload */
2156 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002157 return reql;
2158 }
2159
William Lallemandbddd33a2018-12-11 16:10:53 +01002160 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002161
William Lallemandbddd33a2018-12-11 16:10:53 +01002162 /* splits the command in words */
2163 while (i < MAX_STATS_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002164 /* skip leading spaces/tabs */
2165 p += strspn(p, " \t");
2166 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002167 break;
2168
William Lallemandbddd33a2018-12-11 16:10:53 +01002169 args[i] = p;
William Lallemandda9a2d12020-06-18 18:03:57 +02002170 while (1) {
2171 p += strcspn(p, " \t\\");
2172 /* escaped chars using backlashes (\) */
2173 if (*p == '\\') {
2174 if (!*++p)
2175 break;
2176 if (!*++p)
2177 break;
2178 } else {
2179 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002180 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002181 }
William Lallemandda9a2d12020-06-18 18:03:57 +02002182 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002183 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002184 }
2185
William Lallemandbddd33a2018-12-11 16:10:53 +01002186 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002187
William Lallemandbddd33a2018-12-11 16:10:53 +01002188 for (; i < MAX_STATS_ARGS + 1; i++)
2189 args[i] = NULL;
2190
2191 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2192
2193 /* End of words are ending by \0, we need to replace the \0s by spaces
21941 before forwarding them */
2195 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002196 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002197 if (*p == '\0')
2198 *p = ' ';
2199 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002200 }
2201
William Lallemand3301f3e2018-12-13 09:05:48 +01002202 payload = strstr(str, PAYLOAD_PATTERN);
2203 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2204 /* if the payload pattern is at the end */
2205 s->pcli_flags |= PCLI_F_PAYLOAD;
2206 ret = reql;
2207 }
2208
William Lallemandbddd33a2018-12-11 16:10:53 +01002209 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002210
William Lallemandbddd33a2018-12-11 16:10:53 +01002211 if (wtrim > 0) {
2212 trim = &args[wtrim][0];
2213 if (trim == NULL) /* if this was the last word in the table */
2214 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002215
William Lallemandbddd33a2018-12-11 16:10:53 +01002216 b_del(&req->buf, trim - str);
2217
William Lallemandb7ea1412018-12-13 09:05:47 +01002218 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002219 } else if (wtrim < 0) {
2220 /* parsing error */
2221 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002222 } else {
2223 /* the whole string */
2224 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002225 }
2226
William Lallemandb7ea1412018-12-13 09:05:47 +01002227 if (ret > 1) {
2228 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2229 goto end;
2230 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemand1bd140e2019-07-01 10:56:15 +02002231 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2232 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002233 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemand1bd140e2019-07-01 10:56:15 +02002234 ci_insert_line2(req, 0, "user -", strlen("user -"));
2235 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002236 }
2237 }
2238end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002239
William Lallemandb7ea1412018-12-13 09:05:47 +01002240 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002241}
2242
2243int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2244{
William Lallemandbddd33a2018-12-11 16:10:53 +01002245 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002246 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002247 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002248
William Lallemandb7ea1412018-12-13 09:05:47 +01002249 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2250 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2251
William Lallemandcf62f7e2018-10-26 14:47:40 +02002252read_again:
2253 /* if the channel is closed for read, we won't receive any more data
2254 from the client, but we don't want to forward this close to the
2255 server */
2256 channel_dont_close(req);
2257
2258 /* We don't know yet to which server we will connect */
2259 channel_dont_connect(req);
2260
2261
2262 /* we are not waiting for a response, there is no more request and we
2263 * receive a close from the client, we can leave */
2264 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2265 channel_shutw_now(&s->res);
2266 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2267 return 1;
2268 }
2269
2270 req->flags |= CF_READ_DONTWAIT;
2271
2272 /* need more data */
2273 if (!ci_data(req))
2274 return 0;
2275
2276 /* If there is data available for analysis, log the end of the idle time. */
2277 if (c_data(req) && s->logs.t_idle == -1)
2278 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2279
William Lallemandbddd33a2018-12-11 16:10:53 +01002280 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002281 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002282 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002283 /* enough data */
2284
William Lallemandcf62f7e2018-10-26 14:47:40 +02002285 /* forward only 1 command */
2286 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002287
William Lallemanddc12c2e2018-12-13 09:05:46 +01002288 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002289 /* we send only 1 command per request, and we write close after it */
2290 channel_shutw_now(req);
2291 } else {
2292 pcli_write_prompt(s);
2293 }
2294
2295 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002296
2297 /* remove the XFER_DATA analysers, which forwards all
2298 * the data, we don't want to forward the next requests
2299 * We need to add CF_FLT_ANALYZE to abort the forward too.
2300 */
2301 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2302 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2303 s->res.analysers |= AN_RES_WAIT_CLI;
2304
William Lallemandebf61802018-12-11 16:10:57 +01002305 if (!(s->flags & SF_ASSIGNED)) {
2306 if (next_pid > -1)
2307 target_pid = next_pid;
2308 else
2309 target_pid = s->pcli_next_pid;
2310 /* we can connect now */
2311 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002312
William Lallemandebf61802018-12-11 16:10:57 +01002313 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2314 channel_auto_connect(req);
2315 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002316
2317 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002318 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002319 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002320 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002321 } else if (to_forward == -1 && errmsg) {
2322 /* there was an error during the parsing */
2323 pcli_reply_and_close(s, errmsg);
2324 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002325 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2326 /* buffer is full and we didn't catch the end of a command */
2327 goto send_help;
2328 }
2329
2330 return 0;
2331
2332send_help:
2333 b_reset(&req->buf);
2334 b_putblk(&req->buf, "help\n", 5);
2335 goto read_again;
2336}
2337
2338int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2339{
2340 struct proxy *fe = strm_fe(s);
2341 struct proxy *be = s->be;
2342
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002343 if (rep->flags & CF_READ_ERROR) {
2344 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2345 s->res.analysers &= ~AN_RES_WAIT_CLI;
2346 return 0;
2347 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002348 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2349 rep->flags |= CF_NEVER_WAIT;
2350
2351 /* don't forward the close */
2352 channel_dont_close(&s->res);
2353 channel_dont_close(&s->req);
2354
William Lallemanddc12c2e2018-12-13 09:05:46 +01002355 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002356 s->req.analysers |= AN_REQ_WAIT_CLI;
2357 s->res.analysers &= ~AN_RES_WAIT_CLI;
2358 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2359 return 0;
2360 }
2361
William Lallemandcf62f7e2018-10-26 14:47:40 +02002362 /* forward the data */
2363 if (ci_data(rep)) {
2364 c_adv(rep, ci_data(rep));
2365 return 0;
2366 }
2367
2368 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2369 /* stream cleanup */
2370
William Lallemand2f4ce202018-10-26 14:47:47 +02002371 pcli_write_prompt(s);
2372
William Lallemandcf62f7e2018-10-26 14:47:40 +02002373 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2374 si_shutr(&s->si[1]);
2375 si_shutw(&s->si[1]);
2376
2377 /*
2378 * starting from there this the same code as
2379 * http_end_txn_clean_session().
2380 *
2381 * It allows to do frontend keepalive while reconnecting to a
2382 * new server for each request.
2383 */
2384
2385 if (s->flags & SF_BE_ASSIGNED) {
2386 HA_ATOMIC_SUB(&be->beconn, 1);
2387 if (unlikely(s->srv_conn))
2388 sess_change_server(s, NULL);
2389 }
2390
2391 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2392 stream_process_counters(s);
2393
2394 /* don't count other requests' data */
2395 s->logs.bytes_in -= ci_data(&s->req);
2396 s->logs.bytes_out -= ci_data(&s->res);
2397
2398 /* we may need to know the position in the queue */
2399 pendconn_free(s);
2400
2401 /* let's do a final log if we need it */
2402 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2403 !(s->flags & SF_MONITOR) &&
2404 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2405 s->do_log(s);
2406 }
2407
2408 /* stop tracking content-based counters */
2409 stream_stop_content_counters(s);
2410 stream_update_time_stats(s);
2411
2412 s->logs.accept_date = date; /* user-visible date for logging */
2413 s->logs.tv_accept = now; /* corrected date for internal use */
2414 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2415 s->logs.t_idle = -1;
2416 tv_zero(&s->logs.tv_request);
2417 s->logs.t_queue = -1;
2418 s->logs.t_connect = -1;
2419 s->logs.t_data = -1;
2420 s->logs.t_close = 0;
2421 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2422 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2423
2424 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2425 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2426
2427 stream_del_srv_conn(s);
2428 if (objt_server(s->target)) {
2429 if (s->flags & SF_CURR_SESS) {
2430 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002431 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002433 if (may_dequeue_tasks(__objt_server(s->target), be))
2434 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002435 }
2436
2437 s->target = NULL;
2438
2439 /* only release our endpoint if we don't intend to reuse the
2440 * connection.
2441 */
2442 if (!si_conn_ready(&s->si[1])) {
2443 si_release_endpoint(&s->si[1]);
2444 s->srv_conn = NULL;
2445 }
2446
2447 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2448 s->si[1].err_type = SI_ET_NONE;
2449 s->si[1].conn_retries = 0; /* used for logging too */
2450 s->si[1].exp = TICK_ETERNITY;
2451 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
2452 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);
William Lallemandd12fb062019-06-25 18:00:19 +02002453 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|CF_READ_NULL);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002454 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2455 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2456 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2457 /* reinitialise the current rule list pointer to NULL. We are sure that
2458 * any rulelist match the NULL pointer.
2459 */
2460 s->current_rule_list = NULL;
2461
2462 s->be = strm_fe(s);
2463 s->logs.logwait = strm_fe(s)->to_log;
2464 s->logs.level = 0;
2465 stream_del_srv_conn(s);
2466 s->target = NULL;
2467 /* re-init store persistence */
2468 s->store_count = 0;
2469 s->uniq_id = global.req_count++;
2470
2471 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2472
2473 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2474
2475 s->req.analysers |= AN_REQ_WAIT_CLI;
2476 s->res.analysers &= ~AN_RES_WAIT_CLI;
2477
2478 /* We must trim any excess data from the response buffer, because we
2479 * may have blocked an invalid response from a server that we don't
Joseph Herlant008b3ce2018-11-25 12:51:45 -08002480 * want to accidently forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002481 * we want those data to come along with next response. A typical
2482 * example of such data would be from a buggy server responding to
2483 * a HEAD with some data, or sending more than the advertised
2484 * content-length.
2485 */
2486 if (unlikely(ci_data(&s->res)))
2487 b_set_data(&s->res.buf, co_data(&s->res));
2488
2489 /* Now we can realign the response buffer */
2490 c_realign_if_empty(&s->res);
2491
2492 s->req.rto = strm_fe(s)->timeout.client;
2493 s->req.wto = TICK_ETERNITY;
2494
2495 s->res.rto = TICK_ETERNITY;
2496 s->res.wto = strm_fe(s)->timeout.client;
2497
2498 s->req.rex = TICK_ETERNITY;
2499 s->req.wex = TICK_ETERNITY;
2500 s->req.analyse_exp = TICK_ETERNITY;
2501 s->res.rex = TICK_ETERNITY;
2502 s->res.wex = TICK_ETERNITY;
2503 s->res.analyse_exp = TICK_ETERNITY;
2504 s->si[1].hcto = TICK_ETERNITY;
2505
2506 /* we're removing the analysers, we MUST re-enable events detection.
2507 * We don't enable close on the response channel since it's either
2508 * already closed, or in keep-alive with an idle connection handler.
2509 */
2510 channel_auto_read(&s->req);
2511 channel_auto_close(&s->req);
2512 channel_auto_read(&s->res);
2513
2514
2515 return 1;
2516 }
2517 return 0;
2518}
2519
William Lallemand8a022572018-10-26 14:47:35 +02002520/*
2521 * The mworker functions are used to initialize the CLI in the master process
2522 */
2523
William Lallemand309dc9a2018-10-26 14:47:45 +02002524 /*
2525 * Stop the mworker proxy
2526 */
2527void mworker_cli_proxy_stop()
2528{
William Lallemand550db6d2018-11-06 17:37:12 +01002529 if (mworker_proxy)
2530 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002531}
2532
William Lallemand8a022572018-10-26 14:47:35 +02002533/*
2534 * Create the mworker CLI proxy
2535 */
2536int mworker_cli_proxy_create()
2537{
2538 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002539 char *msg = NULL;
2540 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002541
2542 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2543 if (!mworker_proxy)
2544 return -1;
2545
2546 init_new_proxy(mworker_proxy);
2547 mworker_proxy->next = proxies_list;
2548 proxies_list = mworker_proxy;
2549 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002550 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002551 mworker_proxy->state = PR_STNEW;
2552 mworker_proxy->last_change = now.tv_sec;
2553 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2554 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2555 mworker_proxy->timeout.client = 0; /* no timeout */
2556 mworker_proxy->conf.file = strdup("MASTER");
2557 mworker_proxy->conf.line = 0;
2558 mworker_proxy->accept = frontend_accept;
2559 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2560
2561 /* Does not init the default target the CLI applet, but must be done in
2562 * the request parsing code */
2563 mworker_proxy->default_target = NULL;
2564
2565 /* the check_config_validity() will get an ID for the proxy */
2566 mworker_proxy->uuid = -1;
2567
2568 proxy_store_name(mworker_proxy);
2569
2570 /* create all servers using the mworker_proc list */
2571 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002572 struct server *newsrv = NULL;
2573 struct sockaddr_storage *sk;
2574 int port1, port2, port;
2575 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002576
William Lallemandf0d9dd42020-01-14 15:25:02 +01002577 /* only the workers support the master CLI */
2578 if (!(child->options & PROC_O_TYPE_WORKER))
2579 continue;
2580
William Lallemand8a022572018-10-26 14:47:35 +02002581 newsrv = new_server(mworker_proxy);
2582 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002583 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002584
2585 /* we don't know the new pid yet */
2586 if (child->pid == -1)
2587 memprintf(&msg, "cur-%d", child->relative_pid);
2588 else
2589 memprintf(&msg, "old-%d", child->pid);
2590
2591 newsrv->next = mworker_proxy->srv;
2592 mworker_proxy->srv = newsrv;
2593 newsrv->conf.file = strdup(msg);
2594 newsrv->id = strdup(msg);
2595 newsrv->conf.line = 0;
2596
2597 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002598 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002599 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002600 }
2601 free(msg);
2602 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002603
2604 proto = protocol_by_family(sk->ss_family);
2605 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002606 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002607 }
2608
2609 /* no port specified */
2610 newsrv->flags |= SRV_F_MAPPORTS;
2611 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002612 /* don't let the server participate to load balancing */
2613 newsrv->iweight = 0;
2614 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002615 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002616
2617 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002618 }
2619 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002620
2621error:
2622 ha_alert("%s\n", errmsg);
2623
2624 list_for_each_entry(child, &proc_list, list) {
2625 free((char *)child->srv->conf.file); /* cast because of const char * */
2626 free(child->srv->id);
2627 free(child->srv);
2628 child->srv = NULL;
2629 }
2630 free(mworker_proxy->id);
2631 free(mworker_proxy->conf.file);
2632 free(mworker_proxy);
2633 mworker_proxy = NULL;
2634 free(errmsg);
2635 free(msg);
2636
2637 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002638}
Olivier Houchardf886e342017-04-05 22:24:59 +02002639
William Lallemandce83b4a2018-10-26 14:47:30 +02002640/*
William Lallemande7361152018-10-26 14:47:36 +02002641 * Create a new listener for the master CLI proxy
2642 */
2643int mworker_cli_proxy_new_listener(char *line)
2644{
2645 struct bind_conf *bind_conf;
2646 struct listener *l;
2647 char *err = NULL;
2648 char *args[MAX_LINE_ARGS + 1];
2649 int arg;
2650 int cur_arg;
2651
William Lallemandb4f87862019-11-25 09:58:37 +01002652 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002653 args[0] = line;
2654
2655 /* args is a bind configuration with spaces replaced by commas */
2656 while (*line && arg < MAX_LINE_ARGS) {
2657
2658 if (*line == ',') {
2659 *line++ = '\0';
2660 while (*line == ',')
2661 line++;
William Lallemandb4f87862019-11-25 09:58:37 +01002662 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002663 }
2664 line++;
2665 }
2666
William Lallemandb4f87862019-11-25 09:58:37 +01002667 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002668
2669 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002670 if (!bind_conf)
2671 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002672
2673 bind_conf->level &= ~ACCESS_LVL_MASK;
2674 bind_conf->level |= ACCESS_LVL_ADMIN;
2675
2676 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2677 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002678 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002679 }
2680
2681 cur_arg = 1;
2682
2683 while (*args[cur_arg]) {
2684 static int bind_dumped;
2685 struct bind_kw *kw;
2686
2687 kw = bind_find_kw(args[cur_arg]);
2688 if (kw) {
2689 if (!kw->parse) {
2690 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2691 args[0], args[1], args[cur_arg]);
2692 goto err;
2693 }
2694
2695 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2696 if (err)
2697 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2698 else
2699 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2700 args[0], args[1], args[cur_arg]);
2701 goto err;
2702 }
2703
2704 cur_arg += 1 + kw->skip;
2705 continue;
2706 }
2707
2708 if (!bind_dumped) {
2709 bind_dump_kws(&err);
2710 indent_msg(&err, 4);
2711 bind_dumped = 1;
2712 }
2713
2714 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2715 args[0], args[1], args[cur_arg],
2716 err ? " Registered keywords :" : "", err ? err : "");
2717 goto err;
2718 }
2719
2720
2721 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002722 l->accept = session_accept_fd;
2723 l->default_target = mworker_proxy->default_target;
2724 /* don't make the peers subject to global limits and don't close it in the master */
2725 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2726 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002727 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002728 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002729 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002730
2731 return 0;
2732
2733err:
2734 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002735 free(err);
2736 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002737 return -1;
2738
2739}
2740
2741/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002742 * Create a new CLI socket using a socketpair for a worker process
2743 * <mworker_proc> is the process structure, and <proc> is the process number
2744 */
2745int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2746{
2747 struct bind_conf *bind_conf;
2748 struct listener *l;
2749 char *path = NULL;
2750 char *err = NULL;
2751
2752 /* master pipe to ensure the master is still alive */
2753 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2754 ha_alert("Cannot create worker socketpair.\n");
2755 return -1;
2756 }
2757
2758 /* XXX: we might want to use a separate frontend at some point */
2759 if (!global.stats_fe) {
2760 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2761 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002762 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002763 }
2764 }
2765
2766 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002767 if (!bind_conf)
2768 goto error;
2769
William Lallemandce83b4a2018-10-26 14:47:30 +02002770 bind_conf->level &= ~ACCESS_LVL_MASK;
2771 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2772
2773 bind_conf->bind_proc = 1UL << proc;
2774 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2775
2776 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2777 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002778 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002779 }
2780
2781 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002782 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002783 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002784 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002785 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002786 free(path);
2787 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002788
2789 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002790 l->accept = session_accept_fd;
2791 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002792 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002793 /* it's a sockpair but we don't want to keep the fd in the master */
2794 l->options &= ~LI_O_INHERITED;
2795 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002796 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002797 }
2798
2799 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002800
2801error:
2802 close(mworker_proc->ipc_fd[0]);
2803 close(mworker_proc->ipc_fd[1]);
2804 free(err);
2805
2806 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002807}
2808
William Lallemand74c24fb2016-11-21 17:18:36 +01002809static struct applet cli_applet = {
2810 .obj_type = OBJ_TYPE_APPLET,
2811 .name = "<CLI>", /* used for logging */
2812 .fct = cli_io_handler,
2813 .release = cli_release_handler,
2814};
2815
Willy Tarreau0a739292016-11-22 20:21:23 +01002816/* register cli keywords */
2817static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002818 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2819 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2820 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002821 { { "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 +01002822 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002823 { { "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 +01002824 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002825 { { "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 +02002826 { { "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 +01002827 { { "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 +02002828 { { "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 +01002829 { { "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 +01002830 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2831 { { "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 +02002832 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002833 {{},}
2834}};
2835
Willy Tarreau0108d902018-11-25 19:14:37 +01002836INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2837
William Lallemand74c24fb2016-11-21 17:18:36 +01002838static struct cfg_kw_list cfg_kws = {ILH, {
2839 { CFG_GLOBAL, "stats", stats_parse_global },
2840 { 0, NULL, NULL },
2841}};
2842
Willy Tarreau0108d902018-11-25 19:14:37 +01002843INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2844
William Lallemand74c24fb2016-11-21 17:18:36 +01002845static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002846 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2847 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002848 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002849 { NULL, NULL, 0 },
2850}};
2851
Willy Tarreau0108d902018-11-25 19:14:37 +01002852INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002853
2854/*
2855 * Local variables:
2856 * c-indent-level: 8
2857 * c-basic-offset: 8
2858 * End:
2859 */