blob: c2464b9e25695d118103436dd8eb0ee58d40b2dc [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 Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/applet-t.h>
32#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020038#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020039#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020042#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020043#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020044#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020045#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020046#include <haproxy/log.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020054#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020055#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020056#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020057#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020058#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020059#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020060#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020061#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020062#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020063#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020064#include <haproxy/version.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;
William Lallemand99e0bb92020-11-05 10:28:53 +010069static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010070
Willy Tarreau4975d142021-03-13 11:00:33 +010071static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010072 "Permission denied\n"
73 "";
74
75
Christopher Faulet1bc04c72017-10-29 20:14:08 +010076static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010077
78/* List head of cli keywords */
79static struct cli_kw_list cli_keywords = {
80 .list = LIST_HEAD_INIT(cli_keywords.list)
81};
82
83extern const char *stat_status_codes[];
84
Eric Salama1b8dacc2021-03-16 15:12:17 +010085struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +020086
Willy Tarreau92fbbcc2021-05-09 21:45:29 +020087static int cmp_kw_entries(const void *a, const void *b)
88{
89 const struct cli_kw *l = *(const struct cli_kw **)a;
90 const struct cli_kw *r = *(const struct cli_kw **)b;
91
92 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
93}
94
Willy Tarreaub96a74c2021-03-12 17:13:28 +010095/* This will show the help message and list the commands supported at the
96 * current level that match all of the first words of <args> if args is not
97 * NULL, or all args if none matches or if args is null.
98 */
99static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100100{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200101 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100102 struct cli_kw_list *kw_list;
103 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200104 struct buffer *tmp = get_trash_chunk();
105 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100106 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100107 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200108 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100109 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200110 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100111
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100112 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100113
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200114 if (args && *args && strcmp(*args, "help") == 0) {
115 args++;
116 ishelp = 1;
117 }
118
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100119 /* first, let's measure the longest match */
120 list_for_each_entry(kw_list, &cli_keywords.list, list) {
121 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100122 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100123 continue;
124 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
125 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
126 continue;
127
128 /* OK this command is visible */
129 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
130 if (!kw->str_kw[idx])
131 break; // end of keyword
132 if (!args || !args[idx] || !*args[idx])
133 break; // end of command line
134 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
135 break;
136 if (idx + 1 > length)
137 length = idx + 1;
138 }
139 }
140 }
141
Willy Tarreaub7364582021-03-12 18:24:46 +0100142 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100143 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200144 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100145 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreaub7364582021-03-12 18:24:46 +0100146 else if (!length && (!*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100147 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
148 else // partial match
149 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
150
Willy Tarreaub7364582021-03-12 18:24:46 +0100151 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
152 matches[idx].kw = NULL;
153 matches[idx].dist = INT_MAX;
154 }
155
156 /* In case of partial match we'll look for the best matching entries
157 * starting from position <length>
158 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100159 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100160 list_for_each_entry(kw_list, &cli_keywords.list, list) {
161 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100162 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100163 continue;
164 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
165 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
166 continue;
167
168 for (idx = 0; idx < length; idx++) {
169 if (!kw->str_kw[idx])
170 break; // end of keyword
171 if (!args || !args[idx] || !*args[idx])
172 break; // end of command line
173 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
174 break;
175 }
176
177 /* extra non-matching words are fuzzy-matched */
178 if (kw->usage && idx == length && args[idx] && *args[idx]) {
179 uint8_t word_sig[1024];
180 uint8_t list_sig[1024];
181 int dist = 0;
182 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100183 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100184
185 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100186 * on the remaining words. For this we're computing the signature
187 * of everything that remains and the cumulated length of the
188 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100189 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100190 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100191 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
192 update_word_fingerprint(word_sig, args[i]);
193 totlen += strlen(args[i]);
194 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100195
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100196 memset(list_sig, 0, sizeof(list_sig));
197 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
198 update_word_fingerprint(list_sig, kw->str_kw[i]);
199 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100200 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100201
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100202 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100203
204 /* insert this one at its place if relevant, in order to keep only
205 * the best matches.
206 */
207 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100208 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100209 matches[CLI_MAX_MATCHES-1] = swp;
210 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
211 if (matches[idx+1].dist >= matches[idx].dist)
212 break;
213 matches[idx+1] = matches[idx];
214 matches[idx] = swp;
215 }
216 }
217 }
218 }
219 }
220 }
221
Willy Tarreauec197e82021-03-15 10:35:04 +0100222 if (matches[0].kw) {
223 /* we have fuzzy matches, let's propose them */
224 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
225 kw = matches[idx].kw;
226 if (!kw)
227 break;
228
229 /* stop the dump if some words look very unlikely candidates */
230 if (matches[idx].dist > 5*matches[0].dist/2)
231 break;
232
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200233 if (help_entries < CLI_MAX_HELP_ENTRIES)
234 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100235 }
236 }
237
William Lallemand74c24fb2016-11-21 17:18:36 +0100238 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100239 /* no full dump if we've already found nice candidates */
240 if (matches[0].kw)
241 break;
242
Willy Tarreau91bc3592021-03-12 15:20:39 +0100243 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200244
Willy Tarreau91bc3592021-03-12 15:20:39 +0100245 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100246 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100247 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100248 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100249 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200250
Willy Tarreau91bc3592021-03-12 15:20:39 +0100251 /* in master don't display commands that have neither the master bit
252 * nor the master-only bit.
253 */
254 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
255 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
256 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200257
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100258 for (idx = 0; idx < length; idx++) {
259 if (!kw->str_kw[idx])
260 break; // end of keyword
261 if (!args || !args[idx] || !*args[idx])
262 break; // end of command line
263 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
264 break;
265 }
266
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200267 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
268 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100269 }
270 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100271
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200272 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
273
274 for (idx = 0; idx < help_entries; idx++)
275 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
276
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100277 /* always show the prompt/help/quit commands */
278 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200279 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200280 " prompt : toggle interactive mode with prompt\n"
281 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100282
William Lallemand74c24fb2016-11-21 17:18:36 +0100283 chunk_init(&out, NULL, 0);
284 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200285 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200286
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100287 appctx->ctx.cli.severity = LOG_INFO;
288 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200289 appctx->st0 = CLI_ST_PRINT;
290
William Lallemand74c24fb2016-11-21 17:18:36 +0100291 return dynamic_usage_msg;
292}
293
294struct cli_kw* cli_find_kw(char **args)
295{
296 struct cli_kw_list *kw_list;
297 struct cli_kw *kw;/* current cli_kw */
298 char **tmp_args;
299 const char **tmp_str_kw;
300 int found = 0;
301
302 if (LIST_ISEMPTY(&cli_keywords.list))
303 return NULL;
304
305 list_for_each_entry(kw_list, &cli_keywords.list, list) {
306 kw = &kw_list->kw[0];
307 while (*kw->str_kw) {
308 tmp_args = args;
309 tmp_str_kw = kw->str_kw;
310 while (*tmp_str_kw) {
311 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
312 found = 1;
313 } else {
314 found = 0;
315 break;
316 }
317 tmp_args++;
318 tmp_str_kw++;
319 }
320 if (found)
321 return (kw);
322 kw++;
323 }
324 }
325 return NULL;
326}
327
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100328struct cli_kw* cli_find_kw_exact(char **args)
329{
330 struct cli_kw_list *kw_list;
331 int found = 0;
332 int i;
333 int j;
334
335 if (LIST_ISEMPTY(&cli_keywords.list))
336 return NULL;
337
338 list_for_each_entry(kw_list, &cli_keywords.list, list) {
339 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
340 found = 1;
341 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
342 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
343 break;
344 }
345 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
346 found = 0;
347 break;
348 }
349 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
350 found = 0;
351 break;
352 }
353 }
354 if (found)
355 return &kw_list->kw[i];
356 }
357 }
358 return NULL;
359}
360
William Lallemand74c24fb2016-11-21 17:18:36 +0100361void cli_register_kw(struct cli_kw_list *kw_list)
362{
Willy Tarreau2b718102021-04-21 07:32:39 +0200363 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100364}
365
366
367/* allocate a new stats frontend named <name>, and return it
368 * (or NULL in case of lack of memory).
369 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100370static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100371{
372 struct proxy *fe;
373
374 fe = calloc(1, sizeof(*fe));
375 if (!fe)
376 return NULL;
377
378 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100379 fe->next = proxies_list;
380 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100381 fe->last_change = now.tv_sec;
382 fe->id = strdup("GLOBAL");
383 fe->cap = PR_CAP_FE;
384 fe->maxconn = 10; /* default to 10 concurrent connections */
385 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
386 fe->conf.file = strdup(file);
387 fe->conf.line = line;
388 fe->accept = frontend_accept;
389 fe->default_target = &cli_applet.obj_type;
390
391 /* the stats frontend is the only one able to assign ID #0 */
392 fe->conf.id.key = fe->uuid = 0;
393 eb32_insert(&used_proxy_id, &fe->conf.id);
394 return fe;
395}
396
397/* This function parses a "stats" statement in the "global" section. It returns
398 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
399 * error message into the <err> buffer which will be preallocated. The trailing
400 * '\n' must not be written. The function must be called with <args> pointing to
401 * the first word after "stats".
402 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100403static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
404 const struct proxy *defpx, const char *file, int line,
405 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100406{
407 struct bind_conf *bind_conf;
408 struct listener *l;
409
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100410 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100411 int cur_arg;
412
413 if (*args[2] == 0) {
414 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
415 return -1;
416 }
417
Willy Tarreau4975d142021-03-13 11:00:33 +0100418 if (!global.cli_fe) {
419 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100420 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
421 return -1;
422 }
423 }
424
Willy Tarreau4975d142021-03-13 11:00:33 +0100425 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200426 if (!bind_conf) {
427 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
428 return -1;
429 }
William Lallemand07a62f72017-05-24 00:57:40 +0200430 bind_conf->level &= ~ACCESS_LVL_MASK;
431 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100432
Willy Tarreau4975d142021-03-13 11:00:33 +0100433 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100434 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
435 file, line, args[0], args[1], err && *err ? *err : "error");
436 return -1;
437 }
438
439 cur_arg = 3;
440 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100441 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100442 const char *best;
William Lallemand74c24fb2016-11-21 17:18:36 +0100443
444 kw = bind_find_kw(args[cur_arg]);
445 if (kw) {
446 if (!kw->parse) {
447 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
448 args[0], args[1], args[cur_arg]);
449 return -1;
450 }
451
Willy Tarreau4975d142021-03-13 11:00:33 +0100452 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, err) != 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100453 if (err && *err)
454 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
455 else
456 memprintf(err, "'%s %s' : error encountered while processing '%s'",
457 args[0], args[1], args[cur_arg]);
458 return -1;
459 }
460
461 cur_arg += 1 + kw->skip;
462 continue;
463 }
464
Willy Tarreau433b05f2021-03-12 10:14:07 +0100465 best = bind_find_best_kw(args[cur_arg]);
466 if (best)
467 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
468 args[0], args[1], args[cur_arg], best);
469 else
470 memprintf(err, "'%s %s' : unknown keyword '%s'.",
471 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100472 return -1;
473 }
474
475 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100476 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100477 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100478 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
479 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100480 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100481 }
482 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100483 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100484 unsigned timeout;
485 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
486
Willy Tarreau9faebe32019-06-07 19:00:37 +0200487 if (res == PARSE_TIME_OVER) {
488 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
489 args[2], args[0], args[1]);
490 return -1;
491 }
492 else if (res == PARSE_TIME_UNDER) {
493 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
494 args[2], args[0], args[1]);
495 return -1;
496 }
497 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100498 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
499 return -1;
500 }
501
502 if (!timeout) {
503 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
504 return -1;
505 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100506 if (!global.cli_fe) {
507 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100508 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
509 return -1;
510 }
511 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100512 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100513 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100514 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100515 int maxconn = atol(args[2]);
516
517 if (maxconn <= 0) {
518 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
519 return -1;
520 }
521
Willy Tarreau4975d142021-03-13 11:00:33 +0100522 if (!global.cli_fe) {
523 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100524 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
525 return -1;
526 }
527 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100528 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100529 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100530 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100531 int cur_arg = 2;
532 unsigned long set = 0;
533
Willy Tarreau4975d142021-03-13 11:00:33 +0100534 if (!global.cli_fe) {
535 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100536 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
537 return -1;
538 }
539 }
540
541 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 if (strcmp(args[cur_arg], "all") == 0) {
543 set = 0;
544 break;
545 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100546 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100547 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100548 return -1;
549 }
550 cur_arg++;
551 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100552 global.cli_fe->bind_proc = set;
William Lallemand74c24fb2016-11-21 17:18:36 +0100553 }
554 else {
555 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
556 return -1;
557 }
558 return 0;
559}
560
William Lallemand33d29e22019-04-01 11:30:06 +0200561/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200562 * This function exports the bound addresses of a <frontend> in the environment
563 * variable <varname>. Those addresses are separated by semicolons and prefixed
564 * with their type (abns@, unix@, sockpair@ etc)
565 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200566 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200567int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200568{
569 struct buffer *trash = get_trash_chunk();
570 struct bind_conf *bind_conf;
571
William Lallemand9a37fd02019-04-12 16:09:24 +0200572 if (frontend) {
573 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200574 struct listener *l;
575
576 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
577 char addr[46];
578 char port[6];
579
William Lallemand620072b2019-04-12 16:09:25 +0200580 /* separate listener by semicolons */
581 if (trash->data)
582 chunk_appendf(trash, ";");
583
Willy Tarreau37159062020-08-27 07:48:42 +0200584 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200585 const struct sockaddr_un *un;
586
Willy Tarreau37159062020-08-27 07:48:42 +0200587 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200588 if (un->sun_path[0] == '\0') {
589 chunk_appendf(trash, "abns@%s", un->sun_path+1);
590 } else {
591 chunk_appendf(trash, "unix@%s", un->sun_path);
592 }
Willy Tarreau37159062020-08-27 07:48:42 +0200593 } else if (l->rx.addr.ss_family == AF_INET) {
594 addr_to_str(&l->rx.addr, addr, sizeof(addr));
595 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200596 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200597 } else if (l->rx.addr.ss_family == AF_INET6) {
598 addr_to_str(&l->rx.addr, addr, sizeof(addr));
599 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200600 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200601 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
602 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200603 }
William Lallemand33d29e22019-04-01 11:30:06 +0200604 }
605 }
606 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200607 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200608 return -1;
609 }
610
611 return 0;
612}
613
William Lallemand9a37fd02019-04-12 16:09:24 +0200614int cli_socket_setenv()
615{
Willy Tarreau4975d142021-03-13 11:00:33 +0100616 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200617 return -1;
618 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
619 return -1;
620
621 return 0;
622}
623
William Lallemand33d29e22019-04-01 11:30:06 +0200624REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
625
Willy Tarreaude57a572016-11-23 17:01:39 +0100626/* Verifies that the CLI at least has a level at least as high as <level>
627 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
628 * failure, an error message is prepared and the appctx's state is adjusted
629 * to print it so that a return 1 is enough to abort any processing.
630 */
631int cli_has_level(struct appctx *appctx, int level)
632{
Willy Tarreaude57a572016-11-23 17:01:39 +0100633
William Lallemandf630d012018-12-13 09:05:44 +0100634 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100635 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100636 return 0;
637 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100638 return 1;
639}
640
William Lallemandb7ea1412018-12-13 09:05:47 +0100641/* same as cli_has_level but for the CLI proxy and without error message */
642int pcli_has_level(struct stream *s, int level)
643{
644 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
645 return 0;
646 }
647 return 1;
648}
649
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200650/* Returns severity_output for the current session if set, or default for the socket */
651static int cli_get_severity_output(struct appctx *appctx)
652{
653 if (appctx->cli_severity_output)
654 return appctx->cli_severity_output;
655 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
656}
William Lallemand74c24fb2016-11-21 17:18:36 +0100657
Willy Tarreau41908562016-11-24 16:23:38 +0100658/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100659 * from the CLI's IO handler running in an appctx context. The function returns
660 * 1 if the request was understood, otherwise zero (in which case an error
661 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100662 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
663 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
664 * have its own I/O handler called again. Most of the time, parsers will only
665 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100666 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
667 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100668 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200669static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100670{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100671 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200672 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100673 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100674
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200675 appctx->st2 = 0;
676 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100677
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200678 p = appctx->chunk->area;
679 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100680
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200681 /*
682 * Get the payload start if there is one.
683 * For the sake of simplicity, the payload pattern is looked up
684 * everywhere from the start of the input but it can only be found
685 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
686 *
687 * The input string was zero terminated so it is safe to use
688 * the str*() functions throughout the parsing
689 */
690 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
691 payload = strstr(p, PAYLOAD_PATTERN);
692 end = payload;
693 /* skip the pattern */
694 payload += strlen(PAYLOAD_PATTERN);
695 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100696
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200697 /*
698 * Get pointers on words.
699 * One extra slot is reserved to store a pointer on a null byte.
700 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100701 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200702 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100703
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200704 /* skip leading spaces/tabs */
705 p += strspn(p, " \t");
706 if (!*p)
707 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100708
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200709 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200710 while (1) {
711 p += strcspn(p, " \t\\");
712 /* escaped chars using backlashes (\) */
713 if (*p == '\\') {
714 if (!*++p)
715 break;
716 if (!*++p)
717 break;
718 } else {
719 break;
720 }
721 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200722 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100723
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200724 /* unescape backslashes (\) */
725 for (j = 0, k = 0; args[i][k]; k++) {
726 if (args[i][k] == '\\') {
727 if (args[i][k + 1] == '\\')
728 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100729 else
730 continue;
731 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200732 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100733 j++;
734 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200735 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100736
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 i++;
738 }
739 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200740 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100741 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100743
744 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100745 if (!kw ||
746 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
747 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
748 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100749 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100750 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100751 }
William Lallemand14721be2018-10-26 14:47:37 +0200752
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100753 /* don't handle expert mode commands if not in this mode. */
754 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
755 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200756 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100757 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200758
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100759 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
760 cli_err(appctx, "This command is restricted to experimental mode only.\n");
761 return 0;
762 }
763
Amaury Denoyellef4929922021-05-05 16:29:23 +0200764 if (kw->level == ACCESS_EXPERT)
765 mark_tainted(TAINTED_CLI_EXPERT_MODE);
766 else if (kw->level == ACCESS_EXPERIMENTAL)
767 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
768
Willy Tarreau41908562016-11-24 16:23:38 +0100769 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200770 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200771
772 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
773 goto fail;
774
775 /* kw->parse could set its own io_handler or io_release handler */
776 if (!appctx->io_handler)
777 goto fail;
778
779 appctx->st0 = CLI_ST_CALLBACK;
780 return 1;
781fail:
782 appctx->io_handler = NULL;
783 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100784 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100785}
786
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200787/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
788static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
789{
Willy Tarreau83061a82018-07-13 11:56:34 +0200790 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200791
792 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200793 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200794
795 tmp = get_trash_chunk();
796 chunk_reset(tmp);
797
798 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100799 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200800 chunk_printf(tmp, "[%d]: ", severity);
801 }
802 else {
803 switch (severity_output) {
804 case CLI_SEVERITY_NUMBER:
805 chunk_printf(tmp, "[%d]: ", severity);
806 break;
807 case CLI_SEVERITY_STRING:
808 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
809 break;
810 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100811 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200812 }
813 }
814 chunk_appendf(tmp, "%s", msg);
815
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200816 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200817}
818
William Lallemand74c24fb2016-11-21 17:18:36 +0100819/* This I/O handler runs as an applet embedded in a stream interface. It is
820 * used to processes I/O from/to the stats unix socket. The system relies on a
821 * state machine handling requests and various responses. We read a request,
822 * then we process it and send the response, and we possibly display a prompt.
823 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100824 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100825 * or not.
826 */
827static void cli_io_handler(struct appctx *appctx)
828{
829 struct stream_interface *si = appctx->owner;
830 struct channel *req = si_oc(si);
831 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200832 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100833 int reql;
834 int len;
835
836 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
837 goto out;
838
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800839 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200840 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100841 /* buf.size==0 means we failed to get a buffer and were
842 * already subscribed to a wait list to get a buffer.
843 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100844 goto out;
845 }
846
William Lallemand74c24fb2016-11-21 17:18:36 +0100847 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100848 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100849 /* Stats output not initialized yet */
850 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200851 /* reset severity to default at init */
852 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100853 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100854 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100855 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100856 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100857 /* Let's close for real now. We just close the request
858 * side, the conditions below will complete if needed.
859 */
860 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200861 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200862 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100863 break;
864 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100865 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200866 char *str;
867
868 /* use a trash chunk to store received data */
869 if (!appctx->chunk) {
870 appctx->chunk = alloc_trash_chunk();
871 if (!appctx->chunk) {
872 appctx->st0 = CLI_ST_END;
873 continue;
874 }
875 }
876
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200877 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200878
William Lallemand74c24fb2016-11-21 17:18:36 +0100879 /* ensure we have some output room left in the event we
880 * would want to return some info right after parsing.
881 */
882 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100883 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100884 break;
885 }
886
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200887 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200888 reql = co_getline(si_oc(si), str,
889 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100890 if (reql <= 0) { /* closed or EOL not found */
891 if (reql == 0)
892 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100893 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100894 continue;
895 }
896
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200897 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
898 /* seek for a possible unescaped semi-colon. If we find
899 * one, we replace it with an LF and skip only this part.
900 */
901 for (len = 0; len < reql; len++) {
902 if (str[len] == '\\') {
903 len++;
904 continue;
905 }
906 if (str[len] == ';') {
907 str[len] = '\n';
908 reql = len + 1;
909 break;
910 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100911 }
912 }
913
914 /* now it is time to check that we have a full line,
915 * remove the trailing \n and possibly \r, then cut the
916 * line.
917 */
918 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200919 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100920 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100921 continue;
922 }
923
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200924 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100925 len--;
926
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200927 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200928 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200929
930 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200931 appctx->chunk->area[appctx->chunk->data] = '\n';
932 appctx->chunk->area[appctx->chunk->data + 1] = 0;
933 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200934 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100935
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100936 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200937
938 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
939 /* empty line */
940 if (!len) {
941 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200942 appctx->chunk->data -= 2;
943 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100944 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200945 chunk_reset(appctx->chunk);
946 /* NB: cli_sock_parse_request() may have put
947 * another CLI_ST_O_* into appctx->st0.
948 */
949
950 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100952 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200953 else {
954 /*
955 * Look for the "payload start" pattern at the end of a line
956 * Its location is not remembered here, this is just to switch
957 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100958 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100959 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200960 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200961 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200962 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100963 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200964 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200965 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100966 }
967
968 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200969 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100970 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
971 }
972 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200973 const char *msg;
974 int sev;
975
William Lallemand74c24fb2016-11-21 17:18:36 +0100976 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100977 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100978 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200979 case CLI_ST_PRINT: /* print const message in msg */
980 case CLI_ST_PRINT_ERR: /* print const error in msg */
981 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
982 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
983 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
984 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
985 LOG_ERR : appctx->ctx.cli.severity;
986 msg = appctx->ctx.cli.msg;
987 }
988 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
989 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
990 LOG_ERR : appctx->ctx.cli.severity;
991 msg = appctx->ctx.cli.err;
992 if (!msg) {
993 sev = LOG_ERR;
994 msg = "Out of memory.\n";
995 }
996 }
997 else {
998 sev = LOG_ERR;
999 msg = "Internal error.\n";
1000 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001001
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001002 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1003 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1004 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001005 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001006 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001007 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001008 }
1009 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001010 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001011 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001012
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001013 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001014 if (appctx->io_handler)
1015 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001016 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001017 if (appctx->io_release) {
1018 appctx->io_release(appctx);
1019 appctx->io_release = NULL;
1020 }
1021 }
1022 break;
1023 default: /* abnormal state */
1024 si->flags |= SI_FL_ERR;
1025 break;
1026 }
1027
1028 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001029 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001030 const char *prompt = "";
1031
1032 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1033 /*
1034 * when entering a payload with interactive mode, change the prompt
1035 * to emphasize that more data can still be sent
1036 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001037 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001038 prompt = "+ ";
1039 else
1040 prompt = "\n> ";
1041 }
1042 else {
William Lallemandad032882019-07-01 10:56:15 +02001043 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001044 prompt = "\n";
1045 }
1046
1047 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001048 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001049 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001050 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001051 }
1052
1053 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001054 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001055 break;
1056
1057 /* Now we close the output if one of the writers did so,
1058 * or if we're not in interactive mode and the request
1059 * buffer is empty. This still allows pipelined requests
1060 * to be sent in non-interactive mode.
1061 */
William Lallemand3de09d52018-12-11 16:10:56 +01001062 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1063 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001064 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001065 continue;
1066 }
1067
1068 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001069 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001070 /* reactivate the \n at the end of the response for the next command */
1071 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001072 }
1073 }
1074
1075 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1076 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1077 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1078 /* Other side has closed, let's abort if we have no more processing to do
1079 * and nothing more to consume. This is comparable to a broken pipe, so
1080 * we forward the close to the request side so that it flows upstream to
1081 * the client.
1082 */
1083 si_shutw(si);
1084 }
1085
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001086 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001087 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1088 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1089 /* We have no more processing to do, and nothing more to send, and
1090 * the client side has closed. So we'll forward this state downstream
1091 * on the response buffer.
1092 */
1093 si_shutr(si);
1094 res->flags |= CF_READ_NULL;
1095 }
1096
1097 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001098 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 +01001099 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001100 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 +01001101}
1102
William Lallemand74c24fb2016-11-21 17:18:36 +01001103/* This is called when the stream interface is closed. For instance, upon an
1104 * external abort, we won't call the i/o handler anymore so we may need to
1105 * remove back references to the stream currently being dumped.
1106 */
1107static void cli_release_handler(struct appctx *appctx)
1108{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001109 free_trash_chunk(appctx->chunk);
1110 appctx->chunk = NULL;
1111
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 if (appctx->io_release) {
1113 appctx->io_release(appctx);
1114 appctx->io_release = NULL;
1115 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001116 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001117 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001118 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001119}
1120
1121/* This function dumps all environmnent variables to the buffer. It returns 0
1122 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001123 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1124 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001125 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001126static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001127{
Willy Tarreau0a739292016-11-22 20:21:23 +01001128 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001129 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001130
1131 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1132 return 1;
1133
1134 chunk_reset(&trash);
1135
1136 /* we have two inner loops here, one for the proxy, the other one for
1137 * the buffer.
1138 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001139 while (*var) {
1140 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001141
Willy Tarreau06d80a92017-10-19 14:32:15 +02001142 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001143 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001144 return 0;
1145 }
1146 if (appctx->st2 == STAT_ST_END)
1147 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001148 var++;
1149 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001150 }
1151
1152 /* dump complete */
1153 return 1;
1154}
1155
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001156/* This function dumps all file descriptors states (or the requested one) to
1157 * the buffer. It returns 0 if the output buffer is full and it needs to be
1158 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1159 * It uses cli.i0 as the fd number to restart from.
1160 */
1161static int cli_io_handler_show_fd(struct appctx *appctx)
1162{
1163 struct stream_interface *si = appctx->owner;
1164 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001165 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001166
1167 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001168 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001169
1170 chunk_reset(&trash);
1171
Willy Tarreauca1b1572018-12-18 15:45:11 +01001172 /* isolate the threads once per round. We're limited to a buffer worth
1173 * of output anyway, it cannot last very long.
1174 */
1175 thread_isolate();
1176
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001177 /* we have two inner loops here, one for the proxy, the other one for
1178 * the buffer.
1179 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001180 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001181 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001182 const struct listener *li = NULL;
1183 const struct server *sv = NULL;
1184 const struct proxy *px = NULL;
1185 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001186 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001187 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001188 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001189 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001190 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001191 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001192 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001193
1194 fdt = fdtab[fd];
1195
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001196 /* When DEBUG_FD is set, we also report closed FDs that have a
1197 * non-null event count to detect stuck ones.
1198 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001199 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001200#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001201 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001202#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001203 goto skip; // closed
1204 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001205 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001206 conn = (const struct connection *)fdt.owner;
1207 conn_flags = conn->flags;
1208 mux = conn->mux;
1209 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001210 xprt = conn->xprt;
1211 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001212 li = objt_listener(conn->target);
1213 sv = objt_server(conn->target);
1214 px = objt_proxy(conn->target);
1215 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001216 if (atleast2(fdt.thread_mask))
1217 suspicious = 1;
1218 if (conn->handle.fd != fd)
1219 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001220 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001221 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001222 li = fdt.owner;
1223
Willy Tarreaudacfde42021-01-21 09:07:29 +01001224 if (!fdt.thread_mask)
1225 suspicious = 1;
1226
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001227 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001228 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001229 fd,
1230 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001231 (fdt.state & FD_CLONED) ? 'C' : 'c',
1232 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001233 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1234 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1235 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1236 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1237 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001238 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1239 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1240 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1241 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1242 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1243 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001244 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001245 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001246 fdt.iocb);
1247 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001248
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001249 if (!fdt.owner) {
1250 chunk_appendf(&trash, ")");
1251 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001252 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001253 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001254
1255 if (conn->handle.fd != fd) {
1256 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1257 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001258 } else {
1259 struct sockaddr_storage sa;
1260 socklen_t salen;
1261
1262 salen = sizeof(sa);
1263 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1264 if (sa.ss_family == AF_INET)
1265 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1266 else if (sa.ss_family == AF_INET6)
1267 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1268 else if (sa.ss_family == AF_UNIX)
1269 chunk_appendf(&trash, " fam=unix");
1270 }
1271
1272 salen = sizeof(sa);
1273 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1274 if (sa.ss_family == AF_INET)
1275 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1276 else if (sa.ss_family == AF_INET6)
1277 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1278 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001279 }
1280
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001281 if (px)
1282 chunk_appendf(&trash, " px=%s", px->id);
1283 else if (sv)
1284 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1285 else if (li)
1286 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001287
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001288 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001289 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001290 if (!ctx)
1291 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001292 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001293 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001294 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001295 else
1296 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001297
1298 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001299 if (xprt) {
1300 if (xprt_ctx || xprt->show_fd)
1301 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1302 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001303 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001304 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001305 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001306 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001307 struct sockaddr_storage sa;
1308 socklen_t salen;
1309
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001310 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001311 listener_state_str(li),
1312 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001313
1314 salen = sizeof(sa);
1315 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1316 if (sa.ss_family == AF_INET)
1317 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1318 else if (sa.ss_family == AF_INET6)
1319 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1320 else if (sa.ss_family == AF_UNIX)
1321 chunk_appendf(&trash, " fam=unix");
1322 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001323 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001324 else
1325 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001326
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001327#ifdef DEBUG_FD
1328 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001329 if (fdtab[fd].event_count >= 1000000)
1330 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001331#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001332 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001333
Willy Tarreau06d80a92017-10-19 14:32:15 +02001334 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001335 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001336 appctx->ctx.cli.i0 = fd;
1337 ret = 0;
1338 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001339 }
1340 skip:
1341 if (appctx->st2 == STAT_ST_END)
1342 break;
1343
1344 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001345 }
1346
Willy Tarreauca1b1572018-12-18 15:45:11 +01001347 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001348 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001349
1350 thread_release();
1351 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001352}
1353
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001354/* This function dumps some activity counters used by developers and support to
1355 * rule out some hypothesis during bug reports. It returns 0 if the output
1356 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1357 * everything at once in the buffer and is not designed to do it in multiple
1358 * passes.
1359 */
1360static int cli_io_handler_show_activity(struct appctx *appctx)
1361{
1362 struct stream_interface *si = appctx->owner;
1363 int thr;
1364
1365 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1366 return 1;
1367
1368 chunk_reset(&trash);
1369
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001370#undef SHOW_TOT
1371#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001372 do { \
1373 unsigned int _v[MAX_THREADS]; \
1374 unsigned int _tot; \
1375 const unsigned int _nbt = global.nbthread; \
1376 for (_tot = t = 0; t < _nbt; t++) \
1377 _tot += _v[t] = (x); \
1378 if (_nbt == 1) { \
1379 chunk_appendf(&trash, " %u\n", _tot); \
1380 break; \
1381 } \
1382 chunk_appendf(&trash, " %u [", _tot); \
1383 for (t = 0; t < _nbt; t++) \
1384 chunk_appendf(&trash, " %u", _v[t]); \
1385 chunk_appendf(&trash, " ]\n"); \
1386 } while (0)
1387
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001388#undef SHOW_AVG
1389#define SHOW_AVG(t, x) \
1390 do { \
1391 unsigned int _v[MAX_THREADS]; \
1392 unsigned int _tot; \
1393 const unsigned int _nbt = global.nbthread; \
1394 for (_tot = t = 0; t < _nbt; t++) \
1395 _tot += _v[t] = (x); \
1396 if (_nbt == 1) { \
1397 chunk_appendf(&trash, " %u\n", _tot); \
1398 break; \
1399 } \
1400 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1401 for (t = 0; t < _nbt; t++) \
1402 chunk_appendf(&trash, " %u", _v[t]); \
1403 chunk_appendf(&trash, " ]\n"); \
1404 } while (0)
1405
Willy Tarreaua0211b82019-05-28 15:09:08 +02001406 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1407 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001408 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1409 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1410 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1411 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001412 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001413 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1414 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001415 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001416 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001417 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1418 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1419 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001420 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001421 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001422 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1423 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001424 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1425 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1426 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1427 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1428 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1429 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1430 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001431#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001432 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 Tarreaub1591322020-06-29 14:17:59 +02001433 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001434#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001435
Willy Tarreaud6a78502019-05-27 07:03:38 +02001436#if defined(DEBUG_DEV)
1437 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001438 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1439 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1440 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001441#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001442
1443 if (ci_putchk(si_ic(si), &trash) == -1) {
1444 chunk_reset(&trash);
1445 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001446 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001447 }
1448
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001449#undef SHOW_AVG
1450#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001451 /* dump complete */
1452 return 1;
1453}
1454
William Lallemandeceddf72016-12-15 18:06:44 +01001455/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001456 * CLI IO handler for `show cli sockets`.
1457 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001458 */
1459static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1460{
1461 struct bind_conf *bind_conf;
1462 struct stream_interface *si = appctx->owner;
1463
1464 chunk_reset(&trash);
1465
1466 switch (appctx->st2) {
1467 case STAT_ST_INIT:
1468 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001469 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001470 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001471 return 0;
1472 }
William Lallemandeceddf72016-12-15 18:06:44 +01001473 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001474 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001475
1476 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001477 if (global.cli_fe) {
1478 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001479 struct listener *l;
1480
1481 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001482 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001483 * if the current node is the first of the list
1484 */
1485
Willy Tarreau3af9d832016-12-16 12:58:09 +01001486 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001487 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001488 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001489 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001490 continue;
1491 }
1492
1493 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1494
1495 char addr[46];
1496 char port[6];
1497
Willy Tarreau37159062020-08-27 07:48:42 +02001498 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001499 const struct sockaddr_un *un;
1500
Willy Tarreau37159062020-08-27 07:48:42 +02001501 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001502 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001503 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001504 } else {
1505 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1506 }
Willy Tarreau37159062020-08-27 07:48:42 +02001507 } else if (l->rx.addr.ss_family == AF_INET) {
1508 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1509 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001510 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001511 } else if (l->rx.addr.ss_family == AF_INET6) {
1512 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1513 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001514 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001515 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1516 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001517 } else
William Lallemand26314342018-10-26 14:47:41 +02001518 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001519
William Lallemand07a62f72017-05-24 00:57:40 +02001520 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001521 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001522 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1523 chunk_appendf(&trash, "operator ");
1524 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1525 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001526 else
1527 chunk_appendf(&trash, " ");
1528
Willy Tarreaue26993c2020-09-03 07:18:55 +02001529 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001530 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001531 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1532 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001533 chunk_appendf(&trash, "%d,", pos+1);
1534 }
1535 }
1536 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001537 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001538
1539 } else {
1540 chunk_appendf(&trash, "all\n");
1541 }
1542
Willy Tarreau06d80a92017-10-19 14:32:15 +02001543 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001544 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001545 return 0;
1546 }
1547 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001548 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001549 }
1550 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001551 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001552 default:
1553 appctx->st2 = STAT_ST_FIN;
1554 return 1;
1555 }
1556}
1557
1558
Willy Tarreau0a739292016-11-22 20:21:23 +01001559/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001560 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1561 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001562 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001563static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001564{
1565 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001566 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001567
1568 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1569 return 1;
1570
Willy Tarreauf6710f82016-12-16 17:45:44 +01001571 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001572
1573 if (*args[2]) {
1574 int len = strlen(args[2]);
1575
Willy Tarreauf6710f82016-12-16 17:45:44 +01001576 for (; *var; var++) {
1577 if (strncmp(*var, args[2], len) == 0 &&
1578 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001579 break;
1580 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001581 if (!*var)
1582 return cli_err(appctx, "Variable not found\n");
1583
Willy Tarreau0a739292016-11-22 20:21:23 +01001584 appctx->st2 = STAT_ST_END;
1585 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001586 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001587 return 0;
1588}
1589
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001590/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1591 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1592 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1593 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001594static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001595{
1596 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1597 return 1;
1598
1599 appctx->ctx.cli.i0 = 0;
1600
1601 if (*args[2]) {
1602 appctx->ctx.cli.i0 = atoi(args[2]);
1603 appctx->st2 = STAT_ST_END;
1604 }
1605 return 0;
1606}
1607
Willy Tarreau599852e2016-11-22 20:33:32 +01001608/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001609static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001610{
1611 struct stream_interface *si = appctx->owner;
1612 struct stream *s = si_strm(si);
1613
1614 if (strcmp(args[2], "cli") == 0) {
1615 unsigned timeout;
1616 const char *res;
1617
Willy Tarreau9d008692019-08-09 11:21:01 +02001618 if (!*args[3])
1619 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001620
1621 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001622 if (res || timeout < 1)
1623 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001624
1625 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1626 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1627 return 1;
1628 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001629
1630 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001631}
1632
Willy Tarreau2af99412016-11-23 11:10:59 +01001633/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001634static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001635{
1636 int v;
1637
1638 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1639 return 1;
1640
Willy Tarreau9d008692019-08-09 11:21:01 +02001641 if (!*args[3])
1642 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001643
1644 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001645 if (v > global.hardmaxconn)
1646 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001647
1648 /* check for unlimited values */
1649 if (v <= 0)
1650 v = global.hardmaxconn;
1651
1652 global.maxconn = v;
1653
1654 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001655 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001656
1657 return 1;
1658}
1659
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001660static int set_severity_output(int *target, char *argument)
1661{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001662 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001663 *target = CLI_SEVERITY_NONE;
1664 return 1;
1665 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001666 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001667 *target = CLI_SEVERITY_NUMBER;
1668 return 1;
1669 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001670 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001671 *target = CLI_SEVERITY_STRING;
1672 return 1;
1673 }
1674 return 0;
1675}
1676
1677/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001678static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001679{
1680 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1681 return 0;
1682
Willy Tarreau9d008692019-08-09 11:21:01 +02001683 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001684}
William Lallemandeceddf72016-12-15 18:06:44 +01001685
William Lallemand67a234f2018-12-13 09:05:45 +01001686
1687/* show the level of the current CLI session */
1688static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1689{
William Lallemand67a234f2018-12-13 09:05:45 +01001690 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001691 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001692 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001693 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001694 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001695 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001696 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001697 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001698}
1699
1700/* parse and set the CLI level dynamically */
1701static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1702{
William Lallemandad032882019-07-01 10:56:15 +02001703 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001704 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001705 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1706
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001707 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001708 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1709 return 1;
1710 }
1711 appctx->cli_level &= ~ACCESS_LVL_MASK;
1712 appctx->cli_level |= ACCESS_LVL_OPER;
1713
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001714 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001715 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1716 return 1;
1717 }
1718 appctx->cli_level &= ~ACCESS_LVL_MASK;
1719 appctx->cli_level |= ACCESS_LVL_USER;
1720 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001721 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001722 return 1;
1723}
1724
1725
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001726/* parse and set the CLI expert/experimental-mode dynamically */
1727static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001728{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001729 int level;
1730 char *level_str;
1731 char *output = NULL;
1732
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001733 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1734 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001735
1736 if (!strcmp(args[0], "expert-mode")) {
1737 level = ACCESS_EXPERT;
1738 level_str = "expert-mode";
1739 }
1740 else if (!strcmp(args[0], "experimental-mode")) {
1741 level = ACCESS_EXPERIMENTAL;
1742 level_str = "experimental-mode";
1743 }
1744 else {
1745 return 1;
1746 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001747
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001748 if (!*args[1]) {
1749 memprintf(&output, "%s is %s\n", level_str,
1750 (appctx->cli_level & level) ? "ON" : "OFF");
1751 return cli_dynmsg(appctx, LOG_INFO, output);
1752 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001753
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001754 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001755 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001756 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001757 return 1;
1758}
1759
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001760int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001761{
1762 return 0;
1763}
1764
Willy Tarreau45c742b2016-11-24 14:51:17 +01001765/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001766static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001767{
1768 int v;
1769 int *res;
1770 int mul = 1;
1771
1772 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1773 return 1;
1774
1775 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1776 res = &global.cps_lim;
1777 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1778 res = &global.sps_lim;
1779#ifdef USE_OPENSSL
1780 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1781 res = &global.ssl_lim;
1782#endif
1783 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1784 res = &global.comp_rate_lim;
1785 mul = 1024;
1786 }
1787 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001788 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001789 "'set rate-limit' only supports :\n"
1790 " - 'connections global' to set the per-process maximum connection rate\n"
1791 " - 'sessions global' to set the per-process maximum session rate\n"
1792#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001793 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001794#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001795 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001796 }
1797
Willy Tarreau9d008692019-08-09 11:21:01 +02001798 if (!*args[4])
1799 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001800
1801 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001802 if (v < 0)
1803 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001804
1805 *res = v * mul;
1806
1807 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001808 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001809
1810 return 1;
1811}
1812
William Lallemandf6975e92017-05-26 17:42:10 +02001813/* parse the "expose-fd" argument on the bind lines */
1814static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1815{
1816 if (!*args[cur_arg + 1]) {
1817 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1818 return ERR_ALERT | ERR_FATAL;
1819 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001820 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001821 conf->level |= ACCESS_FD_LISTENERS;
1822 } else {
1823 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1824 args[cur_arg], args[cur_arg+1]);
1825 return ERR_ALERT | ERR_FATAL;
1826 }
1827
1828 return 0;
1829}
1830
William Lallemand74c24fb2016-11-21 17:18:36 +01001831/* parse the "level" argument on the bind lines */
1832static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1833{
1834 if (!*args[cur_arg + 1]) {
1835 memprintf(err, "'%s' : missing level", args[cur_arg]);
1836 return ERR_ALERT | ERR_FATAL;
1837 }
1838
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001839 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001840 conf->level &= ~ACCESS_LVL_MASK;
1841 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001842 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001843 conf->level &= ~ACCESS_LVL_MASK;
1844 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001845 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001846 conf->level &= ~ACCESS_LVL_MASK;
1847 conf->level |= ACCESS_LVL_ADMIN;
1848 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001849 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1850 args[cur_arg], args[cur_arg+1]);
1851 return ERR_ALERT | ERR_FATAL;
1852 }
1853
1854 return 0;
1855}
1856
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001857static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1858{
1859 if (!*args[cur_arg + 1]) {
1860 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1861 return ERR_ALERT | ERR_FATAL;
1862 }
1863
1864 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1865 return 0;
1866 else {
1867 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1868 args[cur_arg], args[cur_arg+1]);
1869 return ERR_ALERT | ERR_FATAL;
1870 }
1871}
1872
Olivier Houchardf886e342017-04-05 22:24:59 +02001873/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001874static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001875{
1876 char *cmsgbuf = NULL;
1877 unsigned char *tmpbuf = NULL;
1878 struct cmsghdr *cmsg;
1879 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001880 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001881 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001882 struct msghdr msghdr;
1883 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001884 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001885 const char *ns_name, *if_name;
1886 unsigned char ns_nlen, if_nlen;
1887 int nb_queued;
1888 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001889 int *tmpfd;
1890 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001891 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001892 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001893 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001894 int ret;
1895
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001896 if (!remote) {
1897 ha_warning("Only works on real connections\n");
1898 goto out;
1899 }
1900
1901 fd = remote->handle.fd;
1902
Olivier Houchardf886e342017-04-05 22:24:59 +02001903 /* Temporary set the FD in blocking mode, that will make our life easier */
1904 old_fcntl = fcntl(fd, F_GETFL);
1905 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001906 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001907 goto out;
1908 }
1909 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1910 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001911 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001912 goto out;
1913 }
1914 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001915 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001916 goto out;
1917 }
Olivier Houchard54740872017-04-06 14:45:14 +02001918 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001919 iov.iov_base = &tot_fd_nb;
1920 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001921 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001922 goto out;
1923 memset(&msghdr, 0, sizeof(msghdr));
1924 /*
1925 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001926 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001927 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001928 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001929 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001930
Olivier Houchardf886e342017-04-05 22:24:59 +02001931 if (tot_fd_nb == 0)
1932 goto out;
1933
1934 /* First send the total number of file descriptors, so that the
1935 * receiving end knows what to expect.
1936 */
1937 msghdr.msg_iov = &iov;
1938 msghdr.msg_iovlen = 1;
1939 ret = sendmsg(fd, &msghdr, 0);
1940 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001941 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001942 goto out;
1943 }
1944
1945 /* Now send the fds */
1946 msghdr.msg_control = cmsgbuf;
1947 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1948 cmsg = CMSG_FIRSTHDR(&msghdr);
1949 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1950 cmsg->cmsg_level = SOL_SOCKET;
1951 cmsg->cmsg_type = SCM_RIGHTS;
1952 tmpfd = (int *)CMSG_DATA(cmsg);
1953
Olivier Houchardf886e342017-04-05 22:24:59 +02001954 /* For each socket, e message is sent, containing the following :
1955 * Size of the namespace name (or 0 if none), as an unsigned char.
1956 * The namespace name, if any
1957 * Size of the interface name (or 0 if none), as an unsigned char
1958 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001959 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001960 */
1961 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001962 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001963 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001964 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001965 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001966 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001967 goto out;
1968 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001969
1970 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001971 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001972 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001973 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001974 continue;
1975
1976 ns_name = if_name = "";
1977 ns_nlen = if_nlen = 0;
1978
1979 /* for now we can only retrieve namespaces and interfaces from
1980 * pure listeners.
1981 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001982 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001983 const struct listener *l = fdtab[cur_fd].owner;
1984
Willy Tarreau818a92e2020-09-03 07:50:19 +02001985 if (l->rx.settings->interface) {
1986 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001987 if_nlen = strlen(if_name);
1988 }
1989
1990#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001991 if (l->rx.settings->netns) {
1992 ns_name = l->rx.settings->netns->node.key;
1993 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001994 }
1995#endif
1996 }
1997
1998 /* put the FD into the CMSG_DATA */
1999 tmpfd[nb_queued++] = cur_fd;
2000
2001 /* first block is <ns_name_len> <ns_name> */
2002 tmpbuf[curoff++] = ns_nlen;
2003 if (ns_nlen)
2004 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2005 curoff += ns_nlen;
2006
2007 /* second block is <if_name_len> <if_name> */
2008 tmpbuf[curoff++] = if_nlen;
2009 if (if_nlen)
2010 memcpy(tmpbuf + curoff, if_name, if_nlen);
2011 curoff += if_nlen;
2012
2013 /* we used to send the listener options here before 2.3 */
2014 memset(tmpbuf + curoff, 0, sizeof(int));
2015 curoff += sizeof(int);
2016
2017 /* there's a limit to how many FDs may be sent at once */
2018 if (nb_queued == MAX_SEND_FD) {
2019 iov.iov_len = curoff;
2020 if (sendmsg(fd, &msghdr, 0) != curoff) {
2021 ha_warning("Failed to transfer sockets\n");
2022 return -1;
2023 }
2024
2025 /* Wait for an ack */
2026 do {
2027 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2028 } while (ret == -1 && errno == EINTR);
2029
2030 if (ret <= 0) {
2031 ha_warning("Unexpected error while transferring sockets\n");
2032 return -1;
2033 }
2034 curoff = 0;
2035 nb_queued = 0;
2036 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002037 }
2038
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002039 /* flush pending stuff */
2040 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002041 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002042 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2043 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002044 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002045 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002046 goto out;
2047 }
2048 }
2049
2050out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002051 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002052 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002053 goto out;
2054 }
2055 appctx->st0 = CLI_ST_END;
2056 free(cmsgbuf);
2057 free(tmpbuf);
2058 return 1;
2059}
2060
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002061static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2062{
2063 if (*args[0] == 'h')
2064 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002065 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002066 else if (*args[0] == 'p')
2067 /* prompt */
2068 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2069 else if (*args[0] == 'q')
2070 /* quit */
2071 appctx->st0 = CLI_ST_END;
2072
2073 return 1;
2074}
Olivier Houchardf886e342017-04-05 22:24:59 +02002075
William Lallemand2f4ce202018-10-26 14:47:47 +02002076void pcli_write_prompt(struct stream *s)
2077{
2078 struct buffer *msg = get_trash_chunk();
2079 struct channel *oc = si_oc(&s->si[0]);
2080
William Lallemanddc12c2e2018-12-13 09:05:46 +01002081 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002082 return;
2083
William Lallemanddc12c2e2018-12-13 09:05:46 +01002084 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002085 chunk_appendf(msg, "+ ");
2086 } else {
2087 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002088 chunk_appendf(msg, "master%s> ",
2089 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002090 else
2091 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2092 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002093 co_inject(oc, msg->area, msg->data);
2094}
2095
William Lallemand291810d2018-10-26 14:47:38 +02002096
William Lallemandcf62f7e2018-10-26 14:47:40 +02002097/* The pcli_* functions are used for the CLI proxy in the master */
2098
William Lallemanddeeaa592018-10-26 14:47:48 +02002099void pcli_reply_and_close(struct stream *s, const char *msg)
2100{
2101 struct buffer *buf = get_trash_chunk();
2102
2103 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002104 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002105}
2106
William Lallemand291810d2018-10-26 14:47:38 +02002107static enum obj_type *pcli_pid_to_server(int proc_pid)
2108{
2109 struct mworker_proc *child;
2110
William Lallemand99e0bb92020-11-05 10:28:53 +01002111 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002112 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002113 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002114
William Lallemand291810d2018-10-26 14:47:38 +02002115 list_for_each_entry(child, &proc_list, list) {
2116 if (child->pid == proc_pid){
2117 return &child->srv->obj_type;
2118 }
2119 }
2120 return NULL;
2121}
2122
2123/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2124 * Return:
2125 * 0: master
2126 * > 0: pid of a worker
2127 * < 0: didn't find a worker
2128 */
2129static int pcli_prefix_to_pid(const char *prefix)
2130{
2131 int proc_pid;
2132 struct mworker_proc *child;
2133 char *errtol = NULL;
2134
2135 if (*prefix != '@') /* not a prefix, should not happen */
2136 return -1;
2137
2138 prefix++;
2139 if (!*prefix) /* sent @ alone, return the master */
2140 return 0;
2141
2142 if (strcmp("master", prefix) == 0) {
2143 return 0;
2144 } else if (*prefix == '!') {
2145 prefix++;
2146 if (!*prefix)
2147 return -1;
2148
2149 proc_pid = strtol(prefix, &errtol, 10);
2150 if (*errtol != '\0')
2151 return -1;
2152 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002153 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002154 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002155 if (child->pid == proc_pid){
2156 return child->pid;
2157 }
2158 }
2159 } else {
2160 struct mworker_proc *chosen = NULL;
2161 /* this is a relative pid */
2162
2163 proc_pid = strtol(prefix, &errtol, 10);
2164 if (*errtol != '\0')
2165 return -1;
2166
2167 if (proc_pid == 0) /* return the master */
2168 return 0;
2169
2170 /* chose the right process, the current one is the one with the
2171 least number of reloads */
2172 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002173 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002174 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002175 if (child->relative_pid == proc_pid){
2176 if (child->reloads == 0)
2177 return child->pid;
2178 else if (chosen == NULL || child->reloads < chosen->reloads)
2179 chosen = child;
2180 }
2181 }
2182 if (chosen)
2183 return chosen->pid;
2184 }
2185 return -1;
2186}
2187
William Lallemandbddd33a2018-12-11 16:10:53 +01002188/* Return::
2189 * >= 0 : number of words to escape
2190 * = -1 : error
2191 */
2192
2193int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2194{
2195 if (argl < 1)
2196 return 0;
2197
2198 /* there is a prefix */
2199 if (args[0][0] == '@') {
2200 int target_pid = pcli_prefix_to_pid(args[0]);
2201
2202 if (target_pid == -1) {
2203 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2204 return -1;
2205 }
2206
2207 /* if the prefix is alone, define a default target */
2208 if (argl == 1)
2209 s->pcli_next_pid = target_pid;
2210 else
2211 *next_pid = target_pid;
2212 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002213 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002214 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002215 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002216
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002217 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002218 channel_shutr_now(&s->req);
2219 channel_shutw_now(&s->res);
2220 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002221 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002222 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2223 memprintf(errmsg, "Permission denied!\n");
2224 return -1;
2225 }
2226 s->pcli_flags &= ~ACCESS_LVL_MASK;
2227 s->pcli_flags |= ACCESS_LVL_OPER;
2228 return argl;
2229
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002230 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002231 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2232 memprintf(errmsg, "Permission denied!\n");
2233 return -1;
2234 }
2235 s->pcli_flags &= ~ACCESS_LVL_MASK;
2236 s->pcli_flags |= ACCESS_LVL_USER;
2237 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002238 }
2239
2240 return 0;
2241}
2242
2243/*
2244 * Parse the CLI request:
2245 * - It does basically the same as the cli_io_handler, but as a proxy
2246 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002247 *
2248 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002249 * - the number of characters to forward or
2250 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002251 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002252int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002253{
William Lallemandbddd33a2018-12-11 16:10:53 +01002254 char *str = (char *)ci_head(req);
2255 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002256 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002257 int argl; /* number of args */
2258 char *p;
2259 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002260 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002261 int wtrim = 0; /* number of words to trim */
2262 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002263 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002264 int i = 0;
2265
2266 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002267
William Lallemanddc12c2e2018-12-13 09:05:46 +01002268 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002269
2270 /* Looks for the end of one command */
2271 while (p+reql < end) {
2272 /* handle escaping */
2273 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002274 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002275 continue;
2276 }
2277 if (p[reql] == ';' || p[reql] == '\n') {
2278 /* found the end of the command */
2279 p[reql] = '\n';
2280 reql++;
2281 break;
2282 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002283 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002284 }
William Lallemandebf61802018-12-11 16:10:57 +01002285 } else {
2286 while (p+reql < end) {
2287 if (p[reql] == '\n') {
2288 /* found the end of the line */
2289 reql++;
2290 break;
2291 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002292 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002293 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002294 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002295
William Lallemandbddd33a2018-12-11 16:10:53 +01002296 /* set end to first byte after the end of the command */
2297 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002298
William Lallemandbddd33a2018-12-11 16:10:53 +01002299 /* there is no end to this command, need more to parse ! */
2300 if (*(end-1) != '\n') {
2301 return -1;
2302 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002303
William Lallemand3301f3e2018-12-13 09:05:48 +01002304 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2305 if (reql == 1) /* last line of the payload */
2306 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002307 return reql;
2308 }
2309
William Lallemandbddd33a2018-12-11 16:10:53 +01002310 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002311
William Lallemandbddd33a2018-12-11 16:10:53 +01002312 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002313 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002314 /* skip leading spaces/tabs */
2315 p += strspn(p, " \t");
2316 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002317 break;
2318
William Lallemandbddd33a2018-12-11 16:10:53 +01002319 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002320 while (1) {
2321 p += strcspn(p, " \t\\");
2322 /* escaped chars using backlashes (\) */
2323 if (*p == '\\') {
2324 if (!*++p)
2325 break;
2326 if (!*++p)
2327 break;
2328 } else {
2329 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002330 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002331 }
William Lallemandfe249c32020-06-18 18:03:57 +02002332 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002333 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002334 }
2335
William Lallemandbddd33a2018-12-11 16:10:53 +01002336 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002337
Willy Tarreauf14c7572021-03-13 10:59:23 +01002338 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002339 args[i] = NULL;
2340
2341 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2342
2343 /* End of words are ending by \0, we need to replace the \0s by spaces
23441 before forwarding them */
2345 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002346 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002347 if (*p == '\0')
2348 *p = ' ';
2349 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002350 }
2351
William Lallemand3301f3e2018-12-13 09:05:48 +01002352 payload = strstr(str, PAYLOAD_PATTERN);
2353 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2354 /* if the payload pattern is at the end */
2355 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002356 }
2357
William Lallemandbddd33a2018-12-11 16:10:53 +01002358 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002359
William Lallemandbddd33a2018-12-11 16:10:53 +01002360 if (wtrim > 0) {
2361 trim = &args[wtrim][0];
2362 if (trim == NULL) /* if this was the last word in the table */
2363 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002364
William Lallemandbddd33a2018-12-11 16:10:53 +01002365 b_del(&req->buf, trim - str);
2366
William Lallemandb7ea1412018-12-13 09:05:47 +01002367 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002368 } else if (wtrim < 0) {
2369 /* parsing error */
2370 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002371 } else {
2372 /* the whole string */
2373 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002374 }
2375
William Lallemandb7ea1412018-12-13 09:05:47 +01002376 if (ret > 1) {
2377 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2378 goto end;
2379 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002380 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2381 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002382 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002383 ci_insert_line2(req, 0, "user -", strlen("user -"));
2384 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002385 }
2386 }
2387end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002388
William Lallemandb7ea1412018-12-13 09:05:47 +01002389 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002390}
2391
2392int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2393{
William Lallemandbddd33a2018-12-11 16:10:53 +01002394 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002395 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002396 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002397
William Lallemandb7ea1412018-12-13 09:05:47 +01002398 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2399 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2400
William Lallemandcf62f7e2018-10-26 14:47:40 +02002401read_again:
2402 /* if the channel is closed for read, we won't receive any more data
2403 from the client, but we don't want to forward this close to the
2404 server */
2405 channel_dont_close(req);
2406
2407 /* We don't know yet to which server we will connect */
2408 channel_dont_connect(req);
2409
2410
2411 /* we are not waiting for a response, there is no more request and we
2412 * receive a close from the client, we can leave */
2413 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2414 channel_shutw_now(&s->res);
2415 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2416 return 1;
2417 }
2418
2419 req->flags |= CF_READ_DONTWAIT;
2420
2421 /* need more data */
2422 if (!ci_data(req))
2423 return 0;
2424
2425 /* If there is data available for analysis, log the end of the idle time. */
2426 if (c_data(req) && s->logs.t_idle == -1)
2427 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2428
William Lallemandbddd33a2018-12-11 16:10:53 +01002429 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002430 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002431 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432 /* enough data */
2433
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434 /* forward only 1 command */
2435 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002436
William Lallemanddc12c2e2018-12-13 09:05:46 +01002437 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002438 /* we send only 1 command per request, and we write close after it */
2439 channel_shutw_now(req);
2440 } else {
2441 pcli_write_prompt(s);
2442 }
2443
2444 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002445
2446 /* remove the XFER_DATA analysers, which forwards all
2447 * the data, we don't want to forward the next requests
2448 * We need to add CF_FLT_ANALYZE to abort the forward too.
2449 */
2450 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2451 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2452 s->res.analysers |= AN_RES_WAIT_CLI;
2453
William Lallemandebf61802018-12-11 16:10:57 +01002454 if (!(s->flags & SF_ASSIGNED)) {
2455 if (next_pid > -1)
2456 target_pid = next_pid;
2457 else
2458 target_pid = s->pcli_next_pid;
2459 /* we can connect now */
2460 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002461
William Lallemandebf61802018-12-11 16:10:57 +01002462 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2463 channel_auto_connect(req);
2464 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002465
2466 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002467 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002468 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002469 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002470 } else if (to_forward == -1 && errmsg) {
2471 /* there was an error during the parsing */
2472 pcli_reply_and_close(s, errmsg);
2473 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002474 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2475 /* buffer is full and we didn't catch the end of a command */
2476 goto send_help;
2477 }
2478
2479 return 0;
2480
2481send_help:
2482 b_reset(&req->buf);
2483 b_putblk(&req->buf, "help\n", 5);
2484 goto read_again;
2485}
2486
2487int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2488{
2489 struct proxy *fe = strm_fe(s);
2490 struct proxy *be = s->be;
2491
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002492 if (rep->flags & CF_READ_ERROR) {
2493 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2494 s->res.analysers &= ~AN_RES_WAIT_CLI;
2495 return 0;
2496 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002497 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2498 rep->flags |= CF_NEVER_WAIT;
2499
2500 /* don't forward the close */
2501 channel_dont_close(&s->res);
2502 channel_dont_close(&s->req);
2503
William Lallemanddc12c2e2018-12-13 09:05:46 +01002504 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002505 s->req.analysers |= AN_REQ_WAIT_CLI;
2506 s->res.analysers &= ~AN_RES_WAIT_CLI;
2507 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2508 return 0;
2509 }
2510
William Lallemandcf62f7e2018-10-26 14:47:40 +02002511 /* forward the data */
2512 if (ci_data(rep)) {
2513 c_adv(rep, ci_data(rep));
2514 return 0;
2515 }
2516
2517 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2518 /* stream cleanup */
2519
William Lallemand2f4ce202018-10-26 14:47:47 +02002520 pcli_write_prompt(s);
2521
William Lallemandcf62f7e2018-10-26 14:47:40 +02002522 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2523 si_shutr(&s->si[1]);
2524 si_shutw(&s->si[1]);
2525
2526 /*
2527 * starting from there this the same code as
2528 * http_end_txn_clean_session().
2529 *
2530 * It allows to do frontend keepalive while reconnecting to a
2531 * new server for each request.
2532 */
2533
2534 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002535 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002536 if (unlikely(s->srv_conn))
2537 sess_change_server(s, NULL);
2538 }
2539
2540 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2541 stream_process_counters(s);
2542
2543 /* don't count other requests' data */
2544 s->logs.bytes_in -= ci_data(&s->req);
2545 s->logs.bytes_out -= ci_data(&s->res);
2546
2547 /* we may need to know the position in the queue */
2548 pendconn_free(s);
2549
2550 /* let's do a final log if we need it */
2551 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2552 !(s->flags & SF_MONITOR) &&
2553 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2554 s->do_log(s);
2555 }
2556
2557 /* stop tracking content-based counters */
2558 stream_stop_content_counters(s);
2559 stream_update_time_stats(s);
2560
2561 s->logs.accept_date = date; /* user-visible date for logging */
2562 s->logs.tv_accept = now; /* corrected date for internal use */
2563 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2564 s->logs.t_idle = -1;
2565 tv_zero(&s->logs.tv_request);
2566 s->logs.t_queue = -1;
2567 s->logs.t_connect = -1;
2568 s->logs.t_data = -1;
2569 s->logs.t_close = 0;
2570 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2571 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2572
2573 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2574 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2575
2576 stream_del_srv_conn(s);
2577 if (objt_server(s->target)) {
2578 if (s->flags & SF_CURR_SESS) {
2579 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002580 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002581 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002582 if (may_dequeue_tasks(__objt_server(s->target), be))
2583 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002584 }
2585
2586 s->target = NULL;
2587
2588 /* only release our endpoint if we don't intend to reuse the
2589 * connection.
2590 */
2591 if (!si_conn_ready(&s->si[1])) {
2592 si_release_endpoint(&s->si[1]);
2593 s->srv_conn = NULL;
2594 }
2595
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002596 sockaddr_free(&s->target_addr);
2597
William Lallemandcf62f7e2018-10-26 14:47:40 +02002598 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2599 s->si[1].err_type = SI_ET_NONE;
2600 s->si[1].conn_retries = 0; /* used for logging too */
2601 s->si[1].exp = TICK_ETERNITY;
2602 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 +02002603 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 +02002604 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 +02002605 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2606 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2607 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2608 /* reinitialise the current rule list pointer to NULL. We are sure that
2609 * any rulelist match the NULL pointer.
2610 */
2611 s->current_rule_list = NULL;
2612
2613 s->be = strm_fe(s);
2614 s->logs.logwait = strm_fe(s)->to_log;
2615 s->logs.level = 0;
2616 stream_del_srv_conn(s);
2617 s->target = NULL;
2618 /* re-init store persistence */
2619 s->store_count = 0;
2620 s->uniq_id = global.req_count++;
2621
2622 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2623
2624 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2625
2626 s->req.analysers |= AN_REQ_WAIT_CLI;
2627 s->res.analysers &= ~AN_RES_WAIT_CLI;
2628
2629 /* We must trim any excess data from the response buffer, because we
2630 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002631 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002632 * we want those data to come along with next response. A typical
2633 * example of such data would be from a buggy server responding to
2634 * a HEAD with some data, or sending more than the advertised
2635 * content-length.
2636 */
2637 if (unlikely(ci_data(&s->res)))
2638 b_set_data(&s->res.buf, co_data(&s->res));
2639
2640 /* Now we can realign the response buffer */
2641 c_realign_if_empty(&s->res);
2642
2643 s->req.rto = strm_fe(s)->timeout.client;
2644 s->req.wto = TICK_ETERNITY;
2645
2646 s->res.rto = TICK_ETERNITY;
2647 s->res.wto = strm_fe(s)->timeout.client;
2648
2649 s->req.rex = TICK_ETERNITY;
2650 s->req.wex = TICK_ETERNITY;
2651 s->req.analyse_exp = TICK_ETERNITY;
2652 s->res.rex = TICK_ETERNITY;
2653 s->res.wex = TICK_ETERNITY;
2654 s->res.analyse_exp = TICK_ETERNITY;
2655 s->si[1].hcto = TICK_ETERNITY;
2656
2657 /* we're removing the analysers, we MUST re-enable events detection.
2658 * We don't enable close on the response channel since it's either
2659 * already closed, or in keep-alive with an idle connection handler.
2660 */
2661 channel_auto_read(&s->req);
2662 channel_auto_close(&s->req);
2663 channel_auto_read(&s->res);
2664
2665
2666 return 1;
2667 }
2668 return 0;
2669}
2670
William Lallemand8a022572018-10-26 14:47:35 +02002671/*
2672 * The mworker functions are used to initialize the CLI in the master process
2673 */
2674
William Lallemand309dc9a2018-10-26 14:47:45 +02002675 /*
2676 * Stop the mworker proxy
2677 */
2678void mworker_cli_proxy_stop()
2679{
William Lallemand550db6d2018-11-06 17:37:12 +01002680 if (mworker_proxy)
2681 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002682}
2683
William Lallemand8a022572018-10-26 14:47:35 +02002684/*
2685 * Create the mworker CLI proxy
2686 */
2687int mworker_cli_proxy_create()
2688{
2689 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002690 char *msg = NULL;
2691 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002692
2693 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2694 if (!mworker_proxy)
2695 return -1;
2696
2697 init_new_proxy(mworker_proxy);
2698 mworker_proxy->next = proxies_list;
2699 proxies_list = mworker_proxy;
2700 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002701 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002702 mworker_proxy->last_change = now.tv_sec;
2703 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2704 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2705 mworker_proxy->timeout.client = 0; /* no timeout */
2706 mworker_proxy->conf.file = strdup("MASTER");
2707 mworker_proxy->conf.line = 0;
2708 mworker_proxy->accept = frontend_accept;
2709 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2710
2711 /* Does not init the default target the CLI applet, but must be done in
2712 * the request parsing code */
2713 mworker_proxy->default_target = NULL;
2714
2715 /* the check_config_validity() will get an ID for the proxy */
2716 mworker_proxy->uuid = -1;
2717
2718 proxy_store_name(mworker_proxy);
2719
2720 /* create all servers using the mworker_proc list */
2721 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002722 struct server *newsrv = NULL;
2723 struct sockaddr_storage *sk;
2724 int port1, port2, port;
2725 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002726
William Lallemanda31b09e2020-01-14 15:25:02 +01002727 /* only the workers support the master CLI */
2728 if (!(child->options & PROC_O_TYPE_WORKER))
2729 continue;
2730
William Lallemand8a022572018-10-26 14:47:35 +02002731 newsrv = new_server(mworker_proxy);
2732 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002733 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002734
2735 /* we don't know the new pid yet */
2736 if (child->pid == -1)
2737 memprintf(&msg, "cur-%d", child->relative_pid);
2738 else
2739 memprintf(&msg, "old-%d", child->pid);
2740
2741 newsrv->next = mworker_proxy->srv;
2742 mworker_proxy->srv = newsrv;
2743 newsrv->conf.file = strdup(msg);
2744 newsrv->id = strdup(msg);
2745 newsrv->conf.line = 0;
2746
2747 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002748 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002749 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002750 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002751 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002752 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002753
Willy Tarreau5fc93282020-09-16 18:25:03 +02002754 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002755 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002756 }
2757
2758 /* no port specified */
2759 newsrv->flags |= SRV_F_MAPPORTS;
2760 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002761 /* don't let the server participate to load balancing */
2762 newsrv->iweight = 0;
2763 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002764 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002765
2766 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002767 }
2768 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002769
2770error:
2771 ha_alert("%s\n", errmsg);
2772
2773 list_for_each_entry(child, &proc_list, list) {
2774 free((char *)child->srv->conf.file); /* cast because of const char * */
2775 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002776 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002777 }
2778 free(mworker_proxy->id);
2779 free(mworker_proxy->conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002780 ha_free(&mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002781 free(errmsg);
2782 free(msg);
2783
2784 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002785}
Olivier Houchardf886e342017-04-05 22:24:59 +02002786
William Lallemandce83b4a2018-10-26 14:47:30 +02002787/*
William Lallemande7361152018-10-26 14:47:36 +02002788 * Create a new listener for the master CLI proxy
2789 */
2790int mworker_cli_proxy_new_listener(char *line)
2791{
2792 struct bind_conf *bind_conf;
2793 struct listener *l;
2794 char *err = NULL;
2795 char *args[MAX_LINE_ARGS + 1];
2796 int arg;
2797 int cur_arg;
2798
William Lallemand2e945c82019-11-25 09:58:37 +01002799 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002800 args[0] = line;
2801
2802 /* args is a bind configuration with spaces replaced by commas */
2803 while (*line && arg < MAX_LINE_ARGS) {
2804
2805 if (*line == ',') {
2806 *line++ = '\0';
2807 while (*line == ',')
2808 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002809 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002810 }
2811 line++;
2812 }
2813
William Lallemand2e945c82019-11-25 09:58:37 +01002814 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002815
2816 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002817 if (!bind_conf)
2818 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002819
2820 bind_conf->level &= ~ACCESS_LVL_MASK;
2821 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002822 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002823
2824 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2825 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002826 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002827 }
2828
2829 cur_arg = 1;
2830
2831 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002832 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002833 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002834
2835 kw = bind_find_kw(args[cur_arg]);
2836 if (kw) {
2837 if (!kw->parse) {
2838 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2839 args[0], args[1], args[cur_arg]);
2840 goto err;
2841 }
2842
Willy Tarreau4975d142021-03-13 11:00:33 +01002843 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002844 if (err)
2845 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2846 else
2847 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2848 args[0], args[1], args[cur_arg]);
2849 goto err;
2850 }
2851
2852 cur_arg += 1 + kw->skip;
2853 continue;
2854 }
2855
Willy Tarreau433b05f2021-03-12 10:14:07 +01002856 best = bind_find_best_kw(args[cur_arg]);
2857 if (best)
2858 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2859 args[0], args[1], args[cur_arg], best);
2860 else
2861 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2862 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002863 goto err;
2864 }
2865
2866
2867 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002868 l->accept = session_accept_fd;
2869 l->default_target = mworker_proxy->default_target;
2870 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002871 l->options |= LI_O_UNLIMITED;
2872 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002873 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002874 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002875 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002876 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002877
2878 return 0;
2879
2880err:
2881 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002882 free(err);
2883 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002884 return -1;
2885
2886}
2887
2888/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002889 * Create a new CLI socket using a socketpair for a worker process
2890 * <mworker_proc> is the process structure, and <proc> is the process number
2891 */
2892int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2893{
2894 struct bind_conf *bind_conf;
2895 struct listener *l;
2896 char *path = NULL;
2897 char *err = NULL;
2898
2899 /* master pipe to ensure the master is still alive */
2900 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2901 ha_alert("Cannot create worker socketpair.\n");
2902 return -1;
2903 }
2904
2905 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002906 if (!global.cli_fe) {
2907 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002908 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002909 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002910 }
2911 }
2912
Willy Tarreau4975d142021-03-13 11:00:33 +01002913 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002914 if (!bind_conf)
2915 goto error;
2916
William Lallemandce83b4a2018-10-26 14:47:30 +02002917 bind_conf->level &= ~ACCESS_LVL_MASK;
2918 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2919
Willy Tarreaue26993c2020-09-03 07:18:55 +02002920 bind_conf->settings.bind_proc = 1UL << proc;
Willy Tarreau4975d142021-03-13 11:00:33 +01002921 global.cli_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
William Lallemandce83b4a2018-10-26 14:47:30 +02002922
2923 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2924 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002925 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002926 }
2927
Willy Tarreau4975d142021-03-13 11:00:33 +01002928 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002929 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002930 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002931 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002932 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002933 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002934
2935 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002936 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002937 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002938 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002939 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002940 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002941 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002942 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002943 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002944 }
2945
2946 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002947
2948error:
2949 close(mworker_proc->ipc_fd[0]);
2950 close(mworker_proc->ipc_fd[1]);
2951 free(err);
2952
2953 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002954}
2955
William Lallemand74c24fb2016-11-21 17:18:36 +01002956static struct applet cli_applet = {
2957 .obj_type = OBJ_TYPE_APPLET,
2958 .name = "<CLI>", /* used for logging */
2959 .fct = cli_io_handler,
2960 .release = cli_release_handler,
2961};
2962
William Lallemand99e0bb92020-11-05 10:28:53 +01002963/* master CLI */
2964static struct applet mcli_applet = {
2965 .obj_type = OBJ_TYPE_APPLET,
2966 .name = "<MCLI>", /* used for logging */
2967 .fct = cli_io_handler,
2968 .release = cli_release_handler,
2969};
2970
Willy Tarreau0a739292016-11-22 20:21:23 +01002971/* register cli keywords */
2972static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002973 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2974 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2975 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2976 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
2977 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2978 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2979 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
2980 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
2981 { { "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 },
2982 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
2983 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
2984 { { "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 },
2985 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2986 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use or a specific one", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
2987 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
2988 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2989 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau0a739292016-11-22 20:21:23 +01002990 {{},}
2991}};
2992
Willy Tarreau0108d902018-11-25 19:14:37 +01002993INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2994
William Lallemand74c24fb2016-11-21 17:18:36 +01002995static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002996 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002997 { 0, NULL, NULL },
2998}};
2999
Willy Tarreau0108d902018-11-25 19:14:37 +01003000INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3001
William Lallemand74c24fb2016-11-21 17:18:36 +01003002static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003003 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3004 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003005 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003006 { NULL, NULL, 0 },
3007}};
3008
Willy Tarreau0108d902018-11-25 19:14:37 +01003009INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003010
3011/*
3012 * Local variables:
3013 * c-indent-level: 8
3014 * c-basic-offset: 8
3015 * End:
3016 */