blob: b60a030c03ecb0afd5a22f92bb6553f54ece7640 [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,
257 " help : full commands list\n"
258 " prompt : toggle interactive mode with prompt\n"
259 " quit : disconnect\n");
260
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
Willy Tarreau41908562016-11-24 16:23:38 +0100742 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200743 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200744
745 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
746 goto fail;
747
748 /* kw->parse could set its own io_handler or io_release handler */
749 if (!appctx->io_handler)
750 goto fail;
751
752 appctx->st0 = CLI_ST_CALLBACK;
753 return 1;
754fail:
755 appctx->io_handler = NULL;
756 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100757 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100758}
759
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200760/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
761static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
762{
Willy Tarreau83061a82018-07-13 11:56:34 +0200763 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200764
765 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200766 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200767
768 tmp = get_trash_chunk();
769 chunk_reset(tmp);
770
771 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100772 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200773 chunk_printf(tmp, "[%d]: ", severity);
774 }
775 else {
776 switch (severity_output) {
777 case CLI_SEVERITY_NUMBER:
778 chunk_printf(tmp, "[%d]: ", severity);
779 break;
780 case CLI_SEVERITY_STRING:
781 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
782 break;
783 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100784 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200785 }
786 }
787 chunk_appendf(tmp, "%s", msg);
788
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200789 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200790}
791
William Lallemand74c24fb2016-11-21 17:18:36 +0100792/* This I/O handler runs as an applet embedded in a stream interface. It is
793 * used to processes I/O from/to the stats unix socket. The system relies on a
794 * state machine handling requests and various responses. We read a request,
795 * then we process it and send the response, and we possibly display a prompt.
796 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100797 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100798 * or not.
799 */
800static void cli_io_handler(struct appctx *appctx)
801{
802 struct stream_interface *si = appctx->owner;
803 struct channel *req = si_oc(si);
804 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200805 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100806 int reql;
807 int len;
808
809 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
810 goto out;
811
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800812 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200813 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100814 /* buf.size==0 means we failed to get a buffer and were
815 * already subscribed to a wait list to get a buffer.
816 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100817 goto out;
818 }
819
William Lallemand74c24fb2016-11-21 17:18:36 +0100820 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100821 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100822 /* Stats output not initialized yet */
823 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200824 /* reset severity to default at init */
825 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100826 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100827 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100828 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100829 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100830 /* Let's close for real now. We just close the request
831 * side, the conditions below will complete if needed.
832 */
833 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200834 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200835 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100836 break;
837 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100838 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200839 char *str;
840
841 /* use a trash chunk to store received data */
842 if (!appctx->chunk) {
843 appctx->chunk = alloc_trash_chunk();
844 if (!appctx->chunk) {
845 appctx->st0 = CLI_ST_END;
846 continue;
847 }
848 }
849
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200850 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200851
William Lallemand74c24fb2016-11-21 17:18:36 +0100852 /* ensure we have some output room left in the event we
853 * would want to return some info right after parsing.
854 */
855 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100856 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100857 break;
858 }
859
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200860 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200861 reql = co_getline(si_oc(si), str,
862 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100863 if (reql <= 0) { /* closed or EOL not found */
864 if (reql == 0)
865 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100866 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100867 continue;
868 }
869
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200870 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
871 /* seek for a possible unescaped semi-colon. If we find
872 * one, we replace it with an LF and skip only this part.
873 */
874 for (len = 0; len < reql; len++) {
875 if (str[len] == '\\') {
876 len++;
877 continue;
878 }
879 if (str[len] == ';') {
880 str[len] = '\n';
881 reql = len + 1;
882 break;
883 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100884 }
885 }
886
887 /* now it is time to check that we have a full line,
888 * remove the trailing \n and possibly \r, then cut the
889 * line.
890 */
891 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200892 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100893 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100894 continue;
895 }
896
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200897 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100898 len--;
899
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200900 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200901 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200902
903 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200904 appctx->chunk->area[appctx->chunk->data] = '\n';
905 appctx->chunk->area[appctx->chunk->data + 1] = 0;
906 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200907 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100908
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100909 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200910
911 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
912 /* empty line */
913 if (!len) {
914 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200915 appctx->chunk->data -= 2;
916 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100917 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200918 chunk_reset(appctx->chunk);
919 /* NB: cli_sock_parse_request() may have put
920 * another CLI_ST_O_* into appctx->st0.
921 */
922
923 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100924 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100925 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200926 else {
927 /*
928 * Look for the "payload start" pattern at the end of a line
929 * Its location is not remembered here, this is just to switch
930 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100931 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100932 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200933 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200934 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200935 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100936 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200937 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200938 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100939 }
940
941 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200942 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100943 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
944 }
945 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200946 const char *msg;
947 int sev;
948
William Lallemand74c24fb2016-11-21 17:18:36 +0100949 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100950 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200952 case CLI_ST_PRINT: /* print const message in msg */
953 case CLI_ST_PRINT_ERR: /* print const error in msg */
954 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
955 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
956 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
957 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
958 LOG_ERR : appctx->ctx.cli.severity;
959 msg = appctx->ctx.cli.msg;
960 }
961 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
962 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
963 LOG_ERR : appctx->ctx.cli.severity;
964 msg = appctx->ctx.cli.err;
965 if (!msg) {
966 sev = LOG_ERR;
967 msg = "Out of memory.\n";
968 }
969 }
970 else {
971 sev = LOG_ERR;
972 msg = "Internal error.\n";
973 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200974
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200975 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
976 if (appctx->st0 == CLI_ST_PRINT_FREE ||
977 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100978 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200979 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100980 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100981 }
982 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100983 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100984 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200985
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100986 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100987 if (appctx->io_handler)
988 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100989 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100990 if (appctx->io_release) {
991 appctx->io_release(appctx);
992 appctx->io_release = NULL;
993 }
994 }
995 break;
996 default: /* abnormal state */
997 si->flags |= SI_FL_ERR;
998 break;
999 }
1000
1001 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001002 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001003 const char *prompt = "";
1004
1005 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1006 /*
1007 * when entering a payload with interactive mode, change the prompt
1008 * to emphasize that more data can still be sent
1009 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001010 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001011 prompt = "+ ";
1012 else
1013 prompt = "\n> ";
1014 }
1015 else {
William Lallemandad032882019-07-01 10:56:15 +02001016 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001017 prompt = "\n";
1018 }
1019
1020 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001021 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001022 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001023 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001024 }
1025
1026 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001027 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001028 break;
1029
1030 /* Now we close the output if one of the writers did so,
1031 * or if we're not in interactive mode and the request
1032 * buffer is empty. This still allows pipelined requests
1033 * to be sent in non-interactive mode.
1034 */
William Lallemand3de09d52018-12-11 16:10:56 +01001035 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1036 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001037 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 continue;
1039 }
1040
1041 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001042 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001043 /* reactivate the \n at the end of the response for the next command */
1044 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001045 }
1046 }
1047
1048 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1049 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1050 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1051 /* Other side has closed, let's abort if we have no more processing to do
1052 * and nothing more to consume. This is comparable to a broken pipe, so
1053 * we forward the close to the request side so that it flows upstream to
1054 * the client.
1055 */
1056 si_shutw(si);
1057 }
1058
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001059 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001060 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1061 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1062 /* We have no more processing to do, and nothing more to send, and
1063 * the client side has closed. So we'll forward this state downstream
1064 * on the response buffer.
1065 */
1066 si_shutr(si);
1067 res->flags |= CF_READ_NULL;
1068 }
1069
1070 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001071 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 +01001072 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001073 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 +01001074}
1075
William Lallemand74c24fb2016-11-21 17:18:36 +01001076/* This is called when the stream interface is closed. For instance, upon an
1077 * external abort, we won't call the i/o handler anymore so we may need to
1078 * remove back references to the stream currently being dumped.
1079 */
1080static void cli_release_handler(struct appctx *appctx)
1081{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001082 free_trash_chunk(appctx->chunk);
1083 appctx->chunk = NULL;
1084
William Lallemand74c24fb2016-11-21 17:18:36 +01001085 if (appctx->io_release) {
1086 appctx->io_release(appctx);
1087 appctx->io_release = NULL;
1088 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001090 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001091 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001092}
1093
1094/* This function dumps all environmnent variables to the buffer. It returns 0
1095 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001096 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1097 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001099static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001100{
Willy Tarreau0a739292016-11-22 20:21:23 +01001101 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001102 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001103
1104 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1105 return 1;
1106
1107 chunk_reset(&trash);
1108
1109 /* we have two inner loops here, one for the proxy, the other one for
1110 * the buffer.
1111 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001112 while (*var) {
1113 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001114
Willy Tarreau06d80a92017-10-19 14:32:15 +02001115 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001116 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001117 return 0;
1118 }
1119 if (appctx->st2 == STAT_ST_END)
1120 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001121 var++;
1122 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001123 }
1124
1125 /* dump complete */
1126 return 1;
1127}
1128
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001129/* This function dumps all file descriptors states (or the requested one) to
1130 * the buffer. It returns 0 if the output buffer is full and it needs to be
1131 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1132 * It uses cli.i0 as the fd number to restart from.
1133 */
1134static int cli_io_handler_show_fd(struct appctx *appctx)
1135{
1136 struct stream_interface *si = appctx->owner;
1137 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001138 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001139
1140 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001141 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001142
1143 chunk_reset(&trash);
1144
Willy Tarreauca1b1572018-12-18 15:45:11 +01001145 /* isolate the threads once per round. We're limited to a buffer worth
1146 * of output anyway, it cannot last very long.
1147 */
1148 thread_isolate();
1149
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001150 /* we have two inner loops here, one for the proxy, the other one for
1151 * the buffer.
1152 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001153 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001154 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001155 const struct listener *li = NULL;
1156 const struct server *sv = NULL;
1157 const struct proxy *px = NULL;
1158 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001159 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001160 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001161 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001162 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001163 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001164 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001165 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001166
1167 fdt = fdtab[fd];
1168
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001169 /* When DEBUG_FD is set, we also report closed FDs that have a
1170 * non-null event count to detect stuck ones.
1171 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001172 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001173#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001174 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001175#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001176 goto skip; // closed
1177 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001178 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001179 conn = (const struct connection *)fdt.owner;
1180 conn_flags = conn->flags;
1181 mux = conn->mux;
1182 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001183 xprt = conn->xprt;
1184 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001185 li = objt_listener(conn->target);
1186 sv = objt_server(conn->target);
1187 px = objt_proxy(conn->target);
1188 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001189 if (atleast2(fdt.thread_mask))
1190 suspicious = 1;
1191 if (conn->handle.fd != fd)
1192 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001193 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001194 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001195 li = fdt.owner;
1196
Willy Tarreaudacfde42021-01-21 09:07:29 +01001197 if (!fdt.thread_mask)
1198 suspicious = 1;
1199
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001200 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001201 " %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 +02001202 fd,
1203 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001204 (fdt.state & FD_CLONED) ? 'C' : 'c',
1205 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001206 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1207 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1208 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1209 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1210 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001211 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1212 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1213 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1214 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1215 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1216 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001217 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001218 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001219 fdt.iocb);
1220 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001221
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001222 if (!fdt.owner) {
1223 chunk_appendf(&trash, ")");
1224 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001225 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001226 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001227
1228 if (conn->handle.fd != fd) {
1229 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1230 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001231 } else {
1232 struct sockaddr_storage sa;
1233 socklen_t salen;
1234
1235 salen = sizeof(sa);
1236 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1237 if (sa.ss_family == AF_INET)
1238 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1239 else if (sa.ss_family == AF_INET6)
1240 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1241 else if (sa.ss_family == AF_UNIX)
1242 chunk_appendf(&trash, " fam=unix");
1243 }
1244
1245 salen = sizeof(sa);
1246 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1247 if (sa.ss_family == AF_INET)
1248 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1249 else if (sa.ss_family == AF_INET6)
1250 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1251 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001252 }
1253
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001254 if (px)
1255 chunk_appendf(&trash, " px=%s", px->id);
1256 else if (sv)
1257 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1258 else if (li)
1259 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001260
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001261 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001262 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001263 if (!ctx)
1264 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001265 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001266 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001267 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001268 else
1269 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001270
1271 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001272 if (xprt) {
1273 if (xprt_ctx || xprt->show_fd)
1274 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1275 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001276 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001277 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001278 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001279 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001280 struct sockaddr_storage sa;
1281 socklen_t salen;
1282
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001283 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001284 listener_state_str(li),
1285 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001286
1287 salen = sizeof(sa);
1288 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1289 if (sa.ss_family == AF_INET)
1290 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1291 else if (sa.ss_family == AF_INET6)
1292 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1293 else if (sa.ss_family == AF_UNIX)
1294 chunk_appendf(&trash, " fam=unix");
1295 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001296 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001297 else
1298 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001299
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001300#ifdef DEBUG_FD
1301 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001302 if (fdtab[fd].event_count >= 1000000)
1303 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001304#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001305 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001306
Willy Tarreau06d80a92017-10-19 14:32:15 +02001307 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001308 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001309 appctx->ctx.cli.i0 = fd;
1310 ret = 0;
1311 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001312 }
1313 skip:
1314 if (appctx->st2 == STAT_ST_END)
1315 break;
1316
1317 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001318 }
1319
Willy Tarreauca1b1572018-12-18 15:45:11 +01001320 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001321 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001322
1323 thread_release();
1324 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001325}
1326
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001327/* This function dumps some activity counters used by developers and support to
1328 * rule out some hypothesis during bug reports. It returns 0 if the output
1329 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1330 * everything at once in the buffer and is not designed to do it in multiple
1331 * passes.
1332 */
1333static int cli_io_handler_show_activity(struct appctx *appctx)
1334{
1335 struct stream_interface *si = appctx->owner;
1336 int thr;
1337
1338 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1339 return 1;
1340
1341 chunk_reset(&trash);
1342
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001343#undef SHOW_TOT
1344#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001345 do { \
1346 unsigned int _v[MAX_THREADS]; \
1347 unsigned int _tot; \
1348 const unsigned int _nbt = global.nbthread; \
1349 for (_tot = t = 0; t < _nbt; t++) \
1350 _tot += _v[t] = (x); \
1351 if (_nbt == 1) { \
1352 chunk_appendf(&trash, " %u\n", _tot); \
1353 break; \
1354 } \
1355 chunk_appendf(&trash, " %u [", _tot); \
1356 for (t = 0; t < _nbt; t++) \
1357 chunk_appendf(&trash, " %u", _v[t]); \
1358 chunk_appendf(&trash, " ]\n"); \
1359 } while (0)
1360
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001361#undef SHOW_AVG
1362#define SHOW_AVG(t, x) \
1363 do { \
1364 unsigned int _v[MAX_THREADS]; \
1365 unsigned int _tot; \
1366 const unsigned int _nbt = global.nbthread; \
1367 for (_tot = t = 0; t < _nbt; t++) \
1368 _tot += _v[t] = (x); \
1369 if (_nbt == 1) { \
1370 chunk_appendf(&trash, " %u\n", _tot); \
1371 break; \
1372 } \
1373 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1374 for (t = 0; t < _nbt; t++) \
1375 chunk_appendf(&trash, " %u", _v[t]); \
1376 chunk_appendf(&trash, " ]\n"); \
1377 } while (0)
1378
Willy Tarreaua0211b82019-05-28 15:09:08 +02001379 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1380 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001381 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1382 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1383 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1384 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001385 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001386 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1387 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001388 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001389 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001390 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1391 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1392 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001393 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001394 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001395 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1396 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001397 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1398 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1399 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1400 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1401 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1402 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1403 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001404#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001405 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 +02001406 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001407#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001408
Willy Tarreaud6a78502019-05-27 07:03:38 +02001409#if defined(DEBUG_DEV)
1410 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001411 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1412 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1413 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001414#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001415
1416 if (ci_putchk(si_ic(si), &trash) == -1) {
1417 chunk_reset(&trash);
1418 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001419 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001420 }
1421
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001422#undef SHOW_AVG
1423#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001424 /* dump complete */
1425 return 1;
1426}
1427
William Lallemandeceddf72016-12-15 18:06:44 +01001428/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001429 * CLI IO handler for `show cli sockets`.
1430 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001431 */
1432static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1433{
1434 struct bind_conf *bind_conf;
1435 struct stream_interface *si = appctx->owner;
1436
1437 chunk_reset(&trash);
1438
1439 switch (appctx->st2) {
1440 case STAT_ST_INIT:
1441 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001442 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001443 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001444 return 0;
1445 }
William Lallemandeceddf72016-12-15 18:06:44 +01001446 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001447 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001448
1449 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001450 if (global.cli_fe) {
1451 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001452 struct listener *l;
1453
1454 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001455 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001456 * if the current node is the first of the list
1457 */
1458
Willy Tarreau3af9d832016-12-16 12:58:09 +01001459 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001460 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001461 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001462 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001463 continue;
1464 }
1465
1466 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1467
1468 char addr[46];
1469 char port[6];
1470
Willy Tarreau37159062020-08-27 07:48:42 +02001471 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001472 const struct sockaddr_un *un;
1473
Willy Tarreau37159062020-08-27 07:48:42 +02001474 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001475 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001476 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001477 } else {
1478 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1479 }
Willy Tarreau37159062020-08-27 07:48:42 +02001480 } else if (l->rx.addr.ss_family == AF_INET) {
1481 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1482 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001483 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001484 } else if (l->rx.addr.ss_family == AF_INET6) {
1485 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1486 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001487 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001488 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1489 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001490 } else
William Lallemand26314342018-10-26 14:47:41 +02001491 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001492
William Lallemand07a62f72017-05-24 00:57:40 +02001493 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001494 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001495 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1496 chunk_appendf(&trash, "operator ");
1497 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1498 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001499 else
1500 chunk_appendf(&trash, " ");
1501
Willy Tarreaue26993c2020-09-03 07:18:55 +02001502 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001503 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001504 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1505 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001506 chunk_appendf(&trash, "%d,", pos+1);
1507 }
1508 }
1509 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001510 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001511
1512 } else {
1513 chunk_appendf(&trash, "all\n");
1514 }
1515
Willy Tarreau06d80a92017-10-19 14:32:15 +02001516 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001517 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001518 return 0;
1519 }
1520 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001521 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001522 }
1523 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001524 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001525 default:
1526 appctx->st2 = STAT_ST_FIN;
1527 return 1;
1528 }
1529}
1530
1531
Willy Tarreau0a739292016-11-22 20:21:23 +01001532/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001533 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1534 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001535 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001536static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001537{
1538 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001539 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001540
1541 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1542 return 1;
1543
Willy Tarreauf6710f82016-12-16 17:45:44 +01001544 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001545
1546 if (*args[2]) {
1547 int len = strlen(args[2]);
1548
Willy Tarreauf6710f82016-12-16 17:45:44 +01001549 for (; *var; var++) {
1550 if (strncmp(*var, args[2], len) == 0 &&
1551 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001552 break;
1553 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001554 if (!*var)
1555 return cli_err(appctx, "Variable not found\n");
1556
Willy Tarreau0a739292016-11-22 20:21:23 +01001557 appctx->st2 = STAT_ST_END;
1558 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001559 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001560 return 0;
1561}
1562
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001563/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1564 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1565 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1566 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001567static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001568{
1569 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1570 return 1;
1571
1572 appctx->ctx.cli.i0 = 0;
1573
1574 if (*args[2]) {
1575 appctx->ctx.cli.i0 = atoi(args[2]);
1576 appctx->st2 = STAT_ST_END;
1577 }
1578 return 0;
1579}
1580
Willy Tarreau599852e2016-11-22 20:33:32 +01001581/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001582static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001583{
1584 struct stream_interface *si = appctx->owner;
1585 struct stream *s = si_strm(si);
1586
1587 if (strcmp(args[2], "cli") == 0) {
1588 unsigned timeout;
1589 const char *res;
1590
Willy Tarreau9d008692019-08-09 11:21:01 +02001591 if (!*args[3])
1592 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001593
1594 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001595 if (res || timeout < 1)
1596 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001597
1598 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1599 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1600 return 1;
1601 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001602
1603 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001604}
1605
Willy Tarreau2af99412016-11-23 11:10:59 +01001606/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001607static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001608{
1609 int v;
1610
1611 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1612 return 1;
1613
Willy Tarreau9d008692019-08-09 11:21:01 +02001614 if (!*args[3])
1615 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001616
1617 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001618 if (v > global.hardmaxconn)
1619 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001620
1621 /* check for unlimited values */
1622 if (v <= 0)
1623 v = global.hardmaxconn;
1624
1625 global.maxconn = v;
1626
1627 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001628 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001629
1630 return 1;
1631}
1632
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001633static int set_severity_output(int *target, char *argument)
1634{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001635 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001636 *target = CLI_SEVERITY_NONE;
1637 return 1;
1638 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001639 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001640 *target = CLI_SEVERITY_NUMBER;
1641 return 1;
1642 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001643 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001644 *target = CLI_SEVERITY_STRING;
1645 return 1;
1646 }
1647 return 0;
1648}
1649
1650/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001651static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001652{
1653 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1654 return 0;
1655
Willy Tarreau9d008692019-08-09 11:21:01 +02001656 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001657}
William Lallemandeceddf72016-12-15 18:06:44 +01001658
William Lallemand67a234f2018-12-13 09:05:45 +01001659
1660/* show the level of the current CLI session */
1661static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1662{
William Lallemand67a234f2018-12-13 09:05:45 +01001663 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001664 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001665 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001666 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001667 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001668 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001669 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001670 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001671}
1672
1673/* parse and set the CLI level dynamically */
1674static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1675{
William Lallemandad032882019-07-01 10:56:15 +02001676 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001677 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001678 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1679
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001680 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001681 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1682 return 1;
1683 }
1684 appctx->cli_level &= ~ACCESS_LVL_MASK;
1685 appctx->cli_level |= ACCESS_LVL_OPER;
1686
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001687 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001688 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1689 return 1;
1690 }
1691 appctx->cli_level &= ~ACCESS_LVL_MASK;
1692 appctx->cli_level |= ACCESS_LVL_USER;
1693 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001694 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001695 return 1;
1696}
1697
1698
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001699/* parse and set the CLI expert/experimental-mode dynamically */
1700static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001701{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001702 int level;
1703 char *level_str;
1704 char *output = NULL;
1705
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001706 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1707 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001708
1709 if (!strcmp(args[0], "expert-mode")) {
1710 level = ACCESS_EXPERT;
1711 level_str = "expert-mode";
1712 }
1713 else if (!strcmp(args[0], "experimental-mode")) {
1714 level = ACCESS_EXPERIMENTAL;
1715 level_str = "experimental-mode";
1716 }
1717 else {
1718 return 1;
1719 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001720
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001721 if (!*args[1]) {
1722 memprintf(&output, "%s is %s\n", level_str,
1723 (appctx->cli_level & level) ? "ON" : "OFF");
1724 return cli_dynmsg(appctx, LOG_INFO, output);
1725 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001726
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001727 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001728 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001729 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001730 return 1;
1731}
1732
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001733int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001734{
1735 return 0;
1736}
1737
Willy Tarreau45c742b2016-11-24 14:51:17 +01001738/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001739static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001740{
1741 int v;
1742 int *res;
1743 int mul = 1;
1744
1745 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1746 return 1;
1747
1748 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1749 res = &global.cps_lim;
1750 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1751 res = &global.sps_lim;
1752#ifdef USE_OPENSSL
1753 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1754 res = &global.ssl_lim;
1755#endif
1756 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1757 res = &global.comp_rate_lim;
1758 mul = 1024;
1759 }
1760 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001761 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001762 "'set rate-limit' only supports :\n"
1763 " - 'connections global' to set the per-process maximum connection rate\n"
1764 " - 'sessions global' to set the per-process maximum session rate\n"
1765#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001766 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001767#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001768 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001769 }
1770
Willy Tarreau9d008692019-08-09 11:21:01 +02001771 if (!*args[4])
1772 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001773
1774 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001775 if (v < 0)
1776 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001777
1778 *res = v * mul;
1779
1780 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001781 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001782
1783 return 1;
1784}
1785
William Lallemandf6975e92017-05-26 17:42:10 +02001786/* parse the "expose-fd" argument on the bind lines */
1787static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1788{
1789 if (!*args[cur_arg + 1]) {
1790 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1791 return ERR_ALERT | ERR_FATAL;
1792 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001793 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001794 conf->level |= ACCESS_FD_LISTENERS;
1795 } else {
1796 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1797 args[cur_arg], args[cur_arg+1]);
1798 return ERR_ALERT | ERR_FATAL;
1799 }
1800
1801 return 0;
1802}
1803
William Lallemand74c24fb2016-11-21 17:18:36 +01001804/* parse the "level" argument on the bind lines */
1805static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1806{
1807 if (!*args[cur_arg + 1]) {
1808 memprintf(err, "'%s' : missing level", args[cur_arg]);
1809 return ERR_ALERT | ERR_FATAL;
1810 }
1811
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001812 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001813 conf->level &= ~ACCESS_LVL_MASK;
1814 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001815 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001816 conf->level &= ~ACCESS_LVL_MASK;
1817 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001818 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001819 conf->level &= ~ACCESS_LVL_MASK;
1820 conf->level |= ACCESS_LVL_ADMIN;
1821 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001822 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1823 args[cur_arg], args[cur_arg+1]);
1824 return ERR_ALERT | ERR_FATAL;
1825 }
1826
1827 return 0;
1828}
1829
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001830static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1831{
1832 if (!*args[cur_arg + 1]) {
1833 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1834 return ERR_ALERT | ERR_FATAL;
1835 }
1836
1837 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1838 return 0;
1839 else {
1840 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1841 args[cur_arg], args[cur_arg+1]);
1842 return ERR_ALERT | ERR_FATAL;
1843 }
1844}
1845
Olivier Houchardf886e342017-04-05 22:24:59 +02001846/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001847static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001848{
1849 char *cmsgbuf = NULL;
1850 unsigned char *tmpbuf = NULL;
1851 struct cmsghdr *cmsg;
1852 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001853 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001854 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001855 struct msghdr msghdr;
1856 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001857 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001858 const char *ns_name, *if_name;
1859 unsigned char ns_nlen, if_nlen;
1860 int nb_queued;
1861 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001862 int *tmpfd;
1863 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001864 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001865 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001866 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001867 int ret;
1868
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001869 if (!remote) {
1870 ha_warning("Only works on real connections\n");
1871 goto out;
1872 }
1873
1874 fd = remote->handle.fd;
1875
Olivier Houchardf886e342017-04-05 22:24:59 +02001876 /* Temporary set the FD in blocking mode, that will make our life easier */
1877 old_fcntl = fcntl(fd, F_GETFL);
1878 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001879 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001880 goto out;
1881 }
1882 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1883 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001884 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001885 goto out;
1886 }
1887 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001888 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001889 goto out;
1890 }
Olivier Houchard54740872017-04-06 14:45:14 +02001891 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001892 iov.iov_base = &tot_fd_nb;
1893 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001894 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001895 goto out;
1896 memset(&msghdr, 0, sizeof(msghdr));
1897 /*
1898 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001899 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001900 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001901 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001902 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001903
Olivier Houchardf886e342017-04-05 22:24:59 +02001904 if (tot_fd_nb == 0)
1905 goto out;
1906
1907 /* First send the total number of file descriptors, so that the
1908 * receiving end knows what to expect.
1909 */
1910 msghdr.msg_iov = &iov;
1911 msghdr.msg_iovlen = 1;
1912 ret = sendmsg(fd, &msghdr, 0);
1913 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001914 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001915 goto out;
1916 }
1917
1918 /* Now send the fds */
1919 msghdr.msg_control = cmsgbuf;
1920 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1921 cmsg = CMSG_FIRSTHDR(&msghdr);
1922 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1923 cmsg->cmsg_level = SOL_SOCKET;
1924 cmsg->cmsg_type = SCM_RIGHTS;
1925 tmpfd = (int *)CMSG_DATA(cmsg);
1926
Olivier Houchardf886e342017-04-05 22:24:59 +02001927 /* For each socket, e message is sent, containing the following :
1928 * Size of the namespace name (or 0 if none), as an unsigned char.
1929 * The namespace name, if any
1930 * Size of the interface name (or 0 if none), as an unsigned char
1931 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001932 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001933 */
1934 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001935 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001936 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001937 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001938 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001939 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001940 goto out;
1941 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001942
1943 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001944 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001945 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001946 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001947 continue;
1948
1949 ns_name = if_name = "";
1950 ns_nlen = if_nlen = 0;
1951
1952 /* for now we can only retrieve namespaces and interfaces from
1953 * pure listeners.
1954 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001955 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001956 const struct listener *l = fdtab[cur_fd].owner;
1957
Willy Tarreau818a92e2020-09-03 07:50:19 +02001958 if (l->rx.settings->interface) {
1959 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001960 if_nlen = strlen(if_name);
1961 }
1962
1963#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001964 if (l->rx.settings->netns) {
1965 ns_name = l->rx.settings->netns->node.key;
1966 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001967 }
1968#endif
1969 }
1970
1971 /* put the FD into the CMSG_DATA */
1972 tmpfd[nb_queued++] = cur_fd;
1973
1974 /* first block is <ns_name_len> <ns_name> */
1975 tmpbuf[curoff++] = ns_nlen;
1976 if (ns_nlen)
1977 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1978 curoff += ns_nlen;
1979
1980 /* second block is <if_name_len> <if_name> */
1981 tmpbuf[curoff++] = if_nlen;
1982 if (if_nlen)
1983 memcpy(tmpbuf + curoff, if_name, if_nlen);
1984 curoff += if_nlen;
1985
1986 /* we used to send the listener options here before 2.3 */
1987 memset(tmpbuf + curoff, 0, sizeof(int));
1988 curoff += sizeof(int);
1989
1990 /* there's a limit to how many FDs may be sent at once */
1991 if (nb_queued == MAX_SEND_FD) {
1992 iov.iov_len = curoff;
1993 if (sendmsg(fd, &msghdr, 0) != curoff) {
1994 ha_warning("Failed to transfer sockets\n");
1995 return -1;
1996 }
1997
1998 /* Wait for an ack */
1999 do {
2000 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2001 } while (ret == -1 && errno == EINTR);
2002
2003 if (ret <= 0) {
2004 ha_warning("Unexpected error while transferring sockets\n");
2005 return -1;
2006 }
2007 curoff = 0;
2008 nb_queued = 0;
2009 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002010 }
2011
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002012 /* flush pending stuff */
2013 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002014 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002015 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2016 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002017 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002018 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002019 goto out;
2020 }
2021 }
2022
2023out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002024 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002025 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002026 goto out;
2027 }
2028 appctx->st0 = CLI_ST_END;
2029 free(cmsgbuf);
2030 free(tmpbuf);
2031 return 1;
2032}
2033
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002034static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2035{
2036 if (*args[0] == 'h')
2037 /* help */
Willy Tarreaub96a74c2021-03-12 17:13:28 +01002038 cli_gen_usage_msg(appctx, NULL);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002039 else if (*args[0] == 'p')
2040 /* prompt */
2041 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2042 else if (*args[0] == 'q')
2043 /* quit */
2044 appctx->st0 = CLI_ST_END;
2045
2046 return 1;
2047}
Olivier Houchardf886e342017-04-05 22:24:59 +02002048
William Lallemand2f4ce202018-10-26 14:47:47 +02002049void pcli_write_prompt(struct stream *s)
2050{
2051 struct buffer *msg = get_trash_chunk();
2052 struct channel *oc = si_oc(&s->si[0]);
2053
William Lallemanddc12c2e2018-12-13 09:05:46 +01002054 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002055 return;
2056
William Lallemanddc12c2e2018-12-13 09:05:46 +01002057 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002058 chunk_appendf(msg, "+ ");
2059 } else {
2060 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002061 chunk_appendf(msg, "master%s> ",
2062 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002063 else
2064 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2065 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002066 co_inject(oc, msg->area, msg->data);
2067}
2068
William Lallemand291810d2018-10-26 14:47:38 +02002069
William Lallemandcf62f7e2018-10-26 14:47:40 +02002070/* The pcli_* functions are used for the CLI proxy in the master */
2071
William Lallemanddeeaa592018-10-26 14:47:48 +02002072void pcli_reply_and_close(struct stream *s, const char *msg)
2073{
2074 struct buffer *buf = get_trash_chunk();
2075
2076 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002077 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002078}
2079
William Lallemand291810d2018-10-26 14:47:38 +02002080static enum obj_type *pcli_pid_to_server(int proc_pid)
2081{
2082 struct mworker_proc *child;
2083
William Lallemand99e0bb92020-11-05 10:28:53 +01002084 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002085 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002086 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002087
William Lallemand291810d2018-10-26 14:47:38 +02002088 list_for_each_entry(child, &proc_list, list) {
2089 if (child->pid == proc_pid){
2090 return &child->srv->obj_type;
2091 }
2092 }
2093 return NULL;
2094}
2095
2096/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2097 * Return:
2098 * 0: master
2099 * > 0: pid of a worker
2100 * < 0: didn't find a worker
2101 */
2102static int pcli_prefix_to_pid(const char *prefix)
2103{
2104 int proc_pid;
2105 struct mworker_proc *child;
2106 char *errtol = NULL;
2107
2108 if (*prefix != '@') /* not a prefix, should not happen */
2109 return -1;
2110
2111 prefix++;
2112 if (!*prefix) /* sent @ alone, return the master */
2113 return 0;
2114
2115 if (strcmp("master", prefix) == 0) {
2116 return 0;
2117 } else if (*prefix == '!') {
2118 prefix++;
2119 if (!*prefix)
2120 return -1;
2121
2122 proc_pid = strtol(prefix, &errtol, 10);
2123 if (*errtol != '\0')
2124 return -1;
2125 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002126 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002127 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002128 if (child->pid == proc_pid){
2129 return child->pid;
2130 }
2131 }
2132 } else {
2133 struct mworker_proc *chosen = NULL;
2134 /* this is a relative pid */
2135
2136 proc_pid = strtol(prefix, &errtol, 10);
2137 if (*errtol != '\0')
2138 return -1;
2139
2140 if (proc_pid == 0) /* return the master */
2141 return 0;
2142
2143 /* chose the right process, the current one is the one with the
2144 least number of reloads */
2145 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002146 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002147 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002148 if (child->relative_pid == proc_pid){
2149 if (child->reloads == 0)
2150 return child->pid;
2151 else if (chosen == NULL || child->reloads < chosen->reloads)
2152 chosen = child;
2153 }
2154 }
2155 if (chosen)
2156 return chosen->pid;
2157 }
2158 return -1;
2159}
2160
William Lallemandbddd33a2018-12-11 16:10:53 +01002161/* Return::
2162 * >= 0 : number of words to escape
2163 * = -1 : error
2164 */
2165
2166int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2167{
2168 if (argl < 1)
2169 return 0;
2170
2171 /* there is a prefix */
2172 if (args[0][0] == '@') {
2173 int target_pid = pcli_prefix_to_pid(args[0]);
2174
2175 if (target_pid == -1) {
2176 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2177 return -1;
2178 }
2179
2180 /* if the prefix is alone, define a default target */
2181 if (argl == 1)
2182 s->pcli_next_pid = target_pid;
2183 else
2184 *next_pid = target_pid;
2185 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002186 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002187 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002188 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002189
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002190 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002191 channel_shutr_now(&s->req);
2192 channel_shutw_now(&s->res);
2193 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002194 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002195 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2196 memprintf(errmsg, "Permission denied!\n");
2197 return -1;
2198 }
2199 s->pcli_flags &= ~ACCESS_LVL_MASK;
2200 s->pcli_flags |= ACCESS_LVL_OPER;
2201 return argl;
2202
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002203 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002204 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2205 memprintf(errmsg, "Permission denied!\n");
2206 return -1;
2207 }
2208 s->pcli_flags &= ~ACCESS_LVL_MASK;
2209 s->pcli_flags |= ACCESS_LVL_USER;
2210 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002211 }
2212
2213 return 0;
2214}
2215
2216/*
2217 * Parse the CLI request:
2218 * - It does basically the same as the cli_io_handler, but as a proxy
2219 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002220 *
2221 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002222 * - the number of characters to forward or
2223 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002224 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002225int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002226{
William Lallemandbddd33a2018-12-11 16:10:53 +01002227 char *str = (char *)ci_head(req);
2228 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002229 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002230 int argl; /* number of args */
2231 char *p;
2232 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002233 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002234 int wtrim = 0; /* number of words to trim */
2235 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002236 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002237 int i = 0;
2238
2239 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002240
William Lallemanddc12c2e2018-12-13 09:05:46 +01002241 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002242
2243 /* Looks for the end of one command */
2244 while (p+reql < end) {
2245 /* handle escaping */
2246 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002247 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002248 continue;
2249 }
2250 if (p[reql] == ';' || p[reql] == '\n') {
2251 /* found the end of the command */
2252 p[reql] = '\n';
2253 reql++;
2254 break;
2255 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002256 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002257 }
William Lallemandebf61802018-12-11 16:10:57 +01002258 } else {
2259 while (p+reql < end) {
2260 if (p[reql] == '\n') {
2261 /* found the end of the line */
2262 reql++;
2263 break;
2264 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002265 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002266 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002267 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002268
William Lallemandbddd33a2018-12-11 16:10:53 +01002269 /* set end to first byte after the end of the command */
2270 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002271
William Lallemandbddd33a2018-12-11 16:10:53 +01002272 /* there is no end to this command, need more to parse ! */
2273 if (*(end-1) != '\n') {
2274 return -1;
2275 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002276
William Lallemand3301f3e2018-12-13 09:05:48 +01002277 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2278 if (reql == 1) /* last line of the payload */
2279 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002280 return reql;
2281 }
2282
William Lallemandbddd33a2018-12-11 16:10:53 +01002283 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002284
William Lallemandbddd33a2018-12-11 16:10:53 +01002285 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002286 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002287 /* skip leading spaces/tabs */
2288 p += strspn(p, " \t");
2289 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002290 break;
2291
William Lallemandbddd33a2018-12-11 16:10:53 +01002292 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002293 while (1) {
2294 p += strcspn(p, " \t\\");
2295 /* escaped chars using backlashes (\) */
2296 if (*p == '\\') {
2297 if (!*++p)
2298 break;
2299 if (!*++p)
2300 break;
2301 } else {
2302 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002303 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002304 }
William Lallemandfe249c32020-06-18 18:03:57 +02002305 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002306 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002307 }
2308
William Lallemandbddd33a2018-12-11 16:10:53 +01002309 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002310
Willy Tarreauf14c7572021-03-13 10:59:23 +01002311 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002312 args[i] = NULL;
2313
2314 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2315
2316 /* End of words are ending by \0, we need to replace the \0s by spaces
23171 before forwarding them */
2318 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002319 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002320 if (*p == '\0')
2321 *p = ' ';
2322 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002323 }
2324
William Lallemand3301f3e2018-12-13 09:05:48 +01002325 payload = strstr(str, PAYLOAD_PATTERN);
2326 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2327 /* if the payload pattern is at the end */
2328 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002329 }
2330
William Lallemandbddd33a2018-12-11 16:10:53 +01002331 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002332
William Lallemandbddd33a2018-12-11 16:10:53 +01002333 if (wtrim > 0) {
2334 trim = &args[wtrim][0];
2335 if (trim == NULL) /* if this was the last word in the table */
2336 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002337
William Lallemandbddd33a2018-12-11 16:10:53 +01002338 b_del(&req->buf, trim - str);
2339
William Lallemandb7ea1412018-12-13 09:05:47 +01002340 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002341 } else if (wtrim < 0) {
2342 /* parsing error */
2343 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002344 } else {
2345 /* the whole string */
2346 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002347 }
2348
William Lallemandb7ea1412018-12-13 09:05:47 +01002349 if (ret > 1) {
2350 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2351 goto end;
2352 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002353 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2354 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002355 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002356 ci_insert_line2(req, 0, "user -", strlen("user -"));
2357 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002358 }
2359 }
2360end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002361
William Lallemandb7ea1412018-12-13 09:05:47 +01002362 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002363}
2364
2365int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2366{
William Lallemandbddd33a2018-12-11 16:10:53 +01002367 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002368 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002369 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002370
William Lallemandb7ea1412018-12-13 09:05:47 +01002371 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2372 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2373
William Lallemandcf62f7e2018-10-26 14:47:40 +02002374read_again:
2375 /* if the channel is closed for read, we won't receive any more data
2376 from the client, but we don't want to forward this close to the
2377 server */
2378 channel_dont_close(req);
2379
2380 /* We don't know yet to which server we will connect */
2381 channel_dont_connect(req);
2382
2383
2384 /* we are not waiting for a response, there is no more request and we
2385 * receive a close from the client, we can leave */
2386 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2387 channel_shutw_now(&s->res);
2388 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2389 return 1;
2390 }
2391
2392 req->flags |= CF_READ_DONTWAIT;
2393
2394 /* need more data */
2395 if (!ci_data(req))
2396 return 0;
2397
2398 /* If there is data available for analysis, log the end of the idle time. */
2399 if (c_data(req) && s->logs.t_idle == -1)
2400 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2401
William Lallemandbddd33a2018-12-11 16:10:53 +01002402 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002403 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002404 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002405 /* enough data */
2406
William Lallemandcf62f7e2018-10-26 14:47:40 +02002407 /* forward only 1 command */
2408 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002409
William Lallemanddc12c2e2018-12-13 09:05:46 +01002410 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002411 /* we send only 1 command per request, and we write close after it */
2412 channel_shutw_now(req);
2413 } else {
2414 pcli_write_prompt(s);
2415 }
2416
2417 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002418
2419 /* remove the XFER_DATA analysers, which forwards all
2420 * the data, we don't want to forward the next requests
2421 * We need to add CF_FLT_ANALYZE to abort the forward too.
2422 */
2423 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2424 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2425 s->res.analysers |= AN_RES_WAIT_CLI;
2426
William Lallemandebf61802018-12-11 16:10:57 +01002427 if (!(s->flags & SF_ASSIGNED)) {
2428 if (next_pid > -1)
2429 target_pid = next_pid;
2430 else
2431 target_pid = s->pcli_next_pid;
2432 /* we can connect now */
2433 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434
William Lallemandebf61802018-12-11 16:10:57 +01002435 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2436 channel_auto_connect(req);
2437 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002438
2439 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002440 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002441 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002442 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002443 } else if (to_forward == -1 && errmsg) {
2444 /* there was an error during the parsing */
2445 pcli_reply_and_close(s, errmsg);
2446 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2448 /* buffer is full and we didn't catch the end of a command */
2449 goto send_help;
2450 }
2451
2452 return 0;
2453
2454send_help:
2455 b_reset(&req->buf);
2456 b_putblk(&req->buf, "help\n", 5);
2457 goto read_again;
2458}
2459
2460int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2461{
2462 struct proxy *fe = strm_fe(s);
2463 struct proxy *be = s->be;
2464
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002465 if (rep->flags & CF_READ_ERROR) {
2466 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2467 s->res.analysers &= ~AN_RES_WAIT_CLI;
2468 return 0;
2469 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002470 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2471 rep->flags |= CF_NEVER_WAIT;
2472
2473 /* don't forward the close */
2474 channel_dont_close(&s->res);
2475 channel_dont_close(&s->req);
2476
William Lallemanddc12c2e2018-12-13 09:05:46 +01002477 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002478 s->req.analysers |= AN_REQ_WAIT_CLI;
2479 s->res.analysers &= ~AN_RES_WAIT_CLI;
2480 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2481 return 0;
2482 }
2483
William Lallemandcf62f7e2018-10-26 14:47:40 +02002484 /* forward the data */
2485 if (ci_data(rep)) {
2486 c_adv(rep, ci_data(rep));
2487 return 0;
2488 }
2489
2490 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2491 /* stream cleanup */
2492
William Lallemand2f4ce202018-10-26 14:47:47 +02002493 pcli_write_prompt(s);
2494
William Lallemandcf62f7e2018-10-26 14:47:40 +02002495 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2496 si_shutr(&s->si[1]);
2497 si_shutw(&s->si[1]);
2498
2499 /*
2500 * starting from there this the same code as
2501 * http_end_txn_clean_session().
2502 *
2503 * It allows to do frontend keepalive while reconnecting to a
2504 * new server for each request.
2505 */
2506
2507 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002508 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002509 if (unlikely(s->srv_conn))
2510 sess_change_server(s, NULL);
2511 }
2512
2513 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2514 stream_process_counters(s);
2515
2516 /* don't count other requests' data */
2517 s->logs.bytes_in -= ci_data(&s->req);
2518 s->logs.bytes_out -= ci_data(&s->res);
2519
2520 /* we may need to know the position in the queue */
2521 pendconn_free(s);
2522
2523 /* let's do a final log if we need it */
2524 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2525 !(s->flags & SF_MONITOR) &&
2526 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2527 s->do_log(s);
2528 }
2529
2530 /* stop tracking content-based counters */
2531 stream_stop_content_counters(s);
2532 stream_update_time_stats(s);
2533
2534 s->logs.accept_date = date; /* user-visible date for logging */
2535 s->logs.tv_accept = now; /* corrected date for internal use */
2536 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2537 s->logs.t_idle = -1;
2538 tv_zero(&s->logs.tv_request);
2539 s->logs.t_queue = -1;
2540 s->logs.t_connect = -1;
2541 s->logs.t_data = -1;
2542 s->logs.t_close = 0;
2543 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2544 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2545
2546 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2547 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2548
2549 stream_del_srv_conn(s);
2550 if (objt_server(s->target)) {
2551 if (s->flags & SF_CURR_SESS) {
2552 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002553 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002554 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002555 if (may_dequeue_tasks(__objt_server(s->target), be))
2556 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002557 }
2558
2559 s->target = NULL;
2560
2561 /* only release our endpoint if we don't intend to reuse the
2562 * connection.
2563 */
2564 if (!si_conn_ready(&s->si[1])) {
2565 si_release_endpoint(&s->si[1]);
2566 s->srv_conn = NULL;
2567 }
2568
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002569 sockaddr_free(&s->target_addr);
2570
William Lallemandcf62f7e2018-10-26 14:47:40 +02002571 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2572 s->si[1].err_type = SI_ET_NONE;
2573 s->si[1].conn_retries = 0; /* used for logging too */
2574 s->si[1].exp = TICK_ETERNITY;
2575 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 +02002576 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 +02002577 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 +02002578 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2579 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2580 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2581 /* reinitialise the current rule list pointer to NULL. We are sure that
2582 * any rulelist match the NULL pointer.
2583 */
2584 s->current_rule_list = NULL;
2585
2586 s->be = strm_fe(s);
2587 s->logs.logwait = strm_fe(s)->to_log;
2588 s->logs.level = 0;
2589 stream_del_srv_conn(s);
2590 s->target = NULL;
2591 /* re-init store persistence */
2592 s->store_count = 0;
2593 s->uniq_id = global.req_count++;
2594
2595 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2596
2597 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2598
2599 s->req.analysers |= AN_REQ_WAIT_CLI;
2600 s->res.analysers &= ~AN_RES_WAIT_CLI;
2601
2602 /* We must trim any excess data from the response buffer, because we
2603 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002604 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002605 * we want those data to come along with next response. A typical
2606 * example of such data would be from a buggy server responding to
2607 * a HEAD with some data, or sending more than the advertised
2608 * content-length.
2609 */
2610 if (unlikely(ci_data(&s->res)))
2611 b_set_data(&s->res.buf, co_data(&s->res));
2612
2613 /* Now we can realign the response buffer */
2614 c_realign_if_empty(&s->res);
2615
2616 s->req.rto = strm_fe(s)->timeout.client;
2617 s->req.wto = TICK_ETERNITY;
2618
2619 s->res.rto = TICK_ETERNITY;
2620 s->res.wto = strm_fe(s)->timeout.client;
2621
2622 s->req.rex = TICK_ETERNITY;
2623 s->req.wex = TICK_ETERNITY;
2624 s->req.analyse_exp = TICK_ETERNITY;
2625 s->res.rex = TICK_ETERNITY;
2626 s->res.wex = TICK_ETERNITY;
2627 s->res.analyse_exp = TICK_ETERNITY;
2628 s->si[1].hcto = TICK_ETERNITY;
2629
2630 /* we're removing the analysers, we MUST re-enable events detection.
2631 * We don't enable close on the response channel since it's either
2632 * already closed, or in keep-alive with an idle connection handler.
2633 */
2634 channel_auto_read(&s->req);
2635 channel_auto_close(&s->req);
2636 channel_auto_read(&s->res);
2637
2638
2639 return 1;
2640 }
2641 return 0;
2642}
2643
William Lallemand8a022572018-10-26 14:47:35 +02002644/*
2645 * The mworker functions are used to initialize the CLI in the master process
2646 */
2647
William Lallemand309dc9a2018-10-26 14:47:45 +02002648 /*
2649 * Stop the mworker proxy
2650 */
2651void mworker_cli_proxy_stop()
2652{
William Lallemand550db6d2018-11-06 17:37:12 +01002653 if (mworker_proxy)
2654 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002655}
2656
William Lallemand8a022572018-10-26 14:47:35 +02002657/*
2658 * Create the mworker CLI proxy
2659 */
2660int mworker_cli_proxy_create()
2661{
2662 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002663 char *msg = NULL;
2664 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002665
2666 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2667 if (!mworker_proxy)
2668 return -1;
2669
2670 init_new_proxy(mworker_proxy);
2671 mworker_proxy->next = proxies_list;
2672 proxies_list = mworker_proxy;
2673 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002674 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002675 mworker_proxy->last_change = now.tv_sec;
2676 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2677 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2678 mworker_proxy->timeout.client = 0; /* no timeout */
2679 mworker_proxy->conf.file = strdup("MASTER");
2680 mworker_proxy->conf.line = 0;
2681 mworker_proxy->accept = frontend_accept;
2682 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2683
2684 /* Does not init the default target the CLI applet, but must be done in
2685 * the request parsing code */
2686 mworker_proxy->default_target = NULL;
2687
2688 /* the check_config_validity() will get an ID for the proxy */
2689 mworker_proxy->uuid = -1;
2690
2691 proxy_store_name(mworker_proxy);
2692
2693 /* create all servers using the mworker_proc list */
2694 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002695 struct server *newsrv = NULL;
2696 struct sockaddr_storage *sk;
2697 int port1, port2, port;
2698 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002699
William Lallemanda31b09e2020-01-14 15:25:02 +01002700 /* only the workers support the master CLI */
2701 if (!(child->options & PROC_O_TYPE_WORKER))
2702 continue;
2703
William Lallemand8a022572018-10-26 14:47:35 +02002704 newsrv = new_server(mworker_proxy);
2705 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002706 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002707
2708 /* we don't know the new pid yet */
2709 if (child->pid == -1)
2710 memprintf(&msg, "cur-%d", child->relative_pid);
2711 else
2712 memprintf(&msg, "old-%d", child->pid);
2713
2714 newsrv->next = mworker_proxy->srv;
2715 mworker_proxy->srv = newsrv;
2716 newsrv->conf.file = strdup(msg);
2717 newsrv->id = strdup(msg);
2718 newsrv->conf.line = 0;
2719
2720 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002721 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002722 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002723 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002724 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002725 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002726
Willy Tarreau5fc93282020-09-16 18:25:03 +02002727 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002728 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002729 }
2730
2731 /* no port specified */
2732 newsrv->flags |= SRV_F_MAPPORTS;
2733 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002734 /* don't let the server participate to load balancing */
2735 newsrv->iweight = 0;
2736 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002737 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002738
2739 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002740 }
2741 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002742
2743error:
2744 ha_alert("%s\n", errmsg);
2745
2746 list_for_each_entry(child, &proc_list, list) {
2747 free((char *)child->srv->conf.file); /* cast because of const char * */
2748 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002749 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002750 }
2751 free(mworker_proxy->id);
2752 free(mworker_proxy->conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002753 ha_free(&mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002754 free(errmsg);
2755 free(msg);
2756
2757 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002758}
Olivier Houchardf886e342017-04-05 22:24:59 +02002759
William Lallemandce83b4a2018-10-26 14:47:30 +02002760/*
William Lallemande7361152018-10-26 14:47:36 +02002761 * Create a new listener for the master CLI proxy
2762 */
2763int mworker_cli_proxy_new_listener(char *line)
2764{
2765 struct bind_conf *bind_conf;
2766 struct listener *l;
2767 char *err = NULL;
2768 char *args[MAX_LINE_ARGS + 1];
2769 int arg;
2770 int cur_arg;
2771
William Lallemand2e945c82019-11-25 09:58:37 +01002772 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002773 args[0] = line;
2774
2775 /* args is a bind configuration with spaces replaced by commas */
2776 while (*line && arg < MAX_LINE_ARGS) {
2777
2778 if (*line == ',') {
2779 *line++ = '\0';
2780 while (*line == ',')
2781 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002782 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002783 }
2784 line++;
2785 }
2786
William Lallemand2e945c82019-11-25 09:58:37 +01002787 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002788
2789 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002790 if (!bind_conf)
2791 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002792
2793 bind_conf->level &= ~ACCESS_LVL_MASK;
2794 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002795 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002796
2797 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2798 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002799 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002800 }
2801
2802 cur_arg = 1;
2803
2804 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002805 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002806 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002807
2808 kw = bind_find_kw(args[cur_arg]);
2809 if (kw) {
2810 if (!kw->parse) {
2811 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2812 args[0], args[1], args[cur_arg]);
2813 goto err;
2814 }
2815
Willy Tarreau4975d142021-03-13 11:00:33 +01002816 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002817 if (err)
2818 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2819 else
2820 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2821 args[0], args[1], args[cur_arg]);
2822 goto err;
2823 }
2824
2825 cur_arg += 1 + kw->skip;
2826 continue;
2827 }
2828
Willy Tarreau433b05f2021-03-12 10:14:07 +01002829 best = bind_find_best_kw(args[cur_arg]);
2830 if (best)
2831 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2832 args[0], args[1], args[cur_arg], best);
2833 else
2834 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2835 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002836 goto err;
2837 }
2838
2839
2840 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002841 l->accept = session_accept_fd;
2842 l->default_target = mworker_proxy->default_target;
2843 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002844 l->options |= LI_O_UNLIMITED;
2845 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002846 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002847 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002848 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002849 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002850
2851 return 0;
2852
2853err:
2854 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002855 free(err);
2856 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002857 return -1;
2858
2859}
2860
2861/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002862 * Create a new CLI socket using a socketpair for a worker process
2863 * <mworker_proc> is the process structure, and <proc> is the process number
2864 */
2865int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2866{
2867 struct bind_conf *bind_conf;
2868 struct listener *l;
2869 char *path = NULL;
2870 char *err = NULL;
2871
2872 /* master pipe to ensure the master is still alive */
2873 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2874 ha_alert("Cannot create worker socketpair.\n");
2875 return -1;
2876 }
2877
2878 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002879 if (!global.cli_fe) {
2880 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002881 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002882 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002883 }
2884 }
2885
Willy Tarreau4975d142021-03-13 11:00:33 +01002886 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002887 if (!bind_conf)
2888 goto error;
2889
William Lallemandce83b4a2018-10-26 14:47:30 +02002890 bind_conf->level &= ~ACCESS_LVL_MASK;
2891 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2892
Willy Tarreaue26993c2020-09-03 07:18:55 +02002893 bind_conf->settings.bind_proc = 1UL << proc;
Willy Tarreau4975d142021-03-13 11:00:33 +01002894 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 +02002895
2896 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2897 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002898 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002899 }
2900
Willy Tarreau4975d142021-03-13 11:00:33 +01002901 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002902 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002903 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002904 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002905 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002906 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002907
2908 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002909 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002910 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002911 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002912 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002913 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002914 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002915 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002916 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002917 }
2918
2919 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002920
2921error:
2922 close(mworker_proc->ipc_fd[0]);
2923 close(mworker_proc->ipc_fd[1]);
2924 free(err);
2925
2926 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002927}
2928
William Lallemand74c24fb2016-11-21 17:18:36 +01002929static struct applet cli_applet = {
2930 .obj_type = OBJ_TYPE_APPLET,
2931 .name = "<CLI>", /* used for logging */
2932 .fct = cli_io_handler,
2933 .release = cli_release_handler,
2934};
2935
William Lallemand99e0bb92020-11-05 10:28:53 +01002936/* master CLI */
2937static struct applet mcli_applet = {
2938 .obj_type = OBJ_TYPE_APPLET,
2939 .name = "<MCLI>", /* used for logging */
2940 .fct = cli_io_handler,
2941 .release = cli_release_handler,
2942};
2943
Willy Tarreau0a739292016-11-22 20:21:23 +01002944/* register cli keywords */
2945static struct cli_kw_list cli_kws = {{ },{
Willy Tarreau0609c9b2021-03-12 17:03:33 +01002946 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2947 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2948 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
Willy Tarreau2af99412016-11-23 11:10:59 +01002949 { { "set", "maxconn", "global", NULL }, "set maxconn global : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
Willy Tarreau45c742b2016-11-24 14:51:17 +01002950 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002951 { { "set", "severity-output", NULL }, "set severity-output [none|number|string] : set presence of severity level in feedback information", cli_parse_set_severity_output, NULL, NULL },
Willy Tarreau599852e2016-11-22 20:33:32 +01002952 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002953 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
William Lallemand35851fb2018-10-26 14:47:42 +02002954 { { "show", "cli", "sockets", NULL }, "show cli sockets : dump list of cli sockets", cli_parse_default, cli_io_handler_show_cli_sock, NULL, NULL, ACCESS_MASTER },
William Lallemand67a234f2018-12-13 09:05:45 +01002955 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02002956 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01002957 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemand67a234f2018-12-13 09:05:45 +01002958 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2959 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Olivier Houchardf886e342017-04-05 22:24:59 +02002960 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01002961 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2962 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002963 {{},}
2964}};
2965
Willy Tarreau0108d902018-11-25 19:14:37 +01002966INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2967
William Lallemand74c24fb2016-11-21 17:18:36 +01002968static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002969 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002970 { 0, NULL, NULL },
2971}};
2972
Willy Tarreau0108d902018-11-25 19:14:37 +01002973INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2974
William Lallemand74c24fb2016-11-21 17:18:36 +01002975static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002976 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2977 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002978 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002979 { NULL, NULL, 0 },
2980}};
2981
Willy Tarreau0108d902018-11-25 19:14:37 +01002982INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002983
2984/*
2985 * Local variables:
2986 * c-indent-level: 8
2987 * c-basic-offset: 8
2988 * End:
2989 */