blob: 2e4da522fd34484637dca1dad3b86e7e19722446 [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{
341 LIST_ADDQ(&cli_keywords.list, &kw_list->list);
342}
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));
William Lallemand07a62f72017-05-24 00:57:40 +0200404 bind_conf->level &= ~ACCESS_LVL_MASK;
405 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100406
Willy Tarreau4975d142021-03-13 11:00:33 +0100407 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100408 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
409 file, line, args[0], args[1], err && *err ? *err : "error");
410 return -1;
411 }
412
413 cur_arg = 3;
414 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100415 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100416 const char *best;
William Lallemand74c24fb2016-11-21 17:18:36 +0100417
418 kw = bind_find_kw(args[cur_arg]);
419 if (kw) {
420 if (!kw->parse) {
421 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
422 args[0], args[1], args[cur_arg]);
423 return -1;
424 }
425
Willy Tarreau4975d142021-03-13 11:00:33 +0100426 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, err) != 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100427 if (err && *err)
428 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
429 else
430 memprintf(err, "'%s %s' : error encountered while processing '%s'",
431 args[0], args[1], args[cur_arg]);
432 return -1;
433 }
434
435 cur_arg += 1 + kw->skip;
436 continue;
437 }
438
Willy Tarreau433b05f2021-03-12 10:14:07 +0100439 best = bind_find_best_kw(args[cur_arg]);
440 if (best)
441 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
442 args[0], args[1], args[cur_arg], best);
443 else
444 memprintf(err, "'%s %s' : unknown keyword '%s'.",
445 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100446 return -1;
447 }
448
449 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100450 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100451 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100452 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
453 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100454 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100455 }
456 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100457 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100458 unsigned timeout;
459 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
460
Willy Tarreau9faebe32019-06-07 19:00:37 +0200461 if (res == PARSE_TIME_OVER) {
462 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
463 args[2], args[0], args[1]);
464 return -1;
465 }
466 else if (res == PARSE_TIME_UNDER) {
467 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
468 args[2], args[0], args[1]);
469 return -1;
470 }
471 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100472 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
473 return -1;
474 }
475
476 if (!timeout) {
477 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
478 return -1;
479 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100480 if (!global.cli_fe) {
481 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100482 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
483 return -1;
484 }
485 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100486 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100487 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100488 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100489 int maxconn = atol(args[2]);
490
491 if (maxconn <= 0) {
492 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
493 return -1;
494 }
495
Willy Tarreau4975d142021-03-13 11:00:33 +0100496 if (!global.cli_fe) {
497 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100498 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
499 return -1;
500 }
501 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100502 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100503 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100504 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100505 int cur_arg = 2;
506 unsigned long set = 0;
507
Willy Tarreau4975d142021-03-13 11:00:33 +0100508 if (!global.cli_fe) {
509 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100510 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
511 return -1;
512 }
513 }
514
515 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100516 if (strcmp(args[cur_arg], "all") == 0) {
517 set = 0;
518 break;
519 }
Willy Tarreauff9c9142019-02-07 10:39:36 +0100520 if (parse_process_number(args[cur_arg], &set, MAX_PROCS, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100521 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100522 return -1;
523 }
524 cur_arg++;
525 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100526 global.cli_fe->bind_proc = set;
William Lallemand74c24fb2016-11-21 17:18:36 +0100527 }
528 else {
529 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
530 return -1;
531 }
532 return 0;
533}
534
William Lallemand33d29e22019-04-01 11:30:06 +0200535/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200536 * This function exports the bound addresses of a <frontend> in the environment
537 * variable <varname>. Those addresses are separated by semicolons and prefixed
538 * with their type (abns@, unix@, sockpair@ etc)
539 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200540 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200541int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200542{
543 struct buffer *trash = get_trash_chunk();
544 struct bind_conf *bind_conf;
545
William Lallemand9a37fd02019-04-12 16:09:24 +0200546 if (frontend) {
547 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200548 struct listener *l;
549
550 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
551 char addr[46];
552 char port[6];
553
William Lallemand620072b2019-04-12 16:09:25 +0200554 /* separate listener by semicolons */
555 if (trash->data)
556 chunk_appendf(trash, ";");
557
Willy Tarreau37159062020-08-27 07:48:42 +0200558 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200559 const struct sockaddr_un *un;
560
Willy Tarreau37159062020-08-27 07:48:42 +0200561 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200562 if (un->sun_path[0] == '\0') {
563 chunk_appendf(trash, "abns@%s", un->sun_path+1);
564 } else {
565 chunk_appendf(trash, "unix@%s", un->sun_path);
566 }
Willy Tarreau37159062020-08-27 07:48:42 +0200567 } else if (l->rx.addr.ss_family == AF_INET) {
568 addr_to_str(&l->rx.addr, addr, sizeof(addr));
569 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200570 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200571 } else if (l->rx.addr.ss_family == AF_INET6) {
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, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200575 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
576 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200577 }
William Lallemand33d29e22019-04-01 11:30:06 +0200578 }
579 }
580 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200581 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200582 return -1;
583 }
584
585 return 0;
586}
587
William Lallemand9a37fd02019-04-12 16:09:24 +0200588int cli_socket_setenv()
589{
Willy Tarreau4975d142021-03-13 11:00:33 +0100590 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200591 return -1;
592 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
593 return -1;
594
595 return 0;
596}
597
William Lallemand33d29e22019-04-01 11:30:06 +0200598REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
599
Willy Tarreaude57a572016-11-23 17:01:39 +0100600/* Verifies that the CLI at least has a level at least as high as <level>
601 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
602 * failure, an error message is prepared and the appctx's state is adjusted
603 * to print it so that a return 1 is enough to abort any processing.
604 */
605int cli_has_level(struct appctx *appctx, int level)
606{
Willy Tarreaude57a572016-11-23 17:01:39 +0100607
William Lallemandf630d012018-12-13 09:05:44 +0100608 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100609 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100610 return 0;
611 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100612 return 1;
613}
614
William Lallemandb7ea1412018-12-13 09:05:47 +0100615/* same as cli_has_level but for the CLI proxy and without error message */
616int pcli_has_level(struct stream *s, int level)
617{
618 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
619 return 0;
620 }
621 return 1;
622}
623
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200624/* Returns severity_output for the current session if set, or default for the socket */
625static int cli_get_severity_output(struct appctx *appctx)
626{
627 if (appctx->cli_severity_output)
628 return appctx->cli_severity_output;
629 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
630}
William Lallemand74c24fb2016-11-21 17:18:36 +0100631
Willy Tarreau41908562016-11-24 16:23:38 +0100632/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100633 * from the CLI's IO handler running in an appctx context. The function returns
634 * 1 if the request was understood, otherwise zero (in which case an error
635 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100636 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
637 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
638 * have its own I/O handler called again. Most of the time, parsers will only
639 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100640 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
641 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100642 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200643static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100644{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100645 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200646 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100647 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100648
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200649 appctx->st2 = 0;
650 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100651
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200652 p = appctx->chunk->area;
653 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100654
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200655 /*
656 * Get the payload start if there is one.
657 * For the sake of simplicity, the payload pattern is looked up
658 * everywhere from the start of the input but it can only be found
659 * at the end of the first line if APPCTX_CLI_ST1_PAYLOAD is set.
660 *
661 * The input string was zero terminated so it is safe to use
662 * the str*() functions throughout the parsing
663 */
664 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
665 payload = strstr(p, PAYLOAD_PATTERN);
666 end = payload;
667 /* skip the pattern */
668 payload += strlen(PAYLOAD_PATTERN);
669 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100670
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200671 /*
672 * Get pointers on words.
673 * One extra slot is reserved to store a pointer on a null byte.
674 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100675 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200676 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100677
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200678 /* skip leading spaces/tabs */
679 p += strspn(p, " \t");
680 if (!*p)
681 break;
William Lallemand74c24fb2016-11-21 17:18:36 +0100682
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200683 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200684 while (1) {
685 p += strcspn(p, " \t\\");
686 /* escaped chars using backlashes (\) */
687 if (*p == '\\') {
688 if (!*++p)
689 break;
690 if (!*++p)
691 break;
692 } else {
693 break;
694 }
695 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200696 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100697
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200698 /* unescape backslashes (\) */
699 for (j = 0, k = 0; args[i][k]; k++) {
700 if (args[i][k] == '\\') {
701 if (args[i][k + 1] == '\\')
702 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100703 else
704 continue;
705 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200706 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100707 j++;
708 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200709 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100710
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200711 i++;
712 }
713 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200714 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100715 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200716 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100717
718 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100719 if (!kw ||
720 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
721 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
722 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100723 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100724 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100725 }
William Lallemand14721be2018-10-26 14:47:37 +0200726
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100727 /* don't handle expert mode commands if not in this mode. */
728 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
729 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200730 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100731 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200732
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100733 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
734 cli_err(appctx, "This command is restricted to experimental mode only.\n");
735 return 0;
736 }
737
Willy Tarreau41908562016-11-24 16:23:38 +0100738 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200739 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200740
741 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
742 goto fail;
743
744 /* kw->parse could set its own io_handler or io_release handler */
745 if (!appctx->io_handler)
746 goto fail;
747
748 appctx->st0 = CLI_ST_CALLBACK;
749 return 1;
750fail:
751 appctx->io_handler = NULL;
752 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100753 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100754}
755
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200756/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
757static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
758{
Willy Tarreau83061a82018-07-13 11:56:34 +0200759 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200760
761 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200762 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200763
764 tmp = get_trash_chunk();
765 chunk_reset(tmp);
766
767 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100768 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200769 chunk_printf(tmp, "[%d]: ", severity);
770 }
771 else {
772 switch (severity_output) {
773 case CLI_SEVERITY_NUMBER:
774 chunk_printf(tmp, "[%d]: ", severity);
775 break;
776 case CLI_SEVERITY_STRING:
777 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
778 break;
779 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100780 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200781 }
782 }
783 chunk_appendf(tmp, "%s", msg);
784
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200785 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200786}
787
William Lallemand74c24fb2016-11-21 17:18:36 +0100788/* This I/O handler runs as an applet embedded in a stream interface. It is
789 * used to processes I/O from/to the stats unix socket. The system relies on a
790 * state machine handling requests and various responses. We read a request,
791 * then we process it and send the response, and we possibly display a prompt.
792 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100793 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100794 * or not.
795 */
796static void cli_io_handler(struct appctx *appctx)
797{
798 struct stream_interface *si = appctx->owner;
799 struct channel *req = si_oc(si);
800 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200801 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100802 int reql;
803 int len;
804
805 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
806 goto out;
807
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800808 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200809 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100810 /* buf.size==0 means we failed to get a buffer and were
811 * already subscribed to a wait list to get a buffer.
812 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100813 goto out;
814 }
815
William Lallemand74c24fb2016-11-21 17:18:36 +0100816 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100817 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100818 /* Stats output not initialized yet */
819 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200820 /* reset severity to default at init */
821 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100822 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100823 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100824 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100825 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100826 /* Let's close for real now. We just close the request
827 * side, the conditions below will complete if needed.
828 */
829 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200830 free_trash_chunk(appctx->chunk);
William Lallemand74c24fb2016-11-21 17:18:36 +0100831 break;
832 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100833 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200834 char *str;
835
836 /* use a trash chunk to store received data */
837 if (!appctx->chunk) {
838 appctx->chunk = alloc_trash_chunk();
839 if (!appctx->chunk) {
840 appctx->st0 = CLI_ST_END;
841 continue;
842 }
843 }
844
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200845 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200846
William Lallemand74c24fb2016-11-21 17:18:36 +0100847 /* ensure we have some output room left in the event we
848 * would want to return some info right after parsing.
849 */
850 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100851 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100852 break;
853 }
854
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200855 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200856 reql = co_getline(si_oc(si), str,
857 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100858 if (reql <= 0) { /* closed or EOL not found */
859 if (reql == 0)
860 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100861 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100862 continue;
863 }
864
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200865 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
866 /* seek for a possible unescaped semi-colon. If we find
867 * one, we replace it with an LF and skip only this part.
868 */
869 for (len = 0; len < reql; len++) {
870 if (str[len] == '\\') {
871 len++;
872 continue;
873 }
874 if (str[len] == ';') {
875 str[len] = '\n';
876 reql = len + 1;
877 break;
878 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100879 }
880 }
881
882 /* now it is time to check that we have a full line,
883 * remove the trailing \n and possibly \r, then cut the
884 * line.
885 */
886 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200887 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100888 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100889 continue;
890 }
891
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200892 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100893 len--;
894
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200895 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200896 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200897
898 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200899 appctx->chunk->area[appctx->chunk->data] = '\n';
900 appctx->chunk->area[appctx->chunk->data + 1] = 0;
901 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200902 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100903
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100904 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200905
906 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
907 /* empty line */
908 if (!len) {
909 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200910 appctx->chunk->data -= 2;
911 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100912 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200913 chunk_reset(appctx->chunk);
914 /* NB: cli_sock_parse_request() may have put
915 * another CLI_ST_O_* into appctx->st0.
916 */
917
918 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100919 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100920 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200921 else {
922 /*
923 * Look for the "payload start" pattern at the end of a line
924 * Its location is not remembered here, this is just to switch
925 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100926 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100927 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200928 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200929 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200930 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100931 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200932 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200933 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100934 }
935
936 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200937 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100938 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
939 }
940 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200941 const char *msg;
942 int sev;
943
William Lallemand74c24fb2016-11-21 17:18:36 +0100944 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100945 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100946 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200947 case CLI_ST_PRINT: /* print const message in msg */
948 case CLI_ST_PRINT_ERR: /* print const error in msg */
949 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
950 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
951 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
952 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
953 LOG_ERR : appctx->ctx.cli.severity;
954 msg = appctx->ctx.cli.msg;
955 }
956 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
957 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
958 LOG_ERR : appctx->ctx.cli.severity;
959 msg = appctx->ctx.cli.err;
960 if (!msg) {
961 sev = LOG_ERR;
962 msg = "Out of memory.\n";
963 }
964 }
965 else {
966 sev = LOG_ERR;
967 msg = "Internal error.\n";
968 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +0200969
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200970 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
971 if (appctx->st0 == CLI_ST_PRINT_FREE ||
972 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100973 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200974 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100975 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100976 }
977 else
Willy Tarreaudb398432018-11-15 11:08:52 +0100978 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100979 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200980
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100981 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +0100982 if (appctx->io_handler)
983 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100984 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100985 if (appctx->io_release) {
986 appctx->io_release(appctx);
987 appctx->io_release = NULL;
988 }
989 }
990 break;
991 default: /* abnormal state */
992 si->flags |= SI_FL_ERR;
993 break;
994 }
995
996 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100997 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200998 const char *prompt = "";
999
1000 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1001 /*
1002 * when entering a payload with interactive mode, change the prompt
1003 * to emphasize that more data can still be sent
1004 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001005 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001006 prompt = "+ ";
1007 else
1008 prompt = "\n> ";
1009 }
1010 else {
William Lallemandad032882019-07-01 10:56:15 +02001011 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001012 prompt = "\n";
1013 }
1014
1015 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001016 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001017 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001018 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001019 }
1020
1021 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001022 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001023 break;
1024
1025 /* Now we close the output if one of the writers did so,
1026 * or if we're not in interactive mode and the request
1027 * buffer is empty. This still allows pipelined requests
1028 * to be sent in non-interactive mode.
1029 */
William Lallemand3de09d52018-12-11 16:10:56 +01001030 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1031 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001032 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001033 continue;
1034 }
1035
1036 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001037 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001038 /* reactivate the \n at the end of the response for the next command */
1039 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
William Lallemand74c24fb2016-11-21 17:18:36 +01001040 }
1041 }
1042
1043 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1044 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1045 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1046 /* Other side has closed, let's abort if we have no more processing to do
1047 * and nothing more to consume. This is comparable to a broken pipe, so
1048 * we forward the close to the request side so that it flows upstream to
1049 * the client.
1050 */
1051 si_shutw(si);
1052 }
1053
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001054 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001055 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1056 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1057 /* We have no more processing to do, and nothing more to send, and
1058 * the client side has closed. So we'll forward this state downstream
1059 * on the response buffer.
1060 */
1061 si_shutr(si);
1062 res->flags |= CF_READ_NULL;
1063 }
1064
1065 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001066 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 +01001067 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001068 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 +01001069}
1070
William Lallemand74c24fb2016-11-21 17:18:36 +01001071/* This is called when the stream interface is closed. For instance, upon an
1072 * external abort, we won't call the i/o handler anymore so we may need to
1073 * remove back references to the stream currently being dumped.
1074 */
1075static void cli_release_handler(struct appctx *appctx)
1076{
1077 if (appctx->io_release) {
1078 appctx->io_release(appctx);
1079 appctx->io_release = NULL;
1080 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001081 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001082 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001083 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001084}
1085
1086/* This function dumps all environmnent variables to the buffer. It returns 0
1087 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001088 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1089 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001090 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001091static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001092{
Willy Tarreau0a739292016-11-22 20:21:23 +01001093 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001094 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001095
1096 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1097 return 1;
1098
1099 chunk_reset(&trash);
1100
1101 /* we have two inner loops here, one for the proxy, the other one for
1102 * the buffer.
1103 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001104 while (*var) {
1105 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001106
Willy Tarreau06d80a92017-10-19 14:32:15 +02001107 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001108 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001109 return 0;
1110 }
1111 if (appctx->st2 == STAT_ST_END)
1112 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001113 var++;
1114 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001115 }
1116
1117 /* dump complete */
1118 return 1;
1119}
1120
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001121/* This function dumps all file descriptors states (or the requested one) to
1122 * the buffer. It returns 0 if the output buffer is full and it needs to be
1123 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1124 * It uses cli.i0 as the fd number to restart from.
1125 */
1126static int cli_io_handler_show_fd(struct appctx *appctx)
1127{
1128 struct stream_interface *si = appctx->owner;
1129 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001130 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001131
1132 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001133 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001134
1135 chunk_reset(&trash);
1136
Willy Tarreauca1b1572018-12-18 15:45:11 +01001137 /* isolate the threads once per round. We're limited to a buffer worth
1138 * of output anyway, it cannot last very long.
1139 */
1140 thread_isolate();
1141
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001142 /* we have two inner loops here, one for the proxy, the other one for
1143 * the buffer.
1144 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001145 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001146 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001147 const struct listener *li = NULL;
1148 const struct server *sv = NULL;
1149 const struct proxy *px = NULL;
1150 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001151 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001152 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001153 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001154 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001155 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001156 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001157 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001158
1159 fdt = fdtab[fd];
1160
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001161 /* When DEBUG_FD is set, we also report closed FDs that have a
1162 * non-null event count to detect stuck ones.
1163 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001164 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001165#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001166 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001167#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001168 goto skip; // closed
1169 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001170 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001171 conn = (const struct connection *)fdt.owner;
1172 conn_flags = conn->flags;
1173 mux = conn->mux;
1174 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001175 xprt = conn->xprt;
1176 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001177 li = objt_listener(conn->target);
1178 sv = objt_server(conn->target);
1179 px = objt_proxy(conn->target);
1180 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001181 if (atleast2(fdt.thread_mask))
1182 suspicious = 1;
1183 if (conn->handle.fd != fd)
1184 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001185 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001186 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001187 li = fdt.owner;
1188
Willy Tarreaudacfde42021-01-21 09:07:29 +01001189 if (!fdt.thread_mask)
1190 suspicious = 1;
1191
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001192 chunk_printf(&trash,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001193 " %5d : st=0x%02x(R:%c%c W:%c%c) ev=0x%02x(%c%c%c%c%c) [%c%c] tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001194 fd,
1195 fdt.state,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001196 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1197 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001198 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1199 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1200 fdt.ev,
1201 (fdt.ev & FD_POLL_HUP) ? 'H' : 'h',
1202 (fdt.ev & FD_POLL_ERR) ? 'E' : 'e',
1203 (fdt.ev & FD_POLL_OUT) ? 'O' : 'o',
1204 (fdt.ev & FD_POLL_PRI) ? 'P' : 'p',
1205 (fdt.ev & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001206 fdt.linger_risk ? 'L' : 'l',
1207 fdt.cloned ? 'C' : 'c',
Willy Tarreauc754b342018-03-30 15:00:15 +02001208 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001209 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001210 fdt.iocb);
1211 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001212
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001213 if (!fdt.owner) {
1214 chunk_appendf(&trash, ")");
1215 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001216 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001217 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001218
1219 if (conn->handle.fd != fd) {
1220 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1221 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001222 } else {
1223 struct sockaddr_storage sa;
1224 socklen_t salen;
1225
1226 salen = sizeof(sa);
1227 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1228 if (sa.ss_family == AF_INET)
1229 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1230 else if (sa.ss_family == AF_INET6)
1231 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1232 else if (sa.ss_family == AF_UNIX)
1233 chunk_appendf(&trash, " fam=unix");
1234 }
1235
1236 salen = sizeof(sa);
1237 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1238 if (sa.ss_family == AF_INET)
1239 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1240 else if (sa.ss_family == AF_INET6)
1241 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1242 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001243 }
1244
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001245 if (px)
1246 chunk_appendf(&trash, " px=%s", px->id);
1247 else if (sv)
1248 chunk_appendf(&trash, " sv=%s/%s", sv->id, sv->proxy->id);
1249 else if (li)
1250 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001251
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001252 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001253 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001254 if (!ctx)
1255 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001256 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001257 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001258 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001259 else
1260 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001261
1262 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001263 if (xprt) {
1264 if (xprt_ctx || xprt->show_fd)
1265 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1266 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001267 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001268 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001269 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001270 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001271 struct sockaddr_storage sa;
1272 socklen_t salen;
1273
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001274 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001275 listener_state_str(li),
1276 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001277
1278 salen = sizeof(sa);
1279 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1280 if (sa.ss_family == AF_INET)
1281 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1282 else if (sa.ss_family == AF_INET6)
1283 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1284 else if (sa.ss_family == AF_UNIX)
1285 chunk_appendf(&trash, " fam=unix");
1286 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001287 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001288 else
1289 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001290
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001291#ifdef DEBUG_FD
1292 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001293 if (fdtab[fd].event_count >= 1000000)
1294 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001295#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001296 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001297
Willy Tarreau06d80a92017-10-19 14:32:15 +02001298 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001299 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001300 appctx->ctx.cli.i0 = fd;
1301 ret = 0;
1302 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001303 }
1304 skip:
1305 if (appctx->st2 == STAT_ST_END)
1306 break;
1307
1308 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001309 }
1310
Willy Tarreauca1b1572018-12-18 15:45:11 +01001311 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001312 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001313
1314 thread_release();
1315 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001316}
1317
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001318/* This function dumps some activity counters used by developers and support to
1319 * rule out some hypothesis during bug reports. It returns 0 if the output
1320 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1321 * everything at once in the buffer and is not designed to do it in multiple
1322 * passes.
1323 */
1324static int cli_io_handler_show_activity(struct appctx *appctx)
1325{
1326 struct stream_interface *si = appctx->owner;
1327 int thr;
1328
1329 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1330 return 1;
1331
1332 chunk_reset(&trash);
1333
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001334#undef SHOW_TOT
1335#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001336 do { \
1337 unsigned int _v[MAX_THREADS]; \
1338 unsigned int _tot; \
1339 const unsigned int _nbt = global.nbthread; \
1340 for (_tot = t = 0; t < _nbt; t++) \
1341 _tot += _v[t] = (x); \
1342 if (_nbt == 1) { \
1343 chunk_appendf(&trash, " %u\n", _tot); \
1344 break; \
1345 } \
1346 chunk_appendf(&trash, " %u [", _tot); \
1347 for (t = 0; t < _nbt; t++) \
1348 chunk_appendf(&trash, " %u", _v[t]); \
1349 chunk_appendf(&trash, " ]\n"); \
1350 } while (0)
1351
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001352#undef SHOW_AVG
1353#define SHOW_AVG(t, x) \
1354 do { \
1355 unsigned int _v[MAX_THREADS]; \
1356 unsigned int _tot; \
1357 const unsigned int _nbt = global.nbthread; \
1358 for (_tot = t = 0; t < _nbt; t++) \
1359 _tot += _v[t] = (x); \
1360 if (_nbt == 1) { \
1361 chunk_appendf(&trash, " %u\n", _tot); \
1362 break; \
1363 } \
1364 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1365 for (t = 0; t < _nbt; t++) \
1366 chunk_appendf(&trash, " %u", _v[t]); \
1367 chunk_appendf(&trash, " ]\n"); \
1368 } while (0)
1369
Willy Tarreaua0211b82019-05-28 15:09:08 +02001370 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1371 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001372 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1373 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1374 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1375 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001376 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001377 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1378 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001379 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001380 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001381 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
1382 chunk_appendf(&trash, "poll_dead_fd:"); SHOW_TOT(thr, activity[thr].poll_dead_fd);
1383 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001384 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001385 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001386 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1387 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001388 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1389 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1390 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1391 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1392 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1393 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1394 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001395#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001396 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 +02001397 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001398#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001399
Willy Tarreaud6a78502019-05-27 07:03:38 +02001400#if defined(DEBUG_DEV)
1401 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001402 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1403 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1404 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001405#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001406
1407 if (ci_putchk(si_ic(si), &trash) == -1) {
1408 chunk_reset(&trash);
1409 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001410 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001411 }
1412
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001413#undef SHOW_AVG
1414#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001415 /* dump complete */
1416 return 1;
1417}
1418
William Lallemandeceddf72016-12-15 18:06:44 +01001419/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001420 * CLI IO handler for `show cli sockets`.
1421 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001422 */
1423static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1424{
1425 struct bind_conf *bind_conf;
1426 struct stream_interface *si = appctx->owner;
1427
1428 chunk_reset(&trash);
1429
1430 switch (appctx->st2) {
1431 case STAT_ST_INIT:
1432 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001433 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001434 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001435 return 0;
1436 }
William Lallemandeceddf72016-12-15 18:06:44 +01001437 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001438 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001439
1440 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001441 if (global.cli_fe) {
1442 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001443 struct listener *l;
1444
1445 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001446 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001447 * if the current node is the first of the list
1448 */
1449
Willy Tarreau3af9d832016-12-16 12:58:09 +01001450 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001451 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001452 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001453 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001454 continue;
1455 }
1456
1457 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1458
1459 char addr[46];
1460 char port[6];
1461
Willy Tarreau37159062020-08-27 07:48:42 +02001462 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001463 const struct sockaddr_un *un;
1464
Willy Tarreau37159062020-08-27 07:48:42 +02001465 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001466 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001467 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001468 } else {
1469 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1470 }
Willy Tarreau37159062020-08-27 07:48:42 +02001471 } else if (l->rx.addr.ss_family == AF_INET) {
1472 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1473 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001474 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001475 } else if (l->rx.addr.ss_family == AF_INET6) {
1476 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1477 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001478 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001479 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1480 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001481 } else
William Lallemand26314342018-10-26 14:47:41 +02001482 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001483
William Lallemand07a62f72017-05-24 00:57:40 +02001484 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001485 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001486 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1487 chunk_appendf(&trash, "operator ");
1488 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1489 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001490 else
1491 chunk_appendf(&trash, " ");
1492
Willy Tarreaue26993c2020-09-03 07:18:55 +02001493 if (bind_conf->settings.bind_proc != 0) {
William Lallemandeceddf72016-12-15 18:06:44 +01001494 int pos;
Willy Tarreaue26993c2020-09-03 07:18:55 +02001495 for (pos = 0; pos < 8 * sizeof(bind_conf->settings.bind_proc); pos++) {
1496 if (bind_conf->settings.bind_proc & (1UL << pos)) {
William Lallemandeceddf72016-12-15 18:06:44 +01001497 chunk_appendf(&trash, "%d,", pos+1);
1498 }
1499 }
1500 /* replace the latest comma by a newline */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001501 trash.area[trash.data-1] = '\n';
William Lallemandeceddf72016-12-15 18:06:44 +01001502
1503 } else {
1504 chunk_appendf(&trash, "all\n");
1505 }
1506
Willy Tarreau06d80a92017-10-19 14:32:15 +02001507 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001508 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001509 return 0;
1510 }
1511 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001512 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001513 }
1514 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001515 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001516 default:
1517 appctx->st2 = STAT_ST_FIN;
1518 return 1;
1519 }
1520}
1521
1522
Willy Tarreau0a739292016-11-22 20:21:23 +01001523/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001524 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1525 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001526 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001527static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001528{
1529 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001530 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001531
1532 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1533 return 1;
1534
Willy Tarreauf6710f82016-12-16 17:45:44 +01001535 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001536
1537 if (*args[2]) {
1538 int len = strlen(args[2]);
1539
Willy Tarreauf6710f82016-12-16 17:45:44 +01001540 for (; *var; var++) {
1541 if (strncmp(*var, args[2], len) == 0 &&
1542 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001543 break;
1544 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001545 if (!*var)
1546 return cli_err(appctx, "Variable not found\n");
1547
Willy Tarreau0a739292016-11-22 20:21:23 +01001548 appctx->st2 = STAT_ST_END;
1549 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001550 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001551 return 0;
1552}
1553
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001554/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1555 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1556 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1557 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001558static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001559{
1560 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1561 return 1;
1562
1563 appctx->ctx.cli.i0 = 0;
1564
1565 if (*args[2]) {
1566 appctx->ctx.cli.i0 = atoi(args[2]);
1567 appctx->st2 = STAT_ST_END;
1568 }
1569 return 0;
1570}
1571
Willy Tarreau599852e2016-11-22 20:33:32 +01001572/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001573static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001574{
1575 struct stream_interface *si = appctx->owner;
1576 struct stream *s = si_strm(si);
1577
1578 if (strcmp(args[2], "cli") == 0) {
1579 unsigned timeout;
1580 const char *res;
1581
Willy Tarreau9d008692019-08-09 11:21:01 +02001582 if (!*args[3])
1583 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001584
1585 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001586 if (res || timeout < 1)
1587 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001588
1589 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1590 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1591 return 1;
1592 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001593
1594 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001595}
1596
Willy Tarreau2af99412016-11-23 11:10:59 +01001597/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001598static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001599{
1600 int v;
1601
1602 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1603 return 1;
1604
Willy Tarreau9d008692019-08-09 11:21:01 +02001605 if (!*args[3])
1606 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001607
1608 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001609 if (v > global.hardmaxconn)
1610 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001611
1612 /* check for unlimited values */
1613 if (v <= 0)
1614 v = global.hardmaxconn;
1615
1616 global.maxconn = v;
1617
1618 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001619 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001620
1621 return 1;
1622}
1623
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001624static int set_severity_output(int *target, char *argument)
1625{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001626 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001627 *target = CLI_SEVERITY_NONE;
1628 return 1;
1629 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001630 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001631 *target = CLI_SEVERITY_NUMBER;
1632 return 1;
1633 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001634 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001635 *target = CLI_SEVERITY_STRING;
1636 return 1;
1637 }
1638 return 0;
1639}
1640
1641/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001642static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001643{
1644 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1645 return 0;
1646
Willy Tarreau9d008692019-08-09 11:21:01 +02001647 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001648}
William Lallemandeceddf72016-12-15 18:06:44 +01001649
William Lallemand67a234f2018-12-13 09:05:45 +01001650
1651/* show the level of the current CLI session */
1652static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1653{
William Lallemand67a234f2018-12-13 09:05:45 +01001654 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001655 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001656 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001657 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001658 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001659 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001660 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001661 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001662}
1663
1664/* parse and set the CLI level dynamically */
1665static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1666{
William Lallemandad032882019-07-01 10:56:15 +02001667 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001668 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001669 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1670
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001671 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001672 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1673 return 1;
1674 }
1675 appctx->cli_level &= ~ACCESS_LVL_MASK;
1676 appctx->cli_level |= ACCESS_LVL_OPER;
1677
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001678 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001679 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1680 return 1;
1681 }
1682 appctx->cli_level &= ~ACCESS_LVL_MASK;
1683 appctx->cli_level |= ACCESS_LVL_USER;
1684 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001685 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001686 return 1;
1687}
1688
1689
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001690/* parse and set the CLI expert/experimental-mode dynamically */
1691static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001692{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001693 int level;
1694 char *level_str;
1695 char *output = NULL;
1696
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001697 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1698 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001699
1700 if (!strcmp(args[0], "expert-mode")) {
1701 level = ACCESS_EXPERT;
1702 level_str = "expert-mode";
1703 }
1704 else if (!strcmp(args[0], "experimental-mode")) {
1705 level = ACCESS_EXPERIMENTAL;
1706 level_str = "experimental-mode";
1707 }
1708 else {
1709 return 1;
1710 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001711
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001712 if (!*args[1]) {
1713 memprintf(&output, "%s is %s\n", level_str,
1714 (appctx->cli_level & level) ? "ON" : "OFF");
1715 return cli_dynmsg(appctx, LOG_INFO, output);
1716 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001717
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001718 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001719 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001720 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001721 return 1;
1722}
1723
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001724int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001725{
1726 return 0;
1727}
1728
Willy Tarreau45c742b2016-11-24 14:51:17 +01001729/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001730static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001731{
1732 int v;
1733 int *res;
1734 int mul = 1;
1735
1736 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1737 return 1;
1738
1739 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1740 res = &global.cps_lim;
1741 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1742 res = &global.sps_lim;
1743#ifdef USE_OPENSSL
1744 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1745 res = &global.ssl_lim;
1746#endif
1747 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1748 res = &global.comp_rate_lim;
1749 mul = 1024;
1750 }
1751 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001752 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001753 "'set rate-limit' only supports :\n"
1754 " - 'connections global' to set the per-process maximum connection rate\n"
1755 " - 'sessions global' to set the per-process maximum session rate\n"
1756#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001757 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001758#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001759 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001760 }
1761
Willy Tarreau9d008692019-08-09 11:21:01 +02001762 if (!*args[4])
1763 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001764
1765 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001766 if (v < 0)
1767 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001768
1769 *res = v * mul;
1770
1771 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001772 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001773
1774 return 1;
1775}
1776
William Lallemandf6975e92017-05-26 17:42:10 +02001777/* parse the "expose-fd" argument on the bind lines */
1778static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1779{
1780 if (!*args[cur_arg + 1]) {
1781 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1782 return ERR_ALERT | ERR_FATAL;
1783 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001784 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001785 conf->level |= ACCESS_FD_LISTENERS;
1786 } else {
1787 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1788 args[cur_arg], args[cur_arg+1]);
1789 return ERR_ALERT | ERR_FATAL;
1790 }
1791
1792 return 0;
1793}
1794
William Lallemand74c24fb2016-11-21 17:18:36 +01001795/* parse the "level" argument on the bind lines */
1796static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1797{
1798 if (!*args[cur_arg + 1]) {
1799 memprintf(err, "'%s' : missing level", args[cur_arg]);
1800 return ERR_ALERT | ERR_FATAL;
1801 }
1802
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001803 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001804 conf->level &= ~ACCESS_LVL_MASK;
1805 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001806 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001807 conf->level &= ~ACCESS_LVL_MASK;
1808 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001809 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001810 conf->level &= ~ACCESS_LVL_MASK;
1811 conf->level |= ACCESS_LVL_ADMIN;
1812 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001813 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1814 args[cur_arg], args[cur_arg+1]);
1815 return ERR_ALERT | ERR_FATAL;
1816 }
1817
1818 return 0;
1819}
1820
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001821static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1822{
1823 if (!*args[cur_arg + 1]) {
1824 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1825 return ERR_ALERT | ERR_FATAL;
1826 }
1827
1828 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1829 return 0;
1830 else {
1831 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1832 args[cur_arg], args[cur_arg+1]);
1833 return ERR_ALERT | ERR_FATAL;
1834 }
1835}
1836
Olivier Houchardf886e342017-04-05 22:24:59 +02001837/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001838static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001839{
1840 char *cmsgbuf = NULL;
1841 unsigned char *tmpbuf = NULL;
1842 struct cmsghdr *cmsg;
1843 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001844 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001845 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001846 struct msghdr msghdr;
1847 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001848 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001849 const char *ns_name, *if_name;
1850 unsigned char ns_nlen, if_nlen;
1851 int nb_queued;
1852 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001853 int *tmpfd;
1854 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001855 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001856 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001857 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001858 int ret;
1859
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001860 if (!remote) {
1861 ha_warning("Only works on real connections\n");
1862 goto out;
1863 }
1864
1865 fd = remote->handle.fd;
1866
Olivier Houchardf886e342017-04-05 22:24:59 +02001867 /* Temporary set the FD in blocking mode, that will make our life easier */
1868 old_fcntl = fcntl(fd, F_GETFL);
1869 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001870 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001871 goto out;
1872 }
1873 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1874 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001875 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001876 goto out;
1877 }
1878 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001879 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001880 goto out;
1881 }
Olivier Houchard54740872017-04-06 14:45:14 +02001882 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001883 iov.iov_base = &tot_fd_nb;
1884 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001885 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001886 goto out;
1887 memset(&msghdr, 0, sizeof(msghdr));
1888 /*
1889 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001890 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001891 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001892 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
1893 tot_fd_nb += fdtab[cur_fd].exported;
William Lallemand5fd3b282020-01-16 15:32:08 +01001894
Olivier Houchardf886e342017-04-05 22:24:59 +02001895 if (tot_fd_nb == 0)
1896 goto out;
1897
1898 /* First send the total number of file descriptors, so that the
1899 * receiving end knows what to expect.
1900 */
1901 msghdr.msg_iov = &iov;
1902 msghdr.msg_iovlen = 1;
1903 ret = sendmsg(fd, &msghdr, 0);
1904 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001905 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001906 goto out;
1907 }
1908
1909 /* Now send the fds */
1910 msghdr.msg_control = cmsgbuf;
1911 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1912 cmsg = CMSG_FIRSTHDR(&msghdr);
1913 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1914 cmsg->cmsg_level = SOL_SOCKET;
1915 cmsg->cmsg_type = SCM_RIGHTS;
1916 tmpfd = (int *)CMSG_DATA(cmsg);
1917
Olivier Houchardf886e342017-04-05 22:24:59 +02001918 /* For each socket, e message is sent, containing the following :
1919 * Size of the namespace name (or 0 if none), as an unsigned char.
1920 * The namespace name, if any
1921 * Size of the interface name (or 0 if none), as an unsigned char
1922 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001923 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001924 */
1925 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001926 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001927 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001928 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001929 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001930 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001931 goto out;
1932 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001933
1934 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001935 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001936 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
1937 if (!(fdtab[cur_fd].exported))
1938 continue;
1939
1940 ns_name = if_name = "";
1941 ns_nlen = if_nlen = 0;
1942
1943 /* for now we can only retrieve namespaces and interfaces from
1944 * pure listeners.
1945 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02001946 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001947 const struct listener *l = fdtab[cur_fd].owner;
1948
Willy Tarreau818a92e2020-09-03 07:50:19 +02001949 if (l->rx.settings->interface) {
1950 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001951 if_nlen = strlen(if_name);
1952 }
1953
1954#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02001955 if (l->rx.settings->netns) {
1956 ns_name = l->rx.settings->netns->node.key;
1957 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001958 }
1959#endif
1960 }
1961
1962 /* put the FD into the CMSG_DATA */
1963 tmpfd[nb_queued++] = cur_fd;
1964
1965 /* first block is <ns_name_len> <ns_name> */
1966 tmpbuf[curoff++] = ns_nlen;
1967 if (ns_nlen)
1968 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
1969 curoff += ns_nlen;
1970
1971 /* second block is <if_name_len> <if_name> */
1972 tmpbuf[curoff++] = if_nlen;
1973 if (if_nlen)
1974 memcpy(tmpbuf + curoff, if_name, if_nlen);
1975 curoff += if_nlen;
1976
1977 /* we used to send the listener options here before 2.3 */
1978 memset(tmpbuf + curoff, 0, sizeof(int));
1979 curoff += sizeof(int);
1980
1981 /* there's a limit to how many FDs may be sent at once */
1982 if (nb_queued == MAX_SEND_FD) {
1983 iov.iov_len = curoff;
1984 if (sendmsg(fd, &msghdr, 0) != curoff) {
1985 ha_warning("Failed to transfer sockets\n");
1986 return -1;
1987 }
1988
1989 /* Wait for an ack */
1990 do {
1991 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
1992 } while (ret == -1 && errno == EINTR);
1993
1994 if (ret <= 0) {
1995 ha_warning("Unexpected error while transferring sockets\n");
1996 return -1;
1997 }
1998 curoff = 0;
1999 nb_queued = 0;
2000 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002001 }
2002
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002003 /* flush pending stuff */
2004 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002005 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002006 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2007 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002008 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002009 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002010 goto out;
2011 }
2012 }
2013
2014out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002015 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002016 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002017 goto out;
2018 }
2019 appctx->st0 = CLI_ST_END;
2020 free(cmsgbuf);
2021 free(tmpbuf);
2022 return 1;
2023}
2024
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002025static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2026{
2027 if (*args[0] == 'h')
2028 /* help */
Willy Tarreaub96a74c2021-03-12 17:13:28 +01002029 cli_gen_usage_msg(appctx, NULL);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002030 else if (*args[0] == 'p')
2031 /* prompt */
2032 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2033 else if (*args[0] == 'q')
2034 /* quit */
2035 appctx->st0 = CLI_ST_END;
2036
2037 return 1;
2038}
Olivier Houchardf886e342017-04-05 22:24:59 +02002039
William Lallemand2f4ce202018-10-26 14:47:47 +02002040void pcli_write_prompt(struct stream *s)
2041{
2042 struct buffer *msg = get_trash_chunk();
2043 struct channel *oc = si_oc(&s->si[0]);
2044
William Lallemanddc12c2e2018-12-13 09:05:46 +01002045 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002046 return;
2047
William Lallemanddc12c2e2018-12-13 09:05:46 +01002048 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002049 chunk_appendf(msg, "+ ");
2050 } else {
2051 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002052 chunk_appendf(msg, "master%s> ",
2053 (global.mode & MODE_MWORKER_WAIT) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002054 else
2055 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2056 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002057 co_inject(oc, msg->area, msg->data);
2058}
2059
William Lallemand291810d2018-10-26 14:47:38 +02002060
William Lallemandcf62f7e2018-10-26 14:47:40 +02002061/* The pcli_* functions are used for the CLI proxy in the master */
2062
William Lallemanddeeaa592018-10-26 14:47:48 +02002063void pcli_reply_and_close(struct stream *s, const char *msg)
2064{
2065 struct buffer *buf = get_trash_chunk();
2066
2067 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002068 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002069}
2070
William Lallemand291810d2018-10-26 14:47:38 +02002071static enum obj_type *pcli_pid_to_server(int proc_pid)
2072{
2073 struct mworker_proc *child;
2074
William Lallemand99e0bb92020-11-05 10:28:53 +01002075 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002076 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002077 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002078
William Lallemand291810d2018-10-26 14:47:38 +02002079 list_for_each_entry(child, &proc_list, list) {
2080 if (child->pid == proc_pid){
2081 return &child->srv->obj_type;
2082 }
2083 }
2084 return NULL;
2085}
2086
2087/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2088 * Return:
2089 * 0: master
2090 * > 0: pid of a worker
2091 * < 0: didn't find a worker
2092 */
2093static int pcli_prefix_to_pid(const char *prefix)
2094{
2095 int proc_pid;
2096 struct mworker_proc *child;
2097 char *errtol = NULL;
2098
2099 if (*prefix != '@') /* not a prefix, should not happen */
2100 return -1;
2101
2102 prefix++;
2103 if (!*prefix) /* sent @ alone, return the master */
2104 return 0;
2105
2106 if (strcmp("master", prefix) == 0) {
2107 return 0;
2108 } else if (*prefix == '!') {
2109 prefix++;
2110 if (!*prefix)
2111 return -1;
2112
2113 proc_pid = strtol(prefix, &errtol, 10);
2114 if (*errtol != '\0')
2115 return -1;
2116 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002117 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002118 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002119 if (child->pid == proc_pid){
2120 return child->pid;
2121 }
2122 }
2123 } else {
2124 struct mworker_proc *chosen = NULL;
2125 /* this is a relative pid */
2126
2127 proc_pid = strtol(prefix, &errtol, 10);
2128 if (*errtol != '\0')
2129 return -1;
2130
2131 if (proc_pid == 0) /* return the master */
2132 return 0;
2133
2134 /* chose the right process, the current one is the one with the
2135 least number of reloads */
2136 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002137 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002138 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002139 if (child->relative_pid == proc_pid){
2140 if (child->reloads == 0)
2141 return child->pid;
2142 else if (chosen == NULL || child->reloads < chosen->reloads)
2143 chosen = child;
2144 }
2145 }
2146 if (chosen)
2147 return chosen->pid;
2148 }
2149 return -1;
2150}
2151
William Lallemandbddd33a2018-12-11 16:10:53 +01002152/* Return::
2153 * >= 0 : number of words to escape
2154 * = -1 : error
2155 */
2156
2157int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2158{
2159 if (argl < 1)
2160 return 0;
2161
2162 /* there is a prefix */
2163 if (args[0][0] == '@') {
2164 int target_pid = pcli_prefix_to_pid(args[0]);
2165
2166 if (target_pid == -1) {
2167 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2168 return -1;
2169 }
2170
2171 /* if the prefix is alone, define a default target */
2172 if (argl == 1)
2173 s->pcli_next_pid = target_pid;
2174 else
2175 *next_pid = target_pid;
2176 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002177 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002178 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002179 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002180
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002181 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002182 channel_shutr_now(&s->req);
2183 channel_shutw_now(&s->res);
2184 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002185 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002186 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2187 memprintf(errmsg, "Permission denied!\n");
2188 return -1;
2189 }
2190 s->pcli_flags &= ~ACCESS_LVL_MASK;
2191 s->pcli_flags |= ACCESS_LVL_OPER;
2192 return argl;
2193
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002194 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002195 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2196 memprintf(errmsg, "Permission denied!\n");
2197 return -1;
2198 }
2199 s->pcli_flags &= ~ACCESS_LVL_MASK;
2200 s->pcli_flags |= ACCESS_LVL_USER;
2201 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002202 }
2203
2204 return 0;
2205}
2206
2207/*
2208 * Parse the CLI request:
2209 * - It does basically the same as the cli_io_handler, but as a proxy
2210 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002211 *
2212 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002213 * - the number of characters to forward or
2214 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002215 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002216int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002217{
William Lallemandbddd33a2018-12-11 16:10:53 +01002218 char *str = (char *)ci_head(req);
2219 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002220 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002221 int argl; /* number of args */
2222 char *p;
2223 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002224 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002225 int wtrim = 0; /* number of words to trim */
2226 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002227 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002228 int i = 0;
2229
2230 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002231
William Lallemanddc12c2e2018-12-13 09:05:46 +01002232 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002233
2234 /* Looks for the end of one command */
2235 while (p+reql < end) {
2236 /* handle escaping */
2237 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002238 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002239 continue;
2240 }
2241 if (p[reql] == ';' || p[reql] == '\n') {
2242 /* found the end of the command */
2243 p[reql] = '\n';
2244 reql++;
2245 break;
2246 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002247 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002248 }
William Lallemandebf61802018-12-11 16:10:57 +01002249 } else {
2250 while (p+reql < end) {
2251 if (p[reql] == '\n') {
2252 /* found the end of the line */
2253 reql++;
2254 break;
2255 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002256 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002257 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002258 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002259
William Lallemandbddd33a2018-12-11 16:10:53 +01002260 /* set end to first byte after the end of the command */
2261 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002262
William Lallemandbddd33a2018-12-11 16:10:53 +01002263 /* there is no end to this command, need more to parse ! */
2264 if (*(end-1) != '\n') {
2265 return -1;
2266 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002267
William Lallemand3301f3e2018-12-13 09:05:48 +01002268 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2269 if (reql == 1) /* last line of the payload */
2270 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002271 return reql;
2272 }
2273
William Lallemandbddd33a2018-12-11 16:10:53 +01002274 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002275
William Lallemandbddd33a2018-12-11 16:10:53 +01002276 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002277 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002278 /* skip leading spaces/tabs */
2279 p += strspn(p, " \t");
2280 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002281 break;
2282
William Lallemandbddd33a2018-12-11 16:10:53 +01002283 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002284 while (1) {
2285 p += strcspn(p, " \t\\");
2286 /* escaped chars using backlashes (\) */
2287 if (*p == '\\') {
2288 if (!*++p)
2289 break;
2290 if (!*++p)
2291 break;
2292 } else {
2293 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002294 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002295 }
William Lallemandfe249c32020-06-18 18:03:57 +02002296 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002297 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002298 }
2299
William Lallemandbddd33a2018-12-11 16:10:53 +01002300 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002301
Willy Tarreauf14c7572021-03-13 10:59:23 +01002302 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002303 args[i] = NULL;
2304
2305 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2306
2307 /* End of words are ending by \0, we need to replace the \0s by spaces
23081 before forwarding them */
2309 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002310 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002311 if (*p == '\0')
2312 *p = ' ';
2313 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002314 }
2315
William Lallemand3301f3e2018-12-13 09:05:48 +01002316 payload = strstr(str, PAYLOAD_PATTERN);
2317 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2318 /* if the payload pattern is at the end */
2319 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002320 }
2321
William Lallemandbddd33a2018-12-11 16:10:53 +01002322 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002323
William Lallemandbddd33a2018-12-11 16:10:53 +01002324 if (wtrim > 0) {
2325 trim = &args[wtrim][0];
2326 if (trim == NULL) /* if this was the last word in the table */
2327 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002328
William Lallemandbddd33a2018-12-11 16:10:53 +01002329 b_del(&req->buf, trim - str);
2330
William Lallemandb7ea1412018-12-13 09:05:47 +01002331 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002332 } else if (wtrim < 0) {
2333 /* parsing error */
2334 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002335 } else {
2336 /* the whole string */
2337 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002338 }
2339
William Lallemandb7ea1412018-12-13 09:05:47 +01002340 if (ret > 1) {
2341 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2342 goto end;
2343 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002344 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2345 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002346 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002347 ci_insert_line2(req, 0, "user -", strlen("user -"));
2348 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002349 }
2350 }
2351end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002352
William Lallemandb7ea1412018-12-13 09:05:47 +01002353 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002354}
2355
2356int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2357{
William Lallemandbddd33a2018-12-11 16:10:53 +01002358 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002359 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002360 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002361
William Lallemandb7ea1412018-12-13 09:05:47 +01002362 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2363 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2364
William Lallemandcf62f7e2018-10-26 14:47:40 +02002365read_again:
2366 /* if the channel is closed for read, we won't receive any more data
2367 from the client, but we don't want to forward this close to the
2368 server */
2369 channel_dont_close(req);
2370
2371 /* We don't know yet to which server we will connect */
2372 channel_dont_connect(req);
2373
2374
2375 /* we are not waiting for a response, there is no more request and we
2376 * receive a close from the client, we can leave */
2377 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2378 channel_shutw_now(&s->res);
2379 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2380 return 1;
2381 }
2382
2383 req->flags |= CF_READ_DONTWAIT;
2384
2385 /* need more data */
2386 if (!ci_data(req))
2387 return 0;
2388
2389 /* If there is data available for analysis, log the end of the idle time. */
2390 if (c_data(req) && s->logs.t_idle == -1)
2391 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2392
William Lallemandbddd33a2018-12-11 16:10:53 +01002393 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002394 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002395 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002396 /* enough data */
2397
William Lallemandcf62f7e2018-10-26 14:47:40 +02002398 /* forward only 1 command */
2399 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002400
William Lallemanddc12c2e2018-12-13 09:05:46 +01002401 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002402 /* we send only 1 command per request, and we write close after it */
2403 channel_shutw_now(req);
2404 } else {
2405 pcli_write_prompt(s);
2406 }
2407
2408 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002409
2410 /* remove the XFER_DATA analysers, which forwards all
2411 * the data, we don't want to forward the next requests
2412 * We need to add CF_FLT_ANALYZE to abort the forward too.
2413 */
2414 req->analysers &= ~(AN_REQ_FLT_XFER_DATA|AN_REQ_WAIT_CLI);
2415 req->analysers |= AN_REQ_FLT_END|CF_FLT_ANALYZE;
2416 s->res.analysers |= AN_RES_WAIT_CLI;
2417
William Lallemandebf61802018-12-11 16:10:57 +01002418 if (!(s->flags & SF_ASSIGNED)) {
2419 if (next_pid > -1)
2420 target_pid = next_pid;
2421 else
2422 target_pid = s->pcli_next_pid;
2423 /* we can connect now */
2424 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002425
William Lallemandebf61802018-12-11 16:10:57 +01002426 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2427 channel_auto_connect(req);
2428 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002429
2430 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002431 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002432 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002433 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002434 } else if (to_forward == -1 && errmsg) {
2435 /* there was an error during the parsing */
2436 pcli_reply_and_close(s, errmsg);
2437 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002438 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2439 /* buffer is full and we didn't catch the end of a command */
2440 goto send_help;
2441 }
2442
2443 return 0;
2444
2445send_help:
2446 b_reset(&req->buf);
2447 b_putblk(&req->buf, "help\n", 5);
2448 goto read_again;
2449}
2450
2451int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2452{
2453 struct proxy *fe = strm_fe(s);
2454 struct proxy *be = s->be;
2455
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002456 if (rep->flags & CF_READ_ERROR) {
2457 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2458 s->res.analysers &= ~AN_RES_WAIT_CLI;
2459 return 0;
2460 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002461 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2462 rep->flags |= CF_NEVER_WAIT;
2463
2464 /* don't forward the close */
2465 channel_dont_close(&s->res);
2466 channel_dont_close(&s->req);
2467
William Lallemanddc12c2e2018-12-13 09:05:46 +01002468 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002469 s->req.analysers |= AN_REQ_WAIT_CLI;
2470 s->res.analysers &= ~AN_RES_WAIT_CLI;
2471 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2472 return 0;
2473 }
2474
William Lallemandcf62f7e2018-10-26 14:47:40 +02002475 /* forward the data */
2476 if (ci_data(rep)) {
2477 c_adv(rep, ci_data(rep));
2478 return 0;
2479 }
2480
2481 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2482 /* stream cleanup */
2483
William Lallemand2f4ce202018-10-26 14:47:47 +02002484 pcli_write_prompt(s);
2485
William Lallemandcf62f7e2018-10-26 14:47:40 +02002486 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2487 si_shutr(&s->si[1]);
2488 si_shutw(&s->si[1]);
2489
2490 /*
2491 * starting from there this the same code as
2492 * http_end_txn_clean_session().
2493 *
2494 * It allows to do frontend keepalive while reconnecting to a
2495 * new server for each request.
2496 */
2497
2498 if (s->flags & SF_BE_ASSIGNED) {
2499 HA_ATOMIC_SUB(&be->beconn, 1);
2500 if (unlikely(s->srv_conn))
2501 sess_change_server(s, NULL);
2502 }
2503
2504 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2505 stream_process_counters(s);
2506
2507 /* don't count other requests' data */
2508 s->logs.bytes_in -= ci_data(&s->req);
2509 s->logs.bytes_out -= ci_data(&s->res);
2510
2511 /* we may need to know the position in the queue */
2512 pendconn_free(s);
2513
2514 /* let's do a final log if we need it */
2515 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2516 !(s->flags & SF_MONITOR) &&
2517 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2518 s->do_log(s);
2519 }
2520
2521 /* stop tracking content-based counters */
2522 stream_stop_content_counters(s);
2523 stream_update_time_stats(s);
2524
2525 s->logs.accept_date = date; /* user-visible date for logging */
2526 s->logs.tv_accept = now; /* corrected date for internal use */
2527 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2528 s->logs.t_idle = -1;
2529 tv_zero(&s->logs.tv_request);
2530 s->logs.t_queue = -1;
2531 s->logs.t_connect = -1;
2532 s->logs.t_data = -1;
2533 s->logs.t_close = 0;
2534 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2535 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2536
2537 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2538 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2539
2540 stream_del_srv_conn(s);
2541 if (objt_server(s->target)) {
2542 if (s->flags & SF_CURR_SESS) {
2543 s->flags &= ~SF_CURR_SESS;
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002544 HA_ATOMIC_SUB(&__objt_server(s->target)->cur_sess, 1);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002545 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002546 if (may_dequeue_tasks(__objt_server(s->target), be))
2547 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002548 }
2549
2550 s->target = NULL;
2551
2552 /* only release our endpoint if we don't intend to reuse the
2553 * connection.
2554 */
2555 if (!si_conn_ready(&s->si[1])) {
2556 si_release_endpoint(&s->si[1]);
2557 s->srv_conn = NULL;
2558 }
2559
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002560 sockaddr_free(&s->target_addr);
2561
William Lallemandcf62f7e2018-10-26 14:47:40 +02002562 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2563 s->si[1].err_type = SI_ET_NONE;
2564 s->si[1].conn_retries = 0; /* used for logging too */
2565 s->si[1].exp = TICK_ETERNITY;
2566 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 +02002567 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 +02002568 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 +02002569 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2570 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2571 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2572 /* reinitialise the current rule list pointer to NULL. We are sure that
2573 * any rulelist match the NULL pointer.
2574 */
2575 s->current_rule_list = NULL;
2576
2577 s->be = strm_fe(s);
2578 s->logs.logwait = strm_fe(s)->to_log;
2579 s->logs.level = 0;
2580 stream_del_srv_conn(s);
2581 s->target = NULL;
2582 /* re-init store persistence */
2583 s->store_count = 0;
2584 s->uniq_id = global.req_count++;
2585
2586 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2587
2588 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2589
2590 s->req.analysers |= AN_REQ_WAIT_CLI;
2591 s->res.analysers &= ~AN_RES_WAIT_CLI;
2592
2593 /* We must trim any excess data from the response buffer, because we
2594 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002595 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002596 * we want those data to come along with next response. A typical
2597 * example of such data would be from a buggy server responding to
2598 * a HEAD with some data, or sending more than the advertised
2599 * content-length.
2600 */
2601 if (unlikely(ci_data(&s->res)))
2602 b_set_data(&s->res.buf, co_data(&s->res));
2603
2604 /* Now we can realign the response buffer */
2605 c_realign_if_empty(&s->res);
2606
2607 s->req.rto = strm_fe(s)->timeout.client;
2608 s->req.wto = TICK_ETERNITY;
2609
2610 s->res.rto = TICK_ETERNITY;
2611 s->res.wto = strm_fe(s)->timeout.client;
2612
2613 s->req.rex = TICK_ETERNITY;
2614 s->req.wex = TICK_ETERNITY;
2615 s->req.analyse_exp = TICK_ETERNITY;
2616 s->res.rex = TICK_ETERNITY;
2617 s->res.wex = TICK_ETERNITY;
2618 s->res.analyse_exp = TICK_ETERNITY;
2619 s->si[1].hcto = TICK_ETERNITY;
2620
2621 /* we're removing the analysers, we MUST re-enable events detection.
2622 * We don't enable close on the response channel since it's either
2623 * already closed, or in keep-alive with an idle connection handler.
2624 */
2625 channel_auto_read(&s->req);
2626 channel_auto_close(&s->req);
2627 channel_auto_read(&s->res);
2628
2629
2630 return 1;
2631 }
2632 return 0;
2633}
2634
William Lallemand8a022572018-10-26 14:47:35 +02002635/*
2636 * The mworker functions are used to initialize the CLI in the master process
2637 */
2638
William Lallemand309dc9a2018-10-26 14:47:45 +02002639 /*
2640 * Stop the mworker proxy
2641 */
2642void mworker_cli_proxy_stop()
2643{
William Lallemand550db6d2018-11-06 17:37:12 +01002644 if (mworker_proxy)
2645 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002646}
2647
William Lallemand8a022572018-10-26 14:47:35 +02002648/*
2649 * Create the mworker CLI proxy
2650 */
2651int mworker_cli_proxy_create()
2652{
2653 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002654 char *msg = NULL;
2655 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002656
2657 mworker_proxy = calloc(1, sizeof(*mworker_proxy));
2658 if (!mworker_proxy)
2659 return -1;
2660
2661 init_new_proxy(mworker_proxy);
2662 mworker_proxy->next = proxies_list;
2663 proxies_list = mworker_proxy;
2664 mworker_proxy->id = strdup("MASTER");
William Lallemandcf62f7e2018-10-26 14:47:40 +02002665 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002666 mworker_proxy->last_change = now.tv_sec;
2667 mworker_proxy->cap = PR_CAP_LISTEN; /* this is a listen section */
2668 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2669 mworker_proxy->timeout.client = 0; /* no timeout */
2670 mworker_proxy->conf.file = strdup("MASTER");
2671 mworker_proxy->conf.line = 0;
2672 mworker_proxy->accept = frontend_accept;
2673 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2674
2675 /* Does not init the default target the CLI applet, but must be done in
2676 * the request parsing code */
2677 mworker_proxy->default_target = NULL;
2678
2679 /* the check_config_validity() will get an ID for the proxy */
2680 mworker_proxy->uuid = -1;
2681
2682 proxy_store_name(mworker_proxy);
2683
2684 /* create all servers using the mworker_proc list */
2685 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002686 struct server *newsrv = NULL;
2687 struct sockaddr_storage *sk;
2688 int port1, port2, port;
2689 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002690
William Lallemanda31b09e2020-01-14 15:25:02 +01002691 /* only the workers support the master CLI */
2692 if (!(child->options & PROC_O_TYPE_WORKER))
2693 continue;
2694
William Lallemand8a022572018-10-26 14:47:35 +02002695 newsrv = new_server(mworker_proxy);
2696 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002697 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002698
2699 /* we don't know the new pid yet */
2700 if (child->pid == -1)
2701 memprintf(&msg, "cur-%d", child->relative_pid);
2702 else
2703 memprintf(&msg, "old-%d", child->pid);
2704
2705 newsrv->next = mworker_proxy->srv;
2706 mworker_proxy->srv = newsrv;
2707 newsrv->conf.file = strdup(msg);
2708 newsrv->id = strdup(msg);
2709 newsrv->conf.line = 0;
2710
2711 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002712 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002713 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002714 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002715 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002716 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002717
Willy Tarreau5fc93282020-09-16 18:25:03 +02002718 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002719 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002720 }
2721
2722 /* no port specified */
2723 newsrv->flags |= SRV_F_MAPPORTS;
2724 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002725 /* don't let the server participate to load balancing */
2726 newsrv->iweight = 0;
2727 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002728 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002729
2730 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002731 }
2732 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002733
2734error:
2735 ha_alert("%s\n", errmsg);
2736
2737 list_for_each_entry(child, &proc_list, list) {
2738 free((char *)child->srv->conf.file); /* cast because of const char * */
2739 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002740 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002741 }
2742 free(mworker_proxy->id);
2743 free(mworker_proxy->conf.file);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002744 ha_free(&mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002745 free(errmsg);
2746 free(msg);
2747
2748 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002749}
Olivier Houchardf886e342017-04-05 22:24:59 +02002750
William Lallemandce83b4a2018-10-26 14:47:30 +02002751/*
William Lallemande7361152018-10-26 14:47:36 +02002752 * Create a new listener for the master CLI proxy
2753 */
2754int mworker_cli_proxy_new_listener(char *line)
2755{
2756 struct bind_conf *bind_conf;
2757 struct listener *l;
2758 char *err = NULL;
2759 char *args[MAX_LINE_ARGS + 1];
2760 int arg;
2761 int cur_arg;
2762
William Lallemand2e945c82019-11-25 09:58:37 +01002763 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002764 args[0] = line;
2765
2766 /* args is a bind configuration with spaces replaced by commas */
2767 while (*line && arg < MAX_LINE_ARGS) {
2768
2769 if (*line == ',') {
2770 *line++ = '\0';
2771 while (*line == ',')
2772 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002773 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002774 }
2775 line++;
2776 }
2777
William Lallemand2e945c82019-11-25 09:58:37 +01002778 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002779
2780 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002781 if (!bind_conf)
2782 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002783
2784 bind_conf->level &= ~ACCESS_LVL_MASK;
2785 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002786 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002787
2788 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2789 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002790 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002791 }
2792
2793 cur_arg = 1;
2794
2795 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002796 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002797 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002798
2799 kw = bind_find_kw(args[cur_arg]);
2800 if (kw) {
2801 if (!kw->parse) {
2802 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2803 args[0], args[1], args[cur_arg]);
2804 goto err;
2805 }
2806
Willy Tarreau4975d142021-03-13 11:00:33 +01002807 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002808 if (err)
2809 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2810 else
2811 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2812 args[0], args[1], args[cur_arg]);
2813 goto err;
2814 }
2815
2816 cur_arg += 1 + kw->skip;
2817 continue;
2818 }
2819
Willy Tarreau433b05f2021-03-12 10:14:07 +01002820 best = bind_find_best_kw(args[cur_arg]);
2821 if (best)
2822 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2823 args[0], args[1], args[cur_arg], best);
2824 else
2825 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2826 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002827 goto err;
2828 }
2829
2830
2831 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002832 l->accept = session_accept_fd;
2833 l->default_target = mworker_proxy->default_target;
2834 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002835 l->options |= LI_O_UNLIMITED;
2836 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002837 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002838 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002839 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002840 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002841
2842 return 0;
2843
2844err:
2845 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002846 free(err);
2847 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002848 return -1;
2849
2850}
2851
2852/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002853 * Create a new CLI socket using a socketpair for a worker process
2854 * <mworker_proc> is the process structure, and <proc> is the process number
2855 */
2856int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2857{
2858 struct bind_conf *bind_conf;
2859 struct listener *l;
2860 char *path = NULL;
2861 char *err = NULL;
2862
2863 /* master pipe to ensure the master is still alive */
2864 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2865 ha_alert("Cannot create worker socketpair.\n");
2866 return -1;
2867 }
2868
2869 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002870 if (!global.cli_fe) {
2871 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002872 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002873 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002874 }
2875 }
2876
Willy Tarreau4975d142021-03-13 11:00:33 +01002877 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002878 if (!bind_conf)
2879 goto error;
2880
William Lallemandce83b4a2018-10-26 14:47:30 +02002881 bind_conf->level &= ~ACCESS_LVL_MASK;
2882 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
2883
Willy Tarreaue26993c2020-09-03 07:18:55 +02002884 bind_conf->settings.bind_proc = 1UL << proc;
Willy Tarreau4975d142021-03-13 11:00:33 +01002885 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 +02002886
2887 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2888 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002889 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002890 }
2891
Willy Tarreau4975d142021-03-13 11:00:33 +01002892 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002893 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002894 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002895 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002896 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002897 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002898
2899 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002900 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002901 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002902 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau455585e2020-10-09 18:25:14 +02002903 HA_ATOMIC_ADD(&unstoppable_jobs, 1);
William Lallemandce83b4a2018-10-26 14:47:30 +02002904 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002905 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002906 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002907 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002908 }
2909
2910 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002911
2912error:
2913 close(mworker_proc->ipc_fd[0]);
2914 close(mworker_proc->ipc_fd[1]);
2915 free(err);
2916
2917 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002918}
2919
William Lallemand74c24fb2016-11-21 17:18:36 +01002920static struct applet cli_applet = {
2921 .obj_type = OBJ_TYPE_APPLET,
2922 .name = "<CLI>", /* used for logging */
2923 .fct = cli_io_handler,
2924 .release = cli_release_handler,
2925};
2926
William Lallemand99e0bb92020-11-05 10:28:53 +01002927/* master CLI */
2928static struct applet mcli_applet = {
2929 .obj_type = OBJ_TYPE_APPLET,
2930 .name = "<MCLI>", /* used for logging */
2931 .fct = cli_io_handler,
2932 .release = cli_release_handler,
2933};
2934
Willy Tarreau0a739292016-11-22 20:21:23 +01002935/* register cli keywords */
2936static struct cli_kw_list cli_kws = {{ },{
Willy Tarreau0609c9b2021-03-12 17:03:33 +01002937 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2938 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2939 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
Willy Tarreau2af99412016-11-23 11:10:59 +01002940 { { "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 +01002941 { { "set", "rate-limit", NULL }, "set rate-limit : change a rate limiting value", cli_parse_set_ratelimit, NULL },
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002942 { { "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 +01002943 { { "set", "timeout", NULL }, "set timeout : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Willy Tarreau0a739292016-11-22 20:21:23 +01002944 { { "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 +02002945 { { "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 +01002946 { { "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 +02002947 { { "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 +01002948 { { "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 +01002949 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
2950 { { "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 +02002951 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01002952 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2953 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
Willy Tarreau0a739292016-11-22 20:21:23 +01002954 {{},}
2955}};
2956
Willy Tarreau0108d902018-11-25 19:14:37 +01002957INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
2958
William Lallemand74c24fb2016-11-21 17:18:36 +01002959static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01002960 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01002961 { 0, NULL, NULL },
2962}};
2963
Willy Tarreau0108d902018-11-25 19:14:37 +01002964INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
2965
William Lallemand74c24fb2016-11-21 17:18:36 +01002966static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02002967 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
2968 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002969 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01002970 { NULL, NULL, 0 },
2971}};
2972
Willy Tarreau0108d902018-11-25 19:14:37 +01002973INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01002974
2975/*
2976 * Local variables:
2977 * c-indent-level: 8
2978 * c-basic-offset: 8
2979 * End:
2980 */