blob: a3ee4c442e93ddd271b1b8e657c1fca262379a3c [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");
William Lallemand6640dbb2021-08-13 15:31:33 +0200383 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100384 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 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200681 * Get pointers on words.
682 * One extra slot is reserved to store a pointer on a null byte.
683 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100684 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200685 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100686
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200687 /* skip leading spaces/tabs */
688 p += strspn(p, " \t");
689 if (!*p)
690 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200691
692 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
693 /* payload pattern recognized here, this is not an arg anymore,
694 * the payload starts at the first byte that follows the zero
695 * after the pattern.
696 */
697 payload = p + strlen(PAYLOAD_PATTERN) + 1;
698 break;
699 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100700
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200701 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200702 while (1) {
703 p += strcspn(p, " \t\\");
704 /* escaped chars using backlashes (\) */
705 if (*p == '\\') {
706 if (!*++p)
707 break;
708 if (!*++p)
709 break;
710 } else {
711 break;
712 }
713 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200714 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100715
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200716 /* unescape backslashes (\) */
717 for (j = 0, k = 0; args[i][k]; k++) {
718 if (args[i][k] == '\\') {
719 if (args[i][k + 1] == '\\')
720 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100721 else
722 continue;
723 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200724 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100725 j++;
726 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200727 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100728
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200729 i++;
730 }
731 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200732 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100733 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200734 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100735
736 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100737 if (!kw ||
738 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
739 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
740 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100741 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100742 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100743 }
William Lallemand14721be2018-10-26 14:47:37 +0200744
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100745 /* don't handle expert mode commands if not in this mode. */
746 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
747 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200748 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100749 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200750
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100751 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
752 cli_err(appctx, "This command is restricted to experimental mode only.\n");
753 return 0;
754 }
755
Amaury Denoyellef4929922021-05-05 16:29:23 +0200756 if (kw->level == ACCESS_EXPERT)
757 mark_tainted(TAINTED_CLI_EXPERT_MODE);
758 else if (kw->level == ACCESS_EXPERIMENTAL)
759 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
760
Willy Tarreau41908562016-11-24 16:23:38 +0100761 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200762 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200763
764 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
765 goto fail;
766
767 /* kw->parse could set its own io_handler or io_release handler */
768 if (!appctx->io_handler)
769 goto fail;
770
771 appctx->st0 = CLI_ST_CALLBACK;
772 return 1;
773fail:
774 appctx->io_handler = NULL;
775 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100776 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100777}
778
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200779/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
780static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
781{
Willy Tarreau83061a82018-07-13 11:56:34 +0200782 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200783
784 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200785 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200786
787 tmp = get_trash_chunk();
788 chunk_reset(tmp);
789
790 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100791 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200792 chunk_printf(tmp, "[%d]: ", severity);
793 }
794 else {
795 switch (severity_output) {
796 case CLI_SEVERITY_NUMBER:
797 chunk_printf(tmp, "[%d]: ", severity);
798 break;
799 case CLI_SEVERITY_STRING:
800 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
801 break;
802 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100803 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200804 }
805 }
806 chunk_appendf(tmp, "%s", msg);
807
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200808 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200809}
810
William Lallemand74c24fb2016-11-21 17:18:36 +0100811/* This I/O handler runs as an applet embedded in a stream interface. It is
812 * used to processes I/O from/to the stats unix socket. The system relies on a
813 * state machine handling requests and various responses. We read a request,
814 * then we process it and send the response, and we possibly display a prompt.
815 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100816 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100817 * or not.
818 */
819static void cli_io_handler(struct appctx *appctx)
820{
821 struct stream_interface *si = appctx->owner;
822 struct channel *req = si_oc(si);
823 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200824 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100825 int reql;
826 int len;
827
828 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
829 goto out;
830
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800831 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200832 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100833 /* buf.size==0 means we failed to get a buffer and were
834 * already subscribed to a wait list to get a buffer.
835 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100836 goto out;
837 }
838
William Lallemand74c24fb2016-11-21 17:18:36 +0100839 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100840 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100841 /* Stats output not initialized yet */
842 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200843 /* reset severity to default at init */
844 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100845 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100846 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100847 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100848 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100849 /* Let's close for real now. We just close the request
850 * side, the conditions below will complete if needed.
851 */
852 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200853 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200854 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100855 break;
856 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100857 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200858 char *str;
859
860 /* use a trash chunk to store received data */
861 if (!appctx->chunk) {
862 appctx->chunk = alloc_trash_chunk();
863 if (!appctx->chunk) {
864 appctx->st0 = CLI_ST_END;
865 continue;
866 }
867 }
868
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200869 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200870
William Lallemand74c24fb2016-11-21 17:18:36 +0100871 /* ensure we have some output room left in the event we
872 * would want to return some info right after parsing.
873 */
874 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100875 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100876 break;
877 }
878
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200879 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200880 reql = co_getline(si_oc(si), str,
881 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100882 if (reql <= 0) { /* closed or EOL not found */
883 if (reql == 0)
884 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100885 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100886 continue;
887 }
888
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200889 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
890 /* seek for a possible unescaped semi-colon. If we find
891 * one, we replace it with an LF and skip only this part.
892 */
893 for (len = 0; len < reql; len++) {
894 if (str[len] == '\\') {
895 len++;
896 continue;
897 }
898 if (str[len] == ';') {
899 str[len] = '\n';
900 reql = len + 1;
901 break;
902 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 }
904 }
905
906 /* now it is time to check that we have a full line,
907 * remove the trailing \n and possibly \r, then cut the
908 * line.
909 */
910 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200911 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100912 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100913 continue;
914 }
915
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200916 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100917 len--;
918
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200919 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200920 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200921
922 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200923 appctx->chunk->area[appctx->chunk->data] = '\n';
924 appctx->chunk->area[appctx->chunk->data + 1] = 0;
925 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200926 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100927
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100928 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200929
930 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
931 /* empty line */
932 if (!len) {
933 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200934 appctx->chunk->data -= 2;
935 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100936 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200937 chunk_reset(appctx->chunk);
938 /* NB: cli_sock_parse_request() may have put
939 * another CLI_ST_O_* into appctx->st0.
940 */
941
942 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100943 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100944 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200945 else {
946 /*
947 * Look for the "payload start" pattern at the end of a line
948 * Its location is not remembered here, this is just to switch
949 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100950 */
Willy Tarreauf2dda522021-09-17 11:07:45 +0200951 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200952 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200953 appctx->chunk->data++; // keep the trailing \0 after '<<'
954 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200955 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200956 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100957 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200958 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200959 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100960 }
961
962 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200963 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100964 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
965 }
966 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200967 const char *msg;
968 int sev;
969
William Lallemand74c24fb2016-11-21 17:18:36 +0100970 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100971 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100972 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200973 case CLI_ST_PRINT: /* print const message in msg */
974 case CLI_ST_PRINT_ERR: /* print const error in msg */
975 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
976 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
977 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
978 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
979 LOG_ERR : appctx->ctx.cli.severity;
980 msg = appctx->ctx.cli.msg;
981 }
982 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
983 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
984 LOG_ERR : appctx->ctx.cli.severity;
985 msg = appctx->ctx.cli.err;
986 if (!msg) {
987 sev = LOG_ERR;
988 msg = "Out of memory.\n";
989 }
990 }
991 else {
992 sev = LOG_ERR;
993 msg = "Internal error.\n";
994 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200995
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200996 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
997 if (appctx->st0 == CLI_ST_PRINT_FREE ||
998 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100999 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001000 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001001 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001002 }
1003 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001004 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001005 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001006
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001007 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001008 if (appctx->io_handler)
1009 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001010 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001011 if (appctx->io_release) {
1012 appctx->io_release(appctx);
1013 appctx->io_release = NULL;
1014 }
1015 }
1016 break;
1017 default: /* abnormal state */
1018 si->flags |= SI_FL_ERR;
1019 break;
1020 }
1021
1022 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001023 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001024 const char *prompt = "";
1025
1026 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1027 /*
1028 * when entering a payload with interactive mode, change the prompt
1029 * to emphasize that more data can still be sent
1030 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001031 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001032 prompt = "+ ";
1033 else
1034 prompt = "\n> ";
1035 }
1036 else {
William Lallemandad032882019-07-01 10:56:15 +02001037 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001038 prompt = "\n";
1039 }
1040
1041 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001042 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001043 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001044 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001045 }
1046
1047 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001048 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001049 break;
1050
1051 /* Now we close the output if one of the writers did so,
1052 * or if we're not in interactive mode and the request
1053 * buffer is empty. This still allows pipelined requests
1054 * to be sent in non-interactive mode.
1055 */
William Lallemand3de09d52018-12-11 16:10:56 +01001056 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1057 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001058 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001059 continue;
1060 }
1061
1062 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001063 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001064 /* reactivate the \n at the end of the response for the next command */
1065 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001066 }
1067 }
1068
1069 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1070 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1071 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1072 /* Other side has closed, let's abort if we have no more processing to do
1073 * and nothing more to consume. This is comparable to a broken pipe, so
1074 * we forward the close to the request side so that it flows upstream to
1075 * the client.
1076 */
1077 si_shutw(si);
1078 }
1079
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001080 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001081 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1082 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1083 /* We have no more processing to do, and nothing more to send, and
1084 * the client side has closed. So we'll forward this state downstream
1085 * on the response buffer.
1086 */
1087 si_shutr(si);
1088 res->flags |= CF_READ_NULL;
1089 }
1090
1091 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001092 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 +01001093 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001094 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 +01001095}
1096
William Lallemand74c24fb2016-11-21 17:18:36 +01001097/* This is called when the stream interface is closed. For instance, upon an
1098 * external abort, we won't call the i/o handler anymore so we may need to
1099 * remove back references to the stream currently being dumped.
1100 */
1101static void cli_release_handler(struct appctx *appctx)
1102{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001103 free_trash_chunk(appctx->chunk);
1104 appctx->chunk = NULL;
1105
William Lallemand74c24fb2016-11-21 17:18:36 +01001106 if (appctx->io_release) {
1107 appctx->io_release(appctx);
1108 appctx->io_release = NULL;
1109 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001110 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001111 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001113}
1114
1115/* This function dumps all environmnent variables to the buffer. It returns 0
1116 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001117 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1118 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001119 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001120static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001121{
Willy Tarreau0a739292016-11-22 20:21:23 +01001122 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001123 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001124
1125 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1126 return 1;
1127
1128 chunk_reset(&trash);
1129
1130 /* we have two inner loops here, one for the proxy, the other one for
1131 * the buffer.
1132 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001133 while (*var) {
1134 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001135
Willy Tarreau06d80a92017-10-19 14:32:15 +02001136 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001137 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001138 return 0;
1139 }
1140 if (appctx->st2 == STAT_ST_END)
1141 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001142 var++;
1143 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001144 }
1145
1146 /* dump complete */
1147 return 1;
1148}
1149
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001150/* This function dumps all file descriptors states (or the requested one) to
1151 * the buffer. It returns 0 if the output buffer is full and it needs to be
1152 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1153 * It uses cli.i0 as the fd number to restart from.
1154 */
1155static int cli_io_handler_show_fd(struct appctx *appctx)
1156{
1157 struct stream_interface *si = appctx->owner;
1158 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001159 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001160
1161 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001162 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001163
1164 chunk_reset(&trash);
1165
Willy Tarreauca1b1572018-12-18 15:45:11 +01001166 /* isolate the threads once per round. We're limited to a buffer worth
1167 * of output anyway, it cannot last very long.
1168 */
1169 thread_isolate();
1170
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001171 /* we have two inner loops here, one for the proxy, the other one for
1172 * the buffer.
1173 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001174 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001175 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001176 const struct listener *li = NULL;
1177 const struct server *sv = NULL;
1178 const struct proxy *px = NULL;
1179 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001180 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001181 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001182 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001183 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001184 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001185 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001186 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001187
1188 fdt = fdtab[fd];
1189
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001190 /* When DEBUG_FD is set, we also report closed FDs that have a
1191 * non-null event count to detect stuck ones.
1192 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001193 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001194#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001195 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001196#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001197 goto skip; // closed
1198 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001199 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001200 conn = (const struct connection *)fdt.owner;
1201 conn_flags = conn->flags;
1202 mux = conn->mux;
1203 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001204 xprt = conn->xprt;
1205 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001206 li = objt_listener(conn->target);
1207 sv = objt_server(conn->target);
1208 px = objt_proxy(conn->target);
1209 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001210 if (atleast2(fdt.thread_mask))
1211 suspicious = 1;
1212 if (conn->handle.fd != fd)
1213 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001214 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001215 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001216 li = fdt.owner;
1217
Willy Tarreaudacfde42021-01-21 09:07:29 +01001218 if (!fdt.thread_mask)
1219 suspicious = 1;
1220
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001221 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001222 " %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 +02001223 fd,
1224 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001225 (fdt.state & FD_CLONED) ? 'C' : 'c',
1226 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001227 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1228 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1229 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1230 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1231 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001232 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1233 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1234 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1235 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1236 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1237 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001238 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001239 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001240 fdt.iocb);
1241 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001242
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001243 if (!fdt.owner) {
1244 chunk_appendf(&trash, ")");
1245 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001246 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001247 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001248
1249 if (conn->handle.fd != fd) {
1250 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1251 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001252 } else {
1253 struct sockaddr_storage sa;
1254 socklen_t salen;
1255
1256 salen = sizeof(sa);
1257 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1258 if (sa.ss_family == AF_INET)
1259 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1260 else if (sa.ss_family == AF_INET6)
1261 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1262 else if (sa.ss_family == AF_UNIX)
1263 chunk_appendf(&trash, " fam=unix");
1264 }
1265
1266 salen = sizeof(sa);
1267 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1268 if (sa.ss_family == AF_INET)
1269 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1270 else if (sa.ss_family == AF_INET6)
1271 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1272 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001273 }
1274
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001275 if (px)
1276 chunk_appendf(&trash, " px=%s", px->id);
1277 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001278 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001279 else if (li)
1280 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001281
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001282 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001283 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001284 if (!ctx)
1285 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001286 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001287 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001288 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001289 else
1290 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001291
1292 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001293 if (xprt) {
1294 if (xprt_ctx || xprt->show_fd)
1295 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1296 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001297 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001298 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001299 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001300 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001301 struct sockaddr_storage sa;
1302 socklen_t salen;
1303
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001304 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001305 listener_state_str(li),
1306 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001307
1308 salen = sizeof(sa);
1309 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1310 if (sa.ss_family == AF_INET)
1311 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1312 else if (sa.ss_family == AF_INET6)
1313 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1314 else if (sa.ss_family == AF_UNIX)
1315 chunk_appendf(&trash, " fam=unix");
1316 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001317 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001318 else
1319 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001320
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001321#ifdef DEBUG_FD
1322 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001323 if (fdtab[fd].event_count >= 1000000)
1324 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001325#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001326 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001327
Willy Tarreau06d80a92017-10-19 14:32:15 +02001328 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001329 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001330 appctx->ctx.cli.i0 = fd;
1331 ret = 0;
1332 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001333 }
1334 skip:
1335 if (appctx->st2 == STAT_ST_END)
1336 break;
1337
1338 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001339 }
1340
Willy Tarreauca1b1572018-12-18 15:45:11 +01001341 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001342 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001343
1344 thread_release();
1345 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001346}
1347
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001348/* This function dumps some activity counters used by developers and support to
1349 * rule out some hypothesis during bug reports. It returns 0 if the output
1350 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1351 * everything at once in the buffer and is not designed to do it in multiple
1352 * passes.
1353 */
1354static int cli_io_handler_show_activity(struct appctx *appctx)
1355{
1356 struct stream_interface *si = appctx->owner;
1357 int thr;
1358
1359 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1360 return 1;
1361
1362 chunk_reset(&trash);
1363
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001364#undef SHOW_TOT
1365#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001366 do { \
1367 unsigned int _v[MAX_THREADS]; \
1368 unsigned int _tot; \
1369 const unsigned int _nbt = global.nbthread; \
1370 for (_tot = t = 0; t < _nbt; t++) \
1371 _tot += _v[t] = (x); \
1372 if (_nbt == 1) { \
1373 chunk_appendf(&trash, " %u\n", _tot); \
1374 break; \
1375 } \
1376 chunk_appendf(&trash, " %u [", _tot); \
1377 for (t = 0; t < _nbt; t++) \
1378 chunk_appendf(&trash, " %u", _v[t]); \
1379 chunk_appendf(&trash, " ]\n"); \
1380 } while (0)
1381
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001382#undef SHOW_AVG
1383#define SHOW_AVG(t, x) \
1384 do { \
1385 unsigned int _v[MAX_THREADS]; \
1386 unsigned int _tot; \
1387 const unsigned int _nbt = global.nbthread; \
1388 for (_tot = t = 0; t < _nbt; t++) \
1389 _tot += _v[t] = (x); \
1390 if (_nbt == 1) { \
1391 chunk_appendf(&trash, " %u\n", _tot); \
1392 break; \
1393 } \
1394 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1395 for (t = 0; t < _nbt; t++) \
1396 chunk_appendf(&trash, " %u", _v[t]); \
1397 chunk_appendf(&trash, " ]\n"); \
1398 } while (0)
1399
Willy Tarreaua0211b82019-05-28 15:09:08 +02001400 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1401 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001402 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1403 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1404 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1405 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001406 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001407 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1408 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001409 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001410 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001411 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001412 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001413 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001414 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001415 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1416 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001417 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1418 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1419 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1420 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1421 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1422 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1423 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001424#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001425 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 +02001426 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001427#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001428
Willy Tarreaud6a78502019-05-27 07:03:38 +02001429#if defined(DEBUG_DEV)
1430 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001431 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1432 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1433 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001434#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001435
1436 if (ci_putchk(si_ic(si), &trash) == -1) {
1437 chunk_reset(&trash);
1438 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001439 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001440 }
1441
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001442#undef SHOW_AVG
1443#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001444 /* dump complete */
1445 return 1;
1446}
1447
William Lallemandeceddf72016-12-15 18:06:44 +01001448/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001449 * CLI IO handler for `show cli sockets`.
1450 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001451 */
1452static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1453{
1454 struct bind_conf *bind_conf;
1455 struct stream_interface *si = appctx->owner;
1456
1457 chunk_reset(&trash);
1458
1459 switch (appctx->st2) {
1460 case STAT_ST_INIT:
1461 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001462 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001463 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001464 return 0;
1465 }
William Lallemandeceddf72016-12-15 18:06:44 +01001466 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001467 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001468
1469 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001470 if (global.cli_fe) {
1471 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001472 struct listener *l;
1473
1474 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001475 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001476 * if the current node is the first of the list
1477 */
1478
Willy Tarreau3af9d832016-12-16 12:58:09 +01001479 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001480 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001481 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001482 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001483 continue;
1484 }
1485
1486 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1487
1488 char addr[46];
1489 char port[6];
1490
Willy Tarreau37159062020-08-27 07:48:42 +02001491 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001492 const struct sockaddr_un *un;
1493
Willy Tarreau37159062020-08-27 07:48:42 +02001494 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001495 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001496 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001497 } else {
1498 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1499 }
Willy Tarreau37159062020-08-27 07:48:42 +02001500 } else if (l->rx.addr.ss_family == AF_INET) {
1501 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1502 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001503 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001504 } else if (l->rx.addr.ss_family == AF_INET6) {
1505 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1506 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001507 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001508 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1509 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001510 } else
William Lallemand26314342018-10-26 14:47:41 +02001511 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001512
William Lallemand07a62f72017-05-24 00:57:40 +02001513 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001514 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001515 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1516 chunk_appendf(&trash, "operator ");
1517 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1518 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001519 else
1520 chunk_appendf(&trash, " ");
1521
Willy Tarreau72faef32021-06-15 08:36:30 +02001522 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001523
Willy Tarreau06d80a92017-10-19 14:32:15 +02001524 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001525 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001526 return 0;
1527 }
1528 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001529 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001530 }
1531 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001532 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001533 default:
1534 appctx->st2 = STAT_ST_FIN;
1535 return 1;
1536 }
1537}
1538
1539
Willy Tarreau0a739292016-11-22 20:21:23 +01001540/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001541 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1542 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001543 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001544static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001545{
1546 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001547 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001548
1549 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1550 return 1;
1551
Willy Tarreauf6710f82016-12-16 17:45:44 +01001552 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001553
1554 if (*args[2]) {
1555 int len = strlen(args[2]);
1556
Willy Tarreauf6710f82016-12-16 17:45:44 +01001557 for (; *var; var++) {
1558 if (strncmp(*var, args[2], len) == 0 &&
1559 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001560 break;
1561 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001562 if (!*var)
1563 return cli_err(appctx, "Variable not found\n");
1564
Willy Tarreau0a739292016-11-22 20:21:23 +01001565 appctx->st2 = STAT_ST_END;
1566 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001567 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001568 return 0;
1569}
1570
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001571/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1572 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1573 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1574 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001575static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001576{
1577 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1578 return 1;
1579
1580 appctx->ctx.cli.i0 = 0;
1581
1582 if (*args[2]) {
1583 appctx->ctx.cli.i0 = atoi(args[2]);
1584 appctx->st2 = STAT_ST_END;
1585 }
1586 return 0;
1587}
1588
Willy Tarreau599852e2016-11-22 20:33:32 +01001589/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001590static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001591{
1592 struct stream_interface *si = appctx->owner;
1593 struct stream *s = si_strm(si);
1594
1595 if (strcmp(args[2], "cli") == 0) {
1596 unsigned timeout;
1597 const char *res;
1598
Willy Tarreau9d008692019-08-09 11:21:01 +02001599 if (!*args[3])
1600 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001601
1602 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001603 if (res || timeout < 1)
1604 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001605
1606 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1607 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1608 return 1;
1609 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001610
1611 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001612}
1613
Willy Tarreau2af99412016-11-23 11:10:59 +01001614/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001615static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001616{
1617 int v;
1618
1619 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1620 return 1;
1621
Willy Tarreau9d008692019-08-09 11:21:01 +02001622 if (!*args[3])
1623 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001624
1625 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001626 if (v > global.hardmaxconn)
1627 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001628
1629 /* check for unlimited values */
1630 if (v <= 0)
1631 v = global.hardmaxconn;
1632
1633 global.maxconn = v;
1634
1635 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001636 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001637
1638 return 1;
1639}
1640
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001641static int set_severity_output(int *target, char *argument)
1642{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001643 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001644 *target = CLI_SEVERITY_NONE;
1645 return 1;
1646 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001647 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001648 *target = CLI_SEVERITY_NUMBER;
1649 return 1;
1650 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001651 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001652 *target = CLI_SEVERITY_STRING;
1653 return 1;
1654 }
1655 return 0;
1656}
1657
1658/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001659static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001660{
1661 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1662 return 0;
1663
Willy Tarreau9d008692019-08-09 11:21:01 +02001664 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001665}
William Lallemandeceddf72016-12-15 18:06:44 +01001666
William Lallemand67a234f2018-12-13 09:05:45 +01001667
1668/* show the level of the current CLI session */
1669static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1670{
William Lallemand67a234f2018-12-13 09:05:45 +01001671 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001672 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001673 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001674 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001675 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001676 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001677 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001678 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001679}
1680
1681/* parse and set the CLI level dynamically */
1682static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1683{
William Lallemandad032882019-07-01 10:56:15 +02001684 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001685 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001686 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1687
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001688 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001689 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1690 return 1;
1691 }
1692 appctx->cli_level &= ~ACCESS_LVL_MASK;
1693 appctx->cli_level |= ACCESS_LVL_OPER;
1694
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001695 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001696 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1697 return 1;
1698 }
1699 appctx->cli_level &= ~ACCESS_LVL_MASK;
1700 appctx->cli_level |= ACCESS_LVL_USER;
1701 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001702 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001703 return 1;
1704}
1705
1706
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001707/* parse and set the CLI expert/experimental-mode dynamically */
1708static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001709{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001710 int level;
1711 char *level_str;
1712 char *output = NULL;
1713
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001714 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1715 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001716
1717 if (!strcmp(args[0], "expert-mode")) {
1718 level = ACCESS_EXPERT;
1719 level_str = "expert-mode";
1720 }
1721 else if (!strcmp(args[0], "experimental-mode")) {
1722 level = ACCESS_EXPERIMENTAL;
1723 level_str = "experimental-mode";
1724 }
1725 else {
1726 return 1;
1727 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001728
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001729 if (!*args[1]) {
1730 memprintf(&output, "%s is %s\n", level_str,
1731 (appctx->cli_level & level) ? "ON" : "OFF");
1732 return cli_dynmsg(appctx, LOG_INFO, output);
1733 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001734
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001735 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001736 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001737 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001738 return 1;
1739}
1740
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001741int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001742{
1743 return 0;
1744}
1745
Willy Tarreau45c742b2016-11-24 14:51:17 +01001746/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001747static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001748{
1749 int v;
1750 int *res;
1751 int mul = 1;
1752
1753 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1754 return 1;
1755
1756 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1757 res = &global.cps_lim;
1758 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1759 res = &global.sps_lim;
1760#ifdef USE_OPENSSL
1761 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1762 res = &global.ssl_lim;
1763#endif
1764 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1765 res = &global.comp_rate_lim;
1766 mul = 1024;
1767 }
1768 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001769 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001770 "'set rate-limit' only supports :\n"
1771 " - 'connections global' to set the per-process maximum connection rate\n"
1772 " - 'sessions global' to set the per-process maximum session rate\n"
1773#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001774 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001775#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001776 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001777 }
1778
Willy Tarreau9d008692019-08-09 11:21:01 +02001779 if (!*args[4])
1780 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001781
1782 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001783 if (v < 0)
1784 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001785
1786 *res = v * mul;
1787
1788 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001789 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001790
1791 return 1;
1792}
1793
William Lallemandf6975e92017-05-26 17:42:10 +02001794/* parse the "expose-fd" argument on the bind lines */
1795static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1796{
1797 if (!*args[cur_arg + 1]) {
1798 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1799 return ERR_ALERT | ERR_FATAL;
1800 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001801 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001802 conf->level |= ACCESS_FD_LISTENERS;
1803 } else {
1804 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1805 args[cur_arg], args[cur_arg+1]);
1806 return ERR_ALERT | ERR_FATAL;
1807 }
1808
1809 return 0;
1810}
1811
William Lallemand74c24fb2016-11-21 17:18:36 +01001812/* parse the "level" argument on the bind lines */
1813static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1814{
1815 if (!*args[cur_arg + 1]) {
1816 memprintf(err, "'%s' : missing level", args[cur_arg]);
1817 return ERR_ALERT | ERR_FATAL;
1818 }
1819
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001820 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001821 conf->level &= ~ACCESS_LVL_MASK;
1822 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001823 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001824 conf->level &= ~ACCESS_LVL_MASK;
1825 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001826 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001827 conf->level &= ~ACCESS_LVL_MASK;
1828 conf->level |= ACCESS_LVL_ADMIN;
1829 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001830 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1831 args[cur_arg], args[cur_arg+1]);
1832 return ERR_ALERT | ERR_FATAL;
1833 }
1834
1835 return 0;
1836}
1837
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001838static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1839{
1840 if (!*args[cur_arg + 1]) {
1841 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1842 return ERR_ALERT | ERR_FATAL;
1843 }
1844
1845 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1846 return 0;
1847 else {
1848 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1849 args[cur_arg], args[cur_arg+1]);
1850 return ERR_ALERT | ERR_FATAL;
1851 }
1852}
1853
Olivier Houchardf886e342017-04-05 22:24:59 +02001854/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001855static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001856{
1857 char *cmsgbuf = NULL;
1858 unsigned char *tmpbuf = NULL;
1859 struct cmsghdr *cmsg;
1860 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001861 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001862 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001863 struct msghdr msghdr;
1864 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001865 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001866 const char *ns_name, *if_name;
1867 unsigned char ns_nlen, if_nlen;
1868 int nb_queued;
1869 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001870 int *tmpfd;
1871 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001872 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001873 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001874 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001875 int ret;
1876
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001877 if (!remote) {
1878 ha_warning("Only works on real connections\n");
1879 goto out;
1880 }
1881
1882 fd = remote->handle.fd;
1883
Olivier Houchardf886e342017-04-05 22:24:59 +02001884 /* Temporary set the FD in blocking mode, that will make our life easier */
1885 old_fcntl = fcntl(fd, F_GETFL);
1886 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001887 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001888 goto out;
1889 }
1890 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1891 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001892 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001893 goto out;
1894 }
1895 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001896 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001897 goto out;
1898 }
Olivier Houchard54740872017-04-06 14:45:14 +02001899 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001900 iov.iov_base = &tot_fd_nb;
1901 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001902 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001903 goto out;
1904 memset(&msghdr, 0, sizeof(msghdr));
1905 /*
1906 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001907 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001908 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001909 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001910 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001911
Olivier Houchardf886e342017-04-05 22:24:59 +02001912 if (tot_fd_nb == 0)
1913 goto out;
1914
1915 /* First send the total number of file descriptors, so that the
1916 * receiving end knows what to expect.
1917 */
1918 msghdr.msg_iov = &iov;
1919 msghdr.msg_iovlen = 1;
1920 ret = sendmsg(fd, &msghdr, 0);
1921 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001922 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001923 goto out;
1924 }
1925
1926 /* Now send the fds */
1927 msghdr.msg_control = cmsgbuf;
1928 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1929 cmsg = CMSG_FIRSTHDR(&msghdr);
1930 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1931 cmsg->cmsg_level = SOL_SOCKET;
1932 cmsg->cmsg_type = SCM_RIGHTS;
1933 tmpfd = (int *)CMSG_DATA(cmsg);
1934
Olivier Houchardf886e342017-04-05 22:24:59 +02001935 /* For each socket, e message is sent, containing the following :
1936 * Size of the namespace name (or 0 if none), as an unsigned char.
1937 * The namespace name, if any
1938 * Size of the interface name (or 0 if none), as an unsigned char
1939 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001940 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001941 */
1942 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001943 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001944 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001945 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001946 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001947 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001948 goto out;
1949 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001950
1951 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001952 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001953 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001954 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001955 continue;
1956
1957 ns_name = if_name = "";
1958 ns_nlen = if_nlen = 0;
1959
1960 /* for now we can only retrieve namespaces and interfaces from
1961 * pure listeners.
1962 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001963 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001964 const struct listener *l = fdtab[cur_fd].owner;
1965
Willy Tarreau818a92e2020-09-03 07:50:19 +02001966 if (l->rx.settings->interface) {
1967 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001968 if_nlen = strlen(if_name);
1969 }
1970
1971#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001972 if (l->rx.settings->netns) {
1973 ns_name = l->rx.settings->netns->node.key;
1974 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001975 }
1976#endif
1977 }
1978
1979 /* put the FD into the CMSG_DATA */
1980 tmpfd[nb_queued++] = cur_fd;
1981
1982 /* first block is <ns_name_len> <ns_name> */
1983 tmpbuf[curoff++] = ns_nlen;
1984 if (ns_nlen)
1985 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1986 curoff += ns_nlen;
1987
1988 /* second block is <if_name_len> <if_name> */
1989 tmpbuf[curoff++] = if_nlen;
1990 if (if_nlen)
1991 memcpy(tmpbuf + curoff, if_name, if_nlen);
1992 curoff += if_nlen;
1993
1994 /* we used to send the listener options here before 2.3 */
1995 memset(tmpbuf + curoff, 0, sizeof(int));
1996 curoff += sizeof(int);
1997
1998 /* there's a limit to how many FDs may be sent at once */
1999 if (nb_queued == MAX_SEND_FD) {
2000 iov.iov_len = curoff;
2001 if (sendmsg(fd, &msghdr, 0) != curoff) {
2002 ha_warning("Failed to transfer sockets\n");
2003 return -1;
2004 }
2005
2006 /* Wait for an ack */
2007 do {
2008 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2009 } while (ret == -1 && errno == EINTR);
2010
2011 if (ret <= 0) {
2012 ha_warning("Unexpected error while transferring sockets\n");
2013 return -1;
2014 }
2015 curoff = 0;
2016 nb_queued = 0;
2017 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002018 }
2019
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002020 /* flush pending stuff */
2021 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002022 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002023 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2024 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002025 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002026 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002027 goto out;
2028 }
2029 }
2030
2031out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002032 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002033 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002034 goto out;
2035 }
2036 appctx->st0 = CLI_ST_END;
2037 free(cmsgbuf);
2038 free(tmpbuf);
2039 return 1;
2040}
2041
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002042static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2043{
2044 if (*args[0] == 'h')
2045 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002046 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002047 else if (*args[0] == 'p')
2048 /* prompt */
2049 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2050 else if (*args[0] == 'q')
2051 /* quit */
2052 appctx->st0 = CLI_ST_END;
2053
2054 return 1;
2055}
Olivier Houchardf886e342017-04-05 22:24:59 +02002056
William Lallemand2f4ce202018-10-26 14:47:47 +02002057void pcli_write_prompt(struct stream *s)
2058{
2059 struct buffer *msg = get_trash_chunk();
2060 struct channel *oc = si_oc(&s->si[0]);
2061
William Lallemanddc12c2e2018-12-13 09:05:46 +01002062 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002063 return;
2064
William Lallemanddc12c2e2018-12-13 09:05:46 +01002065 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002066 chunk_appendf(msg, "+ ");
2067 } else {
2068 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002069 chunk_appendf(msg, "master%s> ",
2070 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002071 else
2072 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2073 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002074 co_inject(oc, msg->area, msg->data);
2075}
2076
William Lallemand291810d2018-10-26 14:47:38 +02002077
William Lallemandcf62f7e2018-10-26 14:47:40 +02002078/* The pcli_* functions are used for the CLI proxy in the master */
2079
William Lallemanddeeaa592018-10-26 14:47:48 +02002080void pcli_reply_and_close(struct stream *s, const char *msg)
2081{
2082 struct buffer *buf = get_trash_chunk();
2083
2084 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002085 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002086}
2087
William Lallemand291810d2018-10-26 14:47:38 +02002088static enum obj_type *pcli_pid_to_server(int proc_pid)
2089{
2090 struct mworker_proc *child;
2091
William Lallemand99e0bb92020-11-05 10:28:53 +01002092 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002093 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002094 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002095
William Lallemand291810d2018-10-26 14:47:38 +02002096 list_for_each_entry(child, &proc_list, list) {
2097 if (child->pid == proc_pid){
2098 return &child->srv->obj_type;
2099 }
2100 }
2101 return NULL;
2102}
2103
2104/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2105 * Return:
2106 * 0: master
2107 * > 0: pid of a worker
2108 * < 0: didn't find a worker
2109 */
2110static int pcli_prefix_to_pid(const char *prefix)
2111{
2112 int proc_pid;
2113 struct mworker_proc *child;
2114 char *errtol = NULL;
2115
2116 if (*prefix != '@') /* not a prefix, should not happen */
2117 return -1;
2118
2119 prefix++;
2120 if (!*prefix) /* sent @ alone, return the master */
2121 return 0;
2122
2123 if (strcmp("master", prefix) == 0) {
2124 return 0;
2125 } else if (*prefix == '!') {
2126 prefix++;
2127 if (!*prefix)
2128 return -1;
2129
2130 proc_pid = strtol(prefix, &errtol, 10);
2131 if (*errtol != '\0')
2132 return -1;
2133 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002134 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002135 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002136 if (child->pid == proc_pid){
2137 return child->pid;
2138 }
2139 }
2140 } else {
2141 struct mworker_proc *chosen = NULL;
2142 /* this is a relative pid */
2143
2144 proc_pid = strtol(prefix, &errtol, 10);
2145 if (*errtol != '\0')
2146 return -1;
2147
2148 if (proc_pid == 0) /* return the master */
2149 return 0;
2150
2151 /* chose the right process, the current one is the one with the
2152 least number of reloads */
2153 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002154 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002155 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002156 if (child->reloads == 0)
2157 return child->pid;
2158 else if (chosen == NULL || child->reloads < chosen->reloads)
2159 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002160 }
2161 if (chosen)
2162 return chosen->pid;
2163 }
2164 return -1;
2165}
2166
William Lallemandbddd33a2018-12-11 16:10:53 +01002167/* Return::
2168 * >= 0 : number of words to escape
2169 * = -1 : error
2170 */
2171
2172int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2173{
2174 if (argl < 1)
2175 return 0;
2176
2177 /* there is a prefix */
2178 if (args[0][0] == '@') {
2179 int target_pid = pcli_prefix_to_pid(args[0]);
2180
2181 if (target_pid == -1) {
2182 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2183 return -1;
2184 }
2185
2186 /* if the prefix is alone, define a default target */
2187 if (argl == 1)
2188 s->pcli_next_pid = target_pid;
2189 else
2190 *next_pid = target_pid;
2191 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002192 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002193 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002194 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002195
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002196 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002197 channel_shutr_now(&s->req);
2198 channel_shutw_now(&s->res);
2199 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002200 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002201 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2202 memprintf(errmsg, "Permission denied!\n");
2203 return -1;
2204 }
2205 s->pcli_flags &= ~ACCESS_LVL_MASK;
2206 s->pcli_flags |= ACCESS_LVL_OPER;
2207 return argl;
2208
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002209 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002210 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2211 memprintf(errmsg, "Permission denied!\n");
2212 return -1;
2213 }
2214 s->pcli_flags &= ~ACCESS_LVL_MASK;
2215 s->pcli_flags |= ACCESS_LVL_USER;
2216 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002217 }
2218
2219 return 0;
2220}
2221
2222/*
2223 * Parse the CLI request:
2224 * - It does basically the same as the cli_io_handler, but as a proxy
2225 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002226 *
2227 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002228 * - the number of characters to forward or
2229 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002230 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002231int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002232{
William Lallemandbddd33a2018-12-11 16:10:53 +01002233 char *str = (char *)ci_head(req);
2234 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002235 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002236 int argl; /* number of args */
2237 char *p;
2238 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002239 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002240 int wtrim = 0; /* number of words to trim */
2241 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002242 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002243 int i = 0;
2244
2245 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002246
William Lallemanddc12c2e2018-12-13 09:05:46 +01002247 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002248
2249 /* Looks for the end of one command */
2250 while (p+reql < end) {
2251 /* handle escaping */
2252 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002253 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002254 continue;
2255 }
2256 if (p[reql] == ';' || p[reql] == '\n') {
2257 /* found the end of the command */
2258 p[reql] = '\n';
2259 reql++;
2260 break;
2261 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002262 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002263 }
William Lallemandebf61802018-12-11 16:10:57 +01002264 } else {
2265 while (p+reql < end) {
2266 if (p[reql] == '\n') {
2267 /* found the end of the line */
2268 reql++;
2269 break;
2270 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002271 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002272 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002273 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002274
William Lallemandbddd33a2018-12-11 16:10:53 +01002275 /* set end to first byte after the end of the command */
2276 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002277
William Lallemandbddd33a2018-12-11 16:10:53 +01002278 /* there is no end to this command, need more to parse ! */
2279 if (*(end-1) != '\n') {
2280 return -1;
2281 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002282
William Lallemand3301f3e2018-12-13 09:05:48 +01002283 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2284 if (reql == 1) /* last line of the payload */
2285 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002286 return reql;
2287 }
2288
William Lallemandbddd33a2018-12-11 16:10:53 +01002289 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002290
William Lallemandbddd33a2018-12-11 16:10:53 +01002291 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002292 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002293 /* skip leading spaces/tabs */
2294 p += strspn(p, " \t");
2295 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002296 break;
2297
William Lallemandbddd33a2018-12-11 16:10:53 +01002298 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002299 while (1) {
2300 p += strcspn(p, " \t\\");
2301 /* escaped chars using backlashes (\) */
2302 if (*p == '\\') {
2303 if (!*++p)
2304 break;
2305 if (!*++p)
2306 break;
2307 } else {
2308 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002309 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002310 }
William Lallemandfe249c32020-06-18 18:03:57 +02002311 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002312 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002313 }
2314
William Lallemandbddd33a2018-12-11 16:10:53 +01002315 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002316
Willy Tarreauf14c7572021-03-13 10:59:23 +01002317 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002318 args[i] = NULL;
2319
2320 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2321
2322 /* End of words are ending by \0, we need to replace the \0s by spaces
23231 before forwarding them */
2324 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002325 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002326 if (*p == '\0')
2327 *p = ' ';
2328 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002329 }
2330
William Lallemand3301f3e2018-12-13 09:05:48 +01002331 payload = strstr(str, PAYLOAD_PATTERN);
2332 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2333 /* if the payload pattern is at the end */
2334 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002335 }
2336
William Lallemandbddd33a2018-12-11 16:10:53 +01002337 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002338
William Lallemandbddd33a2018-12-11 16:10:53 +01002339 if (wtrim > 0) {
2340 trim = &args[wtrim][0];
2341 if (trim == NULL) /* if this was the last word in the table */
2342 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002343
William Lallemandbddd33a2018-12-11 16:10:53 +01002344 b_del(&req->buf, trim - str);
2345
William Lallemandb7ea1412018-12-13 09:05:47 +01002346 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002347 } else if (wtrim < 0) {
2348 /* parsing error */
2349 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002350 } else {
2351 /* the whole string */
2352 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002353 }
2354
William Lallemandb7ea1412018-12-13 09:05:47 +01002355 if (ret > 1) {
2356 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2357 goto end;
2358 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002359 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2360 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002361 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002362 ci_insert_line2(req, 0, "user -", strlen("user -"));
2363 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002364 }
2365 }
2366end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002367
William Lallemandb7ea1412018-12-13 09:05:47 +01002368 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002369}
2370
2371int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2372{
William Lallemandbddd33a2018-12-11 16:10:53 +01002373 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002374 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002375 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002376
William Lallemandb7ea1412018-12-13 09:05:47 +01002377 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2378 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2379
William Lallemandcf62f7e2018-10-26 14:47:40 +02002380read_again:
2381 /* if the channel is closed for read, we won't receive any more data
2382 from the client, but we don't want to forward this close to the
2383 server */
2384 channel_dont_close(req);
2385
2386 /* We don't know yet to which server we will connect */
2387 channel_dont_connect(req);
2388
2389
2390 /* we are not waiting for a response, there is no more request and we
2391 * receive a close from the client, we can leave */
2392 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2393 channel_shutw_now(&s->res);
2394 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2395 return 1;
2396 }
2397
2398 req->flags |= CF_READ_DONTWAIT;
2399
2400 /* need more data */
2401 if (!ci_data(req))
2402 return 0;
2403
2404 /* If there is data available for analysis, log the end of the idle time. */
2405 if (c_data(req) && s->logs.t_idle == -1)
2406 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2407
William Lallemandbddd33a2018-12-11 16:10:53 +01002408 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002409 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002410 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002411 /* enough data */
2412
William Lallemandcf62f7e2018-10-26 14:47:40 +02002413 /* forward only 1 command */
2414 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002415
William Lallemanddc12c2e2018-12-13 09:05:46 +01002416 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002417 /* we send only 1 command per request, and we write close after it */
2418 channel_shutw_now(req);
2419 } else {
2420 pcli_write_prompt(s);
2421 }
2422
2423 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002424
2425 /* remove the XFER_DATA analysers, which forwards all
2426 * the data, we don't want to forward the next requests
2427 * We need to add CF_FLT_ANALYZE to abort the forward too.
2428 */
2429 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2430 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2431 s->res.analysers |= AN_RES_WAIT_CLI;
2432
William Lallemandebf61802018-12-11 16:10:57 +01002433 if (!(s->flags & SF_ASSIGNED)) {
2434 if (next_pid > -1)
2435 target_pid = next_pid;
2436 else
2437 target_pid = s->pcli_next_pid;
2438 /* we can connect now */
2439 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002440
William Lallemandebf61802018-12-11 16:10:57 +01002441 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2442 channel_auto_connect(req);
2443 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002444
2445 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002446 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002447 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002449 } else if (to_forward == -1 && errmsg) {
2450 /* there was an error during the parsing */
2451 pcli_reply_and_close(s, errmsg);
2452 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002453 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2454 /* buffer is full and we didn't catch the end of a command */
2455 goto send_help;
2456 }
2457
2458 return 0;
2459
2460send_help:
2461 b_reset(&req->buf);
2462 b_putblk(&req->buf, "help\n", 5);
2463 goto read_again;
2464}
2465
2466int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2467{
2468 struct proxy *fe = strm_fe(s);
2469 struct proxy *be = s->be;
2470
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002471 if (rep->flags & CF_READ_ERROR) {
2472 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2473 s->res.analysers &= ~AN_RES_WAIT_CLI;
2474 return 0;
2475 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002476 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2477 rep->flags |= CF_NEVER_WAIT;
2478
2479 /* don't forward the close */
2480 channel_dont_close(&s->res);
2481 channel_dont_close(&s->req);
2482
William Lallemanddc12c2e2018-12-13 09:05:46 +01002483 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002484 s->req.analysers |= AN_REQ_WAIT_CLI;
2485 s->res.analysers &= ~AN_RES_WAIT_CLI;
2486 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2487 return 0;
2488 }
2489
William Lallemandcf62f7e2018-10-26 14:47:40 +02002490 /* forward the data */
2491 if (ci_data(rep)) {
2492 c_adv(rep, ci_data(rep));
2493 return 0;
2494 }
2495
2496 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2497 /* stream cleanup */
2498
William Lallemand2f4ce202018-10-26 14:47:47 +02002499 pcli_write_prompt(s);
2500
William Lallemandcf62f7e2018-10-26 14:47:40 +02002501 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2502 si_shutr(&s->si[1]);
2503 si_shutw(&s->si[1]);
2504
2505 /*
2506 * starting from there this the same code as
2507 * http_end_txn_clean_session().
2508 *
2509 * It allows to do frontend keepalive while reconnecting to a
2510 * new server for each request.
2511 */
2512
2513 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002514 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002515 if (unlikely(s->srv_conn))
2516 sess_change_server(s, NULL);
2517 }
2518
2519 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2520 stream_process_counters(s);
2521
2522 /* don't count other requests' data */
2523 s->logs.bytes_in -= ci_data(&s->req);
2524 s->logs.bytes_out -= ci_data(&s->res);
2525
2526 /* we may need to know the position in the queue */
2527 pendconn_free(s);
2528
2529 /* let's do a final log if we need it */
2530 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2531 !(s->flags & SF_MONITOR) &&
2532 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2533 s->do_log(s);
2534 }
2535
2536 /* stop tracking content-based counters */
2537 stream_stop_content_counters(s);
2538 stream_update_time_stats(s);
2539
2540 s->logs.accept_date = date; /* user-visible date for logging */
2541 s->logs.tv_accept = now; /* corrected date for internal use */
2542 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2543 s->logs.t_idle = -1;
2544 tv_zero(&s->logs.tv_request);
2545 s->logs.t_queue = -1;
2546 s->logs.t_connect = -1;
2547 s->logs.t_data = -1;
2548 s->logs.t_close = 0;
2549 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2550 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2551
2552 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2553 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2554
2555 stream_del_srv_conn(s);
2556 if (objt_server(s->target)) {
2557 if (s->flags & SF_CURR_SESS) {
2558 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002559 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002560 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002561 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002562 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002563 }
2564
2565 s->target = NULL;
2566
2567 /* only release our endpoint if we don't intend to reuse the
2568 * connection.
2569 */
2570 if (!si_conn_ready(&s->si[1])) {
2571 si_release_endpoint(&s->si[1]);
2572 s->srv_conn = NULL;
2573 }
2574
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002575 sockaddr_free(&s->target_addr);
2576
William Lallemandcf62f7e2018-10-26 14:47:40 +02002577 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2578 s->si[1].err_type = SI_ET_NONE;
2579 s->si[1].conn_retries = 0; /* used for logging too */
2580 s->si[1].exp = TICK_ETERNITY;
2581 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 +02002582 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 +02002583 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 +02002584 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2585 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2586 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2587 /* reinitialise the current rule list pointer to NULL. We are sure that
2588 * any rulelist match the NULL pointer.
2589 */
2590 s->current_rule_list = NULL;
2591
2592 s->be = strm_fe(s);
2593 s->logs.logwait = strm_fe(s)->to_log;
2594 s->logs.level = 0;
2595 stream_del_srv_conn(s);
2596 s->target = NULL;
2597 /* re-init store persistence */
2598 s->store_count = 0;
2599 s->uniq_id = global.req_count++;
2600
2601 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2602
2603 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2604
2605 s->req.analysers |= AN_REQ_WAIT_CLI;
2606 s->res.analysers &= ~AN_RES_WAIT_CLI;
2607
2608 /* We must trim any excess data from the response buffer, because we
2609 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002610 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002611 * we want those data to come along with next response. A typical
2612 * example of such data would be from a buggy server responding to
2613 * a HEAD with some data, or sending more than the advertised
2614 * content-length.
2615 */
2616 if (unlikely(ci_data(&s->res)))
2617 b_set_data(&s->res.buf, co_data(&s->res));
2618
2619 /* Now we can realign the response buffer */
2620 c_realign_if_empty(&s->res);
2621
2622 s->req.rto = strm_fe(s)->timeout.client;
2623 s->req.wto = TICK_ETERNITY;
2624
2625 s->res.rto = TICK_ETERNITY;
2626 s->res.wto = strm_fe(s)->timeout.client;
2627
2628 s->req.rex = TICK_ETERNITY;
2629 s->req.wex = TICK_ETERNITY;
2630 s->req.analyse_exp = TICK_ETERNITY;
2631 s->res.rex = TICK_ETERNITY;
2632 s->res.wex = TICK_ETERNITY;
2633 s->res.analyse_exp = TICK_ETERNITY;
2634 s->si[1].hcto = TICK_ETERNITY;
2635
2636 /* we're removing the analysers, we MUST re-enable events detection.
2637 * We don't enable close on the response channel since it's either
2638 * already closed, or in keep-alive with an idle connection handler.
2639 */
2640 channel_auto_read(&s->req);
2641 channel_auto_close(&s->req);
2642 channel_auto_read(&s->res);
2643
2644
2645 return 1;
2646 }
2647 return 0;
2648}
2649
William Lallemand8a022572018-10-26 14:47:35 +02002650/*
2651 * The mworker functions are used to initialize the CLI in the master process
2652 */
2653
William Lallemand309dc9a2018-10-26 14:47:45 +02002654 /*
2655 * Stop the mworker proxy
2656 */
2657void mworker_cli_proxy_stop()
2658{
William Lallemand550db6d2018-11-06 17:37:12 +01002659 if (mworker_proxy)
2660 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002661}
2662
William Lallemand8a022572018-10-26 14:47:35 +02002663/*
2664 * Create the mworker CLI proxy
2665 */
2666int mworker_cli_proxy_create()
2667{
2668 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002669 char *msg = NULL;
2670 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002671
William Lallemandae787ba2021-07-29 15:13:22 +02002672 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002673 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002674 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002675
William Lallemandcf62f7e2018-10-26 14:47:40 +02002676 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002677 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2678 mworker_proxy->timeout.client = 0; /* no timeout */
2679 mworker_proxy->conf.file = strdup("MASTER");
2680 mworker_proxy->conf.line = 0;
2681 mworker_proxy->accept = frontend_accept;
2682 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2683
2684 /* Does not init the default target the CLI applet, but must be done in
2685 * the request parsing code */
2686 mworker_proxy->default_target = NULL;
2687
William Lallemand8a022572018-10-26 14:47:35 +02002688 /* create all servers using the mworker_proc list */
2689 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002690 struct server *newsrv = NULL;
2691 struct sockaddr_storage *sk;
2692 int port1, port2, port;
2693 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002694
William Lallemanda31b09e2020-01-14 15:25:02 +01002695 /* only the workers support the master CLI */
2696 if (!(child->options & PROC_O_TYPE_WORKER))
2697 continue;
2698
William Lallemand8a022572018-10-26 14:47:35 +02002699 newsrv = new_server(mworker_proxy);
2700 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002701 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002702
2703 /* we don't know the new pid yet */
2704 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002705 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002706 else
2707 memprintf(&msg, "old-%d", child->pid);
2708
2709 newsrv->next = mworker_proxy->srv;
2710 mworker_proxy->srv = newsrv;
2711 newsrv->conf.file = strdup(msg);
2712 newsrv->id = strdup(msg);
2713 newsrv->conf.line = 0;
2714
2715 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002716 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002717 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002718 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002719 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002720 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002721
Willy Tarreau5fc93282020-09-16 18:25:03 +02002722 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002723 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002724 }
2725
2726 /* no port specified */
2727 newsrv->flags |= SRV_F_MAPPORTS;
2728 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002729 /* don't let the server participate to load balancing */
2730 newsrv->iweight = 0;
2731 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002732 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002733
2734 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002735 }
William Lallemandae787ba2021-07-29 15:13:22 +02002736
2737 mworker_proxy->next = proxies_list;
2738 proxies_list = mworker_proxy;
2739
William Lallemand8a022572018-10-26 14:47:35 +02002740 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002741
2742error:
William Lallemand744a0892018-11-22 16:46:51 +01002743
2744 list_for_each_entry(child, &proc_list, list) {
2745 free((char *)child->srv->conf.file); /* cast because of const char * */
2746 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002747 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002748 }
William Lallemandae787ba2021-07-29 15:13:22 +02002749 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002750 free(msg);
2751
William Lallemandae787ba2021-07-29 15:13:22 +02002752error_proxy:
2753 ha_alert("%s\n", errmsg);
2754 free(errmsg);
2755
William Lallemand744a0892018-11-22 16:46:51 +01002756 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002757}
Olivier Houchardf886e342017-04-05 22:24:59 +02002758
William Lallemandce83b4a2018-10-26 14:47:30 +02002759/*
William Lallemande7361152018-10-26 14:47:36 +02002760 * Create a new listener for the master CLI proxy
2761 */
2762int mworker_cli_proxy_new_listener(char *line)
2763{
2764 struct bind_conf *bind_conf;
2765 struct listener *l;
2766 char *err = NULL;
2767 char *args[MAX_LINE_ARGS + 1];
2768 int arg;
2769 int cur_arg;
2770
William Lallemand2e945c82019-11-25 09:58:37 +01002771 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002772 args[0] = line;
2773
2774 /* args is a bind configuration with spaces replaced by commas */
2775 while (*line && arg < MAX_LINE_ARGS) {
2776
2777 if (*line == ',') {
2778 *line++ = '\0';
2779 while (*line == ',')
2780 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002781 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002782 }
2783 line++;
2784 }
2785
William Lallemand2e945c82019-11-25 09:58:37 +01002786 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002787
2788 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002789 if (!bind_conf)
2790 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002791
2792 bind_conf->level &= ~ACCESS_LVL_MASK;
2793 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002794 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002795
2796 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2797 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002798 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002799 }
2800
2801 cur_arg = 1;
2802
2803 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002804 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002805 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002806
2807 kw = bind_find_kw(args[cur_arg]);
2808 if (kw) {
2809 if (!kw->parse) {
2810 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2811 args[0], args[1], args[cur_arg]);
2812 goto err;
2813 }
2814
Willy Tarreau4975d142021-03-13 11:00:33 +01002815 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002816 if (err)
2817 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2818 else
2819 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2820 args[0], args[1], args[cur_arg]);
2821 goto err;
2822 }
2823
2824 cur_arg += 1 + kw->skip;
2825 continue;
2826 }
2827
Willy Tarreau433b05f2021-03-12 10:14:07 +01002828 best = bind_find_best_kw(args[cur_arg]);
2829 if (best)
2830 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2831 args[0], args[1], args[cur_arg], best);
2832 else
2833 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2834 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002835 goto err;
2836 }
2837
2838
2839 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002840 l->accept = session_accept_fd;
2841 l->default_target = mworker_proxy->default_target;
2842 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002843 l->options |= LI_O_UNLIMITED;
2844 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002845 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002846 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002847 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002848 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002849
2850 return 0;
2851
2852err:
2853 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002854 free(err);
2855 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002856 return -1;
2857
2858}
2859
2860/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002861 * Create a new CLI socket using a socketpair for a worker process
2862 * <mworker_proc> is the process structure, and <proc> is the process number
2863 */
2864int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2865{
2866 struct bind_conf *bind_conf;
2867 struct listener *l;
2868 char *path = NULL;
2869 char *err = NULL;
2870
2871 /* master pipe to ensure the master is still alive */
2872 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2873 ha_alert("Cannot create worker socketpair.\n");
2874 return -1;
2875 }
2876
2877 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002878 if (!global.cli_fe) {
2879 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002880 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002881 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002882 }
2883 }
2884
Willy Tarreau4975d142021-03-13 11:00:33 +01002885 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002886 if (!bind_conf)
2887 goto error;
2888
William Lallemandce83b4a2018-10-26 14:47:30 +02002889 bind_conf->level &= ~ACCESS_LVL_MASK;
2890 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2891
William Lallemandce83b4a2018-10-26 14:47:30 +02002892 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2893 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002894 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002895 }
2896
Willy Tarreau4975d142021-03-13 11:00:33 +01002897 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002898 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002899 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002900 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002901 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002902 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002903
2904 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002905 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002906 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002907 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002908 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002909 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002910 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002911 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002912 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002913 }
2914
2915 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002916
2917error:
2918 close(mworker_proc->ipc_fd[0]);
2919 close(mworker_proc->ipc_fd[1]);
2920 free(err);
2921
2922 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002923}
2924
William Lallemand74c24fb2016-11-21 17:18:36 +01002925static struct applet cli_applet = {
2926 .obj_type = OBJ_TYPE_APPLET,
2927 .name = "<CLI>", /* used for logging */
2928 .fct = cli_io_handler,
2929 .release = cli_release_handler,
2930};
2931
William Lallemand99e0bb92020-11-05 10:28:53 +01002932/* master CLI */
2933static struct applet mcli_applet = {
2934 .obj_type = OBJ_TYPE_APPLET,
2935 .name = "<MCLI>", /* used for logging */
2936 .fct = cli_io_handler,
2937 .release = cli_release_handler,
2938};
2939
Willy Tarreau0a739292016-11-22 20:21:23 +01002940/* register cli keywords */
2941static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002942 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2943 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2944 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2945 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
2946 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2947 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2948 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
2949 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
2950 { { "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 },
2951 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
2952 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
2953 { { "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 },
2954 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2955 { { "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 },
2956 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
2957 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2958 { { "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 +01002959 {{},}
2960}};
2961
Willy Tarreau0108d902018-11-25 19:14:37 +01002962INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2963
William Lallemand74c24fb2016-11-21 17:18:36 +01002964static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002965 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002966 { 0, NULL, NULL },
2967}};
2968
Willy Tarreau0108d902018-11-25 19:14:37 +01002969INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2970
William Lallemand74c24fb2016-11-21 17:18:36 +01002971static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002972 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2973 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002974 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002975 { NULL, NULL, 0 },
2976}};
2977
Willy Tarreau0108d902018-11-25 19:14:37 +01002978INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002979
2980/*
2981 * Local variables:
2982 * c-indent-level: 8
2983 * c-basic-offset: 8
2984 * End:
2985 */