blob: ed2af9c20ccee0d7c5afa7d0464286027f65d59b [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 Tarreau5db446d2021-05-10 07:47:05 +0200146 else if (!length && (!args || !*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 Tarreau72faef32021-06-15 08:36:30 +0200546 if (parse_process_number(args[cur_arg], &set, 1, 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 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100552 }
553 else {
554 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
555 return -1;
556 }
557 return 0;
558}
559
William Lallemand33d29e22019-04-01 11:30:06 +0200560/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200561 * This function exports the bound addresses of a <frontend> in the environment
562 * variable <varname>. Those addresses are separated by semicolons and prefixed
563 * with their type (abns@, unix@, sockpair@ etc)
564 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200565 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200566int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200567{
568 struct buffer *trash = get_trash_chunk();
569 struct bind_conf *bind_conf;
570
William Lallemand9a37fd02019-04-12 16:09:24 +0200571 if (frontend) {
572 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200573 struct listener *l;
574
575 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
576 char addr[46];
577 char port[6];
578
William Lallemand620072b2019-04-12 16:09:25 +0200579 /* separate listener by semicolons */
580 if (trash->data)
581 chunk_appendf(trash, ";");
582
Willy Tarreau37159062020-08-27 07:48:42 +0200583 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200584 const struct sockaddr_un *un;
585
Willy Tarreau37159062020-08-27 07:48:42 +0200586 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200587 if (un->sun_path[0] == '\0') {
588 chunk_appendf(trash, "abns@%s", un->sun_path+1);
589 } else {
590 chunk_appendf(trash, "unix@%s", un->sun_path);
591 }
Willy Tarreau37159062020-08-27 07:48:42 +0200592 } else if (l->rx.addr.ss_family == AF_INET) {
593 addr_to_str(&l->rx.addr, addr, sizeof(addr));
594 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200595 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200596 } else if (l->rx.addr.ss_family == AF_INET6) {
597 addr_to_str(&l->rx.addr, addr, sizeof(addr));
598 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200599 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200600 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
601 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200602 }
William Lallemand33d29e22019-04-01 11:30:06 +0200603 }
604 }
605 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200606 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200607 return -1;
608 }
609
610 return 0;
611}
612
William Lallemand9a37fd02019-04-12 16:09:24 +0200613int cli_socket_setenv()
614{
Willy Tarreau4975d142021-03-13 11:00:33 +0100615 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200616 return -1;
617 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
618 return -1;
619
620 return 0;
621}
622
William Lallemand33d29e22019-04-01 11:30:06 +0200623REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
624
Willy Tarreaude57a572016-11-23 17:01:39 +0100625/* Verifies that the CLI at least has a level at least as high as <level>
626 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
627 * failure, an error message is prepared and the appctx's state is adjusted
628 * to print it so that a return 1 is enough to abort any processing.
629 */
630int cli_has_level(struct appctx *appctx, int level)
631{
Willy Tarreaude57a572016-11-23 17:01:39 +0100632
William Lallemandf630d012018-12-13 09:05:44 +0100633 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100634 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100635 return 0;
636 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100637 return 1;
638}
639
William Lallemandb7ea1412018-12-13 09:05:47 +0100640/* same as cli_has_level but for the CLI proxy and without error message */
641int pcli_has_level(struct stream *s, int level)
642{
643 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
644 return 0;
645 }
646 return 1;
647}
648
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200649/* Returns severity_output for the current session if set, or default for the socket */
650static int cli_get_severity_output(struct appctx *appctx)
651{
652 if (appctx->cli_severity_output)
653 return appctx->cli_severity_output;
654 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
655}
William Lallemand74c24fb2016-11-21 17:18:36 +0100656
Willy Tarreau41908562016-11-24 16:23:38 +0100657/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100658 * from the CLI's IO handler running in an appctx context. The function returns
659 * 1 if the request was understood, otherwise zero (in which case an error
660 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100661 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
662 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
663 * have its own I/O handler called again. Most of the time, parsers will only
664 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100665 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
666 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100667 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200668static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100669{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100670 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200671 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100672 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100673
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200674 appctx->st2 = 0;
675 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100676
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200677 p = appctx->chunk->area;
678 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100679
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200680 /*
681 * Get the payload start if there is one.
682 * For the sake of simplicity, the payload pattern is looked up
683 * everywhere from the start of the input but it can only be found
684 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
685 *
686 * The input string was zero terminated so it is safe to use
687 * the str*() functions throughout the parsing
688 */
689 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
690 payload = strstr(p, PAYLOAD_PATTERN);
691 end = payload;
692 /* skip the pattern */
693 payload += strlen(PAYLOAD_PATTERN);
694 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100695
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200696 /*
697 * Get pointers on words.
698 * One extra slot is reserved to store a pointer on a null byte.
699 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100700 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200701 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100702
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200703 /* skip leading spaces/tabs */
704 p += strspn(p, " \t");
705 if (!*p)
706 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100707
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200708 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200709 while (1) {
710 p += strcspn(p, " \t\\");
711 /* escaped chars using backlashes (\) */
712 if (*p == '\\') {
713 if (!*++p)
714 break;
715 if (!*++p)
716 break;
717 } else {
718 break;
719 }
720 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200721 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100722
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200723 /* unescape backslashes (\) */
724 for (j = 0, k = 0; args[i][k]; k++) {
725 if (args[i][k] == '\\') {
726 if (args[i][k + 1] == '\\')
727 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100728 else
729 continue;
730 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200731 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100732 j++;
733 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200734 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100735
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736 i++;
737 }
738 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200739 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100740 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100742
743 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100744 if (!kw ||
745 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
746 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
747 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100748 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100749 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100750 }
William Lallemand14721be2018-10-26 14:47:37 +0200751
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100752 /* don't handle expert mode commands if not in this mode. */
753 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
754 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200755 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100756 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200757
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100758 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
759 cli_err(appctx, "This command is restricted to experimental mode only.\n");
760 return 0;
761 }
762
Amaury Denoyellef4929922021-05-05 16:29:23 +0200763 if (kw->level == ACCESS_EXPERT)
764 mark_tainted(TAINTED_CLI_EXPERT_MODE);
765 else if (kw->level == ACCESS_EXPERIMENTAL)
766 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
767
Willy Tarreau41908562016-11-24 16:23:38 +0100768 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200769 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200770
771 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
772 goto fail;
773
774 /* kw->parse could set its own io_handler or io_release handler */
775 if (!appctx->io_handler)
776 goto fail;
777
778 appctx->st0 = CLI_ST_CALLBACK;
779 return 1;
780fail:
781 appctx->io_handler = NULL;
782 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100783 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100784}
785
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200786/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
787static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
788{
Willy Tarreau83061a82018-07-13 11:56:34 +0200789 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200790
791 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200792 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200793
794 tmp = get_trash_chunk();
795 chunk_reset(tmp);
796
797 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100798 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200799 chunk_printf(tmp, "[%d]: ", severity);
800 }
801 else {
802 switch (severity_output) {
803 case CLI_SEVERITY_NUMBER:
804 chunk_printf(tmp, "[%d]: ", severity);
805 break;
806 case CLI_SEVERITY_STRING:
807 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
808 break;
809 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100810 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200811 }
812 }
813 chunk_appendf(tmp, "%s", msg);
814
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200815 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200816}
817
William Lallemand74c24fb2016-11-21 17:18:36 +0100818/* This I/O handler runs as an applet embedded in a stream interface. It is
819 * used to processes I/O from/to the stats unix socket. The system relies on a
820 * state machine handling requests and various responses. We read a request,
821 * then we process it and send the response, and we possibly display a prompt.
822 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100823 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100824 * or not.
825 */
826static void cli_io_handler(struct appctx *appctx)
827{
828 struct stream_interface *si = appctx->owner;
829 struct channel *req = si_oc(si);
830 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200831 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100832 int reql;
833 int len;
834
835 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
836 goto out;
837
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800838 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200839 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100840 /* buf.size==0 means we failed to get a buffer and were
841 * already subscribed to a wait list to get a buffer.
842 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100843 goto out;
844 }
845
William Lallemand74c24fb2016-11-21 17:18:36 +0100846 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100847 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100848 /* Stats output not initialized yet */
849 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200850 /* reset severity to default at init */
851 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100852 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100853 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100854 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100855 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100856 /* Let's close for real now. We just close the request
857 * side, the conditions below will complete if needed.
858 */
859 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200860 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200861 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100862 break;
863 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100864 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200865 char *str;
866
867 /* use a trash chunk to store received data */
868 if (!appctx->chunk) {
869 appctx->chunk = alloc_trash_chunk();
870 if (!appctx->chunk) {
871 appctx->st0 = CLI_ST_END;
872 continue;
873 }
874 }
875
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200876 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200877
William Lallemand74c24fb2016-11-21 17:18:36 +0100878 /* ensure we have some output room left in the event we
879 * would want to return some info right after parsing.
880 */
881 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100882 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100883 break;
884 }
885
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200886 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200887 reql = co_getline(si_oc(si), str,
888 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100889 if (reql <= 0) { /* closed or EOL not found */
890 if (reql == 0)
891 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100892 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100893 continue;
894 }
895
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200896 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
897 /* seek for a possible unescaped semi-colon. If we find
898 * one, we replace it with an LF and skip only this part.
899 */
900 for (len = 0; len < reql; len++) {
901 if (str[len] == '\\') {
902 len++;
903 continue;
904 }
905 if (str[len] == ';') {
906 str[len] = '\n';
907 reql = len + 1;
908 break;
909 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100910 }
911 }
912
913 /* now it is time to check that we have a full line,
914 * remove the trailing \n and possibly \r, then cut the
915 * line.
916 */
917 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200918 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100919 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100920 continue;
921 }
922
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200923 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100924 len--;
925
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200926 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200927 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200928
929 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200930 appctx->chunk->area[appctx->chunk->data] = '\n';
931 appctx->chunk->area[appctx->chunk->data + 1] = 0;
932 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200933 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100934
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100935 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200936
937 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
938 /* empty line */
939 if (!len) {
940 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200941 appctx->chunk->data -= 2;
942 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100943 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200944 chunk_reset(appctx->chunk);
945 /* NB: cli_sock_parse_request() may have put
946 * another CLI_ST_O_* into appctx->st0.
947 */
948
949 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100950 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200952 else {
953 /*
954 * Look for the "payload start" pattern at the end of a line
955 * Its location is not remembered here, this is just to switch
956 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100957 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100958 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200959 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200960 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200961 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100962 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200963 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200964 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100965 }
966
967 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200968 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100969 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
970 }
971 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200972 const char *msg;
973 int sev;
974
William Lallemand74c24fb2016-11-21 17:18:36 +0100975 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100976 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100977 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200978 case CLI_ST_PRINT: /* print const message in msg */
979 case CLI_ST_PRINT_ERR: /* print const error in msg */
980 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
981 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
982 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
983 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
984 LOG_ERR : appctx->ctx.cli.severity;
985 msg = appctx->ctx.cli.msg;
986 }
987 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
988 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
989 LOG_ERR : appctx->ctx.cli.severity;
990 msg = appctx->ctx.cli.err;
991 if (!msg) {
992 sev = LOG_ERR;
993 msg = "Out of memory.\n";
994 }
995 }
996 else {
997 sev = LOG_ERR;
998 msg = "Internal error.\n";
999 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001000
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001001 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1002 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1003 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001004 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001005 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001006 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001007 }
1008 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001009 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001010 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001011
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001012 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001013 if (appctx->io_handler)
1014 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001015 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001016 if (appctx->io_release) {
1017 appctx->io_release(appctx);
1018 appctx->io_release = NULL;
1019 }
1020 }
1021 break;
1022 default: /* abnormal state */
1023 si->flags |= SI_FL_ERR;
1024 break;
1025 }
1026
1027 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001028 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001029 const char *prompt = "";
1030
1031 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1032 /*
1033 * when entering a payload with interactive mode, change the prompt
1034 * to emphasize that more data can still be sent
1035 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001036 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001037 prompt = "+ ";
1038 else
1039 prompt = "\n> ";
1040 }
1041 else {
William Lallemandad032882019-07-01 10:56:15 +02001042 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001043 prompt = "\n";
1044 }
1045
1046 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001047 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001048 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001049 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001050 }
1051
1052 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001053 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001054 break;
1055
1056 /* Now we close the output if one of the writers did so,
1057 * or if we're not in interactive mode and the request
1058 * buffer is empty. This still allows pipelined requests
1059 * to be sent in non-interactive mode.
1060 */
William Lallemand3de09d52018-12-11 16:10:56 +01001061 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1062 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001063 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001064 continue;
1065 }
1066
1067 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001068 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001069 /* reactivate the \n at the end of the response for the next command */
1070 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001071 }
1072 }
1073
1074 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1075 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1076 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1077 /* Other side has closed, let's abort if we have no more processing to do
1078 * and nothing more to consume. This is comparable to a broken pipe, so
1079 * we forward the close to the request side so that it flows upstream to
1080 * the client.
1081 */
1082 si_shutw(si);
1083 }
1084
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001085 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001086 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1087 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1088 /* We have no more processing to do, and nothing more to send, and
1089 * the client side has closed. So we'll forward this state downstream
1090 * on the response buffer.
1091 */
1092 si_shutr(si);
1093 res->flags |= CF_READ_NULL;
1094 }
1095
1096 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001097 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 +01001098 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001099 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 +01001100}
1101
William Lallemand74c24fb2016-11-21 17:18:36 +01001102/* This is called when the stream interface is closed. For instance, upon an
1103 * external abort, we won't call the i/o handler anymore so we may need to
1104 * remove back references to the stream currently being dumped.
1105 */
1106static void cli_release_handler(struct appctx *appctx)
1107{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001108 free_trash_chunk(appctx->chunk);
1109 appctx->chunk = NULL;
1110
William Lallemand74c24fb2016-11-21 17:18:36 +01001111 if (appctx->io_release) {
1112 appctx->io_release(appctx);
1113 appctx->io_release = NULL;
1114 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001115 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001116 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001117 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001118}
1119
1120/* This function dumps all environmnent variables to the buffer. It returns 0
1121 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001122 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1123 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001124 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001125static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001126{
Willy Tarreau0a739292016-11-22 20:21:23 +01001127 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001128 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001129
1130 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1131 return 1;
1132
1133 chunk_reset(&trash);
1134
1135 /* we have two inner loops here, one for the proxy, the other one for
1136 * the buffer.
1137 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001138 while (*var) {
1139 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001140
Willy Tarreau06d80a92017-10-19 14:32:15 +02001141 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001142 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001143 return 0;
1144 }
1145 if (appctx->st2 == STAT_ST_END)
1146 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001147 var++;
1148 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001149 }
1150
1151 /* dump complete */
1152 return 1;
1153}
1154
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001155/* This function dumps all file descriptors states (or the requested one) to
1156 * the buffer. It returns 0 if the output buffer is full and it needs to be
1157 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1158 * It uses cli.i0 as the fd number to restart from.
1159 */
1160static int cli_io_handler_show_fd(struct appctx *appctx)
1161{
1162 struct stream_interface *si = appctx->owner;
1163 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001164 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001165
1166 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001167 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001168
1169 chunk_reset(&trash);
1170
Willy Tarreauca1b1572018-12-18 15:45:11 +01001171 /* isolate the threads once per round. We're limited to a buffer worth
1172 * of output anyway, it cannot last very long.
1173 */
1174 thread_isolate();
1175
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001176 /* we have two inner loops here, one for the proxy, the other one for
1177 * the buffer.
1178 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001179 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001180 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001181 const struct listener *li = NULL;
1182 const struct server *sv = NULL;
1183 const struct proxy *px = NULL;
1184 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001185 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001186 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001187 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001188 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001189 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001190 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001191 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001192
1193 fdt = fdtab[fd];
1194
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001195 /* When DEBUG_FD is set, we also report closed FDs that have a
1196 * non-null event count to detect stuck ones.
1197 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001198 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001199#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001200 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001201#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001202 goto skip; // closed
1203 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001204 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001205 conn = (const struct connection *)fdt.owner;
1206 conn_flags = conn->flags;
1207 mux = conn->mux;
1208 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001209 xprt = conn->xprt;
1210 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001211 li = objt_listener(conn->target);
1212 sv = objt_server(conn->target);
1213 px = objt_proxy(conn->target);
1214 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001215 if (atleast2(fdt.thread_mask))
1216 suspicious = 1;
1217 if (conn->handle.fd != fd)
1218 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001219 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001220 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001221 li = fdt.owner;
1222
Willy Tarreaudacfde42021-01-21 09:07:29 +01001223 if (!fdt.thread_mask)
1224 suspicious = 1;
1225
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001226 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001227 " %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 +02001228 fd,
1229 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001230 (fdt.state & FD_CLONED) ? 'C' : 'c',
1231 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001232 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1233 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1234 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1235 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1236 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001237 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1238 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1239 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1240 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1241 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1242 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001243 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001244 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001245 fdt.iocb);
1246 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001247
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001248 if (!fdt.owner) {
1249 chunk_appendf(&trash, ")");
1250 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001251 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001252 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001253
1254 if (conn->handle.fd != fd) {
1255 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1256 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001257 } else {
1258 struct sockaddr_storage sa;
1259 socklen_t salen;
1260
1261 salen = sizeof(sa);
1262 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1263 if (sa.ss_family == AF_INET)
1264 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1265 else if (sa.ss_family == AF_INET6)
1266 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1267 else if (sa.ss_family == AF_UNIX)
1268 chunk_appendf(&trash, " fam=unix");
1269 }
1270
1271 salen = sizeof(sa);
1272 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1273 if (sa.ss_family == AF_INET)
1274 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1275 else if (sa.ss_family == AF_INET6)
1276 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1277 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001278 }
1279
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001280 if (px)
1281 chunk_appendf(&trash, " px=%s", px->id);
1282 else if (sv)
1283 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1284 else if (li)
1285 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001286
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001287 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001288 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001289 if (!ctx)
1290 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001291 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001292 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001293 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001294 else
1295 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001296
1297 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001298 if (xprt) {
1299 if (xprt_ctx || xprt->show_fd)
1300 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1301 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001302 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001303 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001304 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001305 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001306 struct sockaddr_storage sa;
1307 socklen_t salen;
1308
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001309 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001310 listener_state_str(li),
1311 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001312
1313 salen = sizeof(sa);
1314 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1315 if (sa.ss_family == AF_INET)
1316 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1317 else if (sa.ss_family == AF_INET6)
1318 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1319 else if (sa.ss_family == AF_UNIX)
1320 chunk_appendf(&trash, " fam=unix");
1321 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001322 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001323 else
1324 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001325
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001326#ifdef DEBUG_FD
1327 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001328 if (fdtab[fd].event_count >= 1000000)
1329 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001330#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001331 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001332
Willy Tarreau06d80a92017-10-19 14:32:15 +02001333 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001334 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001335 appctx->ctx.cli.i0 = fd;
1336 ret = 0;
1337 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001338 }
1339 skip:
1340 if (appctx->st2 == STAT_ST_END)
1341 break;
1342
1343 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001344 }
1345
Willy Tarreauca1b1572018-12-18 15:45:11 +01001346 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001347 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001348
1349 thread_release();
1350 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001351}
1352
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001353/* This function dumps some activity counters used by developers and support to
1354 * rule out some hypothesis during bug reports. It returns 0 if the output
1355 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1356 * everything at once in the buffer and is not designed to do it in multiple
1357 * passes.
1358 */
1359static int cli_io_handler_show_activity(struct appctx *appctx)
1360{
1361 struct stream_interface *si = appctx->owner;
1362 int thr;
1363
1364 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1365 return 1;
1366
1367 chunk_reset(&trash);
1368
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001369#undef SHOW_TOT
1370#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001371 do { \
1372 unsigned int _v[MAX_THREADS]; \
1373 unsigned int _tot; \
1374 const unsigned int _nbt = global.nbthread; \
1375 for (_tot = t = 0; t < _nbt; t++) \
1376 _tot += _v[t] = (x); \
1377 if (_nbt == 1) { \
1378 chunk_appendf(&trash, " %u\n", _tot); \
1379 break; \
1380 } \
1381 chunk_appendf(&trash, " %u [", _tot); \
1382 for (t = 0; t < _nbt; t++) \
1383 chunk_appendf(&trash, " %u", _v[t]); \
1384 chunk_appendf(&trash, " ]\n"); \
1385 } while (0)
1386
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001387#undef SHOW_AVG
1388#define SHOW_AVG(t, x) \
1389 do { \
1390 unsigned int _v[MAX_THREADS]; \
1391 unsigned int _tot; \
1392 const unsigned int _nbt = global.nbthread; \
1393 for (_tot = t = 0; t < _nbt; t++) \
1394 _tot += _v[t] = (x); \
1395 if (_nbt == 1) { \
1396 chunk_appendf(&trash, " %u\n", _tot); \
1397 break; \
1398 } \
1399 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1400 for (t = 0; t < _nbt; t++) \
1401 chunk_appendf(&trash, " %u", _v[t]); \
1402 chunk_appendf(&trash, " ]\n"); \
1403 } while (0)
1404
Willy Tarreaua0211b82019-05-28 15:09:08 +02001405 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1406 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001407 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1408 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1409 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1410 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001411 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001412 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1413 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001414 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001415 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001416 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1417 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1418 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001419 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001420 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001421 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1422 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001423 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1424 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1425 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1426 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1427 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1428 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1429 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001430#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001431 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 +02001432 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001433#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001434
Willy Tarreaud6a78502019-05-27 07:03:38 +02001435#if defined(DEBUG_DEV)
1436 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001437 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1438 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1439 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001440#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001441
1442 if (ci_putchk(si_ic(si), &trash) == -1) {
1443 chunk_reset(&trash);
1444 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001445 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001446 }
1447
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001448#undef SHOW_AVG
1449#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001450 /* dump complete */
1451 return 1;
1452}
1453
William Lallemandeceddf72016-12-15 18:06:44 +01001454/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001455 * CLI IO handler for `show cli sockets`.
1456 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001457 */
1458static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1459{
1460 struct bind_conf *bind_conf;
1461 struct stream_interface *si = appctx->owner;
1462
1463 chunk_reset(&trash);
1464
1465 switch (appctx->st2) {
1466 case STAT_ST_INIT:
1467 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001468 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001469 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001470 return 0;
1471 }
William Lallemandeceddf72016-12-15 18:06:44 +01001472 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001473 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001474
1475 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001476 if (global.cli_fe) {
1477 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001478 struct listener *l;
1479
1480 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001481 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001482 * if the current node is the first of the list
1483 */
1484
Willy Tarreau3af9d832016-12-16 12:58:09 +01001485 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001486 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001487 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001488 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001489 continue;
1490 }
1491
1492 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1493
1494 char addr[46];
1495 char port[6];
1496
Willy Tarreau37159062020-08-27 07:48:42 +02001497 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001498 const struct sockaddr_un *un;
1499
Willy Tarreau37159062020-08-27 07:48:42 +02001500 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001501 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001502 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001503 } else {
1504 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1505 }
Willy Tarreau37159062020-08-27 07:48:42 +02001506 } else if (l->rx.addr.ss_family == AF_INET) {
1507 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1508 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001509 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001510 } else if (l->rx.addr.ss_family == AF_INET6) {
1511 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1512 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001513 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001514 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1515 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001516 } else
William Lallemand26314342018-10-26 14:47:41 +02001517 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001518
William Lallemand07a62f72017-05-24 00:57:40 +02001519 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001520 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001521 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1522 chunk_appendf(&trash, "operator ");
1523 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1524 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001525 else
1526 chunk_appendf(&trash, " ");
1527
Willy Tarreau72faef32021-06-15 08:36:30 +02001528 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001529
Willy Tarreau06d80a92017-10-19 14:32:15 +02001530 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001531 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001532 return 0;
1533 }
1534 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001535 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001536 }
1537 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001538 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001539 default:
1540 appctx->st2 = STAT_ST_FIN;
1541 return 1;
1542 }
1543}
1544
1545
Willy Tarreau0a739292016-11-22 20:21:23 +01001546/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001547 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1548 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001549 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001550static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001551{
1552 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001553 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001554
1555 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1556 return 1;
1557
Willy Tarreauf6710f82016-12-16 17:45:44 +01001558 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001559
1560 if (*args[2]) {
1561 int len = strlen(args[2]);
1562
Willy Tarreauf6710f82016-12-16 17:45:44 +01001563 for (; *var; var++) {
1564 if (strncmp(*var, args[2], len) == 0 &&
1565 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001566 break;
1567 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001568 if (!*var)
1569 return cli_err(appctx, "Variable not found\n");
1570
Willy Tarreau0a739292016-11-22 20:21:23 +01001571 appctx->st2 = STAT_ST_END;
1572 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001573 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001574 return 0;
1575}
1576
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001577/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1578 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1579 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1580 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001581static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001582{
1583 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1584 return 1;
1585
1586 appctx->ctx.cli.i0 = 0;
1587
1588 if (*args[2]) {
1589 appctx->ctx.cli.i0 = atoi(args[2]);
1590 appctx->st2 = STAT_ST_END;
1591 }
1592 return 0;
1593}
1594
Willy Tarreau599852e2016-11-22 20:33:32 +01001595/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001596static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001597{
1598 struct stream_interface *si = appctx->owner;
1599 struct stream *s = si_strm(si);
1600
1601 if (strcmp(args[2], "cli") == 0) {
1602 unsigned timeout;
1603 const char *res;
1604
Willy Tarreau9d008692019-08-09 11:21:01 +02001605 if (!*args[3])
1606 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001607
1608 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001609 if (res || timeout < 1)
1610 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001611
1612 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1613 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1614 return 1;
1615 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001616
1617 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001618}
1619
Willy Tarreau2af99412016-11-23 11:10:59 +01001620/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001621static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001622{
1623 int v;
1624
1625 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1626 return 1;
1627
Willy Tarreau9d008692019-08-09 11:21:01 +02001628 if (!*args[3])
1629 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001630
1631 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001632 if (v > global.hardmaxconn)
1633 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001634
1635 /* check for unlimited values */
1636 if (v <= 0)
1637 v = global.hardmaxconn;
1638
1639 global.maxconn = v;
1640
1641 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001642 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001643
1644 return 1;
1645}
1646
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001647static int set_severity_output(int *target, char *argument)
1648{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001649 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001650 *target = CLI_SEVERITY_NONE;
1651 return 1;
1652 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001653 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001654 *target = CLI_SEVERITY_NUMBER;
1655 return 1;
1656 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001657 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001658 *target = CLI_SEVERITY_STRING;
1659 return 1;
1660 }
1661 return 0;
1662}
1663
1664/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001665static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001666{
1667 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1668 return 0;
1669
Willy Tarreau9d008692019-08-09 11:21:01 +02001670 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001671}
William Lallemandeceddf72016-12-15 18:06:44 +01001672
William Lallemand67a234f2018-12-13 09:05:45 +01001673
1674/* show the level of the current CLI session */
1675static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1676{
William Lallemand67a234f2018-12-13 09:05:45 +01001677 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001678 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001679 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001680 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001681 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001682 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001683 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001684 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001685}
1686
1687/* parse and set the CLI level dynamically */
1688static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1689{
William Lallemandad032882019-07-01 10:56:15 +02001690 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001691 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001692 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1693
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001694 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001695 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1696 return 1;
1697 }
1698 appctx->cli_level &= ~ACCESS_LVL_MASK;
1699 appctx->cli_level |= ACCESS_LVL_OPER;
1700
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001701 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001702 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1703 return 1;
1704 }
1705 appctx->cli_level &= ~ACCESS_LVL_MASK;
1706 appctx->cli_level |= ACCESS_LVL_USER;
1707 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001708 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001709 return 1;
1710}
1711
1712
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001713/* parse and set the CLI expert/experimental-mode dynamically */
1714static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001715{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001716 int level;
1717 char *level_str;
1718 char *output = NULL;
1719
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001720 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1721 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001722
1723 if (!strcmp(args[0], "expert-mode")) {
1724 level = ACCESS_EXPERT;
1725 level_str = "expert-mode";
1726 }
1727 else if (!strcmp(args[0], "experimental-mode")) {
1728 level = ACCESS_EXPERIMENTAL;
1729 level_str = "experimental-mode";
1730 }
1731 else {
1732 return 1;
1733 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001734
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001735 if (!*args[1]) {
1736 memprintf(&output, "%s is %s\n", level_str,
1737 (appctx->cli_level & level) ? "ON" : "OFF");
1738 return cli_dynmsg(appctx, LOG_INFO, output);
1739 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001740
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001741 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001742 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001743 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001744 return 1;
1745}
1746
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001747int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001748{
1749 return 0;
1750}
1751
Willy Tarreau45c742b2016-11-24 14:51:17 +01001752/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001753static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001754{
1755 int v;
1756 int *res;
1757 int mul = 1;
1758
1759 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1760 return 1;
1761
1762 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1763 res = &global.cps_lim;
1764 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1765 res = &global.sps_lim;
1766#ifdef USE_OPENSSL
1767 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1768 res = &global.ssl_lim;
1769#endif
1770 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1771 res = &global.comp_rate_lim;
1772 mul = 1024;
1773 }
1774 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001775 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001776 "'set rate-limit' only supports :\n"
1777 " - 'connections global' to set the per-process maximum connection rate\n"
1778 " - 'sessions global' to set the per-process maximum session rate\n"
1779#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001780 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001781#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001782 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001783 }
1784
Willy Tarreau9d008692019-08-09 11:21:01 +02001785 if (!*args[4])
1786 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001787
1788 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001789 if (v < 0)
1790 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001791
1792 *res = v * mul;
1793
1794 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001795 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001796
1797 return 1;
1798}
1799
William Lallemandf6975e92017-05-26 17:42:10 +02001800/* parse the "expose-fd" argument on the bind lines */
1801static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1802{
1803 if (!*args[cur_arg + 1]) {
1804 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1805 return ERR_ALERT | ERR_FATAL;
1806 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001807 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001808 conf->level |= ACCESS_FD_LISTENERS;
1809 } else {
1810 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1811 args[cur_arg], args[cur_arg+1]);
1812 return ERR_ALERT | ERR_FATAL;
1813 }
1814
1815 return 0;
1816}
1817
William Lallemand74c24fb2016-11-21 17:18:36 +01001818/* parse the "level" argument on the bind lines */
1819static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1820{
1821 if (!*args[cur_arg + 1]) {
1822 memprintf(err, "'%s' : missing level", args[cur_arg]);
1823 return ERR_ALERT | ERR_FATAL;
1824 }
1825
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001826 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001827 conf->level &= ~ACCESS_LVL_MASK;
1828 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001829 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001830 conf->level &= ~ACCESS_LVL_MASK;
1831 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001832 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001833 conf->level &= ~ACCESS_LVL_MASK;
1834 conf->level |= ACCESS_LVL_ADMIN;
1835 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001836 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1837 args[cur_arg], args[cur_arg+1]);
1838 return ERR_ALERT | ERR_FATAL;
1839 }
1840
1841 return 0;
1842}
1843
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001844static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1845{
1846 if (!*args[cur_arg + 1]) {
1847 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1848 return ERR_ALERT | ERR_FATAL;
1849 }
1850
1851 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1852 return 0;
1853 else {
1854 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1855 args[cur_arg], args[cur_arg+1]);
1856 return ERR_ALERT | ERR_FATAL;
1857 }
1858}
1859
Olivier Houchardf886e342017-04-05 22:24:59 +02001860/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001861static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001862{
1863 char *cmsgbuf = NULL;
1864 unsigned char *tmpbuf = NULL;
1865 struct cmsghdr *cmsg;
1866 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001867 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001868 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001869 struct msghdr msghdr;
1870 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001871 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001872 const char *ns_name, *if_name;
1873 unsigned char ns_nlen, if_nlen;
1874 int nb_queued;
1875 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001876 int *tmpfd;
1877 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001878 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001879 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001880 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001881 int ret;
1882
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001883 if (!remote) {
1884 ha_warning("Only works on real connections\n");
1885 goto out;
1886 }
1887
1888 fd = remote->handle.fd;
1889
Olivier Houchardf886e342017-04-05 22:24:59 +02001890 /* Temporary set the FD in blocking mode, that will make our life easier */
1891 old_fcntl = fcntl(fd, F_GETFL);
1892 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001893 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001894 goto out;
1895 }
1896 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1897 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001898 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001899 goto out;
1900 }
1901 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001902 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001903 goto out;
1904 }
Olivier Houchard54740872017-04-06 14:45:14 +02001905 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001906 iov.iov_base = &tot_fd_nb;
1907 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001908 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001909 goto out;
1910 memset(&msghdr, 0, sizeof(msghdr));
1911 /*
1912 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001913 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001914 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001915 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001916 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001917
Olivier Houchardf886e342017-04-05 22:24:59 +02001918 if (tot_fd_nb == 0)
1919 goto out;
1920
1921 /* First send the total number of file descriptors, so that the
1922 * receiving end knows what to expect.
1923 */
1924 msghdr.msg_iov = &iov;
1925 msghdr.msg_iovlen = 1;
1926 ret = sendmsg(fd, &msghdr, 0);
1927 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001928 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001929 goto out;
1930 }
1931
1932 /* Now send the fds */
1933 msghdr.msg_control = cmsgbuf;
1934 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1935 cmsg = CMSG_FIRSTHDR(&msghdr);
1936 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1937 cmsg->cmsg_level = SOL_SOCKET;
1938 cmsg->cmsg_type = SCM_RIGHTS;
1939 tmpfd = (int *)CMSG_DATA(cmsg);
1940
Olivier Houchardf886e342017-04-05 22:24:59 +02001941 /* For each socket, e message is sent, containing the following :
1942 * Size of the namespace name (or 0 if none), as an unsigned char.
1943 * The namespace name, if any
1944 * Size of the interface name (or 0 if none), as an unsigned char
1945 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001946 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001947 */
1948 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001949 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001950 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001951 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001952 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001953 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001954 goto out;
1955 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001956
1957 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001958 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001959 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001960 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001961 continue;
1962
1963 ns_name = if_name = "";
1964 ns_nlen = if_nlen = 0;
1965
1966 /* for now we can only retrieve namespaces and interfaces from
1967 * pure listeners.
1968 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001969 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001970 const struct listener *l = fdtab[cur_fd].owner;
1971
Willy Tarreau818a92e2020-09-03 07:50:19 +02001972 if (l->rx.settings->interface) {
1973 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001974 if_nlen = strlen(if_name);
1975 }
1976
1977#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001978 if (l->rx.settings->netns) {
1979 ns_name = l->rx.settings->netns->node.key;
1980 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001981 }
1982#endif
1983 }
1984
1985 /* put the FD into the CMSG_DATA */
1986 tmpfd[nb_queued++] = cur_fd;
1987
1988 /* first block is <ns_name_len> <ns_name> */
1989 tmpbuf[curoff++] = ns_nlen;
1990 if (ns_nlen)
1991 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1992 curoff += ns_nlen;
1993
1994 /* second block is <if_name_len> <if_name> */
1995 tmpbuf[curoff++] = if_nlen;
1996 if (if_nlen)
1997 memcpy(tmpbuf + curoff, if_name, if_nlen);
1998 curoff += if_nlen;
1999
2000 /* we used to send the listener options here before 2.3 */
2001 memset(tmpbuf + curoff, 0, sizeof(int));
2002 curoff += sizeof(int);
2003
2004 /* there's a limit to how many FDs may be sent at once */
2005 if (nb_queued == MAX_SEND_FD) {
2006 iov.iov_len = curoff;
2007 if (sendmsg(fd, &msghdr, 0) != curoff) {
2008 ha_warning("Failed to transfer sockets\n");
2009 return -1;
2010 }
2011
2012 /* Wait for an ack */
2013 do {
2014 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2015 } while (ret == -1 && errno == EINTR);
2016
2017 if (ret <= 0) {
2018 ha_warning("Unexpected error while transferring sockets\n");
2019 return -1;
2020 }
2021 curoff = 0;
2022 nb_queued = 0;
2023 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002024 }
2025
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002026 /* flush pending stuff */
2027 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002028 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002029 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2030 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002031 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002032 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002033 goto out;
2034 }
2035 }
2036
2037out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002038 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002039 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002040 goto out;
2041 }
2042 appctx->st0 = CLI_ST_END;
2043 free(cmsgbuf);
2044 free(tmpbuf);
2045 return 1;
2046}
2047
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002048static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2049{
2050 if (*args[0] == 'h')
2051 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002052 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002053 else if (*args[0] == 'p')
2054 /* prompt */
2055 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2056 else if (*args[0] == 'q')
2057 /* quit */
2058 appctx->st0 = CLI_ST_END;
2059
2060 return 1;
2061}
Olivier Houchardf886e342017-04-05 22:24:59 +02002062
William Lallemand2f4ce202018-10-26 14:47:47 +02002063void pcli_write_prompt(struct stream *s)
2064{
2065 struct buffer *msg = get_trash_chunk();
2066 struct channel *oc = si_oc(&s->si[0]);
2067
William Lallemanddc12c2e2018-12-13 09:05:46 +01002068 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002069 return;
2070
William Lallemanddc12c2e2018-12-13 09:05:46 +01002071 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002072 chunk_appendf(msg, "+ ");
2073 } else {
2074 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002075 chunk_appendf(msg, "master%s> ",
2076 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002077 else
2078 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2079 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002080 co_inject(oc, msg->area, msg->data);
2081}
2082
William Lallemand291810d2018-10-26 14:47:38 +02002083
William Lallemandcf62f7e2018-10-26 14:47:40 +02002084/* The pcli_* functions are used for the CLI proxy in the master */
2085
William Lallemanddeeaa592018-10-26 14:47:48 +02002086void pcli_reply_and_close(struct stream *s, const char *msg)
2087{
2088 struct buffer *buf = get_trash_chunk();
2089
2090 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002091 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002092}
2093
William Lallemand291810d2018-10-26 14:47:38 +02002094static enum obj_type *pcli_pid_to_server(int proc_pid)
2095{
2096 struct mworker_proc *child;
2097
William Lallemand99e0bb92020-11-05 10:28:53 +01002098 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002099 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002100 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002101
William Lallemand291810d2018-10-26 14:47:38 +02002102 list_for_each_entry(child, &proc_list, list) {
2103 if (child->pid == proc_pid){
2104 return &child->srv->obj_type;
2105 }
2106 }
2107 return NULL;
2108}
2109
2110/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2111 * Return:
2112 * 0: master
2113 * > 0: pid of a worker
2114 * < 0: didn't find a worker
2115 */
2116static int pcli_prefix_to_pid(const char *prefix)
2117{
2118 int proc_pid;
2119 struct mworker_proc *child;
2120 char *errtol = NULL;
2121
2122 if (*prefix != '@') /* not a prefix, should not happen */
2123 return -1;
2124
2125 prefix++;
2126 if (!*prefix) /* sent @ alone, return the master */
2127 return 0;
2128
2129 if (strcmp("master", prefix) == 0) {
2130 return 0;
2131 } else if (*prefix == '!') {
2132 prefix++;
2133 if (!*prefix)
2134 return -1;
2135
2136 proc_pid = strtol(prefix, &errtol, 10);
2137 if (*errtol != '\0')
2138 return -1;
2139 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002140 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002141 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002142 if (child->pid == proc_pid){
2143 return child->pid;
2144 }
2145 }
2146 } else {
2147 struct mworker_proc *chosen = NULL;
2148 /* this is a relative pid */
2149
2150 proc_pid = strtol(prefix, &errtol, 10);
2151 if (*errtol != '\0')
2152 return -1;
2153
2154 if (proc_pid == 0) /* return the master */
2155 return 0;
2156
2157 /* chose the right process, the current one is the one with the
2158 least number of reloads */
2159 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002160 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002161 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002162 if (child->relative_pid == proc_pid){
2163 if (child->reloads == 0)
2164 return child->pid;
2165 else if (chosen == NULL || child->reloads < chosen->reloads)
2166 chosen = child;
2167 }
2168 }
2169 if (chosen)
2170 return chosen->pid;
2171 }
2172 return -1;
2173}
2174
William Lallemandbddd33a2018-12-11 16:10:53 +01002175/* Return::
2176 * >= 0 : number of words to escape
2177 * = -1 : error
2178 */
2179
2180int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2181{
2182 if (argl < 1)
2183 return 0;
2184
2185 /* there is a prefix */
2186 if (args[0][0] == '@') {
2187 int target_pid = pcli_prefix_to_pid(args[0]);
2188
2189 if (target_pid == -1) {
2190 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2191 return -1;
2192 }
2193
2194 /* if the prefix is alone, define a default target */
2195 if (argl == 1)
2196 s->pcli_next_pid = target_pid;
2197 else
2198 *next_pid = target_pid;
2199 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002200 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002201 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002202 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002203
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002204 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002205 channel_shutr_now(&s->req);
2206 channel_shutw_now(&s->res);
2207 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002208 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002209 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2210 memprintf(errmsg, "Permission denied!\n");
2211 return -1;
2212 }
2213 s->pcli_flags &= ~ACCESS_LVL_MASK;
2214 s->pcli_flags |= ACCESS_LVL_OPER;
2215 return argl;
2216
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002217 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002218 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2219 memprintf(errmsg, "Permission denied!\n");
2220 return -1;
2221 }
2222 s->pcli_flags &= ~ACCESS_LVL_MASK;
2223 s->pcli_flags |= ACCESS_LVL_USER;
2224 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002225 }
2226
2227 return 0;
2228}
2229
2230/*
2231 * Parse the CLI request:
2232 * - It does basically the same as the cli_io_handler, but as a proxy
2233 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002234 *
2235 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002236 * - the number of characters to forward or
2237 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002238 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002239int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002240{
William Lallemandbddd33a2018-12-11 16:10:53 +01002241 char *str = (char *)ci_head(req);
2242 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002243 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002244 int argl; /* number of args */
2245 char *p;
2246 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002247 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002248 int wtrim = 0; /* number of words to trim */
2249 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002250 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002251 int i = 0;
2252
2253 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002254
William Lallemanddc12c2e2018-12-13 09:05:46 +01002255 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002256
2257 /* Looks for the end of one command */
2258 while (p+reql < end) {
2259 /* handle escaping */
2260 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002261 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002262 continue;
2263 }
2264 if (p[reql] == ';' || p[reql] == '\n') {
2265 /* found the end of the command */
2266 p[reql] = '\n';
2267 reql++;
2268 break;
2269 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002270 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002271 }
William Lallemandebf61802018-12-11 16:10:57 +01002272 } else {
2273 while (p+reql < end) {
2274 if (p[reql] == '\n') {
2275 /* found the end of the line */
2276 reql++;
2277 break;
2278 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002279 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002280 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002281 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002282
William Lallemandbddd33a2018-12-11 16:10:53 +01002283 /* set end to first byte after the end of the command */
2284 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002285
William Lallemandbddd33a2018-12-11 16:10:53 +01002286 /* there is no end to this command, need more to parse ! */
2287 if (*(end-1) != '\n') {
2288 return -1;
2289 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002290
William Lallemand3301f3e2018-12-13 09:05:48 +01002291 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2292 if (reql == 1) /* last line of the payload */
2293 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002294 return reql;
2295 }
2296
William Lallemandbddd33a2018-12-11 16:10:53 +01002297 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002298
William Lallemandbddd33a2018-12-11 16:10:53 +01002299 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002300 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002301 /* skip leading spaces/tabs */
2302 p += strspn(p, " \t");
2303 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002304 break;
2305
William Lallemandbddd33a2018-12-11 16:10:53 +01002306 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002307 while (1) {
2308 p += strcspn(p, " \t\\");
2309 /* escaped chars using backlashes (\) */
2310 if (*p == '\\') {
2311 if (!*++p)
2312 break;
2313 if (!*++p)
2314 break;
2315 } else {
2316 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002317 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002318 }
William Lallemandfe249c32020-06-18 18:03:57 +02002319 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002320 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002321 }
2322
William Lallemandbddd33a2018-12-11 16:10:53 +01002323 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002324
Willy Tarreauf14c7572021-03-13 10:59:23 +01002325 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002326 args[i] = NULL;
2327
2328 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2329
2330 /* End of words are ending by \0, we need to replace the \0s by spaces
23311 before forwarding them */
2332 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002333 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002334 if (*p == '\0')
2335 *p = ' ';
2336 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002337 }
2338
William Lallemand3301f3e2018-12-13 09:05:48 +01002339 payload = strstr(str, PAYLOAD_PATTERN);
2340 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2341 /* if the payload pattern is at the end */
2342 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002343 }
2344
William Lallemandbddd33a2018-12-11 16:10:53 +01002345 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002346
William Lallemandbddd33a2018-12-11 16:10:53 +01002347 if (wtrim > 0) {
2348 trim = &args[wtrim][0];
2349 if (trim == NULL) /* if this was the last word in the table */
2350 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002351
William Lallemandbddd33a2018-12-11 16:10:53 +01002352 b_del(&req->buf, trim - str);
2353
William Lallemandb7ea1412018-12-13 09:05:47 +01002354 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002355 } else if (wtrim < 0) {
2356 /* parsing error */
2357 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002358 } else {
2359 /* the whole string */
2360 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002361 }
2362
William Lallemandb7ea1412018-12-13 09:05:47 +01002363 if (ret > 1) {
2364 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2365 goto end;
2366 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002367 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2368 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002369 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002370 ci_insert_line2(req, 0, "user -", strlen("user -"));
2371 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002372 }
2373 }
2374end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002375
William Lallemandb7ea1412018-12-13 09:05:47 +01002376 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002377}
2378
2379int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2380{
William Lallemandbddd33a2018-12-11 16:10:53 +01002381 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002382 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002383 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002384
William Lallemandb7ea1412018-12-13 09:05:47 +01002385 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2386 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2387
William Lallemandcf62f7e2018-10-26 14:47:40 +02002388read_again:
2389 /* if the channel is closed for read, we won't receive any more data
2390 from the client, but we don't want to forward this close to the
2391 server */
2392 channel_dont_close(req);
2393
2394 /* We don't know yet to which server we will connect */
2395 channel_dont_connect(req);
2396
2397
2398 /* we are not waiting for a response, there is no more request and we
2399 * receive a close from the client, we can leave */
2400 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2401 channel_shutw_now(&s->res);
2402 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2403 return 1;
2404 }
2405
2406 req->flags |= CF_READ_DONTWAIT;
2407
2408 /* need more data */
2409 if (!ci_data(req))
2410 return 0;
2411
2412 /* If there is data available for analysis, log the end of the idle time. */
2413 if (c_data(req) && s->logs.t_idle == -1)
2414 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2415
William Lallemandbddd33a2018-12-11 16:10:53 +01002416 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002417 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002418 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002419 /* enough data */
2420
William Lallemandcf62f7e2018-10-26 14:47:40 +02002421 /* forward only 1 command */
2422 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002423
William Lallemanddc12c2e2018-12-13 09:05:46 +01002424 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002425 /* we send only 1 command per request, and we write close after it */
2426 channel_shutw_now(req);
2427 } else {
2428 pcli_write_prompt(s);
2429 }
2430
2431 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432
2433 /* remove the XFER_DATA analysers, which forwards all
2434 * the data, we don't want to forward the next requests
2435 * We need to add CF_FLT_ANALYZE to abort the forward too.
2436 */
2437 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2438 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2439 s->res.analysers |= AN_RES_WAIT_CLI;
2440
William Lallemandebf61802018-12-11 16:10:57 +01002441 if (!(s->flags & SF_ASSIGNED)) {
2442 if (next_pid > -1)
2443 target_pid = next_pid;
2444 else
2445 target_pid = s->pcli_next_pid;
2446 /* we can connect now */
2447 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448
William Lallemandebf61802018-12-11 16:10:57 +01002449 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2450 channel_auto_connect(req);
2451 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002452
2453 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002454 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002455 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002456 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002457 } else if (to_forward == -1 && errmsg) {
2458 /* there was an error during the parsing */
2459 pcli_reply_and_close(s, errmsg);
2460 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002461 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2462 /* buffer is full and we didn't catch the end of a command */
2463 goto send_help;
2464 }
2465
2466 return 0;
2467
2468send_help:
2469 b_reset(&req->buf);
2470 b_putblk(&req->buf, "help\n", 5);
2471 goto read_again;
2472}
2473
2474int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2475{
2476 struct proxy *fe = strm_fe(s);
2477 struct proxy *be = s->be;
2478
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002479 if (rep->flags & CF_READ_ERROR) {
2480 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2481 s->res.analysers &= ~AN_RES_WAIT_CLI;
2482 return 0;
2483 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002484 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2485 rep->flags |= CF_NEVER_WAIT;
2486
2487 /* don't forward the close */
2488 channel_dont_close(&s->res);
2489 channel_dont_close(&s->req);
2490
William Lallemanddc12c2e2018-12-13 09:05:46 +01002491 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002492 s->req.analysers |= AN_REQ_WAIT_CLI;
2493 s->res.analysers &= ~AN_RES_WAIT_CLI;
2494 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2495 return 0;
2496 }
2497
William Lallemandcf62f7e2018-10-26 14:47:40 +02002498 /* forward the data */
2499 if (ci_data(rep)) {
2500 c_adv(rep, ci_data(rep));
2501 return 0;
2502 }
2503
2504 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2505 /* stream cleanup */
2506
William Lallemand2f4ce202018-10-26 14:47:47 +02002507 pcli_write_prompt(s);
2508
William Lallemandcf62f7e2018-10-26 14:47:40 +02002509 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2510 si_shutr(&s->si[1]);
2511 si_shutw(&s->si[1]);
2512
2513 /*
2514 * starting from there this the same code as
2515 * http_end_txn_clean_session().
2516 *
2517 * It allows to do frontend keepalive while reconnecting to a
2518 * new server for each request.
2519 */
2520
2521 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002522 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002523 if (unlikely(s->srv_conn))
2524 sess_change_server(s, NULL);
2525 }
2526
2527 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2528 stream_process_counters(s);
2529
2530 /* don't count other requests' data */
2531 s->logs.bytes_in -= ci_data(&s->req);
2532 s->logs.bytes_out -= ci_data(&s->res);
2533
2534 /* we may need to know the position in the queue */
2535 pendconn_free(s);
2536
2537 /* let's do a final log if we need it */
2538 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2539 !(s->flags & SF_MONITOR) &&
2540 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2541 s->do_log(s);
2542 }
2543
2544 /* stop tracking content-based counters */
2545 stream_stop_content_counters(s);
2546 stream_update_time_stats(s);
2547
2548 s->logs.accept_date = date; /* user-visible date for logging */
2549 s->logs.tv_accept = now; /* corrected date for internal use */
2550 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2551 s->logs.t_idle = -1;
2552 tv_zero(&s->logs.tv_request);
2553 s->logs.t_queue = -1;
2554 s->logs.t_connect = -1;
2555 s->logs.t_data = -1;
2556 s->logs.t_close = 0;
2557 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2558 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2559
2560 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2561 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2562
2563 stream_del_srv_conn(s);
2564 if (objt_server(s->target)) {
2565 if (s->flags & SF_CURR_SESS) {
2566 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002567 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002568 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002569 if (may_dequeue_tasks(__objt_server(s->target), be))
2570 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002571 }
2572
2573 s->target = NULL;
2574
2575 /* only release our endpoint if we don't intend to reuse the
2576 * connection.
2577 */
2578 if (!si_conn_ready(&s->si[1])) {
2579 si_release_endpoint(&s->si[1]);
2580 s->srv_conn = NULL;
2581 }
2582
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002583 sockaddr_free(&s->target_addr);
2584
William Lallemandcf62f7e2018-10-26 14:47:40 +02002585 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2586 s->si[1].err_type = SI_ET_NONE;
2587 s->si[1].conn_retries = 0; /* used for logging too */
2588 s->si[1].exp = TICK_ETERNITY;
2589 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 +02002590 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 +02002591 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 +02002592 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2593 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2594 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2595 /* reinitialise the current rule list pointer to NULL. We are sure that
2596 * any rulelist match the NULL pointer.
2597 */
2598 s->current_rule_list = NULL;
2599
2600 s->be = strm_fe(s);
2601 s->logs.logwait = strm_fe(s)->to_log;
2602 s->logs.level = 0;
2603 stream_del_srv_conn(s);
2604 s->target = NULL;
2605 /* re-init store persistence */
2606 s->store_count = 0;
2607 s->uniq_id = global.req_count++;
2608
2609 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2610
2611 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2612
2613 s->req.analysers |= AN_REQ_WAIT_CLI;
2614 s->res.analysers &= ~AN_RES_WAIT_CLI;
2615
2616 /* We must trim any excess data from the response buffer, because we
2617 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002618 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002619 * we want those data to come along with next response. A typical
2620 * example of such data would be from a buggy server responding to
2621 * a HEAD with some data, or sending more than the advertised
2622 * content-length.
2623 */
2624 if (unlikely(ci_data(&s->res)))
2625 b_set_data(&s->res.buf, co_data(&s->res));
2626
2627 /* Now we can realign the response buffer */
2628 c_realign_if_empty(&s->res);
2629
2630 s->req.rto = strm_fe(s)->timeout.client;
2631 s->req.wto = TICK_ETERNITY;
2632
2633 s->res.rto = TICK_ETERNITY;
2634 s->res.wto = strm_fe(s)->timeout.client;
2635
2636 s->req.rex = TICK_ETERNITY;
2637 s->req.wex = TICK_ETERNITY;
2638 s->req.analyse_exp = TICK_ETERNITY;
2639 s->res.rex = TICK_ETERNITY;
2640 s->res.wex = TICK_ETERNITY;
2641 s->res.analyse_exp = TICK_ETERNITY;
2642 s->si[1].hcto = TICK_ETERNITY;
2643
2644 /* we're removing the analysers, we MUST re-enable events detection.
2645 * We don't enable close on the response channel since it's either
2646 * already closed, or in keep-alive with an idle connection handler.
2647 */
2648 channel_auto_read(&s->req);
2649 channel_auto_close(&s->req);
2650 channel_auto_read(&s->res);
2651
2652
2653 return 1;
2654 }
2655 return 0;
2656}
2657
William Lallemand8a022572018-10-26 14:47:35 +02002658/*
2659 * The mworker functions are used to initialize the CLI in the master process
2660 */
2661
William Lallemand309dc9a2018-10-26 14:47:45 +02002662 /*
2663 * Stop the mworker proxy
2664 */
2665void mworker_cli_proxy_stop()
2666{
William Lallemand550db6d2018-11-06 17:37:12 +01002667 if (mworker_proxy)
2668 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002669}
2670
William Lallemand8a022572018-10-26 14:47:35 +02002671/*
2672 * Create the mworker CLI proxy
2673 */
2674int mworker_cli_proxy_create()
2675{
2676 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002677 char *msg = NULL;
2678 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002679
2680 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2681 if (!mworker_proxy)
2682 return -1;
2683
2684 init_new_proxy(mworker_proxy);
2685 mworker_proxy->next = proxies_list;
2686 proxies_list = mworker_proxy;
2687 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002688 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002689 mworker_proxy->last_change = now.tv_sec;
2690 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2691 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2692 mworker_proxy->timeout.client = 0; /* no timeout */
2693 mworker_proxy->conf.file = strdup("MASTER");
2694 mworker_proxy->conf.line = 0;
2695 mworker_proxy->accept = frontend_accept;
2696 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2697
2698 /* Does not init the default target the CLI applet, but must be done in
2699 * the request parsing code */
2700 mworker_proxy->default_target = NULL;
2701
2702 /* the check_config_validity() will get an ID for the proxy */
2703 mworker_proxy->uuid = -1;
2704
2705 proxy_store_name(mworker_proxy);
2706
2707 /* create all servers using the mworker_proc list */
2708 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002709 struct server *newsrv = NULL;
2710 struct sockaddr_storage *sk;
2711 int port1, port2, port;
2712 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002713
William Lallemanda31b09e2020-01-14 15:25:02 +01002714 /* only the workers support the master CLI */
2715 if (!(child->options & PROC_O_TYPE_WORKER))
2716 continue;
2717
William Lallemand8a022572018-10-26 14:47:35 +02002718 newsrv = new_server(mworker_proxy);
2719 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002720 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002721
2722 /* we don't know the new pid yet */
2723 if (child->pid == -1)
2724 memprintf(&msg, "cur-%d", child->relative_pid);
2725 else
2726 memprintf(&msg, "old-%d", child->pid);
2727
2728 newsrv->next = mworker_proxy->srv;
2729 mworker_proxy->srv = newsrv;
2730 newsrv->conf.file = strdup(msg);
2731 newsrv->id = strdup(msg);
2732 newsrv->conf.line = 0;
2733
2734 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002735 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002736 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002737 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002738 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002739 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002740
Willy Tarreau5fc93282020-09-16 18:25:03 +02002741 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002742 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002743 }
2744
2745 /* no port specified */
2746 newsrv->flags |= SRV_F_MAPPORTS;
2747 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002748 /* don't let the server participate to load balancing */
2749 newsrv->iweight = 0;
2750 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002751 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002752
2753 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002754 }
2755 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002756
2757error:
2758 ha_alert("%s\n", errmsg);
2759
2760 list_for_each_entry(child, &proc_list, list) {
2761 free((char *)child->srv->conf.file); /* cast because of const char * */
2762 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002763 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002764 }
2765 free(mworker_proxy->id);
2766 free(mworker_proxy->conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002767 ha_free(&mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002768 free(errmsg);
2769 free(msg);
2770
2771 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002772}
Olivier Houchardf886e342017-04-05 22:24:59 +02002773
William Lallemandce83b4a2018-10-26 14:47:30 +02002774/*
William Lallemande7361152018-10-26 14:47:36 +02002775 * Create a new listener for the master CLI proxy
2776 */
2777int mworker_cli_proxy_new_listener(char *line)
2778{
2779 struct bind_conf *bind_conf;
2780 struct listener *l;
2781 char *err = NULL;
2782 char *args[MAX_LINE_ARGS + 1];
2783 int arg;
2784 int cur_arg;
2785
William Lallemand2e945c82019-11-25 09:58:37 +01002786 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002787 args[0] = line;
2788
2789 /* args is a bind configuration with spaces replaced by commas */
2790 while (*line && arg < MAX_LINE_ARGS) {
2791
2792 if (*line == ',') {
2793 *line++ = '\0';
2794 while (*line == ',')
2795 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002796 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002797 }
2798 line++;
2799 }
2800
William Lallemand2e945c82019-11-25 09:58:37 +01002801 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002802
2803 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002804 if (!bind_conf)
2805 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002806
2807 bind_conf->level &= ~ACCESS_LVL_MASK;
2808 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002809 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002810
2811 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2812 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002813 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002814 }
2815
2816 cur_arg = 1;
2817
2818 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002819 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002820 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002821
2822 kw = bind_find_kw(args[cur_arg]);
2823 if (kw) {
2824 if (!kw->parse) {
2825 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2826 args[0], args[1], args[cur_arg]);
2827 goto err;
2828 }
2829
Willy Tarreau4975d142021-03-13 11:00:33 +01002830 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002831 if (err)
2832 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2833 else
2834 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2835 args[0], args[1], args[cur_arg]);
2836 goto err;
2837 }
2838
2839 cur_arg += 1 + kw->skip;
2840 continue;
2841 }
2842
Willy Tarreau433b05f2021-03-12 10:14:07 +01002843 best = bind_find_best_kw(args[cur_arg]);
2844 if (best)
2845 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2846 args[0], args[1], args[cur_arg], best);
2847 else
2848 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2849 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002850 goto err;
2851 }
2852
2853
2854 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002855 l->accept = session_accept_fd;
2856 l->default_target = mworker_proxy->default_target;
2857 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002858 l->options |= LI_O_UNLIMITED;
2859 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002860 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002861 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002862 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002863 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002864
2865 return 0;
2866
2867err:
2868 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002869 free(err);
2870 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002871 return -1;
2872
2873}
2874
2875/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002876 * Create a new CLI socket using a socketpair for a worker process
2877 * <mworker_proc> is the process structure, and <proc> is the process number
2878 */
2879int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2880{
2881 struct bind_conf *bind_conf;
2882 struct listener *l;
2883 char *path = NULL;
2884 char *err = NULL;
2885
2886 /* master pipe to ensure the master is still alive */
2887 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2888 ha_alert("Cannot create worker socketpair.\n");
2889 return -1;
2890 }
2891
2892 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002893 if (!global.cli_fe) {
2894 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002895 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002896 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002897 }
2898 }
2899
Willy Tarreau4975d142021-03-13 11:00:33 +01002900 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002901 if (!bind_conf)
2902 goto error;
2903
William Lallemandce83b4a2018-10-26 14:47:30 +02002904 bind_conf->level &= ~ACCESS_LVL_MASK;
2905 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2906
William Lallemandce83b4a2018-10-26 14:47:30 +02002907 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2908 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002909 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002910 }
2911
Willy Tarreau4975d142021-03-13 11:00:33 +01002912 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002913 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002914 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002915 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002916 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002917 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002918
2919 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002920 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002921 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002922 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002923 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002924 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002925 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002926 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002927 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002928 }
2929
2930 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002931
2932error:
2933 close(mworker_proc->ipc_fd[0]);
2934 close(mworker_proc->ipc_fd[1]);
2935 free(err);
2936
2937 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002938}
2939
William Lallemand74c24fb2016-11-21 17:18:36 +01002940static struct applet cli_applet = {
2941 .obj_type = OBJ_TYPE_APPLET,
2942 .name = "<CLI>", /* used for logging */
2943 .fct = cli_io_handler,
2944 .release = cli_release_handler,
2945};
2946
William Lallemand99e0bb92020-11-05 10:28:53 +01002947/* master CLI */
2948static struct applet mcli_applet = {
2949 .obj_type = OBJ_TYPE_APPLET,
2950 .name = "<MCLI>", /* used for logging */
2951 .fct = cli_io_handler,
2952 .release = cli_release_handler,
2953};
2954
Willy Tarreau0a739292016-11-22 20:21:23 +01002955/* register cli keywords */
2956static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002957 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2958 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2959 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2960 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
2961 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2962 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2963 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
2964 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
2965 { { "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 },
2966 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
2967 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
2968 { { "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 },
2969 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2970 { { "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 },
2971 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
2972 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2973 { { "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 +01002974 {{},}
2975}};
2976
Willy Tarreau0108d902018-11-25 19:14:37 +01002977INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2978
William Lallemand74c24fb2016-11-21 17:18:36 +01002979static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002980 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002981 { 0, NULL, NULL },
2982}};
2983
Willy Tarreau0108d902018-11-25 19:14:37 +01002984INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2985
William Lallemand74c24fb2016-11-21 17:18:36 +01002986static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002987 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2988 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002989 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002990 { NULL, NULL, 0 },
2991}};
2992
Willy Tarreau0108d902018-11-25 19:14:37 +01002993INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002994
2995/*
2996 * Local variables:
2997 * c-indent-level: 8
2998 * c-basic-offset: 8
2999 * End:
3000 */