blob: c5009a3bccd1d091f1033e55ae48d7b2e313d738 [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 Tarreaub96a74c2021-03-12 17:13:28 +010087/* This will show the help message and list the commands supported at the
88 * current level that match all of the first words of <args> if args is not
89 * NULL, or all args if none matches or if args is null.
90 */
91static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +010092{
93 struct cli_kw_list *kw_list;
94 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +020095 struct buffer *tmp = get_trash_chunk();
96 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +010097 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +010098 int idx;
99 int length = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100100
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100101 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100102
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100103 /* first, let's measure the longest match */
104 list_for_each_entry(kw_list, &cli_keywords.list, list) {
105 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100106 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100107 continue;
108 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
109 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
110 continue;
111
112 /* OK this command is visible */
113 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
114 if (!kw->str_kw[idx])
115 break; // end of keyword
116 if (!args || !args[idx] || !*args[idx])
117 break; // end of command line
118 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
119 break;
120 if (idx + 1 > length)
121 length = idx + 1;
122 }
123 }
124 }
125
Willy Tarreaub7364582021-03-12 18:24:46 +0100126 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100127 chunk_reset(tmp);
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100128 if (!args) // this is the help message.
129 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreaub7364582021-03-12 18:24:46 +0100130 else if (!length && (!*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100131 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
132 else // partial match
133 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
134
Willy Tarreaub7364582021-03-12 18:24:46 +0100135 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
136 matches[idx].kw = NULL;
137 matches[idx].dist = INT_MAX;
138 }
139
140 /* In case of partial match we'll look for the best matching entries
141 * starting from position <length>
142 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100143 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100144 list_for_each_entry(kw_list, &cli_keywords.list, list) {
145 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100146 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100147 continue;
148 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
149 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
150 continue;
151
152 for (idx = 0; idx < length; idx++) {
153 if (!kw->str_kw[idx])
154 break; // end of keyword
155 if (!args || !args[idx] || !*args[idx])
156 break; // end of command line
157 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
158 break;
159 }
160
161 /* extra non-matching words are fuzzy-matched */
162 if (kw->usage && idx == length && args[idx] && *args[idx]) {
163 uint8_t word_sig[1024];
164 uint8_t list_sig[1024];
165 int dist = 0;
166 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100167 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100168
169 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100170 * on the remaining words. For this we're computing the signature
171 * of everything that remains and the cumulated length of the
172 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100173 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100174 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100175 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
176 update_word_fingerprint(word_sig, args[i]);
177 totlen += strlen(args[i]);
178 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100179
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100180 memset(list_sig, 0, sizeof(list_sig));
181 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
182 update_word_fingerprint(list_sig, kw->str_kw[i]);
183 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100184 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100185
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100186 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100187
188 /* insert this one at its place if relevant, in order to keep only
189 * the best matches.
190 */
191 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100192 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100193 matches[CLI_MAX_MATCHES-1] = swp;
194 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
195 if (matches[idx+1].dist >= matches[idx].dist)
196 break;
197 matches[idx+1] = matches[idx];
198 matches[idx] = swp;
199 }
200 }
201 }
202 }
203 }
204 }
205
Willy Tarreauec197e82021-03-15 10:35:04 +0100206 if (matches[0].kw) {
207 /* we have fuzzy matches, let's propose them */
208 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
209 kw = matches[idx].kw;
210 if (!kw)
211 break;
212
213 /* stop the dump if some words look very unlikely candidates */
214 if (matches[idx].dist > 5*matches[0].dist/2)
215 break;
216
217 chunk_appendf(tmp, " %s\n", kw->usage);
218 }
219 }
220
William Lallemand74c24fb2016-11-21 17:18:36 +0100221 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100222 /* no full dump if we've already found nice candidates */
223 if (matches[0].kw)
224 break;
225
Willy Tarreau91bc3592021-03-12 15:20:39 +0100226 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200227
Willy Tarreau91bc3592021-03-12 15:20:39 +0100228 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100229 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100230 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100231 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100232 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200233
Willy Tarreau91bc3592021-03-12 15:20:39 +0100234 /* in master don't display commands that have neither the master bit
235 * nor the master-only bit.
236 */
237 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
238 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
239 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200240
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100241 for (idx = 0; idx < length; idx++) {
242 if (!kw->str_kw[idx])
243 break; // end of keyword
244 if (!args || !args[idx] || !*args[idx])
245 break; // end of command line
246 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
247 break;
248 }
249
Willy Tarreauec197e82021-03-15 10:35:04 +0100250 if (kw->usage && idx == length)
251 chunk_appendf(tmp, " %s\n", kw->usage);
William Lallemand74c24fb2016-11-21 17:18:36 +0100252 }
253 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100254
255 /* always show the prompt/help/quit commands */
256 chunk_strcat(tmp,
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200257 " help : full commands list\n"
258 " prompt : toggle interactive mode with prompt\n"
259 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100260
William Lallemand74c24fb2016-11-21 17:18:36 +0100261 chunk_init(&out, NULL, 0);
262 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200263 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200264
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100265 appctx->ctx.cli.severity = LOG_INFO;
266 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200267 appctx->st0 = CLI_ST_PRINT;
268
William Lallemand74c24fb2016-11-21 17:18:36 +0100269 return dynamic_usage_msg;
270}
271
272struct cli_kw* cli_find_kw(char **args)
273{
274 struct cli_kw_list *kw_list;
275 struct cli_kw *kw;/* current cli_kw */
276 char **tmp_args;
277 const char **tmp_str_kw;
278 int found = 0;
279
280 if (LIST_ISEMPTY(&cli_keywords.list))
281 return NULL;
282
283 list_for_each_entry(kw_list, &cli_keywords.list, list) {
284 kw = &kw_list->kw[0];
285 while (*kw->str_kw) {
286 tmp_args = args;
287 tmp_str_kw = kw->str_kw;
288 while (*tmp_str_kw) {
289 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
290 found = 1;
291 } else {
292 found = 0;
293 break;
294 }
295 tmp_args++;
296 tmp_str_kw++;
297 }
298 if (found)
299 return (kw);
300 kw++;
301 }
302 }
303 return NULL;
304}
305
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100306struct cli_kw* cli_find_kw_exact(char **args)
307{
308 struct cli_kw_list *kw_list;
309 int found = 0;
310 int i;
311 int j;
312
313 if (LIST_ISEMPTY(&cli_keywords.list))
314 return NULL;
315
316 list_for_each_entry(kw_list, &cli_keywords.list, list) {
317 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
318 found = 1;
319 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
320 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
321 break;
322 }
323 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
324 found = 0;
325 break;
326 }
327 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
328 found = 0;
329 break;
330 }
331 }
332 if (found)
333 return &kw_list->kw[i];
334 }
335 }
336 return NULL;
337}
338
William Lallemand74c24fb2016-11-21 17:18:36 +0100339void cli_register_kw(struct cli_kw_list *kw_list)
340{
Willy Tarreau2b718102021-04-21 07:32:39 +0200341 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100342}
343
344
345/* allocate a new stats frontend named <name>, and return it
346 * (or NULL in case of lack of memory).
347 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100348static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100349{
350 struct proxy *fe;
351
352 fe = calloc(1, sizeof(*fe));
353 if (!fe)
354 return NULL;
355
356 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100357 fe->next = proxies_list;
358 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100359 fe->last_change = now.tv_sec;
360 fe->id = strdup("GLOBAL");
361 fe->cap = PR_CAP_FE;
362 fe->maxconn = 10; /* default to 10 concurrent connections */
363 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
364 fe->conf.file = strdup(file);
365 fe->conf.line = line;
366 fe->accept = frontend_accept;
367 fe->default_target = &cli_applet.obj_type;
368
369 /* the stats frontend is the only one able to assign ID #0 */
370 fe->conf.id.key = fe->uuid = 0;
371 eb32_insert(&used_proxy_id, &fe->conf.id);
372 return fe;
373}
374
375/* This function parses a "stats" statement in the "global" section. It returns
376 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
377 * error message into the <err> buffer which will be preallocated. The trailing
378 * '\n' must not be written. The function must be called with <args> pointing to
379 * the first word after "stats".
380 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100381static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
382 const struct proxy *defpx, const char *file, int line,
383 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100384{
385 struct bind_conf *bind_conf;
386 struct listener *l;
387
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100388 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100389 int cur_arg;
390
391 if (*args[2] == 0) {
392 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
393 return -1;
394 }
395
Willy Tarreau4975d142021-03-13 11:00:33 +0100396 if (!global.cli_fe) {
397 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100398 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
399 return -1;
400 }
401 }
402
Willy Tarreau4975d142021-03-13 11:00:33 +0100403 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200404 if (!bind_conf) {
405 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
406 return -1;
407 }
William Lallemand07a62f72017-05-24 00:57:40 +0200408 bind_conf->level &= ~ACCESS_LVL_MASK;
409 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100410
Willy Tarreau4975d142021-03-13 11:00:33 +0100411 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100412 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
413 file, line, args[0], args[1], err && *err ? *err : "error");
414 return -1;
415 }
416
417 cur_arg = 3;
418 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100419 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100420 const char *best;
William Lallemand74c24fb2016-11-21 17:18:36 +0100421
422 kw = bind_find_kw(args[cur_arg]);
423 if (kw) {
424 if (!kw->parse) {
425 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
426 args[0], args[1], args[cur_arg]);
427 return -1;
428 }
429
Willy Tarreau4975d142021-03-13 11:00:33 +0100430 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, err) != 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100431 if (err && *err)
432 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
433 else
434 memprintf(err, "'%s %s' : error encountered while processing '%s'",
435 args[0], args[1], args[cur_arg]);
436 return -1;
437 }
438
439 cur_arg += 1 + kw->skip;
440 continue;
441 }
442
Willy Tarreau433b05f2021-03-12 10:14:07 +0100443 best = bind_find_best_kw(args[cur_arg]);
444 if (best)
445 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
446 args[0], args[1], args[cur_arg], best);
447 else
448 memprintf(err, "'%s %s' : unknown keyword '%s'.",
449 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100450 return -1;
451 }
452
453 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100454 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100455 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100456 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
457 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100458 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100459 }
460 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100461 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100462 unsigned timeout;
463 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
464
Willy Tarreau9faebe32019-06-07 19:00:37 +0200465 if (res == PARSE_TIME_OVER) {
466 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
467 args[2], args[0], args[1]);
468 return -1;
469 }
470 else if (res == PARSE_TIME_UNDER) {
471 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
472 args[2], args[0], args[1]);
473 return -1;
474 }
475 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100476 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
477 return -1;
478 }
479
480 if (!timeout) {
481 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
482 return -1;
483 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100484 if (!global.cli_fe) {
485 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100486 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
487 return -1;
488 }
489 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100490 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100491 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100492 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100493 int maxconn = atol(args[2]);
494
495 if (maxconn <= 0) {
496 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
497 return -1;
498 }
499
Willy Tarreau4975d142021-03-13 11:00:33 +0100500 if (!global.cli_fe) {
501 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100502 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
503 return -1;
504 }
505 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100506 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100507 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100508 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100509 int cur_arg = 2;
510 unsigned long set = 0;
511
Willy Tarreau4975d142021-03-13 11:00:33 +0100512 if (!global.cli_fe) {
513 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100514 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
515 return -1;
516 }
517 }
518
519 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100520 if (strcmp(args[cur_arg], "all") == 0) {
521 set = 0;
522 break;
523 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100524 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100525 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100526 return -1;
527 }
528 cur_arg++;
529 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100530 global.cli_fe->bind_proc = set;
William Lallemand74c24fb2016-11-21 17:18:36 +0100531 }
532 else {
533 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
534 return -1;
535 }
536 return 0;
537}
538
William Lallemand33d29e22019-04-01 11:30:06 +0200539/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200540 * This function exports the bound addresses of a <frontend> in the environment
541 * variable <varname>. Those addresses are separated by semicolons and prefixed
542 * with their type (abns@, unix@, sockpair@ etc)
543 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200544 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200545int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200546{
547 struct buffer *trash = get_trash_chunk();
548 struct bind_conf *bind_conf;
549
William Lallemand9a37fd02019-04-12 16:09:24 +0200550 if (frontend) {
551 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200552 struct listener *l;
553
554 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
555 char addr[46];
556 char port[6];
557
William Lallemand620072b2019-04-12 16:09:25 +0200558 /* separate listener by semicolons */
559 if (trash->data)
560 chunk_appendf(trash, ";");
561
Willy Tarreau37159062020-08-27 07:48:42 +0200562 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200563 const struct sockaddr_un *un;
564
Willy Tarreau37159062020-08-27 07:48:42 +0200565 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200566 if (un->sun_path[0] == '\0') {
567 chunk_appendf(trash, "abns@%s", un->sun_path+1);
568 } else {
569 chunk_appendf(trash, "unix@%s", un->sun_path);
570 }
Willy Tarreau37159062020-08-27 07:48:42 +0200571 } else if (l->rx.addr.ss_family == AF_INET) {
572 addr_to_str(&l->rx.addr, addr, sizeof(addr));
573 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200574 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200575 } else if (l->rx.addr.ss_family == AF_INET6) {
576 addr_to_str(&l->rx.addr, addr, sizeof(addr));
577 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200578 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200579 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
580 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200581 }
William Lallemand33d29e22019-04-01 11:30:06 +0200582 }
583 }
584 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200585 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200586 return -1;
587 }
588
589 return 0;
590}
591
William Lallemand9a37fd02019-04-12 16:09:24 +0200592int cli_socket_setenv()
593{
Willy Tarreau4975d142021-03-13 11:00:33 +0100594 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200595 return -1;
596 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
597 return -1;
598
599 return 0;
600}
601
William Lallemand33d29e22019-04-01 11:30:06 +0200602REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
603
Willy Tarreaude57a572016-11-23 17:01:39 +0100604/* Verifies that the CLI at least has a level at least as high as <level>
605 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
606 * failure, an error message is prepared and the appctx's state is adjusted
607 * to print it so that a return 1 is enough to abort any processing.
608 */
609int cli_has_level(struct appctx *appctx, int level)
610{
Willy Tarreaude57a572016-11-23 17:01:39 +0100611
William Lallemandf630d012018-12-13 09:05:44 +0100612 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100613 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100614 return 0;
615 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100616 return 1;
617}
618
William Lallemandb7ea1412018-12-13 09:05:47 +0100619/* same as cli_has_level but for the CLI proxy and without error message */
620int pcli_has_level(struct stream *s, int level)
621{
622 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
623 return 0;
624 }
625 return 1;
626}
627
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200628/* Returns severity_output for the current session if set, or default for the socket */
629static int cli_get_severity_output(struct appctx *appctx)
630{
631 if (appctx->cli_severity_output)
632 return appctx->cli_severity_output;
633 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
634}
William Lallemand74c24fb2016-11-21 17:18:36 +0100635
Willy Tarreau41908562016-11-24 16:23:38 +0100636/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100637 * from the CLI's IO handler running in an appctx context. The function returns
638 * 1 if the request was understood, otherwise zero (in which case an error
639 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100640 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
641 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
642 * have its own I/O handler called again. Most of the time, parsers will only
643 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100644 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
645 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100646 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200647static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100648{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100649 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200650 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100651 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100652
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200653 appctx->st2 = 0;
654 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100655
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200656 p = appctx->chunk->area;
657 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100658
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200659 /*
660 * Get the payload start if there is one.
661 * For the sake of simplicity, the payload pattern is looked up
662 * everywhere from the start of the input but it can only be found
663 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
664 *
665 * The input string was zero terminated so it is safe to use
666 * the str*() functions throughout the parsing
667 */
668 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
669 payload = strstr(p, PAYLOAD_PATTERN);
670 end = payload;
671 /* skip the pattern */
672 payload += strlen(PAYLOAD_PATTERN);
673 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100674
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200675 /*
676 * Get pointers on words.
677 * One extra slot is reserved to store a pointer on a null byte.
678 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100679 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200680 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100681
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200682 /* skip leading spaces/tabs */
683 p += strspn(p, " \t");
684 if (!*p)
685 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100686
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200687 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200688 while (1) {
689 p += strcspn(p, " \t\\");
690 /* escaped chars using backlashes (\) */
691 if (*p == '\\') {
692 if (!*++p)
693 break;
694 if (!*++p)
695 break;
696 } else {
697 break;
698 }
699 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200700 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100701
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200702 /* unescape backslashes (\) */
703 for (j = 0, k = 0; args[i][k]; k++) {
704 if (args[i][k] == '\\') {
705 if (args[i][k + 1] == '\\')
706 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100707 else
708 continue;
709 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200710 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100711 j++;
712 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200713 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100714
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200715 i++;
716 }
717 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200718 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100719 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200720 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100721
722 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100723 if (!kw ||
724 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
725 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
726 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100727 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100728 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100729 }
William Lallemand14721be2018-10-26 14:47:37 +0200730
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100731 /* don't handle expert mode commands if not in this mode. */
732 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
733 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200734 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100735 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200736
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100737 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
738 cli_err(appctx, "This command is restricted to experimental mode only.\n");
739 return 0;
740 }
741
Amaury Denoyellef4929922021-05-05 16:29:23 +0200742 if (kw->level == ACCESS_EXPERT)
743 mark_tainted(TAINTED_CLI_EXPERT_MODE);
744 else if (kw->level == ACCESS_EXPERIMENTAL)
745 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
746
Willy Tarreau41908562016-11-24 16:23:38 +0100747 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200748 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200749
750 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
751 goto fail;
752
753 /* kw->parse could set its own io_handler or io_release handler */
754 if (!appctx->io_handler)
755 goto fail;
756
757 appctx->st0 = CLI_ST_CALLBACK;
758 return 1;
759fail:
760 appctx->io_handler = NULL;
761 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100762 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100763}
764
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200765/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
766static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
767{
Willy Tarreau83061a82018-07-13 11:56:34 +0200768 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200769
770 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200771 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200772
773 tmp = get_trash_chunk();
774 chunk_reset(tmp);
775
776 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100777 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200778 chunk_printf(tmp, "[%d]: ", severity);
779 }
780 else {
781 switch (severity_output) {
782 case CLI_SEVERITY_NUMBER:
783 chunk_printf(tmp, "[%d]: ", severity);
784 break;
785 case CLI_SEVERITY_STRING:
786 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
787 break;
788 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100789 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200790 }
791 }
792 chunk_appendf(tmp, "%s", msg);
793
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200794 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200795}
796
William Lallemand74c24fb2016-11-21 17:18:36 +0100797/* This I/O handler runs as an applet embedded in a stream interface. It is
798 * used to processes I/O from/to the stats unix socket. The system relies on a
799 * state machine handling requests and various responses. We read a request,
800 * then we process it and send the response, and we possibly display a prompt.
801 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100802 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100803 * or not.
804 */
805static void cli_io_handler(struct appctx *appctx)
806{
807 struct stream_interface *si = appctx->owner;
808 struct channel *req = si_oc(si);
809 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200810 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100811 int reql;
812 int len;
813
814 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
815 goto out;
816
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800817 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200818 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100819 /* buf.size==0 means we failed to get a buffer and were
820 * already subscribed to a wait list to get a buffer.
821 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100822 goto out;
823 }
824
William Lallemand74c24fb2016-11-21 17:18:36 +0100825 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100826 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100827 /* Stats output not initialized yet */
828 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200829 /* reset severity to default at init */
830 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100831 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100832 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100833 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100834 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100835 /* Let's close for real now. We just close the request
836 * side, the conditions below will complete if needed.
837 */
838 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200839 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200840 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100841 break;
842 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100843 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200844 char *str;
845
846 /* use a trash chunk to store received data */
847 if (!appctx->chunk) {
848 appctx->chunk = alloc_trash_chunk();
849 if (!appctx->chunk) {
850 appctx->st0 = CLI_ST_END;
851 continue;
852 }
853 }
854
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200855 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200856
William Lallemand74c24fb2016-11-21 17:18:36 +0100857 /* ensure we have some output room left in the event we
858 * would want to return some info right after parsing.
859 */
860 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100861 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100862 break;
863 }
864
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200865 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200866 reql = co_getline(si_oc(si), str,
867 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100868 if (reql <= 0) { /* closed or EOL not found */
869 if (reql == 0)
870 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100871 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100872 continue;
873 }
874
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200875 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
876 /* seek for a possible unescaped semi-colon. If we find
877 * one, we replace it with an LF and skip only this part.
878 */
879 for (len = 0; len < reql; len++) {
880 if (str[len] == '\\') {
881 len++;
882 continue;
883 }
884 if (str[len] == ';') {
885 str[len] = '\n';
886 reql = len + 1;
887 break;
888 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100889 }
890 }
891
892 /* now it is time to check that we have a full line,
893 * remove the trailing \n and possibly \r, then cut the
894 * line.
895 */
896 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200897 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100898 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100899 continue;
900 }
901
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200902 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 len--;
904
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200905 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200906 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200907
908 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200909 appctx->chunk->area[appctx->chunk->data] = '\n';
910 appctx->chunk->area[appctx->chunk->data + 1] = 0;
911 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200912 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100913
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100914 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200915
916 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
917 /* empty line */
918 if (!len) {
919 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200920 appctx->chunk->data -= 2;
921 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100922 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200923 chunk_reset(appctx->chunk);
924 /* NB: cli_sock_parse_request() may have put
925 * another CLI_ST_O_* into appctx->st0.
926 */
927
928 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100929 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100930 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200931 else {
932 /*
933 * Look for the "payload start" pattern at the end of a line
934 * Its location is not remembered here, this is just to switch
935 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100936 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100937 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200938 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200939 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200940 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100941 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200942 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200943 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100944 }
945
946 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200947 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100948 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
949 }
950 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200951 const char *msg;
952 int sev;
953
William Lallemand74c24fb2016-11-21 17:18:36 +0100954 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100955 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100956 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200957 case CLI_ST_PRINT: /* print const message in msg */
958 case CLI_ST_PRINT_ERR: /* print const error in msg */
959 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
960 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
961 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
962 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
963 LOG_ERR : appctx->ctx.cli.severity;
964 msg = appctx->ctx.cli.msg;
965 }
966 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
967 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
968 LOG_ERR : appctx->ctx.cli.severity;
969 msg = appctx->ctx.cli.err;
970 if (!msg) {
971 sev = LOG_ERR;
972 msg = "Out of memory.\n";
973 }
974 }
975 else {
976 sev = LOG_ERR;
977 msg = "Internal error.\n";
978 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200979
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200980 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
981 if (appctx->st0 == CLI_ST_PRINT_FREE ||
982 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100983 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200984 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100985 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100986 }
987 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100988 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100989 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200990
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100991 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100992 if (appctx->io_handler)
993 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100994 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100995 if (appctx->io_release) {
996 appctx->io_release(appctx);
997 appctx->io_release = NULL;
998 }
999 }
1000 break;
1001 default: /* abnormal state */
1002 si->flags |= SI_FL_ERR;
1003 break;
1004 }
1005
1006 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001007 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001008 const char *prompt = "";
1009
1010 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1011 /*
1012 * when entering a payload with interactive mode, change the prompt
1013 * to emphasize that more data can still be sent
1014 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001015 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001016 prompt = "+ ";
1017 else
1018 prompt = "\n> ";
1019 }
1020 else {
William Lallemandad032882019-07-01 10:56:15 +02001021 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001022 prompt = "\n";
1023 }
1024
1025 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001026 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001027 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001028 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001029 }
1030
1031 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001032 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001033 break;
1034
1035 /* Now we close the output if one of the writers did so,
1036 * or if we're not in interactive mode and the request
1037 * buffer is empty. This still allows pipelined requests
1038 * to be sent in non-interactive mode.
1039 */
William Lallemand3de09d52018-12-11 16:10:56 +01001040 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1041 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001042 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001043 continue;
1044 }
1045
1046 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001047 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001048 /* reactivate the \n at the end of the response for the next command */
1049 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001050 }
1051 }
1052
1053 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1054 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1055 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1056 /* Other side has closed, let's abort if we have no more processing to do
1057 * and nothing more to consume. This is comparable to a broken pipe, so
1058 * we forward the close to the request side so that it flows upstream to
1059 * the client.
1060 */
1061 si_shutw(si);
1062 }
1063
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001064 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001065 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1066 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1067 /* We have no more processing to do, and nothing more to send, and
1068 * the client side has closed. So we'll forward this state downstream
1069 * on the response buffer.
1070 */
1071 si_shutr(si);
1072 res->flags |= CF_READ_NULL;
1073 }
1074
1075 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001076 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 +01001077 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001078 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 +01001079}
1080
William Lallemand74c24fb2016-11-21 17:18:36 +01001081/* This is called when the stream interface is closed. For instance, upon an
1082 * external abort, we won't call the i/o handler anymore so we may need to
1083 * remove back references to the stream currently being dumped.
1084 */
1085static void cli_release_handler(struct appctx *appctx)
1086{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001087 free_trash_chunk(appctx->chunk);
1088 appctx->chunk = NULL;
1089
William Lallemand74c24fb2016-11-21 17:18:36 +01001090 if (appctx->io_release) {
1091 appctx->io_release(appctx);
1092 appctx->io_release = NULL;
1093 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001094 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001095 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001096 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001097}
1098
1099/* This function dumps all environmnent variables to the buffer. It returns 0
1100 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001101 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1102 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001103 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001104static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001105{
Willy Tarreau0a739292016-11-22 20:21:23 +01001106 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001107 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001108
1109 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1110 return 1;
1111
1112 chunk_reset(&trash);
1113
1114 /* we have two inner loops here, one for the proxy, the other one for
1115 * the buffer.
1116 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001117 while (*var) {
1118 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001119
Willy Tarreau06d80a92017-10-19 14:32:15 +02001120 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001121 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001122 return 0;
1123 }
1124 if (appctx->st2 == STAT_ST_END)
1125 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001126 var++;
1127 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001128 }
1129
1130 /* dump complete */
1131 return 1;
1132}
1133
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001134/* This function dumps all file descriptors states (or the requested one) to
1135 * the buffer. It returns 0 if the output buffer is full and it needs to be
1136 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1137 * It uses cli.i0 as the fd number to restart from.
1138 */
1139static int cli_io_handler_show_fd(struct appctx *appctx)
1140{
1141 struct stream_interface *si = appctx->owner;
1142 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001143 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001144
1145 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001146 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001147
1148 chunk_reset(&trash);
1149
Willy Tarreauca1b1572018-12-18 15:45:11 +01001150 /* isolate the threads once per round. We're limited to a buffer worth
1151 * of output anyway, it cannot last very long.
1152 */
1153 thread_isolate();
1154
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001155 /* we have two inner loops here, one for the proxy, the other one for
1156 * the buffer.
1157 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001158 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001159 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001160 const struct listener *li = NULL;
1161 const struct server *sv = NULL;
1162 const struct proxy *px = NULL;
1163 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001164 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001165 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001166 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001167 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001168 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001169 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001170 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001171
1172 fdt = fdtab[fd];
1173
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001174 /* When DEBUG_FD is set, we also report closed FDs that have a
1175 * non-null event count to detect stuck ones.
1176 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001177 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001178#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001179 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001180#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001181 goto skip; // closed
1182 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001183 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001184 conn = (const struct connection *)fdt.owner;
1185 conn_flags = conn->flags;
1186 mux = conn->mux;
1187 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001188 xprt = conn->xprt;
1189 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001190 li = objt_listener(conn->target);
1191 sv = objt_server(conn->target);
1192 px = objt_proxy(conn->target);
1193 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001194 if (atleast2(fdt.thread_mask))
1195 suspicious = 1;
1196 if (conn->handle.fd != fd)
1197 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001198 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001199 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001200 li = fdt.owner;
1201
Willy Tarreaudacfde42021-01-21 09:07:29 +01001202 if (!fdt.thread_mask)
1203 suspicious = 1;
1204
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001205 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001206 " %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 +02001207 fd,
1208 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001209 (fdt.state & FD_CLONED) ? 'C' : 'c',
1210 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001211 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1212 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1213 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1214 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1215 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001216 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1217 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1218 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1219 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1220 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1221 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001222 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001223 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001224 fdt.iocb);
1225 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001226
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001227 if (!fdt.owner) {
1228 chunk_appendf(&trash, ")");
1229 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001230 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001231 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001232
1233 if (conn->handle.fd != fd) {
1234 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1235 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001236 } else {
1237 struct sockaddr_storage sa;
1238 socklen_t salen;
1239
1240 salen = sizeof(sa);
1241 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1242 if (sa.ss_family == AF_INET)
1243 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1244 else if (sa.ss_family == AF_INET6)
1245 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1246 else if (sa.ss_family == AF_UNIX)
1247 chunk_appendf(&trash, " fam=unix");
1248 }
1249
1250 salen = sizeof(sa);
1251 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1252 if (sa.ss_family == AF_INET)
1253 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1254 else if (sa.ss_family == AF_INET6)
1255 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1256 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001257 }
1258
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001259 if (px)
1260 chunk_appendf(&trash, " px=%s", px->id);
1261 else if (sv)
1262 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1263 else if (li)
1264 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001265
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001266 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001267 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001268 if (!ctx)
1269 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001270 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001271 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001272 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001273 else
1274 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001275
1276 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001277 if (xprt) {
1278 if (xprt_ctx || xprt->show_fd)
1279 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1280 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001281 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001282 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001283 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001284 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001285 struct sockaddr_storage sa;
1286 socklen_t salen;
1287
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001288 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001289 listener_state_str(li),
1290 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001291
1292 salen = sizeof(sa);
1293 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1294 if (sa.ss_family == AF_INET)
1295 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1296 else if (sa.ss_family == AF_INET6)
1297 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1298 else if (sa.ss_family == AF_UNIX)
1299 chunk_appendf(&trash, " fam=unix");
1300 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001301 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001302 else
1303 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001304
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001305#ifdef DEBUG_FD
1306 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001307 if (fdtab[fd].event_count >= 1000000)
1308 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001309#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001310 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001311
Willy Tarreau06d80a92017-10-19 14:32:15 +02001312 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001313 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001314 appctx->ctx.cli.i0 = fd;
1315 ret = 0;
1316 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001317 }
1318 skip:
1319 if (appctx->st2 == STAT_ST_END)
1320 break;
1321
1322 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001323 }
1324
Willy Tarreauca1b1572018-12-18 15:45:11 +01001325 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001326 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001327
1328 thread_release();
1329 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001330}
1331
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001332/* This function dumps some activity counters used by developers and support to
1333 * rule out some hypothesis during bug reports. It returns 0 if the output
1334 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1335 * everything at once in the buffer and is not designed to do it in multiple
1336 * passes.
1337 */
1338static int cli_io_handler_show_activity(struct appctx *appctx)
1339{
1340 struct stream_interface *si = appctx->owner;
1341 int thr;
1342
1343 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1344 return 1;
1345
1346 chunk_reset(&trash);
1347
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001348#undef SHOW_TOT
1349#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001350 do { \
1351 unsigned int _v[MAX_THREADS]; \
1352 unsigned int _tot; \
1353 const unsigned int _nbt = global.nbthread; \
1354 for (_tot = t = 0; t < _nbt; t++) \
1355 _tot += _v[t] = (x); \
1356 if (_nbt == 1) { \
1357 chunk_appendf(&trash, " %u\n", _tot); \
1358 break; \
1359 } \
1360 chunk_appendf(&trash, " %u [", _tot); \
1361 for (t = 0; t < _nbt; t++) \
1362 chunk_appendf(&trash, " %u", _v[t]); \
1363 chunk_appendf(&trash, " ]\n"); \
1364 } while (0)
1365
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001366#undef SHOW_AVG
1367#define SHOW_AVG(t, x) \
1368 do { \
1369 unsigned int _v[MAX_THREADS]; \
1370 unsigned int _tot; \
1371 const unsigned int _nbt = global.nbthread; \
1372 for (_tot = t = 0; t < _nbt; t++) \
1373 _tot += _v[t] = (x); \
1374 if (_nbt == 1) { \
1375 chunk_appendf(&trash, " %u\n", _tot); \
1376 break; \
1377 } \
1378 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1379 for (t = 0; t < _nbt; t++) \
1380 chunk_appendf(&trash, " %u", _v[t]); \
1381 chunk_appendf(&trash, " ]\n"); \
1382 } while (0)
1383
Willy Tarreaua0211b82019-05-28 15:09:08 +02001384 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1385 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001386 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1387 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1388 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1389 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001390 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001391 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1392 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001393 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001394 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001395 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1396 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1397 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001398 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001399 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001400 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1401 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001402 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1403 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1404 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1405 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1406 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1407 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1408 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001409#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001410 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 +02001411 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001412#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001413
Willy Tarreaud6a78502019-05-27 07:03:38 +02001414#if defined(DEBUG_DEV)
1415 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001416 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1417 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1418 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001419#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001420
1421 if (ci_putchk(si_ic(si), &trash) == -1) {
1422 chunk_reset(&trash);
1423 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001424 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001425 }
1426
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001427#undef SHOW_AVG
1428#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001429 /* dump complete */
1430 return 1;
1431}
1432
William Lallemandeceddf72016-12-15 18:06:44 +01001433/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001434 * CLI IO handler for `show cli sockets`.
1435 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001436 */
1437static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1438{
1439 struct bind_conf *bind_conf;
1440 struct stream_interface *si = appctx->owner;
1441
1442 chunk_reset(&trash);
1443
1444 switch (appctx->st2) {
1445 case STAT_ST_INIT:
1446 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001447 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001448 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001449 return 0;
1450 }
William Lallemandeceddf72016-12-15 18:06:44 +01001451 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001452 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001453
1454 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001455 if (global.cli_fe) {
1456 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001457 struct listener *l;
1458
1459 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001460 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001461 * if the current node is the first of the list
1462 */
1463
Willy Tarreau3af9d832016-12-16 12:58:09 +01001464 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001465 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001466 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001467 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001468 continue;
1469 }
1470
1471 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1472
1473 char addr[46];
1474 char port[6];
1475
Willy Tarreau37159062020-08-27 07:48:42 +02001476 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001477 const struct sockaddr_un *un;
1478
Willy Tarreau37159062020-08-27 07:48:42 +02001479 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001480 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001481 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001482 } else {
1483 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1484 }
Willy Tarreau37159062020-08-27 07:48:42 +02001485 } else if (l->rx.addr.ss_family == AF_INET) {
1486 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1487 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001488 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001489 } else if (l->rx.addr.ss_family == AF_INET6) {
1490 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1491 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001492 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001493 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1494 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001495 } else
William Lallemand26314342018-10-26 14:47:41 +02001496 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001497
William Lallemand07a62f72017-05-24 00:57:40 +02001498 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001499 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001500 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1501 chunk_appendf(&trash, "operator ");
1502 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1503 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001504 else
1505 chunk_appendf(&trash, " ");
1506
Willy Tarreaue26993c2020-09-03 07:18:55 +02001507 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001508 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001509 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1510 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001511 chunk_appendf(&trash, "%d,", pos+1);
1512 }
1513 }
1514 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001515 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001516
1517 } else {
1518 chunk_appendf(&trash, "all\n");
1519 }
1520
Willy Tarreau06d80a92017-10-19 14:32:15 +02001521 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001522 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001523 return 0;
1524 }
1525 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001526 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001527 }
1528 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001529 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001530 default:
1531 appctx->st2 = STAT_ST_FIN;
1532 return 1;
1533 }
1534}
1535
1536
Willy Tarreau0a739292016-11-22 20:21:23 +01001537/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001538 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1539 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001540 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001541static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001542{
1543 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001544 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001545
1546 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1547 return 1;
1548
Willy Tarreauf6710f82016-12-16 17:45:44 +01001549 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001550
1551 if (*args[2]) {
1552 int len = strlen(args[2]);
1553
Willy Tarreauf6710f82016-12-16 17:45:44 +01001554 for (; *var; var++) {
1555 if (strncmp(*var, args[2], len) == 0 &&
1556 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001557 break;
1558 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001559 if (!*var)
1560 return cli_err(appctx, "Variable not found\n");
1561
Willy Tarreau0a739292016-11-22 20:21:23 +01001562 appctx->st2 = STAT_ST_END;
1563 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001564 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001565 return 0;
1566}
1567
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001568/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1569 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1570 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1571 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001572static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001573{
1574 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1575 return 1;
1576
1577 appctx->ctx.cli.i0 = 0;
1578
1579 if (*args[2]) {
1580 appctx->ctx.cli.i0 = atoi(args[2]);
1581 appctx->st2 = STAT_ST_END;
1582 }
1583 return 0;
1584}
1585
Willy Tarreau599852e2016-11-22 20:33:32 +01001586/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001587static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001588{
1589 struct stream_interface *si = appctx->owner;
1590 struct stream *s = si_strm(si);
1591
1592 if (strcmp(args[2], "cli") == 0) {
1593 unsigned timeout;
1594 const char *res;
1595
Willy Tarreau9d008692019-08-09 11:21:01 +02001596 if (!*args[3])
1597 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001598
1599 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001600 if (res || timeout < 1)
1601 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001602
1603 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1604 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1605 return 1;
1606 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001607
1608 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001609}
1610
Willy Tarreau2af99412016-11-23 11:10:59 +01001611/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001612static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001613{
1614 int v;
1615
1616 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1617 return 1;
1618
Willy Tarreau9d008692019-08-09 11:21:01 +02001619 if (!*args[3])
1620 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001621
1622 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001623 if (v > global.hardmaxconn)
1624 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001625
1626 /* check for unlimited values */
1627 if (v <= 0)
1628 v = global.hardmaxconn;
1629
1630 global.maxconn = v;
1631
1632 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001633 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001634
1635 return 1;
1636}
1637
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001638static int set_severity_output(int *target, char *argument)
1639{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001640 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001641 *target = CLI_SEVERITY_NONE;
1642 return 1;
1643 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001644 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001645 *target = CLI_SEVERITY_NUMBER;
1646 return 1;
1647 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001648 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001649 *target = CLI_SEVERITY_STRING;
1650 return 1;
1651 }
1652 return 0;
1653}
1654
1655/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001656static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001657{
1658 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1659 return 0;
1660
Willy Tarreau9d008692019-08-09 11:21:01 +02001661 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001662}
William Lallemandeceddf72016-12-15 18:06:44 +01001663
William Lallemand67a234f2018-12-13 09:05:45 +01001664
1665/* show the level of the current CLI session */
1666static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1667{
William Lallemand67a234f2018-12-13 09:05:45 +01001668 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001669 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001670 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001671 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001672 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001673 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001674 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001675 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001676}
1677
1678/* parse and set the CLI level dynamically */
1679static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1680{
William Lallemandad032882019-07-01 10:56:15 +02001681 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001682 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001683 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1684
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001685 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001686 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1687 return 1;
1688 }
1689 appctx->cli_level &= ~ACCESS_LVL_MASK;
1690 appctx->cli_level |= ACCESS_LVL_OPER;
1691
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001692 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001693 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1694 return 1;
1695 }
1696 appctx->cli_level &= ~ACCESS_LVL_MASK;
1697 appctx->cli_level |= ACCESS_LVL_USER;
1698 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001699 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001700 return 1;
1701}
1702
1703
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001704/* parse and set the CLI expert/experimental-mode dynamically */
1705static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001706{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001707 int level;
1708 char *level_str;
1709 char *output = NULL;
1710
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001711 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1712 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001713
1714 if (!strcmp(args[0], "expert-mode")) {
1715 level = ACCESS_EXPERT;
1716 level_str = "expert-mode";
1717 }
1718 else if (!strcmp(args[0], "experimental-mode")) {
1719 level = ACCESS_EXPERIMENTAL;
1720 level_str = "experimental-mode";
1721 }
1722 else {
1723 return 1;
1724 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001725
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001726 if (!*args[1]) {
1727 memprintf(&output, "%s is %s\n", level_str,
1728 (appctx->cli_level & level) ? "ON" : "OFF");
1729 return cli_dynmsg(appctx, LOG_INFO, output);
1730 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001731
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001732 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001733 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001734 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001735 return 1;
1736}
1737
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001738int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001739{
1740 return 0;
1741}
1742
Willy Tarreau45c742b2016-11-24 14:51:17 +01001743/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001744static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001745{
1746 int v;
1747 int *res;
1748 int mul = 1;
1749
1750 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1751 return 1;
1752
1753 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1754 res = &global.cps_lim;
1755 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1756 res = &global.sps_lim;
1757#ifdef USE_OPENSSL
1758 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1759 res = &global.ssl_lim;
1760#endif
1761 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1762 res = &global.comp_rate_lim;
1763 mul = 1024;
1764 }
1765 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001766 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001767 "'set rate-limit' only supports :\n"
1768 " - 'connections global' to set the per-process maximum connection rate\n"
1769 " - 'sessions global' to set the per-process maximum session rate\n"
1770#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001771 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001772#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001773 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001774 }
1775
Willy Tarreau9d008692019-08-09 11:21:01 +02001776 if (!*args[4])
1777 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001778
1779 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001780 if (v < 0)
1781 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001782
1783 *res = v * mul;
1784
1785 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001786 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001787
1788 return 1;
1789}
1790
William Lallemandf6975e92017-05-26 17:42:10 +02001791/* parse the "expose-fd" argument on the bind lines */
1792static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1793{
1794 if (!*args[cur_arg + 1]) {
1795 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1796 return ERR_ALERT | ERR_FATAL;
1797 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001798 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001799 conf->level |= ACCESS_FD_LISTENERS;
1800 } else {
1801 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1802 args[cur_arg], args[cur_arg+1]);
1803 return ERR_ALERT | ERR_FATAL;
1804 }
1805
1806 return 0;
1807}
1808
William Lallemand74c24fb2016-11-21 17:18:36 +01001809/* parse the "level" argument on the bind lines */
1810static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1811{
1812 if (!*args[cur_arg + 1]) {
1813 memprintf(err, "'%s' : missing level", args[cur_arg]);
1814 return ERR_ALERT | ERR_FATAL;
1815 }
1816
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001817 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001818 conf->level &= ~ACCESS_LVL_MASK;
1819 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001820 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001821 conf->level &= ~ACCESS_LVL_MASK;
1822 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001823 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001824 conf->level &= ~ACCESS_LVL_MASK;
1825 conf->level |= ACCESS_LVL_ADMIN;
1826 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001827 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1828 args[cur_arg], args[cur_arg+1]);
1829 return ERR_ALERT | ERR_FATAL;
1830 }
1831
1832 return 0;
1833}
1834
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001835static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1836{
1837 if (!*args[cur_arg + 1]) {
1838 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1839 return ERR_ALERT | ERR_FATAL;
1840 }
1841
1842 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1843 return 0;
1844 else {
1845 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1846 args[cur_arg], args[cur_arg+1]);
1847 return ERR_ALERT | ERR_FATAL;
1848 }
1849}
1850
Olivier Houchardf886e342017-04-05 22:24:59 +02001851/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001852static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001853{
1854 char *cmsgbuf = NULL;
1855 unsigned char *tmpbuf = NULL;
1856 struct cmsghdr *cmsg;
1857 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001858 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001859 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001860 struct msghdr msghdr;
1861 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001862 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001863 const char *ns_name, *if_name;
1864 unsigned char ns_nlen, if_nlen;
1865 int nb_queued;
1866 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001867 int *tmpfd;
1868 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001869 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001870 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001871 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001872 int ret;
1873
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001874 if (!remote) {
1875 ha_warning("Only works on real connections\n");
1876 goto out;
1877 }
1878
1879 fd = remote->handle.fd;
1880
Olivier Houchardf886e342017-04-05 22:24:59 +02001881 /* Temporary set the FD in blocking mode, that will make our life easier */
1882 old_fcntl = fcntl(fd, F_GETFL);
1883 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001884 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001885 goto out;
1886 }
1887 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1888 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001889 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001890 goto out;
1891 }
1892 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001893 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001894 goto out;
1895 }
Olivier Houchard54740872017-04-06 14:45:14 +02001896 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001897 iov.iov_base = &tot_fd_nb;
1898 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001899 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001900 goto out;
1901 memset(&msghdr, 0, sizeof(msghdr));
1902 /*
1903 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001904 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001905 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001906 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001907 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001908
Olivier Houchardf886e342017-04-05 22:24:59 +02001909 if (tot_fd_nb == 0)
1910 goto out;
1911
1912 /* First send the total number of file descriptors, so that the
1913 * receiving end knows what to expect.
1914 */
1915 msghdr.msg_iov = &iov;
1916 msghdr.msg_iovlen = 1;
1917 ret = sendmsg(fd, &msghdr, 0);
1918 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001919 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001920 goto out;
1921 }
1922
1923 /* Now send the fds */
1924 msghdr.msg_control = cmsgbuf;
1925 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1926 cmsg = CMSG_FIRSTHDR(&msghdr);
1927 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1928 cmsg->cmsg_level = SOL_SOCKET;
1929 cmsg->cmsg_type = SCM_RIGHTS;
1930 tmpfd = (int *)CMSG_DATA(cmsg);
1931
Olivier Houchardf886e342017-04-05 22:24:59 +02001932 /* For each socket, e message is sent, containing the following :
1933 * Size of the namespace name (or 0 if none), as an unsigned char.
1934 * The namespace name, if any
1935 * Size of the interface name (or 0 if none), as an unsigned char
1936 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001937 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001938 */
1939 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001940 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001941 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001942 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001943 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001944 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001945 goto out;
1946 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001947
1948 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001949 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001950 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001951 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001952 continue;
1953
1954 ns_name = if_name = "";
1955 ns_nlen = if_nlen = 0;
1956
1957 /* for now we can only retrieve namespaces and interfaces from
1958 * pure listeners.
1959 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001960 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001961 const struct listener *l = fdtab[cur_fd].owner;
1962
Willy Tarreau818a92e2020-09-03 07:50:19 +02001963 if (l->rx.settings->interface) {
1964 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001965 if_nlen = strlen(if_name);
1966 }
1967
1968#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001969 if (l->rx.settings->netns) {
1970 ns_name = l->rx.settings->netns->node.key;
1971 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001972 }
1973#endif
1974 }
1975
1976 /* put the FD into the CMSG_DATA */
1977 tmpfd[nb_queued++] = cur_fd;
1978
1979 /* first block is <ns_name_len> <ns_name> */
1980 tmpbuf[curoff++] = ns_nlen;
1981 if (ns_nlen)
1982 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1983 curoff += ns_nlen;
1984
1985 /* second block is <if_name_len> <if_name> */
1986 tmpbuf[curoff++] = if_nlen;
1987 if (if_nlen)
1988 memcpy(tmpbuf + curoff, if_name, if_nlen);
1989 curoff += if_nlen;
1990
1991 /* we used to send the listener options here before 2.3 */
1992 memset(tmpbuf + curoff, 0, sizeof(int));
1993 curoff += sizeof(int);
1994
1995 /* there's a limit to how many FDs may be sent at once */
1996 if (nb_queued == MAX_SEND_FD) {
1997 iov.iov_len = curoff;
1998 if (sendmsg(fd, &msghdr, 0) != curoff) {
1999 ha_warning("Failed to transfer sockets\n");
2000 return -1;
2001 }
2002
2003 /* Wait for an ack */
2004 do {
2005 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2006 } while (ret == -1 && errno == EINTR);
2007
2008 if (ret <= 0) {
2009 ha_warning("Unexpected error while transferring sockets\n");
2010 return -1;
2011 }
2012 curoff = 0;
2013 nb_queued = 0;
2014 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002015 }
2016
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002017 /* flush pending stuff */
2018 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002019 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002020 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2021 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002022 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002023 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002024 goto out;
2025 }
2026 }
2027
2028out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002029 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002030 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002031 goto out;
2032 }
2033 appctx->st0 = CLI_ST_END;
2034 free(cmsgbuf);
2035 free(tmpbuf);
2036 return 1;
2037}
2038
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002039static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2040{
2041 if (*args[0] == 'h')
2042 /* help */
Willy Tarreaub96a74c2021-03-12 17:13:28 +01002043 cli_gen_usage_msg(appctx, NULL);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002044 else if (*args[0] == 'p')
2045 /* prompt */
2046 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2047 else if (*args[0] == 'q')
2048 /* quit */
2049 appctx->st0 = CLI_ST_END;
2050
2051 return 1;
2052}
Olivier Houchardf886e342017-04-05 22:24:59 +02002053
William Lallemand2f4ce202018-10-26 14:47:47 +02002054void pcli_write_prompt(struct stream *s)
2055{
2056 struct buffer *msg = get_trash_chunk();
2057 struct channel *oc = si_oc(&s->si[0]);
2058
William Lallemanddc12c2e2018-12-13 09:05:46 +01002059 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002060 return;
2061
William Lallemanddc12c2e2018-12-13 09:05:46 +01002062 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002063 chunk_appendf(msg, "+ ");
2064 } else {
2065 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002066 chunk_appendf(msg, "master%s> ",
2067 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002068 else
2069 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2070 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002071 co_inject(oc, msg->area, msg->data);
2072}
2073
William Lallemand291810d2018-10-26 14:47:38 +02002074
William Lallemandcf62f7e2018-10-26 14:47:40 +02002075/* The pcli_* functions are used for the CLI proxy in the master */
2076
William Lallemanddeeaa592018-10-26 14:47:48 +02002077void pcli_reply_and_close(struct stream *s, const char *msg)
2078{
2079 struct buffer *buf = get_trash_chunk();
2080
2081 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002082 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002083}
2084
William Lallemand291810d2018-10-26 14:47:38 +02002085static enum obj_type *pcli_pid_to_server(int proc_pid)
2086{
2087 struct mworker_proc *child;
2088
William Lallemand99e0bb92020-11-05 10:28:53 +01002089 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002090 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002091 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002092
William Lallemand291810d2018-10-26 14:47:38 +02002093 list_for_each_entry(child, &proc_list, list) {
2094 if (child->pid == proc_pid){
2095 return &child->srv->obj_type;
2096 }
2097 }
2098 return NULL;
2099}
2100
2101/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2102 * Return:
2103 * 0: master
2104 * > 0: pid of a worker
2105 * < 0: didn't find a worker
2106 */
2107static int pcli_prefix_to_pid(const char *prefix)
2108{
2109 int proc_pid;
2110 struct mworker_proc *child;
2111 char *errtol = NULL;
2112
2113 if (*prefix != '@') /* not a prefix, should not happen */
2114 return -1;
2115
2116 prefix++;
2117 if (!*prefix) /* sent @ alone, return the master */
2118 return 0;
2119
2120 if (strcmp("master", prefix) == 0) {
2121 return 0;
2122 } else if (*prefix == '!') {
2123 prefix++;
2124 if (!*prefix)
2125 return -1;
2126
2127 proc_pid = strtol(prefix, &errtol, 10);
2128 if (*errtol != '\0')
2129 return -1;
2130 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002131 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002132 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002133 if (child->pid == proc_pid){
2134 return child->pid;
2135 }
2136 }
2137 } else {
2138 struct mworker_proc *chosen = NULL;
2139 /* this is a relative pid */
2140
2141 proc_pid = strtol(prefix, &errtol, 10);
2142 if (*errtol != '\0')
2143 return -1;
2144
2145 if (proc_pid == 0) /* return the master */
2146 return 0;
2147
2148 /* chose the right process, the current one is the one with the
2149 least number of reloads */
2150 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002151 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002152 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002153 if (child->relative_pid == proc_pid){
2154 if (child->reloads == 0)
2155 return child->pid;
2156 else if (chosen == NULL || child->reloads < chosen->reloads)
2157 chosen = child;
2158 }
2159 }
2160 if (chosen)
2161 return chosen->pid;
2162 }
2163 return -1;
2164}
2165
William Lallemandbddd33a2018-12-11 16:10:53 +01002166/* Return::
2167 * >= 0 : number of words to escape
2168 * = -1 : error
2169 */
2170
2171int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2172{
2173 if (argl < 1)
2174 return 0;
2175
2176 /* there is a prefix */
2177 if (args[0][0] == '@') {
2178 int target_pid = pcli_prefix_to_pid(args[0]);
2179
2180 if (target_pid == -1) {
2181 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2182 return -1;
2183 }
2184
2185 /* if the prefix is alone, define a default target */
2186 if (argl == 1)
2187 s->pcli_next_pid = target_pid;
2188 else
2189 *next_pid = target_pid;
2190 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002191 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002192 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002193 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002194
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002195 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002196 channel_shutr_now(&s->req);
2197 channel_shutw_now(&s->res);
2198 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002199 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002200 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2201 memprintf(errmsg, "Permission denied!\n");
2202 return -1;
2203 }
2204 s->pcli_flags &= ~ACCESS_LVL_MASK;
2205 s->pcli_flags |= ACCESS_LVL_OPER;
2206 return argl;
2207
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002208 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002209 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2210 memprintf(errmsg, "Permission denied!\n");
2211 return -1;
2212 }
2213 s->pcli_flags &= ~ACCESS_LVL_MASK;
2214 s->pcli_flags |= ACCESS_LVL_USER;
2215 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002216 }
2217
2218 return 0;
2219}
2220
2221/*
2222 * Parse the CLI request:
2223 * - It does basically the same as the cli_io_handler, but as a proxy
2224 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002225 *
2226 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002227 * - the number of characters to forward or
2228 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002229 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002230int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002231{
William Lallemandbddd33a2018-12-11 16:10:53 +01002232 char *str = (char *)ci_head(req);
2233 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002234 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002235 int argl; /* number of args */
2236 char *p;
2237 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002238 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002239 int wtrim = 0; /* number of words to trim */
2240 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002241 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002242 int i = 0;
2243
2244 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002245
William Lallemanddc12c2e2018-12-13 09:05:46 +01002246 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002247
2248 /* Looks for the end of one command */
2249 while (p+reql < end) {
2250 /* handle escaping */
2251 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002252 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002253 continue;
2254 }
2255 if (p[reql] == ';' || p[reql] == '\n') {
2256 /* found the end of the command */
2257 p[reql] = '\n';
2258 reql++;
2259 break;
2260 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002261 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002262 }
William Lallemandebf61802018-12-11 16:10:57 +01002263 } else {
2264 while (p+reql < end) {
2265 if (p[reql] == '\n') {
2266 /* found the end of the line */
2267 reql++;
2268 break;
2269 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002270 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002271 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002272 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002273
William Lallemandbddd33a2018-12-11 16:10:53 +01002274 /* set end to first byte after the end of the command */
2275 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002276
William Lallemandbddd33a2018-12-11 16:10:53 +01002277 /* there is no end to this command, need more to parse ! */
2278 if (*(end-1) != '\n') {
2279 return -1;
2280 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002281
William Lallemand3301f3e2018-12-13 09:05:48 +01002282 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2283 if (reql == 1) /* last line of the payload */
2284 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002285 return reql;
2286 }
2287
William Lallemandbddd33a2018-12-11 16:10:53 +01002288 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002289
William Lallemandbddd33a2018-12-11 16:10:53 +01002290 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002291 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002292 /* skip leading spaces/tabs */
2293 p += strspn(p, " \t");
2294 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002295 break;
2296
William Lallemandbddd33a2018-12-11 16:10:53 +01002297 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002298 while (1) {
2299 p += strcspn(p, " \t\\");
2300 /* escaped chars using backlashes (\) */
2301 if (*p == '\\') {
2302 if (!*++p)
2303 break;
2304 if (!*++p)
2305 break;
2306 } else {
2307 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002308 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002309 }
William Lallemandfe249c32020-06-18 18:03:57 +02002310 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002311 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002312 }
2313
William Lallemandbddd33a2018-12-11 16:10:53 +01002314 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002315
Willy Tarreauf14c7572021-03-13 10:59:23 +01002316 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002317 args[i] = NULL;
2318
2319 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2320
2321 /* End of words are ending by \0, we need to replace the \0s by spaces
23221 before forwarding them */
2323 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002324 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002325 if (*p == '\0')
2326 *p = ' ';
2327 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002328 }
2329
William Lallemand3301f3e2018-12-13 09:05:48 +01002330 payload = strstr(str, PAYLOAD_PATTERN);
2331 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2332 /* if the payload pattern is at the end */
2333 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002334 }
2335
William Lallemandbddd33a2018-12-11 16:10:53 +01002336 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002337
William Lallemandbddd33a2018-12-11 16:10:53 +01002338 if (wtrim > 0) {
2339 trim = &args[wtrim][0];
2340 if (trim == NULL) /* if this was the last word in the table */
2341 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002342
William Lallemandbddd33a2018-12-11 16:10:53 +01002343 b_del(&req->buf, trim - str);
2344
William Lallemandb7ea1412018-12-13 09:05:47 +01002345 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002346 } else if (wtrim < 0) {
2347 /* parsing error */
2348 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002349 } else {
2350 /* the whole string */
2351 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002352 }
2353
William Lallemandb7ea1412018-12-13 09:05:47 +01002354 if (ret > 1) {
2355 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2356 goto end;
2357 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002358 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2359 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002360 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002361 ci_insert_line2(req, 0, "user -", strlen("user -"));
2362 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002363 }
2364 }
2365end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002366
William Lallemandb7ea1412018-12-13 09:05:47 +01002367 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002368}
2369
2370int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2371{
William Lallemandbddd33a2018-12-11 16:10:53 +01002372 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002373 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002374 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002375
William Lallemandb7ea1412018-12-13 09:05:47 +01002376 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2377 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2378
William Lallemandcf62f7e2018-10-26 14:47:40 +02002379read_again:
2380 /* if the channel is closed for read, we won't receive any more data
2381 from the client, but we don't want to forward this close to the
2382 server */
2383 channel_dont_close(req);
2384
2385 /* We don't know yet to which server we will connect */
2386 channel_dont_connect(req);
2387
2388
2389 /* we are not waiting for a response, there is no more request and we
2390 * receive a close from the client, we can leave */
2391 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2392 channel_shutw_now(&s->res);
2393 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2394 return 1;
2395 }
2396
2397 req->flags |= CF_READ_DONTWAIT;
2398
2399 /* need more data */
2400 if (!ci_data(req))
2401 return 0;
2402
2403 /* If there is data available for analysis, log the end of the idle time. */
2404 if (c_data(req) && s->logs.t_idle == -1)
2405 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2406
William Lallemandbddd33a2018-12-11 16:10:53 +01002407 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002408 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002409 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002410 /* enough data */
2411
William Lallemandcf62f7e2018-10-26 14:47:40 +02002412 /* forward only 1 command */
2413 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002414
William Lallemanddc12c2e2018-12-13 09:05:46 +01002415 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002416 /* we send only 1 command per request, and we write close after it */
2417 channel_shutw_now(req);
2418 } else {
2419 pcli_write_prompt(s);
2420 }
2421
2422 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002423
2424 /* remove the XFER_DATA analysers, which forwards all
2425 * the data, we don't want to forward the next requests
2426 * We need to add CF_FLT_ANALYZE to abort the forward too.
2427 */
2428 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2429 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2430 s->res.analysers |= AN_RES_WAIT_CLI;
2431
William Lallemandebf61802018-12-11 16:10:57 +01002432 if (!(s->flags & SF_ASSIGNED)) {
2433 if (next_pid > -1)
2434 target_pid = next_pid;
2435 else
2436 target_pid = s->pcli_next_pid;
2437 /* we can connect now */
2438 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002439
William Lallemandebf61802018-12-11 16:10:57 +01002440 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2441 channel_auto_connect(req);
2442 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002443
2444 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002445 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002446 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 } else if (to_forward == -1 && errmsg) {
2449 /* there was an error during the parsing */
2450 pcli_reply_and_close(s, errmsg);
2451 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002452 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2453 /* buffer is full and we didn't catch the end of a command */
2454 goto send_help;
2455 }
2456
2457 return 0;
2458
2459send_help:
2460 b_reset(&req->buf);
2461 b_putblk(&req->buf, "help\n", 5);
2462 goto read_again;
2463}
2464
2465int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2466{
2467 struct proxy *fe = strm_fe(s);
2468 struct proxy *be = s->be;
2469
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002470 if (rep->flags & CF_READ_ERROR) {
2471 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2472 s->res.analysers &= ~AN_RES_WAIT_CLI;
2473 return 0;
2474 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002475 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2476 rep->flags |= CF_NEVER_WAIT;
2477
2478 /* don't forward the close */
2479 channel_dont_close(&s->res);
2480 channel_dont_close(&s->req);
2481
William Lallemanddc12c2e2018-12-13 09:05:46 +01002482 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002483 s->req.analysers |= AN_REQ_WAIT_CLI;
2484 s->res.analysers &= ~AN_RES_WAIT_CLI;
2485 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2486 return 0;
2487 }
2488
William Lallemandcf62f7e2018-10-26 14:47:40 +02002489 /* forward the data */
2490 if (ci_data(rep)) {
2491 c_adv(rep, ci_data(rep));
2492 return 0;
2493 }
2494
2495 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2496 /* stream cleanup */
2497
William Lallemand2f4ce202018-10-26 14:47:47 +02002498 pcli_write_prompt(s);
2499
William Lallemandcf62f7e2018-10-26 14:47:40 +02002500 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2501 si_shutr(&s->si[1]);
2502 si_shutw(&s->si[1]);
2503
2504 /*
2505 * starting from there this the same code as
2506 * http_end_txn_clean_session().
2507 *
2508 * It allows to do frontend keepalive while reconnecting to a
2509 * new server for each request.
2510 */
2511
2512 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002513 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002514 if (unlikely(s->srv_conn))
2515 sess_change_server(s, NULL);
2516 }
2517
2518 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2519 stream_process_counters(s);
2520
2521 /* don't count other requests' data */
2522 s->logs.bytes_in -= ci_data(&s->req);
2523 s->logs.bytes_out -= ci_data(&s->res);
2524
2525 /* we may need to know the position in the queue */
2526 pendconn_free(s);
2527
2528 /* let's do a final log if we need it */
2529 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2530 !(s->flags & SF_MONITOR) &&
2531 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2532 s->do_log(s);
2533 }
2534
2535 /* stop tracking content-based counters */
2536 stream_stop_content_counters(s);
2537 stream_update_time_stats(s);
2538
2539 s->logs.accept_date = date; /* user-visible date for logging */
2540 s->logs.tv_accept = now; /* corrected date for internal use */
2541 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2542 s->logs.t_idle = -1;
2543 tv_zero(&s->logs.tv_request);
2544 s->logs.t_queue = -1;
2545 s->logs.t_connect = -1;
2546 s->logs.t_data = -1;
2547 s->logs.t_close = 0;
2548 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2549 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2550
2551 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2552 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2553
2554 stream_del_srv_conn(s);
2555 if (objt_server(s->target)) {
2556 if (s->flags & SF_CURR_SESS) {
2557 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002558 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002559 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002560 if (may_dequeue_tasks(__objt_server(s->target), be))
2561 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002562 }
2563
2564 s->target = NULL;
2565
2566 /* only release our endpoint if we don't intend to reuse the
2567 * connection.
2568 */
2569 if (!si_conn_ready(&s->si[1])) {
2570 si_release_endpoint(&s->si[1]);
2571 s->srv_conn = NULL;
2572 }
2573
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002574 sockaddr_free(&s->target_addr);
2575
William Lallemandcf62f7e2018-10-26 14:47:40 +02002576 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2577 s->si[1].err_type = SI_ET_NONE;
2578 s->si[1].conn_retries = 0; /* used for logging too */
2579 s->si[1].exp = TICK_ETERNITY;
2580 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 +02002581 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 +02002582 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 +02002583 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2584 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2585 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2586 /* reinitialise the current rule list pointer to NULL. We are sure that
2587 * any rulelist match the NULL pointer.
2588 */
2589 s->current_rule_list = NULL;
2590
2591 s->be = strm_fe(s);
2592 s->logs.logwait = strm_fe(s)->to_log;
2593 s->logs.level = 0;
2594 stream_del_srv_conn(s);
2595 s->target = NULL;
2596 /* re-init store persistence */
2597 s->store_count = 0;
2598 s->uniq_id = global.req_count++;
2599
2600 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2601
2602 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2603
2604 s->req.analysers |= AN_REQ_WAIT_CLI;
2605 s->res.analysers &= ~AN_RES_WAIT_CLI;
2606
2607 /* We must trim any excess data from the response buffer, because we
2608 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002609 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002610 * we want those data to come along with next response. A typical
2611 * example of such data would be from a buggy server responding to
2612 * a HEAD with some data, or sending more than the advertised
2613 * content-length.
2614 */
2615 if (unlikely(ci_data(&s->res)))
2616 b_set_data(&s->res.buf, co_data(&s->res));
2617
2618 /* Now we can realign the response buffer */
2619 c_realign_if_empty(&s->res);
2620
2621 s->req.rto = strm_fe(s)->timeout.client;
2622 s->req.wto = TICK_ETERNITY;
2623
2624 s->res.rto = TICK_ETERNITY;
2625 s->res.wto = strm_fe(s)->timeout.client;
2626
2627 s->req.rex = TICK_ETERNITY;
2628 s->req.wex = TICK_ETERNITY;
2629 s->req.analyse_exp = TICK_ETERNITY;
2630 s->res.rex = TICK_ETERNITY;
2631 s->res.wex = TICK_ETERNITY;
2632 s->res.analyse_exp = TICK_ETERNITY;
2633 s->si[1].hcto = TICK_ETERNITY;
2634
2635 /* we're removing the analysers, we MUST re-enable events detection.
2636 * We don't enable close on the response channel since it's either
2637 * already closed, or in keep-alive with an idle connection handler.
2638 */
2639 channel_auto_read(&s->req);
2640 channel_auto_close(&s->req);
2641 channel_auto_read(&s->res);
2642
2643
2644 return 1;
2645 }
2646 return 0;
2647}
2648
William Lallemand8a022572018-10-26 14:47:35 +02002649/*
2650 * The mworker functions are used to initialize the CLI in the master process
2651 */
2652
William Lallemand309dc9a2018-10-26 14:47:45 +02002653 /*
2654 * Stop the mworker proxy
2655 */
2656void mworker_cli_proxy_stop()
2657{
William Lallemand550db6d2018-11-06 17:37:12 +01002658 if (mworker_proxy)
2659 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002660}
2661
William Lallemand8a022572018-10-26 14:47:35 +02002662/*
2663 * Create the mworker CLI proxy
2664 */
2665int mworker_cli_proxy_create()
2666{
2667 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002668 char *msg = NULL;
2669 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002670
2671 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2672 if (!mworker_proxy)
2673 return -1;
2674
2675 init_new_proxy(mworker_proxy);
2676 mworker_proxy->next = proxies_list;
2677 proxies_list = mworker_proxy;
2678 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002679 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002680 mworker_proxy->last_change = now.tv_sec;
2681 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2682 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2683 mworker_proxy->timeout.client = 0; /* no timeout */
2684 mworker_proxy->conf.file = strdup("MASTER");
2685 mworker_proxy->conf.line = 0;
2686 mworker_proxy->accept = frontend_accept;
2687 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2688
2689 /* Does not init the default target the CLI applet, but must be done in
2690 * the request parsing code */
2691 mworker_proxy->default_target = NULL;
2692
2693 /* the check_config_validity() will get an ID for the proxy */
2694 mworker_proxy->uuid = -1;
2695
2696 proxy_store_name(mworker_proxy);
2697
2698 /* create all servers using the mworker_proc list */
2699 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002700 struct server *newsrv = NULL;
2701 struct sockaddr_storage *sk;
2702 int port1, port2, port;
2703 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002704
William Lallemanda31b09e2020-01-14 15:25:02 +01002705 /* only the workers support the master CLI */
2706 if (!(child->options & PROC_O_TYPE_WORKER))
2707 continue;
2708
William Lallemand8a022572018-10-26 14:47:35 +02002709 newsrv = new_server(mworker_proxy);
2710 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002711 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002712
2713 /* we don't know the new pid yet */
2714 if (child->pid == -1)
2715 memprintf(&msg, "cur-%d", child->relative_pid);
2716 else
2717 memprintf(&msg, "old-%d", child->pid);
2718
2719 newsrv->next = mworker_proxy->srv;
2720 mworker_proxy->srv = newsrv;
2721 newsrv->conf.file = strdup(msg);
2722 newsrv->id = strdup(msg);
2723 newsrv->conf.line = 0;
2724
2725 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002726 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002727 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002728 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002729 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002730 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002731
Willy Tarreau5fc93282020-09-16 18:25:03 +02002732 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002733 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002734 }
2735
2736 /* no port specified */
2737 newsrv->flags |= SRV_F_MAPPORTS;
2738 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002739 /* don't let the server participate to load balancing */
2740 newsrv->iweight = 0;
2741 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002742 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002743
2744 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002745 }
2746 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002747
2748error:
2749 ha_alert("%s\n", errmsg);
2750
2751 list_for_each_entry(child, &proc_list, list) {
2752 free((char *)child->srv->conf.file); /* cast because of const char * */
2753 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002754 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002755 }
2756 free(mworker_proxy->id);
2757 free(mworker_proxy->conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002758 ha_free(&mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002759 free(errmsg);
2760 free(msg);
2761
2762 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002763}
Olivier Houchardf886e342017-04-05 22:24:59 +02002764
William Lallemandce83b4a2018-10-26 14:47:30 +02002765/*
William Lallemande7361152018-10-26 14:47:36 +02002766 * Create a new listener for the master CLI proxy
2767 */
2768int mworker_cli_proxy_new_listener(char *line)
2769{
2770 struct bind_conf *bind_conf;
2771 struct listener *l;
2772 char *err = NULL;
2773 char *args[MAX_LINE_ARGS + 1];
2774 int arg;
2775 int cur_arg;
2776
William Lallemand2e945c82019-11-25 09:58:37 +01002777 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002778 args[0] = line;
2779
2780 /* args is a bind configuration with spaces replaced by commas */
2781 while (*line && arg < MAX_LINE_ARGS) {
2782
2783 if (*line == ',') {
2784 *line++ = '\0';
2785 while (*line == ',')
2786 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002787 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002788 }
2789 line++;
2790 }
2791
William Lallemand2e945c82019-11-25 09:58:37 +01002792 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002793
2794 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002795 if (!bind_conf)
2796 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002797
2798 bind_conf->level &= ~ACCESS_LVL_MASK;
2799 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002800 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002801
2802 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2803 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002804 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002805 }
2806
2807 cur_arg = 1;
2808
2809 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002810 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002811 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002812
2813 kw = bind_find_kw(args[cur_arg]);
2814 if (kw) {
2815 if (!kw->parse) {
2816 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2817 args[0], args[1], args[cur_arg]);
2818 goto err;
2819 }
2820
Willy Tarreau4975d142021-03-13 11:00:33 +01002821 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002822 if (err)
2823 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2824 else
2825 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2826 args[0], args[1], args[cur_arg]);
2827 goto err;
2828 }
2829
2830 cur_arg += 1 + kw->skip;
2831 continue;
2832 }
2833
Willy Tarreau433b05f2021-03-12 10:14:07 +01002834 best = bind_find_best_kw(args[cur_arg]);
2835 if (best)
2836 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2837 args[0], args[1], args[cur_arg], best);
2838 else
2839 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2840 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002841 goto err;
2842 }
2843
2844
2845 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002846 l->accept = session_accept_fd;
2847 l->default_target = mworker_proxy->default_target;
2848 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002849 l->options |= LI_O_UNLIMITED;
2850 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002851 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002852 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002853 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002854 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002855
2856 return 0;
2857
2858err:
2859 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002860 free(err);
2861 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002862 return -1;
2863
2864}
2865
2866/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002867 * Create a new CLI socket using a socketpair for a worker process
2868 * <mworker_proc> is the process structure, and <proc> is the process number
2869 */
2870int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2871{
2872 struct bind_conf *bind_conf;
2873 struct listener *l;
2874 char *path = NULL;
2875 char *err = NULL;
2876
2877 /* master pipe to ensure the master is still alive */
2878 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2879 ha_alert("Cannot create worker socketpair.\n");
2880 return -1;
2881 }
2882
2883 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002884 if (!global.cli_fe) {
2885 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002886 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002887 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002888 }
2889 }
2890
Willy Tarreau4975d142021-03-13 11:00:33 +01002891 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002892 if (!bind_conf)
2893 goto error;
2894
William Lallemandce83b4a2018-10-26 14:47:30 +02002895 bind_conf->level &= ~ACCESS_LVL_MASK;
2896 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2897
Willy Tarreaue26993c2020-09-03 07:18:55 +02002898 bind_conf->settings.bind_proc = 1UL << proc;
Willy Tarreau4975d142021-03-13 11:00:33 +01002899 global.cli_fe->bind_proc = 0; /* XXX: we should be careful with that, it can be removed by configuration */
William Lallemandce83b4a2018-10-26 14:47:30 +02002900
2901 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2902 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002903 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002904 }
2905
Willy Tarreau4975d142021-03-13 11:00:33 +01002906 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002907 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002908 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002909 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002910 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002911 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002912
2913 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002914 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002915 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002916 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002917 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002918 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002919 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002920 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002921 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002922 }
2923
2924 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002925
2926error:
2927 close(mworker_proc->ipc_fd[0]);
2928 close(mworker_proc->ipc_fd[1]);
2929 free(err);
2930
2931 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002932}
2933
William Lallemand74c24fb2016-11-21 17:18:36 +01002934static struct applet cli_applet = {
2935 .obj_type = OBJ_TYPE_APPLET,
2936 .name = "<CLI>", /* used for logging */
2937 .fct = cli_io_handler,
2938 .release = cli_release_handler,
2939};
2940
William Lallemand99e0bb92020-11-05 10:28:53 +01002941/* master CLI */
2942static struct applet mcli_applet = {
2943 .obj_type = OBJ_TYPE_APPLET,
2944 .name = "<MCLI>", /* used for logging */
2945 .fct = cli_io_handler,
2946 .release = cli_release_handler,
2947};
2948
Willy Tarreau0a739292016-11-22 20:21:23 +01002949/* register cli keywords */
2950static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002951 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2952 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2953 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2954 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
2955 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2956 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2957 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
2958 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
2959 { { "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 },
2960 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
2961 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
2962 { { "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 },
2963 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2964 { { "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 },
2965 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
2966 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2967 { { "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 +01002968 {{},}
2969}};
2970
Willy Tarreau0108d902018-11-25 19:14:37 +01002971INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2972
William Lallemand74c24fb2016-11-21 17:18:36 +01002973static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002974 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002975 { 0, NULL, NULL },
2976}};
2977
Willy Tarreau0108d902018-11-25 19:14:37 +01002978INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2979
William Lallemand74c24fb2016-11-21 17:18:36 +01002980static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002981 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2982 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002983 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002984 { NULL, NULL, 0 },
2985}};
2986
Willy Tarreau0108d902018-11-25 19:14:37 +01002987INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002988
2989/*
2990 * Local variables:
2991 * c-indent-level: 8
2992 * c-basic-offset: 8
2993 * End:
2994 */