blob: 321a974e232567a6266eea112994a03038055225 [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
Willy Tarreau3f0f82e2020-06-04 19:42:41 +020029#include <haproxy/applet-t.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010031#include <common/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020032#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020033#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020034#include <haproxy/cli.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020035#include <haproxy/dns-t.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020036#include <haproxy/frontend.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020037#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020038#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020039#include <haproxy/log.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020040#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020041#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020042#include <haproxy/peers.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020043#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020044#include <haproxy/sample-t.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020045#include <haproxy/session.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020046#include <haproxy/stats-t.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020047#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020048#include <haproxy/task.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020049#include <haproxy/tools.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020050#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020051#include <haproxy/time.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020052#include <haproxy/version.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020053#include <haproxy/base64.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010054
Willy Tarreauf268ee82020-06-04 17:05:57 +020055#include <haproxy/global.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010056
Willy Tarreaua04ded52020-06-02 10:29:48 +020057#include <haproxy/activity.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020058#include <haproxy/compression.h>
Willy Tarreau0f6ffd62020-06-03 19:33:00 +020059#include <haproxy/fd.h>
Willy Tarreau66347942020-06-01 12:18:08 +020060#include <haproxy/freq_ctr.h>
Willy Tarreau551271d2020-06-04 08:32:23 +020061#include <haproxy/pipe.h>
Willy Tarreau2dd7c352020-06-03 15:26:55 +020062#include <haproxy/protocol.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010063#include <proto/stream.h>
64#include <proto/server.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010065
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020066#define PAYLOAD_PATTERN "<<"
67
William Lallemand74c24fb2016-11-21 17:18:36 +010068static struct applet cli_applet;
69
70static const char stats_sock_usage_msg[] =
71 "Unknown command. Please enter one of the following commands only :\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010072 " help : this message\n"
73 " prompt : toggle interactive mode with prompt\n"
74 " quit : disconnect\n"
William Lallemand74c24fb2016-11-21 17:18:36 +010075 "";
76
77static const char stats_permission_denied_msg[] =
78 "Permission denied\n"
79 "";
80
81
Christopher Faulet1bc04c72017-10-29 20:14:08 +010082static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010083
84/* List head of cli keywords */
85static struct cli_kw_list cli_keywords = {
86 .list = LIST_HEAD_INIT(cli_keywords.list)
87};
88
89extern const char *stat_status_codes[];
90
William Lallemand8a022572018-10-26 14:47:35 +020091static struct proxy *mworker_proxy; /* CLI proxy of the master */
92
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020093static char *cli_gen_usage_msg(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +010094{
95 struct cli_kw_list *kw_list;
96 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020097 struct buffer *tmp = get_trash_chunk();
98 struct buffer out;
William Lallemand74c24fb2016-11-21 17:18:36 +010099
100 free(dynamic_usage_msg);
101 dynamic_usage_msg = NULL;
102
103 if (LIST_ISEMPTY(&cli_keywords.list))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200104 goto end;
William Lallemand74c24fb2016-11-21 17:18:36 +0100105
106 chunk_reset(tmp);
107 chunk_strcat(tmp, stats_sock_usage_msg);
108 list_for_each_entry(kw_list, &cli_keywords.list, list) {
109 kw = &kw_list->kw[0];
William Lallemand0154edc2018-05-15 11:50:04 +0200110 while (kw->str_kw[0]) {
William Lallemand14721be2018-10-26 14:47:37 +0200111
112 /* in a worker or normal process, don't display master only commands */
113 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
114 goto next_kw;
115
116 /* in master don't displays if we don't have the master bits */
117 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
118 goto next_kw;
119
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200120 /* only show expert commands in expert mode */
121 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
122 goto next_kw;
123
William Lallemand0154edc2018-05-15 11:50:04 +0200124 if (kw->usage)
125 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand14721be2018-10-26 14:47:37 +0200126
127next_kw:
128
William Lallemand74c24fb2016-11-21 17:18:36 +0100129 kw++;
130 }
131 }
132 chunk_init(&out, NULL, 0);
133 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200134 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200135
136end:
137 if (dynamic_usage_msg) {
138 appctx->ctx.cli.severity = LOG_INFO;
139 appctx->ctx.cli.msg = dynamic_usage_msg;
140 }
141 else {
142 appctx->ctx.cli.severity = LOG_INFO;
143 appctx->ctx.cli.msg = stats_sock_usage_msg;
144 }
145 appctx->st0 = CLI_ST_PRINT;
146
William Lallemand74c24fb2016-11-21 17:18:36 +0100147 return dynamic_usage_msg;
148}
149
150struct cli_kw* cli_find_kw(char **args)
151{
152 struct cli_kw_list *kw_list;
153 struct cli_kw *kw;/* current cli_kw */
154 char **tmp_args;
155 const char **tmp_str_kw;
156 int found = 0;
157
158 if (LIST_ISEMPTY(&cli_keywords.list))
159 return NULL;
160
161 list_for_each_entry(kw_list, &cli_keywords.list, list) {
162 kw = &kw_list->kw[0];
163 while (*kw->str_kw) {
164 tmp_args = args;
165 tmp_str_kw = kw->str_kw;
166 while (*tmp_str_kw) {
167 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
168 found = 1;
169 } else {
170 found = 0;
171 break;
172 }
173 tmp_args++;
174 tmp_str_kw++;
175 }
176 if (found)
177 return (kw);
178 kw++;
179 }
180 }
181 return NULL;
182}
183
184void cli_register_kw(struct cli_kw_list *kw_list)
185{
186 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
187}
188
189
190/* allocate a new stats frontend named <name>, and return it
191 * (or NULL in case of lack of memory).
192 */
193static struct proxy *alloc_stats_fe(const char *name, const char *file, int line)
194{
195 struct proxy *fe;
196
197 fe = calloc(1, sizeof(*fe));
198 if (!fe)
199 return NULL;
200
201 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100202 fe->next = proxies_list;
203 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100204 fe->last_change = now.tv_sec;
205 fe->id = strdup("GLOBAL");
206 fe->cap = PR_CAP_FE;
207 fe->maxconn = 10; /* default to 10 concurrent connections */
208 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
209 fe->conf.file = strdup(file);
210 fe->conf.line = line;
211 fe->accept = frontend_accept;
212 fe->default_target = &cli_applet.obj_type;
213
214 /* the stats frontend is the only one able to assign ID #0 */
215 fe->conf.id.key = fe->uuid = 0;
216 eb32_insert(&used_proxy_id, &fe->conf.id);
217 return fe;
218}
219
220/* This function parses a "stats" statement in the "global" section. It returns
221 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
222 * error message into the <err> buffer which will be preallocated. The trailing
223 * '\n' must not be written. The function must be called with <args> pointing to
224 * the first word after "stats".
225 */
226static int stats_parse_global(char **args, int section_type, struct proxy *curpx,
227 struct proxy *defpx, const char *file, int line,
228 char **err)
229{
230 struct bind_conf *bind_conf;
231 struct listener *l;
232
233 if (!strcmp(args[1], "socket")) {
234 int cur_arg;
235
236 if (*args[2] == 0) {
237 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
238 return -1;
239 }
240
241 if (!global.stats_fe) {
242 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
243 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
244 return -1;
245 }
246 }
247
Willy Tarreaua261e9b2016-12-22 20:44:00 +0100248 bind_conf = bind_conf_alloc(global.stats_fe, file, line, args[2], xprt_get(XPRT_RAW));
William Lallemand07a62f72017-05-24 00:57:40 +0200249 bind_conf->level &= ~ACCESS_LVL_MASK;
250 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100251
252 if (!str2listener(args[2], global.stats_fe, bind_conf, file, line, err)) {
253 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
254 file, line, args[0], args[1], err && *err ? *err : "error");
255 return -1;
256 }
257
258 cur_arg = 3;
259 while (*args[cur_arg]) {
260 static int bind_dumped;
261 struct bind_kw *kw;
262
263 kw = bind_find_kw(args[cur_arg]);
264 if (kw) {
265 if (!kw->parse) {
266 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
267 args[0], args[1], args[cur_arg]);
268 return -1;
269 }
270
271 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, err) != 0) {
272 if (err && *err)
273 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
274 else
275 memprintf(err, "'%s %s' : error encountered while processing '%s'",
276 args[0], args[1], args[cur_arg]);
277 return -1;
278 }
279
280 cur_arg += 1 + kw->skip;
281 continue;
282 }
283
284 if (!bind_dumped) {
285 bind_dump_kws(err);
286 indent_msg(err, 4);
287 bind_dumped = 1;
288 }
289
290 memprintf(err, "'%s %s' : unknown keyword '%s'.%s%s",
291 args[0], args[1], args[cur_arg],
292 err && *err ? " Registered keywords :" : "", err && *err ? *err : "");
293 return -1;
294 }
295
296 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100297 l->accept = session_accept_fd;
William Lallemand74c24fb2016-11-21 17:18:36 +0100298 l->default_target = global.stats_fe->default_target;
299 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
300 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100301 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100302 }
303 }
304 else if (!strcmp(args[1], "timeout")) {
305 unsigned timeout;
306 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
307
Willy Tarreau9faebe32019-06-07 19:00:37 +0200308 if (res == PARSE_TIME_OVER) {
309 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
310 args[2], args[0], args[1]);
311 return -1;
312 }
313 else if (res == PARSE_TIME_UNDER) {
314 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
315 args[2], args[0], args[1]);
316 return -1;
317 }
318 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100319 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
320 return -1;
321 }
322
323 if (!timeout) {
324 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
325 return -1;
326 }
327 if (!global.stats_fe) {
328 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
329 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
330 return -1;
331 }
332 }
333 global.stats_fe->timeout.client = MS_TO_TICKS(timeout);
334 }
335 else if (!strcmp(args[1], "maxconn")) {
336 int maxconn = atol(args[2]);
337
338 if (maxconn <= 0) {
339 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
340 return -1;
341 }
342
343 if (!global.stats_fe) {
344 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
345 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
346 return -1;
347 }
348 }
349 global.stats_fe->maxconn = maxconn;
350 }
351 else if (!strcmp(args[1], "bind-process")) { /* enable the socket only on some processes */
352 int cur_arg = 2;
353 unsigned long set = 0;
354
355 if (!global.stats_fe) {
356 if ((global.stats_fe = alloc_stats_fe("GLOBAL", file, line)) == NULL) {
357 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
358 return -1;
359 }
360 }
361
362 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100363 if (strcmp(args[cur_arg], "all") == 0) {
364 set = 0;
365 break;
366 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100367 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100368 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100369 return -1;
370 }
371 cur_arg++;
372 }
373 global.stats_fe->bind_proc = set;
374 }
375 else {
376 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
377 return -1;
378 }
379 return 0;
380}
381
William Lallemand33d29e22019-04-01 11:30:06 +0200382/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200383 * This function exports the bound addresses of a <frontend> in the environment
384 * variable <varname>. Those addresses are separated by semicolons and prefixed
385 * with their type (abns@, unix@, sockpair@ etc)
386 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200387 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200388int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200389{
390 struct buffer *trash = get_trash_chunk();
391 struct bind_conf *bind_conf;
392
William Lallemand9a37fd02019-04-12 16:09:24 +0200393 if (frontend) {
394 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200395 struct listener *l;
396
397 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
398 char addr[46];
399 char port[6];
400
William Lallemand620072b2019-04-12 16:09:25 +0200401 /* separate listener by semicolons */
402 if (trash->data)
403 chunk_appendf(trash, ";");
404
William Lallemand33d29e22019-04-01 11:30:06 +0200405 if (l->addr.ss_family == AF_UNIX) {
406 const struct sockaddr_un *un;
407
408 un = (struct sockaddr_un *)&l->addr;
409 if (un->sun_path[0] == '\0') {
410 chunk_appendf(trash, "abns@%s", un->sun_path+1);
411 } else {
412 chunk_appendf(trash, "unix@%s", un->sun_path);
413 }
414 } else if (l->addr.ss_family == AF_INET) {
415 addr_to_str(&l->addr, addr, sizeof(addr));
416 port_to_str(&l->addr, port, sizeof(port));
417 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
418 } else if (l->addr.ss_family == AF_INET6) {
419 addr_to_str(&l->addr, addr, sizeof(addr));
420 port_to_str(&l->addr, port, sizeof(port));
421 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
422 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
423 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
424 }
William Lallemand33d29e22019-04-01 11:30:06 +0200425 }
426 }
427 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200428 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200429 return -1;
430 }
431
432 return 0;
433}
434
William Lallemand9a37fd02019-04-12 16:09:24 +0200435int cli_socket_setenv()
436{
437 if (listeners_setenv(global.stats_fe, "HAPROXY_CLI") < 0)
438 return -1;
439 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
440 return -1;
441
442 return 0;
443}
444
William Lallemand33d29e22019-04-01 11:30:06 +0200445REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
446
Willy Tarreaude57a572016-11-23 17:01:39 +0100447/* Verifies that the CLI at least has a level at least as high as <level>
448 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
449 * failure, an error message is prepared and the appctx's state is adjusted
450 * to print it so that a return 1 is enough to abort any processing.
451 */
452int cli_has_level(struct appctx *appctx, int level)
453{
Willy Tarreaude57a572016-11-23 17:01:39 +0100454
William Lallemandf630d012018-12-13 09:05:44 +0100455 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau9d008692019-08-09 11:21:01 +0200456 cli_err(appctx, stats_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100457 return 0;
458 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100459 return 1;
460}
461
William Lallemandb7ea1412018-12-13 09:05:47 +0100462/* same as cli_has_level but for the CLI proxy and without error message */
463int pcli_has_level(struct stream *s, int level)
464{
465 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
466 return 0;
467 }
468 return 1;
469}
470
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200471/* Returns severity_output for the current session if set, or default for the socket */
472static int cli_get_severity_output(struct appctx *appctx)
473{
474 if (appctx->cli_severity_output)
475 return appctx->cli_severity_output;
476 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
477}
William Lallemand74c24fb2016-11-21 17:18:36 +0100478
Willy Tarreau41908562016-11-24 16:23:38 +0100479/* Processes the CLI interpreter on the stats socket. This function is called
480 * from the CLI's IO handler running in an appctx context. The function returns 1
481 * if the request was understood, otherwise zero. It is called with appctx->st0
482 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
483 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
484 * have its own I/O handler called again. Most of the time, parsers will only
485 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100486 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
487 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100488 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200489static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100490{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200491 char *args[MAX_STATS_ARGS + 1], *p, *end, *payload = NULL;
492 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100493 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100494
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200495 appctx->st2 = 0;
496 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100497
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200498 p = appctx->chunk->area;
499 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100500
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200501 /*
502 * Get the payload start if there is one.
503 * For the sake of simplicity, the payload pattern is looked up
504 * everywhere from the start of the input but it can only be found
505 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
506 *
507 * The input string was zero terminated so it is safe to use
508 * the str*() functions throughout the parsing
509 */
510 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
511 payload = strstr(p, PAYLOAD_PATTERN);
512 end = payload;
513 /* skip the pattern */
514 payload += strlen(PAYLOAD_PATTERN);
515 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100516
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200517 /*
518 * Get pointers on words.
519 * One extra slot is reserved to store a pointer on a null byte.
520 */
521 while (i < MAX_STATS_ARGS && p < end) {
522 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100523
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200524 /* skip leading spaces/tabs */
525 p += strspn(p, " \t");
526 if (!*p)
527 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100528
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200529 args[i] = p;
530 p += strcspn(p, " \t");
531 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100532
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200533 /* unescape backslashes (\) */
534 for (j = 0, k = 0; args[i][k]; k++) {
535 if (args[i][k] == '\\') {
536 if (args[i][k + 1] == '\\')
537 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100538 else
539 continue;
540 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200541 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 j++;
543 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200544 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100545
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200546 i++;
547 }
548 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200549 p = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200550 for (; i < MAX_STATS_ARGS + 1; i++)
551 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100552
553 kw = cli_find_kw(args);
Willy Tarreaueaffde32016-12-16 17:59:25 +0100554 if (!kw)
Willy Tarreau41908562016-11-24 16:23:38 +0100555 return 0;
556
William Lallemand14721be2018-10-26 14:47:37 +0200557 /* in a worker or normal process, don't display master only commands */
558 if (master == 0 && (kw->level & ACCESS_MASTER_ONLY))
559 return 0;
560
561 /* in master don't displays if we don't have the master bits */
562 if (master == 1 && !(kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
563 return 0;
564
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200565 /* only accept expert commands in expert mode */
566 if ((kw->level & ~appctx->cli_level) & ACCESS_EXPERT)
567 return 0;
568
Willy Tarreau41908562016-11-24 16:23:38 +0100569 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200570 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200571
572 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
573 goto fail;
574
575 /* kw->parse could set its own io_handler or io_release handler */
576 if (!appctx->io_handler)
577 goto fail;
578
579 appctx->st0 = CLI_ST_CALLBACK;
580 return 1;
581fail:
582 appctx->io_handler = NULL;
583 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100584 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100585}
586
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200587/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
588static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
589{
Willy Tarreau83061a82018-07-13 11:56:34 +0200590 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200591
592 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200593 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200594
595 tmp = get_trash_chunk();
596 chunk_reset(tmp);
597
598 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100599 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200600 chunk_printf(tmp, "[%d]: ", severity);
601 }
602 else {
603 switch (severity_output) {
604 case CLI_SEVERITY_NUMBER:
605 chunk_printf(tmp, "[%d]: ", severity);
606 break;
607 case CLI_SEVERITY_STRING:
608 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
609 break;
610 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100611 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200612 }
613 }
614 chunk_appendf(tmp, "%s", msg);
615
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200616 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200617}
618
William Lallemand74c24fb2016-11-21 17:18:36 +0100619/* This I/O handler runs as an applet embedded in a stream interface. It is
620 * used to processes I/O from/to the stats unix socket. The system relies on a
621 * state machine handling requests and various responses. We read a request,
622 * then we process it and send the response, and we possibly display a prompt.
623 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100624 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100625 * or not.
626 */
627static void cli_io_handler(struct appctx *appctx)
628{
629 struct stream_interface *si = appctx->owner;
630 struct channel *req = si_oc(si);
631 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200632 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100633 int reql;
634 int len;
635
636 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
637 goto out;
638
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800639 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200640 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100641 /* buf.size==0 means we failed to get a buffer and were
642 * already subscribed to a wait list to get a buffer.
643 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100644 goto out;
645 }
646
William Lallemand74c24fb2016-11-21 17:18:36 +0100647 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100648 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100649 /* Stats output not initialized yet */
650 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200651 /* reset severity to default at init */
652 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100653 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100654 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100655 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100656 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100657 /* Let's close for real now. We just close the request
658 * side, the conditions below will complete if needed.
659 */
660 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200661 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100662 break;
663 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100664 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200665 char *str;
666
667 /* use a trash chunk to store received data */
668 if (!appctx->chunk) {
669 appctx->chunk = alloc_trash_chunk();
670 if (!appctx->chunk) {
671 appctx->st0 = CLI_ST_END;
672 continue;
673 }
674 }
675
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200676 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200677
William Lallemand74c24fb2016-11-21 17:18:36 +0100678 /* ensure we have some output room left in the event we
679 * would want to return some info right after parsing.
680 */
681 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100682 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100683 break;
684 }
685
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200686 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200687 reql = co_getline(si_oc(si), str,
688 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100689 if (reql <= 0) { /* closed or EOL not found */
690 if (reql == 0)
691 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100692 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 continue;
694 }
695
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200696 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
697 /* seek for a possible unescaped semi-colon. If we find
698 * one, we replace it with an LF and skip only this part.
699 */
700 for (len = 0; len < reql; len++) {
701 if (str[len] == '\\') {
702 len++;
703 continue;
704 }
705 if (str[len] == ';') {
706 str[len] = '\n';
707 reql = len + 1;
708 break;
709 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100710 }
711 }
712
713 /* now it is time to check that we have a full line,
714 * remove the trailing \n and possibly \r, then cut the
715 * line.
716 */
717 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200718 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100719 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100720 continue;
721 }
722
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200723 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100724 len--;
725
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200726 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200727 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200728
729 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200730 appctx->chunk->area[appctx->chunk->data] = '\n';
731 appctx->chunk->area[appctx->chunk->data + 1] = 0;
732 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200733 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100734
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100735 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736
737 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
738 /* empty line */
739 if (!len) {
740 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200741 appctx->chunk->data -= 2;
742 appctx->chunk->area[appctx->chunk->data] = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743
744 if (!cli_parse_request(appctx))
745 cli_gen_usage_msg(appctx);
746
747 chunk_reset(appctx->chunk);
748 /* NB: cli_sock_parse_request() may have put
749 * another CLI_ST_O_* into appctx->st0.
750 */
751
752 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100753 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100754 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200755 else {
756 /*
757 * Look for the "payload start" pattern at the end of a line
758 * Its location is not remembered here, this is just to switch
759 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100760 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200761 if (!strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200762 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200763 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200764 /* no payload, the command is complete: parse the request */
765 if (!cli_parse_request(appctx))
766 cli_gen_usage_msg(appctx);
767
768 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200769 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100770 }
771
772 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200773 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100774 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
775 }
776 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200777 const char *msg;
778 int sev;
779
William Lallemand74c24fb2016-11-21 17:18:36 +0100780 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100781 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100782 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200783 case CLI_ST_PRINT: /* print const message in msg */
784 case CLI_ST_PRINT_ERR: /* print const error in msg */
785 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
786 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
787 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
788 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
789 LOG_ERR : appctx->ctx.cli.severity;
790 msg = appctx->ctx.cli.msg;
791 }
792 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
793 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
794 LOG_ERR : appctx->ctx.cli.severity;
795 msg = appctx->ctx.cli.err;
796 if (!msg) {
797 sev = LOG_ERR;
798 msg = "Out of memory.\n";
799 }
800 }
801 else {
802 sev = LOG_ERR;
803 msg = "Internal error.\n";
804 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200805
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200806 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
807 if (appctx->st0 == CLI_ST_PRINT_FREE ||
808 appctx->st0 == CLI_ST_PRINT_DYN) {
809 free(appctx->ctx.cli.err);
810 appctx->ctx.cli.err = NULL;
811 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100812 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100813 }
814 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100815 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100816 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200817
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100818 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100819 if (appctx->io_handler)
820 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100821 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100822 if (appctx->io_release) {
823 appctx->io_release(appctx);
824 appctx->io_release = NULL;
825 }
826 }
827 break;
828 default: /* abnormal state */
829 si->flags |= SI_FL_ERR;
830 break;
831 }
832
833 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100834 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200835 const char *prompt = "";
836
837 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
838 /*
839 * when entering a payload with interactive mode, change the prompt
840 * to emphasize that more data can still be sent
841 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200842 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200843 prompt = "+ ";
844 else
845 prompt = "\n> ";
846 }
847 else {
William Lallemandad032882019-07-01 10:56:15 +0200848 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200849 prompt = "\n";
850 }
851
852 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100853 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +0100854 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100855 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100856 }
857
858 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100859 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +0100860 break;
861
862 /* Now we close the output if one of the writers did so,
863 * or if we're not in interactive mode and the request
864 * buffer is empty. This still allows pipelined requests
865 * to be sent in non-interactive mode.
866 */
William Lallemand3de09d52018-12-11 16:10:56 +0100867 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
868 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100869 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100870 continue;
871 }
872
873 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100874 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +0200875 /* reactivate the \n at the end of the response for the next command */
876 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +0100877 }
878 }
879
880 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
881 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
882 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
883 /* Other side has closed, let's abort if we have no more processing to do
884 * and nothing more to consume. This is comparable to a broken pipe, so
885 * we forward the close to the request side so that it flows upstream to
886 * the client.
887 */
888 si_shutw(si);
889 }
890
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100891 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100892 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
893 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
894 /* We have no more processing to do, and nothing more to send, and
895 * the client side has closed. So we'll forward this state downstream
896 * on the response buffer.
897 */
898 si_shutr(si);
899 res->flags |= CF_READ_NULL;
900 }
901
902 out:
Christopher Faulet45073512018-07-20 10:16:29 +0200903 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 +0100904 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +0200905 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 +0100906}
907
William Lallemand74c24fb2016-11-21 17:18:36 +0100908/* This is called when the stream interface is closed. For instance, upon an
909 * external abort, we won't call the i/o handler anymore so we may need to
910 * remove back references to the stream currently being dumped.
911 */
912static void cli_release_handler(struct appctx *appctx)
913{
914 if (appctx->io_release) {
915 appctx->io_release(appctx);
916 appctx->io_release = NULL;
917 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200918 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100919 free(appctx->ctx.cli.err);
920 appctx->ctx.cli.err = NULL;
921 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100922}
923
924/* This function dumps all environmnent variables to the buffer. It returns 0
925 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +0100926 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
927 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +0100928 */
Willy Tarreau0a739292016-11-22 20:21:23 +0100929static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100930{
Willy Tarreau0a739292016-11-22 20:21:23 +0100931 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100932 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100933
934 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
935 return 1;
936
937 chunk_reset(&trash);
938
939 /* we have two inner loops here, one for the proxy, the other one for
940 * the buffer.
941 */
Willy Tarreauf6710f82016-12-16 17:45:44 +0100942 while (*var) {
943 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +0100944
Willy Tarreau06d80a92017-10-19 14:32:15 +0200945 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100946 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100947 return 0;
948 }
949 if (appctx->st2 == STAT_ST_END)
950 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +0100951 var++;
952 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +0100953 }
954
955 /* dump complete */
956 return 1;
957}
958
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200959/* This function dumps all file descriptors states (or the requested one) to
960 * the buffer. It returns 0 if the output buffer is full and it needs to be
961 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
962 * It uses cli.i0 as the fd number to restart from.
963 */
964static int cli_io_handler_show_fd(struct appctx *appctx)
965{
966 struct stream_interface *si = appctx->owner;
967 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +0100968 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200969
970 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +0100971 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200972
973 chunk_reset(&trash);
974
Willy Tarreauca1b1572018-12-18 15:45:11 +0100975 /* isolate the threads once per round. We're limited to a buffer worth
976 * of output anyway, it cannot last very long.
977 */
978 thread_isolate();
979
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200980 /* we have two inner loops here, one for the proxy, the other one for
981 * the buffer.
982 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +0100983 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200984 struct fdtab fdt;
Willy Tarreau286ec682017-08-09 16:35:44 +0200985 struct listener *li = NULL;
986 struct server *sv = NULL;
987 struct proxy *px = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +0200988 const struct mux_ops *mux = NULL;
Willy Tarreau35b1b482018-03-28 18:41:30 +0200989 void *ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +0200990 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +0100991 int is_back = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200992
993 fdt = fdtab[fd];
994
Willy Tarreauca1b1572018-12-18 15:45:11 +0100995 if (!fdt.owner)
Willy Tarreau017af242017-10-04 20:24:54 +0200996 goto skip; // closed
997
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +0200998 if (fdt.iocb == conn_fd_handler) {
999 conn_flags = ((struct connection *)fdt.owner)->flags;
Willy Tarreau35b1b482018-03-28 18:41:30 +02001000 mux = ((struct connection *)fdt.owner)->mux;
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001001 ctx = ((struct connection *)fdt.owner)->ctx;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001002 li = objt_listener(((struct connection *)fdt.owner)->target);
1003 sv = objt_server(((struct connection *)fdt.owner)->target);
1004 px = objt_proxy(((struct connection *)fdt.owner)->target);
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001005 is_back = conn_is_back((struct connection *)fdt.owner);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001006 }
1007 else if (fdt.iocb == listener_accept)
1008 li = fdt.owner;
1009
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001010 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001011 " %5d : st=0x%02x(R:%c%c W:%c%c) ev=0x%02x(%c%c%c%c%c) [%c%c] tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001012 fd,
1013 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001014 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1015 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001016 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1017 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1018 fdt.ev,
1019 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1020 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1021 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1022 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1023 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001024 fdt.linger_risk ? 'L' : 'l',
1025 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001026 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001027 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001028 fdt.iocb);
1029 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001030
1031 if (fdt.iocb == conn_fd_handler) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001032 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001033 if (px)
1034 chunk_appendf(&trash, " px=%s", px->id);
1035 else if (sv)
1036 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1037 else if (li)
1038 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001039
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001040 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001041 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001042 if (mux->show_fd)
1043 mux->show_fd(&trash, fdt.owner);
1044 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001045 else
1046 chunk_appendf(&trash, " nomux");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001047 }
1048 else if (fdt.iocb == listener_accept) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001049 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001050 listener_state_str(li),
1051 li->bind_conf->frontend->id);
1052 }
1053
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001054 chunk_appendf(&trash, ")\n");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001055
Willy Tarreau06d80a92017-10-19 14:32:15 +02001056 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001057 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001058 appctx->ctx.cli.i0 = fd;
1059 ret = 0;
1060 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001061 }
1062 skip:
1063 if (appctx->st2 == STAT_ST_END)
1064 break;
1065
1066 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001067 }
1068
Willy Tarreauca1b1572018-12-18 15:45:11 +01001069 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001070 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001071
1072 thread_release();
1073 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001074}
1075
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001076/* This function dumps some activity counters used by developers and support to
1077 * rule out some hypothesis during bug reports. It returns 0 if the output
1078 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1079 * everything at once in the buffer and is not designed to do it in multiple
1080 * passes.
1081 */
1082static int cli_io_handler_show_activity(struct appctx *appctx)
1083{
1084 struct stream_interface *si = appctx->owner;
1085 int thr;
1086
1087 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1088 return 1;
1089
1090 chunk_reset(&trash);
1091
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001092#undef SHOW_TOT
1093#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001094 do { \
1095 unsigned int _v[MAX_THREADS]; \
1096 unsigned int _tot; \
1097 const unsigned int _nbt = global.nbthread; \
1098 for (_tot = t = 0; t < _nbt; t++) \
1099 _tot += _v[t] = (x); \
1100 if (_nbt == 1) { \
1101 chunk_appendf(&trash, " %u\n", _tot); \
1102 break; \
1103 } \
1104 chunk_appendf(&trash, " %u [", _tot); \
1105 for (t = 0; t < _nbt; t++) \
1106 chunk_appendf(&trash, " %u", _v[t]); \
1107 chunk_appendf(&trash, " ]\n"); \
1108 } while (0)
1109
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001110#undef SHOW_AVG
1111#define SHOW_AVG(t, x) \
1112 do { \
1113 unsigned int _v[MAX_THREADS]; \
1114 unsigned int _tot; \
1115 const unsigned int _nbt = global.nbthread; \
1116 for (_tot = t = 0; t < _nbt; t++) \
1117 _tot += _v[t] = (x); \
1118 if (_nbt == 1) { \
1119 chunk_appendf(&trash, " %u\n", _tot); \
1120 break; \
1121 } \
1122 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1123 for (t = 0; t < _nbt; t++) \
1124 chunk_appendf(&trash, " %u", _v[t]); \
1125 chunk_appendf(&trash, " ]\n"); \
1126 } while (0)
1127
Willy Tarreaua0211b82019-05-28 15:09:08 +02001128 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1129 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001130 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001131 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1132 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
1133 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
1134 chunk_appendf(&trash, "poll_drop:"); SHOW_TOT(thr, activity[thr].poll_drop);
1135 chunk_appendf(&trash, "poll_dead:"); SHOW_TOT(thr, activity[thr].poll_dead);
1136 chunk_appendf(&trash, "poll_skip:"); SHOW_TOT(thr, activity[thr].poll_skip);
1137 chunk_appendf(&trash, "fd_lock:"); SHOW_TOT(thr, activity[thr].fd_lock);
1138 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
1139 chunk_appendf(&trash, "stream:"); SHOW_TOT(thr, activity[thr].stream);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001140 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1141 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001142 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1143 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
1144 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1145 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1146 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1147 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1148 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1149 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1150 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1151 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1152 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001153#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001154 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 +02001155#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001156
Willy Tarreaud6a78502019-05-27 07:03:38 +02001157#if defined(DEBUG_DEV)
1158 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001159 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1160 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1161 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001162#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001163
1164 if (ci_putchk(si_ic(si), &trash) == -1) {
1165 chunk_reset(&trash);
1166 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001167 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001168 }
1169
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001170#undef SHOW_AVG
1171#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001172 /* dump complete */
1173 return 1;
1174}
1175
William Lallemandeceddf72016-12-15 18:06:44 +01001176/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001177 * CLI IO handler for `show cli sockets`.
1178 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001179 */
1180static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1181{
1182 struct bind_conf *bind_conf;
1183 struct stream_interface *si = appctx->owner;
1184
1185 chunk_reset(&trash);
1186
1187 switch (appctx->st2) {
1188 case STAT_ST_INIT:
1189 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001190 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001191 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001192 return 0;
1193 }
William Lallemandeceddf72016-12-15 18:06:44 +01001194 appctx->st2 = STAT_ST_LIST;
1195
1196 case STAT_ST_LIST:
1197 if (global.stats_fe) {
1198 list_for_each_entry(bind_conf, &global.stats_fe->conf.bind, by_fe) {
1199 struct listener *l;
1200
1201 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001202 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001203 * if the current node is the first of the list
1204 */
1205
Willy Tarreau3af9d832016-12-16 12:58:09 +01001206 if (appctx->ctx.cli.p0 &&
1207 &bind_conf->by_fe == (&global.stats_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001208 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001209 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001210 continue;
1211 }
1212
1213 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1214
1215 char addr[46];
1216 char port[6];
1217
1218 if (l->addr.ss_family == AF_UNIX) {
1219 const struct sockaddr_un *un;
1220
1221 un = (struct sockaddr_un *)&l->addr;
William Lallemande58915f2019-04-01 11:30:05 +02001222 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001223 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001224 } else {
1225 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1226 }
William Lallemandeceddf72016-12-15 18:06:44 +01001227 } else if (l->addr.ss_family == AF_INET) {
1228 addr_to_str(&l->addr, addr, sizeof(addr));
1229 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001230 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
William Lallemandeceddf72016-12-15 18:06:44 +01001231 } else if (l->addr.ss_family == AF_INET6) {
1232 addr_to_str(&l->addr, addr, sizeof(addr));
1233 port_to_str(&l->addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001234 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
William Lallemand26314342018-10-26 14:47:41 +02001235 } else if (l->addr.ss_family == AF_CUST_SOCKPAIR) {
1236 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001237 } else
William Lallemand26314342018-10-26 14:47:41 +02001238 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001239
William Lallemand07a62f72017-05-24 00:57:40 +02001240 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001241 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001242 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1243 chunk_appendf(&trash, "operator ");
1244 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1245 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001246 else
1247 chunk_appendf(&trash, " ");
1248
1249 if (bind_conf->bind_proc != 0) {
1250 int pos;
Willy Tarreau20c5e522016-12-16 12:50:55 +01001251 for (pos = 0; pos < 8 * sizeof(bind_conf->bind_proc); pos++) {
Willy Tarreau4305ac72016-12-16 12:56:31 +01001252 if (bind_conf->bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001253 chunk_appendf(&trash, "%d,", pos+1);
1254 }
1255 }
1256 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001257 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001258
1259 } else {
1260 chunk_appendf(&trash, "all\n");
1261 }
1262
Willy Tarreau06d80a92017-10-19 14:32:15 +02001263 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001264 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001265 return 0;
1266 }
1267 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001268 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001269 }
1270 }
1271 default:
1272 appctx->st2 = STAT_ST_FIN;
1273 return 1;
1274 }
1275}
1276
1277
Willy Tarreau0a739292016-11-22 20:21:23 +01001278/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001279 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1280 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001281 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001282static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001283{
1284 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001285 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001286
1287 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1288 return 1;
1289
Willy Tarreauf6710f82016-12-16 17:45:44 +01001290 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001291
1292 if (*args[2]) {
1293 int len = strlen(args[2]);
1294
Willy Tarreauf6710f82016-12-16 17:45:44 +01001295 for (; *var; var++) {
1296 if (strncmp(*var, args[2], len) == 0 &&
1297 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001298 break;
1299 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001300 if (!*var)
1301 return cli_err(appctx, "Variable not found\n");
1302
Willy Tarreau0a739292016-11-22 20:21:23 +01001303 appctx->st2 = STAT_ST_END;
1304 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001305 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001306 return 0;
1307}
1308
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001309/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1310 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1311 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1312 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001313static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001314{
1315 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1316 return 1;
1317
1318 appctx->ctx.cli.i0 = 0;
1319
1320 if (*args[2]) {
1321 appctx->ctx.cli.i0 = atoi(args[2]);
1322 appctx->st2 = STAT_ST_END;
1323 }
1324 return 0;
1325}
1326
Willy Tarreau599852e2016-11-22 20:33:32 +01001327/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001328static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001329{
1330 struct stream_interface *si = appctx->owner;
1331 struct stream *s = si_strm(si);
1332
1333 if (strcmp(args[2], "cli") == 0) {
1334 unsigned timeout;
1335 const char *res;
1336
Willy Tarreau9d008692019-08-09 11:21:01 +02001337 if (!*args[3])
1338 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001339
1340 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001341 if (res || timeout < 1)
1342 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001343
1344 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1345 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1346 return 1;
1347 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001348
1349 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001350}
1351
Willy Tarreau2af99412016-11-23 11:10:59 +01001352/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001353static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001354{
1355 int v;
1356
1357 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1358 return 1;
1359
Willy Tarreau9d008692019-08-09 11:21:01 +02001360 if (!*args[3])
1361 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001362
1363 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001364 if (v > global.hardmaxconn)
1365 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001366
1367 /* check for unlimited values */
1368 if (v <= 0)
1369 v = global.hardmaxconn;
1370
1371 global.maxconn = v;
1372
1373 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001374 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001375
1376 return 1;
1377}
1378
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001379static int set_severity_output(int *target, char *argument)
1380{
1381 if (!strcmp(argument, "none")) {
1382 *target = CLI_SEVERITY_NONE;
1383 return 1;
1384 }
1385 else if (!strcmp(argument, "number")) {
1386 *target = CLI_SEVERITY_NUMBER;
1387 return 1;
1388 }
1389 else if (!strcmp(argument, "string")) {
1390 *target = CLI_SEVERITY_STRING;
1391 return 1;
1392 }
1393 return 0;
1394}
1395
1396/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001397static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001398{
1399 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1400 return 0;
1401
Willy Tarreau9d008692019-08-09 11:21:01 +02001402 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001403}
William Lallemandeceddf72016-12-15 18:06:44 +01001404
William Lallemand67a234f2018-12-13 09:05:45 +01001405
1406/* show the level of the current CLI session */
1407static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1408{
William Lallemand67a234f2018-12-13 09:05:45 +01001409 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001410 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001411 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001412 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001413 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001414 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001415 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001416 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001417}
1418
1419/* parse and set the CLI level dynamically */
1420static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1421{
William Lallemandad032882019-07-01 10:56:15 +02001422 /* this will ask the applet to not output a \n after the command */
1423 if (!strcmp(args[1], "-"))
1424 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1425
William Lallemand67a234f2018-12-13 09:05:45 +01001426 if (!strcmp(args[0], "operator")) {
1427 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1428 return 1;
1429 }
1430 appctx->cli_level &= ~ACCESS_LVL_MASK;
1431 appctx->cli_level |= ACCESS_LVL_OPER;
1432
1433 } else if (!strcmp(args[0], "user")) {
1434 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1435 return 1;
1436 }
1437 appctx->cli_level &= ~ACCESS_LVL_MASK;
1438 appctx->cli_level |= ACCESS_LVL_USER;
1439 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001440 appctx->cli_level &= ~ACCESS_EXPERT;
1441 return 1;
1442}
1443
1444
1445/* parse and set the CLI expert-mode dynamically */
1446static int cli_parse_expert_mode(char **args, char *payload, struct appctx *appctx, void *private)
1447{
1448 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1449 return 1;
1450
1451 if (!*args[1])
1452 return (appctx->cli_level & ACCESS_EXPERT)
1453 ? cli_msg(appctx, LOG_INFO, "expert-mode is ON\n")
1454 : cli_msg(appctx, LOG_INFO, "expert-mode is OFF\n");
1455
1456 appctx->cli_level &= ~ACCESS_EXPERT;
1457 if (strcmp(args[1], "on") == 0)
1458 appctx->cli_level |= ACCESS_EXPERT;
William Lallemand67a234f2018-12-13 09:05:45 +01001459 return 1;
1460}
1461
William Lallemanda57b7e32018-12-14 21:11:31 +01001462
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001463int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001464{
1465 return 0;
1466}
1467
Willy Tarreau45c742b2016-11-24 14:51:17 +01001468/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001469static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001470{
1471 int v;
1472 int *res;
1473 int mul = 1;
1474
1475 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1476 return 1;
1477
1478 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1479 res = &global.cps_lim;
1480 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1481 res = &global.sps_lim;
1482#ifdef USE_OPENSSL
1483 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1484 res = &global.ssl_lim;
1485#endif
1486 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1487 res = &global.comp_rate_lim;
1488 mul = 1024;
1489 }
1490 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001491 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001492 "'set rate-limit' only supports :\n"
1493 " - 'connections global' to set the per-process maximum connection rate\n"
1494 " - 'sessions global' to set the per-process maximum session rate\n"
1495#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001496 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001497#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001498 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001499 }
1500
Willy Tarreau9d008692019-08-09 11:21:01 +02001501 if (!*args[4])
1502 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001503
1504 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001505 if (v < 0)
1506 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001507
1508 *res = v * mul;
1509
1510 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001511 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001512
1513 return 1;
1514}
1515
William Lallemandf6975e92017-05-26 17:42:10 +02001516/* parse the "expose-fd" argument on the bind lines */
1517static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1518{
1519 if (!*args[cur_arg + 1]) {
1520 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1521 return ERR_ALERT | ERR_FATAL;
1522 }
1523 if (!strcmp(args[cur_arg+1], "listeners")) {
1524 conf->level |= ACCESS_FD_LISTENERS;
1525 } else {
1526 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1527 args[cur_arg], args[cur_arg+1]);
1528 return ERR_ALERT | ERR_FATAL;
1529 }
1530
1531 return 0;
1532}
1533
William Lallemand74c24fb2016-11-21 17:18:36 +01001534/* parse the "level" argument on the bind lines */
1535static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1536{
1537 if (!*args[cur_arg + 1]) {
1538 memprintf(err, "'%s' : missing level", args[cur_arg]);
1539 return ERR_ALERT | ERR_FATAL;
1540 }
1541
William Lallemand07a62f72017-05-24 00:57:40 +02001542 if (!strcmp(args[cur_arg+1], "user")) {
1543 conf->level &= ~ACCESS_LVL_MASK;
1544 conf->level |= ACCESS_LVL_USER;
1545 } else if (!strcmp(args[cur_arg+1], "operator")) {
1546 conf->level &= ~ACCESS_LVL_MASK;
1547 conf->level |= ACCESS_LVL_OPER;
1548 } else if (!strcmp(args[cur_arg+1], "admin")) {
1549 conf->level &= ~ACCESS_LVL_MASK;
1550 conf->level |= ACCESS_LVL_ADMIN;
1551 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001552 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1553 args[cur_arg], args[cur_arg+1]);
1554 return ERR_ALERT | ERR_FATAL;
1555 }
1556
1557 return 0;
1558}
1559
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001560static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1561{
1562 if (!*args[cur_arg + 1]) {
1563 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1564 return ERR_ALERT | ERR_FATAL;
1565 }
1566
1567 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1568 return 0;
1569 else {
1570 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1571 args[cur_arg], args[cur_arg+1]);
1572 return ERR_ALERT | ERR_FATAL;
1573 }
1574}
1575
William Lallemandd308c5e2020-01-16 16:26:41 +01001576/*
1577 * For one proxy, fill the iov and send the msghdr. Also update fd_it and offset.
1578 * Return -1 upon error, otherwise 0.
1579 *
1580 * This function is only meant to deduplicate the code between the peers and
1581 * the proxy list in _getsocks(), not to be used anywhere else.
1582 */
1583inline static int _getsocks_gen_send(struct proxy *px, int sendfd, int *tmpfd, struct iovec *iov,
1584 int tot_fd_nb, int *fd_it, int *offset, struct msghdr *msghdr)
1585{
1586 int i = *fd_it;
1587 int curoff = *offset;
1588 struct listener *l;
1589 unsigned char *tmpbuf = iov->iov_base;
1590
1591 list_for_each_entry(l, &px->conf.listeners, by_fe) {
1592 int ret;
1593 /* Only transfer IPv4/IPv6 sockets */
1594 if (l->state >= LI_ZOMBIE &&
1595 (l->proto->sock_family == AF_INET ||
1596 l->proto->sock_family == AF_INET6 ||
1597 l->proto->sock_family == AF_UNIX)) {
1598 memcpy(&tmpfd[i % MAX_SEND_FD], &l->fd, sizeof(l->fd));
1599 if (!l->netns)
1600 tmpbuf[curoff++] = 0;
1601#ifdef USE_NS
1602 else {
1603 char *name = l->netns->node.key;
1604 unsigned char len = l->netns->name_len;
1605 tmpbuf[curoff++] = len;
1606 memcpy(tmpbuf + curoff, name, len);
1607 curoff += len;
1608 }
1609#endif
1610 if (l->interface) {
1611 unsigned char len = strlen(l->interface);
1612 tmpbuf[curoff++] = len;
1613 memcpy(tmpbuf + curoff, l->interface, len);
1614 curoff += len;
1615 } else
1616 tmpbuf[curoff++] = 0;
1617 memcpy(tmpbuf + curoff, &l->options,
1618 sizeof(l->options));
1619 curoff += sizeof(l->options);
1620
1621 i++;
1622 } else
1623 continue;
1624 /* if it reaches the max number of fd per msghdr */
1625 if ((!(i % MAX_SEND_FD))) {
1626 iov->iov_len = curoff;
1627 if (sendmsg(sendfd, msghdr, 0) != curoff) {
1628 ha_warning("Failed to transfer sockets\n");
1629 return -1;
1630 }
1631 /* Wait for an ack */
1632 do {
1633 ret = recv(sendfd, &tot_fd_nb,
1634 sizeof(tot_fd_nb), 0);
1635 } while (ret == -1 && errno == EINTR);
1636 if (ret <= 0) {
1637 ha_warning("Unexpected error while transferring sockets\n");
1638 return -1;
1639 }
1640 curoff = 0;
1641 }
1642 }
1643
1644 *fd_it = i;
1645 *offset = curoff;
1646
1647 return 0;
1648}
William Lallemand16dd1b32018-11-19 18:46:18 +01001649
William Lallemandb9f9e3b2018-10-26 14:47:39 +02001650
Olivier Houchardf886e342017-04-05 22:24:59 +02001651/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001652static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001653{
1654 char *cmsgbuf = NULL;
1655 unsigned char *tmpbuf = NULL;
1656 struct cmsghdr *cmsg;
1657 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001658 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001659 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001660 struct msghdr msghdr;
1661 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001662 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Olivier Houchardf886e342017-04-05 22:24:59 +02001663 int *tmpfd;
1664 int tot_fd_nb = 0;
1665 struct proxy *px;
William Lallemand5fd3b282020-01-16 15:32:08 +01001666 struct peers *prs;
Olivier Houchardf886e342017-04-05 22:24:59 +02001667 int i = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001668 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001669 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001670 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001671 int ret;
1672
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001673 if (!remote) {
1674 ha_warning("Only works on real connections\n");
1675 goto out;
1676 }
1677
1678 fd = remote->handle.fd;
1679
Olivier Houchardf886e342017-04-05 22:24:59 +02001680 /* Temporary set the FD in blocking mode, that will make our life easier */
1681 old_fcntl = fcntl(fd, F_GETFL);
1682 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001683 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001684 goto out;
1685 }
1686 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1687 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001688 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001689 goto out;
1690 }
1691 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001692 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001693 goto out;
1694 }
Olivier Houchard54740872017-04-06 14:45:14 +02001695 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001696 iov.iov_base = &tot_fd_nb;
1697 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001698 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001699 goto out;
1700 memset(&msghdr, 0, sizeof(msghdr));
1701 /*
1702 * First, calculates the total number of FD, so that we can let
1703 * the caller know how much he should expects.
1704 */
Olivier Houchardfbc74e82017-11-24 16:54:05 +01001705 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001706 while (px) {
1707 struct listener *l;
1708
1709 list_for_each_entry(l, &px->conf.listeners, by_fe) {
Olivier Houchard1fc05162017-04-06 01:05:05 +02001710 /* Only transfer IPv4/IPv6/UNIX sockets */
1711 if (l->state >= LI_ZOMBIE &&
1712 (l->proto->sock_family == AF_INET ||
Olivier Houchardf886e342017-04-05 22:24:59 +02001713 l->proto->sock_family == AF_INET6 ||
Olivier Houchard1fc05162017-04-06 01:05:05 +02001714 l->proto->sock_family == AF_UNIX))
Olivier Houchardf886e342017-04-05 22:24:59 +02001715 tot_fd_nb++;
1716 }
1717 px = px->next;
1718 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001719 prs = cfg_peers;
1720 while (prs) {
1721 if (prs->peers_fe) {
1722 struct listener *l;
1723
1724 list_for_each_entry(l, &prs->peers_fe->conf.listeners, by_fe) {
1725 /* Only transfer IPv4/IPv6/UNIX sockets */
1726 if (l->state >= LI_ZOMBIE &&
1727 (l->proto->sock_family == AF_INET ||
1728 l->proto->sock_family == AF_INET6 ||
1729 l->proto->sock_family == AF_UNIX))
1730 tot_fd_nb++;
1731 }
1732 }
1733 prs = prs->next;
1734 }
Olivier Houchardf886e342017-04-05 22:24:59 +02001735 if (tot_fd_nb == 0)
1736 goto out;
1737
1738 /* First send the total number of file descriptors, so that the
1739 * receiving end knows what to expect.
1740 */
1741 msghdr.msg_iov = &iov;
1742 msghdr.msg_iovlen = 1;
1743 ret = sendmsg(fd, &msghdr, 0);
1744 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001745 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001746 goto out;
1747 }
1748
1749 /* Now send the fds */
1750 msghdr.msg_control = cmsgbuf;
1751 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1752 cmsg = CMSG_FIRSTHDR(&msghdr);
1753 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1754 cmsg->cmsg_level = SOL_SOCKET;
1755 cmsg->cmsg_type = SCM_RIGHTS;
1756 tmpfd = (int *)CMSG_DATA(cmsg);
1757
Olivier Houchardf886e342017-04-05 22:24:59 +02001758 /* For each socket, e message is sent, containing the following :
1759 * Size of the namespace name (or 0 if none), as an unsigned char.
1760 * The namespace name, if any
1761 * Size of the interface name (or 0 if none), as an unsigned char
1762 * The interface name, if any
1763 * Listener options, as an int.
1764 */
1765 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001766 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001767 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001768 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001769 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001770 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001771 goto out;
1772 }
1773 iov.iov_base = tmpbuf;
William Lallemand5fd3b282020-01-16 15:32:08 +01001774 px = proxies_list;
Olivier Houchardf886e342017-04-05 22:24:59 +02001775 while (px) {
William Lallemandd308c5e2020-01-16 16:26:41 +01001776 if (_getsocks_gen_send(px, fd, tmpfd, &iov,
1777 tot_fd_nb, &i, &curoff, &msghdr) < 0)
1778 goto out;
Olivier Houchardf886e342017-04-05 22:24:59 +02001779 px = px->next;
1780 }
William Lallemand5fd3b282020-01-16 15:32:08 +01001781 /* should be done for peers too */
1782 prs = cfg_peers;
1783 while (prs) {
William Lallemandd308c5e2020-01-16 16:26:41 +01001784 if (prs->peers_fe)
1785 if (_getsocks_gen_send(prs->peers_fe, fd, tmpfd, &iov,
1786 tot_fd_nb, &i, &curoff, &msghdr) < 0)
1787 goto out;
William Lallemand5fd3b282020-01-16 15:32:08 +01001788 prs = prs->next;
1789 }
1790
Olivier Houchardf886e342017-04-05 22:24:59 +02001791 if (i % MAX_SEND_FD) {
1792 iov.iov_len = curoff;
1793 cmsg->cmsg_len = CMSG_LEN((i % MAX_SEND_FD) * sizeof(int));
1794 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * (i % MAX_SEND_FD));
1795 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001796 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001797 goto out;
1798 }
1799 }
1800
1801out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001802 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001803 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001804 goto out;
1805 }
1806 appctx->st0 = CLI_ST_END;
1807 free(cmsgbuf);
1808 free(tmpbuf);
1809 return 1;
1810}
1811
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001812static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
1813{
1814 if (*args[0] == 'h')
1815 /* help */
1816 cli_gen_usage_msg(appctx);
1817 else if (*args[0] == 'p')
1818 /* prompt */
1819 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
1820 else if (*args[0] == 'q')
1821 /* quit */
1822 appctx->st0 = CLI_ST_END;
1823
1824 return 1;
1825}
Olivier Houchardf886e342017-04-05 22:24:59 +02001826
William Lallemand2f4ce202018-10-26 14:47:47 +02001827void pcli_write_prompt(struct stream *s)
1828{
1829 struct buffer *msg = get_trash_chunk();
1830 struct channel *oc = si_oc(&s->si[0]);
1831
William Lallemanddc12c2e2018-12-13 09:05:46 +01001832 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01001833 return;
1834
William Lallemanddc12c2e2018-12-13 09:05:46 +01001835 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01001836 chunk_appendf(msg, "+ ");
1837 } else {
1838 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01001839 chunk_appendf(msg, "master%s> ",
1840 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01001841 else
1842 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
1843 }
William Lallemand2f4ce202018-10-26 14:47:47 +02001844 co_inject(oc, msg->area, msg->data);
1845}
1846
William Lallemand291810d2018-10-26 14:47:38 +02001847
William Lallemandcf62f7e2018-10-26 14:47:40 +02001848/* The pcli_* functions are used for the CLI proxy in the master */
1849
William Lallemanddeeaa592018-10-26 14:47:48 +02001850void pcli_reply_and_close(struct stream *s, const char *msg)
1851{
1852 struct buffer *buf = get_trash_chunk();
1853
1854 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001855 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02001856}
1857
William Lallemand291810d2018-10-26 14:47:38 +02001858static enum obj_type *pcli_pid_to_server(int proc_pid)
1859{
1860 struct mworker_proc *child;
1861
William Lallemandbddd33a2018-12-11 16:10:53 +01001862 /* return the CLI applet of the master */
1863 if (proc_pid == 0)
1864 return &cli_applet.obj_type;
1865
William Lallemand291810d2018-10-26 14:47:38 +02001866 list_for_each_entry(child, &proc_list, list) {
1867 if (child->pid == proc_pid){
1868 return &child->srv->obj_type;
1869 }
1870 }
1871 return NULL;
1872}
1873
1874/* Take a CLI prefix in argument (eg: @!1234 @master @1)
1875 * Return:
1876 * 0: master
1877 * > 0: pid of a worker
1878 * < 0: didn't find a worker
1879 */
1880static int pcli_prefix_to_pid(const char *prefix)
1881{
1882 int proc_pid;
1883 struct mworker_proc *child;
1884 char *errtol = NULL;
1885
1886 if (*prefix != '@') /* not a prefix, should not happen */
1887 return -1;
1888
1889 prefix++;
1890 if (!*prefix) /* sent @ alone, return the master */
1891 return 0;
1892
1893 if (strcmp("master", prefix) == 0) {
1894 return 0;
1895 } else if (*prefix == '!') {
1896 prefix++;
1897 if (!*prefix)
1898 return -1;
1899
1900 proc_pid = strtol(prefix, &errtol, 10);
1901 if (*errtol != '\0')
1902 return -1;
1903 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001904 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001905 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001906 if (child->pid == proc_pid){
1907 return child->pid;
1908 }
1909 }
1910 } else {
1911 struct mworker_proc *chosen = NULL;
1912 /* this is a relative pid */
1913
1914 proc_pid = strtol(prefix, &errtol, 10);
1915 if (*errtol != '\0')
1916 return -1;
1917
1918 if (proc_pid == 0) /* return the master */
1919 return 0;
1920
1921 /* chose the right process, the current one is the one with the
1922 least number of reloads */
1923 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02001924 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01001925 continue;
William Lallemand291810d2018-10-26 14:47:38 +02001926 if (child->relative_pid == proc_pid){
1927 if (child->reloads == 0)
1928 return child->pid;
1929 else if (chosen == NULL || child->reloads < chosen->reloads)
1930 chosen = child;
1931 }
1932 }
1933 if (chosen)
1934 return chosen->pid;
1935 }
1936 return -1;
1937}
1938
William Lallemandbddd33a2018-12-11 16:10:53 +01001939/* Return::
1940 * >= 0 : number of words to escape
1941 * = -1 : error
1942 */
1943
1944int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
1945{
1946 if (argl < 1)
1947 return 0;
1948
1949 /* there is a prefix */
1950 if (args[0][0] == '@') {
1951 int target_pid = pcli_prefix_to_pid(args[0]);
1952
1953 if (target_pid == -1) {
1954 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
1955 return -1;
1956 }
1957
1958 /* if the prefix is alone, define a default target */
1959 if (argl == 1)
1960 s->pcli_next_pid = target_pid;
1961 else
1962 *next_pid = target_pid;
1963 return 1;
William Lallemand5b80fa22018-12-11 16:10:54 +01001964 } else if (!strcmp("prompt", args[0])) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01001965 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01001966 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01001967
1968 } else if (!strcmp("quit", args[0])) {
1969 channel_shutr_now(&s->req);
1970 channel_shutw_now(&s->res);
1971 return argl; /* return the number of elements in the array */
William Lallemandb7ea1412018-12-13 09:05:47 +01001972 } else if (!strcmp(args[0], "operator")) {
1973 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
1974 memprintf(errmsg, "Permission denied!\n");
1975 return -1;
1976 }
1977 s->pcli_flags &= ~ACCESS_LVL_MASK;
1978 s->pcli_flags |= ACCESS_LVL_OPER;
1979 return argl;
1980
1981 } else if (!strcmp(args[0], "user")) {
1982 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
1983 memprintf(errmsg, "Permission denied!\n");
1984 return -1;
1985 }
1986 s->pcli_flags &= ~ACCESS_LVL_MASK;
1987 s->pcli_flags |= ACCESS_LVL_USER;
1988 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01001989 }
1990
1991 return 0;
1992}
1993
1994/*
1995 * Parse the CLI request:
1996 * - It does basically the same as the cli_io_handler, but as a proxy
1997 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02001998 *
1999 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002000 * - the number of characters to forward or
2001 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002002 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002003int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002004{
William Lallemandbddd33a2018-12-11 16:10:53 +01002005 char *str = (char *)ci_head(req);
2006 char *end = (char *)ci_stop(req);
2007 char *args[MAX_STATS_ARGS + 1]; /* +1 for storing a NULL */
2008 int argl; /* number of args */
2009 char *p;
2010 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002011 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002012 int wtrim = 0; /* number of words to trim */
2013 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002014 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002015 int i = 0;
2016
2017 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002018
William Lallemanddc12c2e2018-12-13 09:05:46 +01002019 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002020
2021 /* Looks for the end of one command */
2022 while (p+reql < end) {
2023 /* handle escaping */
2024 if (p[reql] == '\\') {
2025 reql++;
2026 continue;
2027 }
2028 if (p[reql] == ';' || p[reql] == '\n') {
2029 /* found the end of the command */
2030 p[reql] = '\n';
2031 reql++;
2032 break;
2033 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002034 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002035 }
William Lallemandebf61802018-12-11 16:10:57 +01002036 } else {
2037 while (p+reql < end) {
2038 if (p[reql] == '\n') {
2039 /* found the end of the line */
2040 reql++;
2041 break;
2042 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002043 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002044 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002045 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002046
William Lallemandbddd33a2018-12-11 16:10:53 +01002047 /* set end to first byte after the end of the command */
2048 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002049
William Lallemandbddd33a2018-12-11 16:10:53 +01002050 /* there is no end to this command, need more to parse ! */
2051 if (*(end-1) != '\n') {
2052 return -1;
2053 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002054
William Lallemand3301f3e2018-12-13 09:05:48 +01002055 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2056 if (reql == 1) /* last line of the payload */
2057 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002058 return reql;
2059 }
2060
William Lallemandbddd33a2018-12-11 16:10:53 +01002061 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002062
William Lallemandbddd33a2018-12-11 16:10:53 +01002063 /* splits the command in words */
2064 while (i < MAX_STATS_ARGS && p < end) {
2065 int j, k;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002066
William Lallemandbddd33a2018-12-11 16:10:53 +01002067 /* skip leading spaces/tabs */
2068 p += strspn(p, " \t");
2069 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002070 break;
2071
William Lallemandbddd33a2018-12-11 16:10:53 +01002072 args[i] = p;
2073 p += strcspn(p, " \t");
2074 *p++ = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002075
William Lallemandbddd33a2018-12-11 16:10:53 +01002076 /* unescape backslashes (\) */
2077 for (j = 0, k = 0; args[i][k]; k++) {
2078 if (args[i][k] == '\\') {
2079 if (args[i][k + 1] == '\\')
2080 k++;
2081 else
2082 continue;
2083 }
2084 args[i][j] = args[i][k];
2085 j++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002086 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002087 args[i][j] = 0;
2088 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002089 }
2090
William Lallemandbddd33a2018-12-11 16:10:53 +01002091 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002092
William Lallemandbddd33a2018-12-11 16:10:53 +01002093 for (; i < MAX_STATS_ARGS + 1; i++)
2094 args[i] = NULL;
2095
2096 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2097
2098 /* End of words are ending by \0, we need to replace the \0s by spaces
20991 before forwarding them */
2100 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002101 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002102 if (*p == '\0')
2103 *p = ' ';
2104 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002105 }
2106
William Lallemand3301f3e2018-12-13 09:05:48 +01002107 payload = strstr(str, PAYLOAD_PATTERN);
2108 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2109 /* if the payload pattern is at the end */
2110 s->pcli_flags |= PCLI_F_PAYLOAD;
2111 ret = reql;
2112 }
2113
William Lallemandbddd33a2018-12-11 16:10:53 +01002114 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002115
William Lallemandbddd33a2018-12-11 16:10:53 +01002116 if (wtrim > 0) {
2117 trim = &args[wtrim][0];
2118 if (trim == NULL) /* if this was the last word in the table */
2119 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002120
William Lallemandbddd33a2018-12-11 16:10:53 +01002121 b_del(&req->buf, trim - str);
2122
William Lallemandb7ea1412018-12-13 09:05:47 +01002123 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002124 } else if (wtrim < 0) {
2125 /* parsing error */
2126 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002127 } else {
2128 /* the whole string */
2129 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002130 }
2131
William Lallemandb7ea1412018-12-13 09:05:47 +01002132 if (ret > 1) {
2133 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2134 goto end;
2135 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002136 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2137 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002138 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002139 ci_insert_line2(req, 0, "user -", strlen("user -"));
2140 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002141 }
2142 }
2143end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002144
William Lallemandb7ea1412018-12-13 09:05:47 +01002145 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002146}
2147
2148int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2149{
William Lallemandbddd33a2018-12-11 16:10:53 +01002150 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002151 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002152 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002153
William Lallemandb7ea1412018-12-13 09:05:47 +01002154 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2155 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2156
William Lallemandcf62f7e2018-10-26 14:47:40 +02002157read_again:
2158 /* if the channel is closed for read, we won't receive any more data
2159 from the client, but we don't want to forward this close to the
2160 server */
2161 channel_dont_close(req);
2162
2163 /* We don't know yet to which server we will connect */
2164 channel_dont_connect(req);
2165
2166
2167 /* we are not waiting for a response, there is no more request and we
2168 * receive a close from the client, we can leave */
2169 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2170 channel_shutw_now(&s->res);
2171 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2172 return 1;
2173 }
2174
2175 req->flags |= CF_READ_DONTWAIT;
2176
2177 /* need more data */
2178 if (!ci_data(req))
2179 return 0;
2180
2181 /* If there is data available for analysis, log the end of the idle time. */
2182 if (c_data(req) && s->logs.t_idle == -1)
2183 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2184
William Lallemandbddd33a2018-12-11 16:10:53 +01002185 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002186 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002187 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002188 /* enough data */
2189
William Lallemandcf62f7e2018-10-26 14:47:40 +02002190 /* forward only 1 command */
2191 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002192
William Lallemanddc12c2e2018-12-13 09:05:46 +01002193 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002194 /* we send only 1 command per request, and we write close after it */
2195 channel_shutw_now(req);
2196 } else {
2197 pcli_write_prompt(s);
2198 }
2199
2200 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002201
2202 /* remove the XFER_DATA analysers, which forwards all
2203 * the data, we don't want to forward the next requests
2204 * We need to add CF_FLT_ANALYZE to abort the forward too.
2205 */
2206 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2207 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2208 s->res.analysers |= AN_RES_WAIT_CLI;
2209
William Lallemandebf61802018-12-11 16:10:57 +01002210 if (!(s->flags & SF_ASSIGNED)) {
2211 if (next_pid > -1)
2212 target_pid = next_pid;
2213 else
2214 target_pid = s->pcli_next_pid;
2215 /* we can connect now */
2216 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002217
William Lallemandebf61802018-12-11 16:10:57 +01002218 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2219 channel_auto_connect(req);
2220 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002221
2222 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002223 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002224 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002225 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002226 } else if (to_forward == -1 && errmsg) {
2227 /* there was an error during the parsing */
2228 pcli_reply_and_close(s, errmsg);
2229 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002230 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2231 /* buffer is full and we didn't catch the end of a command */
2232 goto send_help;
2233 }
2234
2235 return 0;
2236
2237send_help:
2238 b_reset(&req->buf);
2239 b_putblk(&req->buf, "help\n", 5);
2240 goto read_again;
2241}
2242
2243int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2244{
2245 struct proxy *fe = strm_fe(s);
2246 struct proxy *be = s->be;
2247
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002248 if (rep->flags & CF_READ_ERROR) {
2249 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2250 s->res.analysers &= ~AN_RES_WAIT_CLI;
2251 return 0;
2252 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002253 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2254 rep->flags |= CF_NEVER_WAIT;
2255
2256 /* don't forward the close */
2257 channel_dont_close(&s->res);
2258 channel_dont_close(&s->req);
2259
William Lallemanddc12c2e2018-12-13 09:05:46 +01002260 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002261 s->req.analysers |= AN_REQ_WAIT_CLI;
2262 s->res.analysers &= ~AN_RES_WAIT_CLI;
2263 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2264 return 0;
2265 }
2266
William Lallemandcf62f7e2018-10-26 14:47:40 +02002267 /* forward the data */
2268 if (ci_data(rep)) {
2269 c_adv(rep, ci_data(rep));
2270 return 0;
2271 }
2272
2273 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2274 /* stream cleanup */
2275
William Lallemand2f4ce202018-10-26 14:47:47 +02002276 pcli_write_prompt(s);
2277
William Lallemandcf62f7e2018-10-26 14:47:40 +02002278 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2279 si_shutr(&s->si[1]);
2280 si_shutw(&s->si[1]);
2281
2282 /*
2283 * starting from there this the same code as
2284 * http_end_txn_clean_session().
2285 *
2286 * It allows to do frontend keepalive while reconnecting to a
2287 * new server for each request.
2288 */
2289
2290 if (s->flags & SF_BE_ASSIGNED) {
2291 HA_ATOMIC_SUB(&be->beconn, 1);
2292 if (unlikely(s->srv_conn))
2293 sess_change_server(s, NULL);
2294 }
2295
2296 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2297 stream_process_counters(s);
2298
2299 /* don't count other requests' data */
2300 s->logs.bytes_in -= ci_data(&s->req);
2301 s->logs.bytes_out -= ci_data(&s->res);
2302
2303 /* we may need to know the position in the queue */
2304 pendconn_free(s);
2305
2306 /* let's do a final log if we need it */
2307 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2308 !(s->flags & SF_MONITOR) &&
2309 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2310 s->do_log(s);
2311 }
2312
2313 /* stop tracking content-based counters */
2314 stream_stop_content_counters(s);
2315 stream_update_time_stats(s);
2316
2317 s->logs.accept_date = date; /* user-visible date for logging */
2318 s->logs.tv_accept = now; /* corrected date for internal use */
2319 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2320 s->logs.t_idle = -1;
2321 tv_zero(&s->logs.tv_request);
2322 s->logs.t_queue = -1;
2323 s->logs.t_connect = -1;
2324 s->logs.t_data = -1;
2325 s->logs.t_close = 0;
2326 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2327 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2328
2329 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2330 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2331
2332 stream_del_srv_conn(s);
2333 if (objt_server(s->target)) {
2334 if (s->flags & SF_CURR_SESS) {
2335 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002336 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002337 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002338 if (may_dequeue_tasks(__objt_server(s->target), be))
2339 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002340 }
2341
2342 s->target = NULL;
2343
2344 /* only release our endpoint if we don't intend to reuse the
2345 * connection.
2346 */
2347 if (!si_conn_ready(&s->si[1])) {
2348 si_release_endpoint(&s->si[1]);
2349 s->srv_conn = NULL;
2350 }
2351
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002352 sockaddr_free(&s->target_addr);
2353
William Lallemandcf62f7e2018-10-26 14:47:40 +02002354 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2355 s->si[1].err_type = SI_ET_NONE;
2356 s->si[1].conn_retries = 0; /* used for logging too */
2357 s->si[1].exp = TICK_ETERNITY;
2358 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet22dc2482019-07-16 14:43:08 +02002359 s->req.flags &= ~(CF_SHUTW|CF_SHUTW_NOW|CF_AUTO_CONNECT|CF_WRITE_ERROR|CF_STREAMER|CF_STREAMER_FAST|CF_NEVER_WAIT|CF_WROTE_DATA);
William Lallemand19338012019-06-25 18:00:19 +02002360 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 +02002361 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2362 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2363 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2364 /* reinitialise the current rule list pointer to NULL. We are sure that
2365 * any rulelist match the NULL pointer.
2366 */
2367 s->current_rule_list = NULL;
2368
2369 s->be = strm_fe(s);
2370 s->logs.logwait = strm_fe(s)->to_log;
2371 s->logs.level = 0;
2372 stream_del_srv_conn(s);
2373 s->target = NULL;
2374 /* re-init store persistence */
2375 s->store_count = 0;
2376 s->uniq_id = global.req_count++;
2377
2378 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2379
2380 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2381
2382 s->req.analysers |= AN_REQ_WAIT_CLI;
2383 s->res.analysers &= ~AN_RES_WAIT_CLI;
2384
2385 /* We must trim any excess data from the response buffer, because we
2386 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002387 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002388 * we want those data to come along with next response. A typical
2389 * example of such data would be from a buggy server responding to
2390 * a HEAD with some data, or sending more than the advertised
2391 * content-length.
2392 */
2393 if (unlikely(ci_data(&s->res)))
2394 b_set_data(&s->res.buf, co_data(&s->res));
2395
2396 /* Now we can realign the response buffer */
2397 c_realign_if_empty(&s->res);
2398
2399 s->req.rto = strm_fe(s)->timeout.client;
2400 s->req.wto = TICK_ETERNITY;
2401
2402 s->res.rto = TICK_ETERNITY;
2403 s->res.wto = strm_fe(s)->timeout.client;
2404
2405 s->req.rex = TICK_ETERNITY;
2406 s->req.wex = TICK_ETERNITY;
2407 s->req.analyse_exp = TICK_ETERNITY;
2408 s->res.rex = TICK_ETERNITY;
2409 s->res.wex = TICK_ETERNITY;
2410 s->res.analyse_exp = TICK_ETERNITY;
2411 s->si[1].hcto = TICK_ETERNITY;
2412
2413 /* we're removing the analysers, we MUST re-enable events detection.
2414 * We don't enable close on the response channel since it's either
2415 * already closed, or in keep-alive with an idle connection handler.
2416 */
2417 channel_auto_read(&s->req);
2418 channel_auto_close(&s->req);
2419 channel_auto_read(&s->res);
2420
2421
2422 return 1;
2423 }
2424 return 0;
2425}
2426
William Lallemand8a022572018-10-26 14:47:35 +02002427/*
2428 * The mworker functions are used to initialize the CLI in the master process
2429 */
2430
William Lallemand309dc9a2018-10-26 14:47:45 +02002431 /*
2432 * Stop the mworker proxy
2433 */
2434void mworker_cli_proxy_stop()
2435{
William Lallemand550db6d2018-11-06 17:37:12 +01002436 if (mworker_proxy)
2437 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002438}
2439
William Lallemand8a022572018-10-26 14:47:35 +02002440/*
2441 * Create the mworker CLI proxy
2442 */
2443int mworker_cli_proxy_create()
2444{
2445 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002446 char *msg = NULL;
2447 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002448
2449 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2450 if (!mworker_proxy)
2451 return -1;
2452
2453 init_new_proxy(mworker_proxy);
2454 mworker_proxy->next = proxies_list;
2455 proxies_list = mworker_proxy;
2456 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002457 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002458 mworker_proxy->state = PR_STNEW;
2459 mworker_proxy->last_change = now.tv_sec;
2460 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2461 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2462 mworker_proxy->timeout.client = 0; /* no timeout */
2463 mworker_proxy->conf.file = strdup("MASTER");
2464 mworker_proxy->conf.line = 0;
2465 mworker_proxy->accept = frontend_accept;
2466 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2467
2468 /* Does not init the default target the CLI applet, but must be done in
2469 * the request parsing code */
2470 mworker_proxy->default_target = NULL;
2471
2472 /* the check_config_validity() will get an ID for the proxy */
2473 mworker_proxy->uuid = -1;
2474
2475 proxy_store_name(mworker_proxy);
2476
2477 /* create all servers using the mworker_proc list */
2478 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002479 struct server *newsrv = NULL;
2480 struct sockaddr_storage *sk;
2481 int port1, port2, port;
2482 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002483
William Lallemanda31b09e2020-01-14 15:25:02 +01002484 /* only the workers support the master CLI */
2485 if (!(child->options & PROC_O_TYPE_WORKER))
2486 continue;
2487
William Lallemand8a022572018-10-26 14:47:35 +02002488 newsrv = new_server(mworker_proxy);
2489 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002490 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002491
2492 /* we don't know the new pid yet */
2493 if (child->pid == -1)
2494 memprintf(&msg, "cur-%d", child->relative_pid);
2495 else
2496 memprintf(&msg, "old-%d", child->pid);
2497
2498 newsrv->next = mworker_proxy->srv;
2499 mworker_proxy->srv = newsrv;
2500 newsrv->conf.file = strdup(msg);
2501 newsrv->id = strdup(msg);
2502 newsrv->conf.line = 0;
2503
2504 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002505 if ((sk = str2sa_range(msg, &port, &port1, &port2, &errmsg, NULL, NULL, 0)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002506 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002507 }
2508 free(msg);
2509 msg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002510
2511 proto = protocol_by_family(sk->ss_family);
2512 if (!proto || !proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002513 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002514 }
2515
2516 /* no port specified */
2517 newsrv->flags |= SRV_F_MAPPORTS;
2518 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002519 /* don't let the server participate to load balancing */
2520 newsrv->iweight = 0;
2521 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002522 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002523
2524 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002525 }
2526 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002527
2528error:
2529 ha_alert("%s\n", errmsg);
2530
2531 list_for_each_entry(child, &proc_list, list) {
2532 free((char *)child->srv->conf.file); /* cast because of const char * */
2533 free(child->srv->id);
2534 free(child->srv);
2535 child->srv = NULL;
2536 }
2537 free(mworker_proxy->id);
2538 free(mworker_proxy->conf.file);
2539 free(mworker_proxy);
2540 mworker_proxy = NULL;
2541 free(errmsg);
2542 free(msg);
2543
2544 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002545}
Olivier Houchardf886e342017-04-05 22:24:59 +02002546
William Lallemandce83b4a2018-10-26 14:47:30 +02002547/*
William Lallemande7361152018-10-26 14:47:36 +02002548 * Create a new listener for the master CLI proxy
2549 */
2550int mworker_cli_proxy_new_listener(char *line)
2551{
2552 struct bind_conf *bind_conf;
2553 struct listener *l;
2554 char *err = NULL;
2555 char *args[MAX_LINE_ARGS + 1];
2556 int arg;
2557 int cur_arg;
2558
William Lallemand2e945c82019-11-25 09:58:37 +01002559 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002560 args[0] = line;
2561
2562 /* args is a bind configuration with spaces replaced by commas */
2563 while (*line && arg < MAX_LINE_ARGS) {
2564
2565 if (*line == ',') {
2566 *line++ = '\0';
2567 while (*line == ',')
2568 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002569 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002570 }
2571 line++;
2572 }
2573
William Lallemand2e945c82019-11-25 09:58:37 +01002574 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002575
2576 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002577 if (!bind_conf)
2578 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002579
2580 bind_conf->level &= ~ACCESS_LVL_MASK;
2581 bind_conf->level |= ACCESS_LVL_ADMIN;
2582
2583 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2584 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002585 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002586 }
2587
2588 cur_arg = 1;
2589
2590 while (*args[cur_arg]) {
2591 static int bind_dumped;
2592 struct bind_kw *kw;
2593
2594 kw = bind_find_kw(args[cur_arg]);
2595 if (kw) {
2596 if (!kw->parse) {
2597 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2598 args[0], args[1], args[cur_arg]);
2599 goto err;
2600 }
2601
2602 if (kw->parse(args, cur_arg, global.stats_fe, bind_conf, &err) != 0) {
2603 if (err)
2604 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2605 else
2606 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2607 args[0], args[1], args[cur_arg]);
2608 goto err;
2609 }
2610
2611 cur_arg += 1 + kw->skip;
2612 continue;
2613 }
2614
2615 if (!bind_dumped) {
2616 bind_dump_kws(&err);
2617 indent_msg(&err, 4);
2618 bind_dumped = 1;
2619 }
2620
2621 memprintf(&err, "'%s %s' : unknown keyword '%s'.%s%s",
2622 args[0], args[1], args[cur_arg],
2623 err ? " Registered keywords :" : "", err ? err : "");
2624 goto err;
2625 }
2626
2627
2628 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002629 l->accept = session_accept_fd;
2630 l->default_target = mworker_proxy->default_target;
2631 /* don't make the peers subject to global limits and don't close it in the master */
2632 l->options |= (LI_O_UNLIMITED|LI_O_MWORKER); /* we are keeping this FD in the master */
2633 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002634 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002635 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002636 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002637
2638 return 0;
2639
2640err:
2641 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002642 free(err);
2643 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002644 return -1;
2645
2646}
2647
2648/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002649 * Create a new CLI socket using a socketpair for a worker process
2650 * <mworker_proc> is the process structure, and <proc> is the process number
2651 */
2652int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2653{
2654 struct bind_conf *bind_conf;
2655 struct listener *l;
2656 char *path = NULL;
2657 char *err = NULL;
2658
2659 /* master pipe to ensure the master is still alive */
2660 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2661 ha_alert("Cannot create worker socketpair.\n");
2662 return -1;
2663 }
2664
2665 /* XXX: we might want to use a separate frontend at some point */
2666 if (!global.stats_fe) {
2667 if ((global.stats_fe = alloc_stats_fe("GLOBAL", "master-socket", 0)) == NULL) {
2668 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002669 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002670 }
2671 }
2672
2673 bind_conf = bind_conf_alloc(global.stats_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002674 if (!bind_conf)
2675 goto error;
2676
William Lallemandce83b4a2018-10-26 14:47:30 +02002677 bind_conf->level &= ~ACCESS_LVL_MASK;
2678 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2679
2680 bind_conf->bind_proc = 1UL << proc;
2681 global.stats_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
2682
2683 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2684 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002685 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002686 }
2687
2688 if (!str2listener(path, global.stats_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002689 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002690 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002691 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002692 }
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002693 free(path);
2694 path = NULL;
William Lallemandce83b4a2018-10-26 14:47:30 +02002695
2696 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002697 l->accept = session_accept_fd;
2698 l->default_target = global.stats_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002699 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
William Lallemandce83b4a2018-10-26 14:47:30 +02002700 /* it's a sockpair but we don't want to keep the fd in the master */
2701 l->options &= ~LI_O_INHERITED;
2702 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002703 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002704 }
2705
2706 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002707
2708error:
2709 close(mworker_proc->ipc_fd[0]);
2710 close(mworker_proc->ipc_fd[1]);
2711 free(err);
2712
2713 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002714}
2715
William Lallemand74c24fb2016-11-21 17:18:36 +01002716static struct applet cli_applet = {
2717 .obj_type = OBJ_TYPE_APPLET,
2718 .name = "<CLI>", /* used for logging */
2719 .fct = cli_io_handler,
2720 .release = cli_release_handler,
2721};
2722
Willy Tarreau0a739292016-11-22 20:21:23 +01002723/* register cli keywords */
2724static struct cli_kw_list cli_kws = {{ },{
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002725 { { "help", NULL }, NULL, cli_parse_simple, NULL },
2726 { { "prompt", NULL }, NULL, cli_parse_simple, NULL },
2727 { { "quit", NULL }, NULL, cli_parse_simple, NULL },
Willy Tarreau2af99412016-11-23 11:10:59 +01002728 { { "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 +01002729 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002730 { { "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 +01002731 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002732 { { "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 +02002733 { { "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 +01002734 { { "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 +02002735 { { "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 +01002736 { { "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 +01002737 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2738 { { "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 +02002739 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02002740 { { "expert-mode", NULL }, NULL, cli_parse_expert_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002741 {{},}
2742}};
2743
Willy Tarreau0108d902018-11-25 19:14:37 +01002744INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2745
William Lallemand74c24fb2016-11-21 17:18:36 +01002746static struct cfg_kw_list cfg_kws = {ILH, {
2747 { CFG_GLOBAL, "stats", stats_parse_global },
2748 { 0, NULL, NULL },
2749}};
2750
Willy Tarreau0108d902018-11-25 19:14:37 +01002751INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2752
William Lallemand74c24fb2016-11-21 17:18:36 +01002753static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002754 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2755 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002756 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002757 { NULL, NULL, 0 },
2758}};
2759
Willy Tarreau0108d902018-11-25 19:14:37 +01002760INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002761
2762/*
2763 * Local variables:
2764 * c-indent-level: 8
2765 * c-basic-offset: 8
2766 * End:
2767 */