blob: f3d05d80079b669b59cccca88fb7f9c3c7be64e6 [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>
Christopher Faulet908628c2022-03-25 16:43:49 +010037#include <haproxy/conn_stream.h>
38#include <haproxy/cs_utils.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020039#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020040#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020041#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/fd.h>
43#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020044#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020045#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020046#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020047#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020048#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010049#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020050#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020051#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020052#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020053#include <haproxy/pipe.h>
54#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020055#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020056#include <haproxy/sample-t.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020057#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020058#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020059#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020060#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020061#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020062#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020063#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020064#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020065#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020066#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020067#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010068
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020069#define PAYLOAD_PATTERN "<<"
70
William Lallemand74c24fb2016-11-21 17:18:36 +010071static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010072static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010073
Willy Tarreau4975d142021-03-13 11:00:33 +010074static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010075 "Permission denied\n"
76 "";
77
78
Christopher Faulet1bc04c72017-10-29 20:14:08 +010079static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010080
81/* List head of cli keywords */
82static struct cli_kw_list cli_keywords = {
83 .list = LIST_HEAD_INIT(cli_keywords.list)
84};
85
86extern const char *stat_status_codes[];
87
Eric Salama1b8dacc2021-03-16 15:12:17 +010088struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +020089
Willy Tarreau92fbbcc2021-05-09 21:45:29 +020090static int cmp_kw_entries(const void *a, const void *b)
91{
92 const struct cli_kw *l = *(const struct cli_kw **)a;
93 const struct cli_kw *r = *(const struct cli_kw **)b;
94
95 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
96}
97
Willy Tarreaub96a74c2021-03-12 17:13:28 +010098/* This will show the help message and list the commands supported at the
99 * current level that match all of the first words of <args> if args is not
100 * NULL, or all args if none matches or if args is null.
101 */
102static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100103{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200104 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100105 struct cli_kw_list *kw_list;
106 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200107 struct buffer *tmp = get_trash_chunk();
108 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100109 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100110 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200111 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100112 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200113 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100114
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100115 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100116
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200117 if (args && *args && strcmp(*args, "help") == 0) {
118 args++;
119 ishelp = 1;
120 }
121
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100122 /* first, let's measure the longest match */
123 list_for_each_entry(kw_list, &cli_keywords.list, list) {
124 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100125 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100126 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100127 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
128 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100129 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
130 continue;
131
132 /* OK this command is visible */
133 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
134 if (!kw->str_kw[idx])
135 break; // end of keyword
136 if (!args || !args[idx] || !*args[idx])
137 break; // end of command line
138 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
139 break;
140 if (idx + 1 > length)
141 length = idx + 1;
142 }
143 }
144 }
145
Willy Tarreaub7364582021-03-12 18:24:46 +0100146 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100147 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200148 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100149 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200150 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100151 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
152 else // partial match
153 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
154
Willy Tarreaub7364582021-03-12 18:24:46 +0100155 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
156 matches[idx].kw = NULL;
157 matches[idx].dist = INT_MAX;
158 }
159
160 /* In case of partial match we'll look for the best matching entries
161 * starting from position <length>
162 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100163 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100164 list_for_each_entry(kw_list, &cli_keywords.list, list) {
165 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100166 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100167 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100168 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
169 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
170 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100171 continue;
172
173 for (idx = 0; idx < length; idx++) {
174 if (!kw->str_kw[idx])
175 break; // end of keyword
176 if (!args || !args[idx] || !*args[idx])
177 break; // end of command line
178 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
179 break;
180 }
181
182 /* extra non-matching words are fuzzy-matched */
183 if (kw->usage && idx == length && args[idx] && *args[idx]) {
184 uint8_t word_sig[1024];
185 uint8_t list_sig[1024];
186 int dist = 0;
187 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100188 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100189
190 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100191 * on the remaining words. For this we're computing the signature
192 * of everything that remains and the cumulated length of the
193 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100194 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100195 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100196 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
197 update_word_fingerprint(word_sig, args[i]);
198 totlen += strlen(args[i]);
199 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100200
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100201 memset(list_sig, 0, sizeof(list_sig));
202 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
203 update_word_fingerprint(list_sig, kw->str_kw[i]);
204 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100205 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100206
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100207 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100208
209 /* insert this one at its place if relevant, in order to keep only
210 * the best matches.
211 */
212 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100213 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100214 matches[CLI_MAX_MATCHES-1] = swp;
215 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
216 if (matches[idx+1].dist >= matches[idx].dist)
217 break;
218 matches[idx+1] = matches[idx];
219 matches[idx] = swp;
220 }
221 }
222 }
223 }
224 }
225 }
226
Willy Tarreauec197e82021-03-15 10:35:04 +0100227 if (matches[0].kw) {
228 /* we have fuzzy matches, let's propose them */
229 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
230 kw = matches[idx].kw;
231 if (!kw)
232 break;
233
234 /* stop the dump if some words look very unlikely candidates */
235 if (matches[idx].dist > 5*matches[0].dist/2)
236 break;
237
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200238 if (help_entries < CLI_MAX_HELP_ENTRIES)
239 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100240 }
241 }
242
William Lallemand74c24fb2016-11-21 17:18:36 +0100243 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100244 /* no full dump if we've already found nice candidates */
245 if (matches[0].kw)
246 break;
247
Willy Tarreau91bc3592021-03-12 15:20:39 +0100248 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200249
Willy Tarreau91bc3592021-03-12 15:20:39 +0100250 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100251 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100252 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100253 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100254 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200255
William Lallemand2a171912022-02-02 11:43:20 +0100256 /* in master, if the CLI don't have the
257 * ACCESS_MCLI_DEBUG don't display commands that have
258 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100259 */
William Lallemand2a171912022-02-02 11:43:20 +0100260 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
261 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
262 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100263 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200264
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100265 for (idx = 0; idx < length; idx++) {
266 if (!kw->str_kw[idx])
267 break; // end of keyword
268 if (!args || !args[idx] || !*args[idx])
269 break; // end of command line
270 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
271 break;
272 }
273
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200274 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
275 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100276 }
277 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100278
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200279 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
280
281 for (idx = 0; idx < help_entries; idx++)
282 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
283
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100284 /* always show the prompt/help/quit commands */
285 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200286 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200287 " prompt : toggle interactive mode with prompt\n"
288 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100289
William Lallemand74c24fb2016-11-21 17:18:36 +0100290 chunk_init(&out, NULL, 0);
291 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200292 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200293
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100294 appctx->ctx.cli.severity = LOG_INFO;
295 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200296 appctx->st0 = CLI_ST_PRINT;
297
William Lallemand74c24fb2016-11-21 17:18:36 +0100298 return dynamic_usage_msg;
299}
300
301struct cli_kw* cli_find_kw(char **args)
302{
303 struct cli_kw_list *kw_list;
304 struct cli_kw *kw;/* current cli_kw */
305 char **tmp_args;
306 const char **tmp_str_kw;
307 int found = 0;
308
309 if (LIST_ISEMPTY(&cli_keywords.list))
310 return NULL;
311
312 list_for_each_entry(kw_list, &cli_keywords.list, list) {
313 kw = &kw_list->kw[0];
314 while (*kw->str_kw) {
315 tmp_args = args;
316 tmp_str_kw = kw->str_kw;
317 while (*tmp_str_kw) {
318 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
319 found = 1;
320 } else {
321 found = 0;
322 break;
323 }
324 tmp_args++;
325 tmp_str_kw++;
326 }
327 if (found)
328 return (kw);
329 kw++;
330 }
331 }
332 return NULL;
333}
334
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100335struct cli_kw* cli_find_kw_exact(char **args)
336{
337 struct cli_kw_list *kw_list;
338 int found = 0;
339 int i;
340 int j;
341
342 if (LIST_ISEMPTY(&cli_keywords.list))
343 return NULL;
344
345 list_for_each_entry(kw_list, &cli_keywords.list, list) {
346 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
347 found = 1;
348 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
349 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
350 break;
351 }
352 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
353 found = 0;
354 break;
355 }
356 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
357 found = 0;
358 break;
359 }
360 }
361 if (found)
362 return &kw_list->kw[i];
363 }
364 }
365 return NULL;
366}
367
William Lallemand74c24fb2016-11-21 17:18:36 +0100368void cli_register_kw(struct cli_kw_list *kw_list)
369{
Willy Tarreau2b718102021-04-21 07:32:39 +0200370 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100371}
372
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200373/* list all known keywords on stdout, one per line */
374void cli_list_keywords(void)
375{
376 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200377 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200378 int idx;
379
Willy Tarreau44651712022-03-30 12:02:35 +0200380 for (kwn = kwp = NULL;; kwp = kwn) {
381 list_for_each_entry(kw_list, &cli_keywords.list, list) {
382 /* note: we sort based on the usage message when available,
383 * otherwise we fall back to the first keyword.
384 */
385 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
386 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
387 kw->usage ? kw->usage : kw->str_kw[0],
388 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
389 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200390 }
Willy Tarreau44651712022-03-30 12:02:35 +0200391 }
392
393 if (kwn == kwp)
394 break;
395
396 for (idx = 0; kwn->str_kw[idx]; idx++) {
397 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200398 }
Willy Tarreau44651712022-03-30 12:02:35 +0200399 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
400 printf("[MASTER] ");
401 if (!(kwn->level & ACCESS_MASTER_ONLY))
402 printf("[WORKER] ");
403 if (kwn->level & ACCESS_EXPERT)
404 printf("[EXPERT] ");
405 if (kwn->level & ACCESS_EXPERIMENTAL)
406 printf("[EXPERIM] ");
407 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200408 }
409}
William Lallemand74c24fb2016-11-21 17:18:36 +0100410
411/* allocate a new stats frontend named <name>, and return it
412 * (or NULL in case of lack of memory).
413 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100414static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100415{
416 struct proxy *fe;
417
418 fe = calloc(1, sizeof(*fe));
419 if (!fe)
420 return NULL;
421
422 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100423 fe->next = proxies_list;
424 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100425 fe->last_change = now.tv_sec;
426 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200427 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100428 fe->maxconn = 10; /* default to 10 concurrent connections */
429 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
430 fe->conf.file = strdup(file);
431 fe->conf.line = line;
432 fe->accept = frontend_accept;
433 fe->default_target = &cli_applet.obj_type;
434
435 /* the stats frontend is the only one able to assign ID #0 */
436 fe->conf.id.key = fe->uuid = 0;
437 eb32_insert(&used_proxy_id, &fe->conf.id);
438 return fe;
439}
440
441/* This function parses a "stats" statement in the "global" section. It returns
442 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
443 * error message into the <err> buffer which will be preallocated. The trailing
444 * '\n' must not be written. The function must be called with <args> pointing to
445 * the first word after "stats".
446 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100447static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
448 const struct proxy *defpx, const char *file, int line,
449 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100450{
451 struct bind_conf *bind_conf;
452 struct listener *l;
453
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100454 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100455 int cur_arg;
456
457 if (*args[2] == 0) {
458 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
459 return -1;
460 }
461
Willy Tarreau4975d142021-03-13 11:00:33 +0100462 if (!global.cli_fe) {
463 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100464 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
465 return -1;
466 }
467 }
468
Willy Tarreau4975d142021-03-13 11:00:33 +0100469 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200470 if (!bind_conf) {
471 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
472 return -1;
473 }
William Lallemand07a62f72017-05-24 00:57:40 +0200474 bind_conf->level &= ~ACCESS_LVL_MASK;
475 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100476
Willy Tarreau4975d142021-03-13 11:00:33 +0100477 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100478 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
479 file, line, args[0], args[1], err && *err ? *err : "error");
480 return -1;
481 }
482
483 cur_arg = 3;
484 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100485 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100486 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100487 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100488
489 kw = bind_find_kw(args[cur_arg]);
490 if (kw) {
491 if (!kw->parse) {
492 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
493 args[0], args[1], args[cur_arg]);
494 return -1;
495 }
496
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100497 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
498
499 /* FIXME: this is ugly, we don't have a way to collect warnings,
500 * yet some important bind keywords may report warnings that we
501 * must display.
502 */
503 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
504 indent_msg(err, 2);
505 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
506 ha_free(err);
507 }
508
509 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100510 if (err && *err)
511 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
512 else
513 memprintf(err, "'%s %s' : error encountered while processing '%s'",
514 args[0], args[1], args[cur_arg]);
515 return -1;
516 }
517
518 cur_arg += 1 + kw->skip;
519 continue;
520 }
521
Willy Tarreau433b05f2021-03-12 10:14:07 +0100522 best = bind_find_best_kw(args[cur_arg]);
523 if (best)
524 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
525 args[0], args[1], args[cur_arg], best);
526 else
527 memprintf(err, "'%s %s' : unknown keyword '%s'.",
528 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100529 return -1;
530 }
531
532 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100533 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100534 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100535 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
536 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100537 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100538 }
539 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100540 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100541 unsigned timeout;
542 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
543
Willy Tarreau9faebe32019-06-07 19:00:37 +0200544 if (res == PARSE_TIME_OVER) {
545 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
546 args[2], args[0], args[1]);
547 return -1;
548 }
549 else if (res == PARSE_TIME_UNDER) {
550 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
551 args[2], args[0], args[1]);
552 return -1;
553 }
554 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100555 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
556 return -1;
557 }
558
559 if (!timeout) {
560 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
561 return -1;
562 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100563 if (!global.cli_fe) {
564 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100565 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
566 return -1;
567 }
568 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100569 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100570 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100571 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100572 int maxconn = atol(args[2]);
573
574 if (maxconn <= 0) {
575 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
576 return -1;
577 }
578
Willy Tarreau4975d142021-03-13 11:00:33 +0100579 if (!global.cli_fe) {
580 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100581 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
582 return -1;
583 }
584 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100585 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100586 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100587 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100588 int cur_arg = 2;
589 unsigned long set = 0;
590
Willy Tarreau4975d142021-03-13 11:00:33 +0100591 if (!global.cli_fe) {
592 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100593 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
594 return -1;
595 }
596 }
597
598 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100599 if (strcmp(args[cur_arg], "all") == 0) {
600 set = 0;
601 break;
602 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200603 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100604 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100605 return -1;
606 }
607 cur_arg++;
608 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100609 }
610 else {
611 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
612 return -1;
613 }
614 return 0;
615}
616
William Lallemand33d29e22019-04-01 11:30:06 +0200617/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200618 * This function exports the bound addresses of a <frontend> in the environment
619 * variable <varname>. Those addresses are separated by semicolons and prefixed
620 * with their type (abns@, unix@, sockpair@ etc)
621 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200622 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200623int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200624{
625 struct buffer *trash = get_trash_chunk();
626 struct bind_conf *bind_conf;
627
William Lallemand9a37fd02019-04-12 16:09:24 +0200628 if (frontend) {
629 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200630 struct listener *l;
631
632 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
633 char addr[46];
634 char port[6];
635
William Lallemand620072b2019-04-12 16:09:25 +0200636 /* separate listener by semicolons */
637 if (trash->data)
638 chunk_appendf(trash, ";");
639
Willy Tarreau37159062020-08-27 07:48:42 +0200640 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200641 const struct sockaddr_un *un;
642
Willy Tarreau37159062020-08-27 07:48:42 +0200643 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200644 if (un->sun_path[0] == '\0') {
645 chunk_appendf(trash, "abns@%s", un->sun_path+1);
646 } else {
647 chunk_appendf(trash, "unix@%s", un->sun_path);
648 }
Willy Tarreau37159062020-08-27 07:48:42 +0200649 } else if (l->rx.addr.ss_family == AF_INET) {
650 addr_to_str(&l->rx.addr, addr, sizeof(addr));
651 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200652 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200653 } else if (l->rx.addr.ss_family == AF_INET6) {
654 addr_to_str(&l->rx.addr, addr, sizeof(addr));
655 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200656 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200657 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
658 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200659 }
William Lallemand33d29e22019-04-01 11:30:06 +0200660 }
661 }
662 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200663 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200664 return -1;
665 }
666
667 return 0;
668}
669
William Lallemand9a37fd02019-04-12 16:09:24 +0200670int cli_socket_setenv()
671{
Willy Tarreau4975d142021-03-13 11:00:33 +0100672 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200673 return -1;
674 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
675 return -1;
676
677 return 0;
678}
679
William Lallemand33d29e22019-04-01 11:30:06 +0200680REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
681
Willy Tarreaude57a572016-11-23 17:01:39 +0100682/* Verifies that the CLI at least has a level at least as high as <level>
683 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
684 * failure, an error message is prepared and the appctx's state is adjusted
685 * to print it so that a return 1 is enough to abort any processing.
686 */
687int cli_has_level(struct appctx *appctx, int level)
688{
Willy Tarreaude57a572016-11-23 17:01:39 +0100689
William Lallemandf630d012018-12-13 09:05:44 +0100690 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100691 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100692 return 0;
693 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100694 return 1;
695}
696
William Lallemandb7ea1412018-12-13 09:05:47 +0100697/* same as cli_has_level but for the CLI proxy and without error message */
698int pcli_has_level(struct stream *s, int level)
699{
700 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
701 return 0;
702 }
703 return 1;
704}
705
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200706/* Returns severity_output for the current session if set, or default for the socket */
707static int cli_get_severity_output(struct appctx *appctx)
708{
709 if (appctx->cli_severity_output)
710 return appctx->cli_severity_output;
Christopher Faulet908628c2022-03-25 16:43:49 +0100711 return strm_li(__cs_strm(appctx->owner))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200712}
William Lallemand74c24fb2016-11-21 17:18:36 +0100713
Willy Tarreau41908562016-11-24 16:23:38 +0100714/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100715 * from the CLI's IO handler running in an appctx context. The function returns
716 * 1 if the request was understood, otherwise zero (in which case an error
717 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100718 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
719 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
720 * have its own I/O handler called again. Most of the time, parsers will only
721 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100722 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
723 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100724 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200725static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100726{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100727 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200728 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100729 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100730
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200731 appctx->st2 = 0;
732 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100733
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200734 p = appctx->chunk->area;
735 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100736
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738 * Get pointers on words.
739 * One extra slot is reserved to store a pointer on a null byte.
740 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100741 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200744 /* skip leading spaces/tabs */
745 p += strspn(p, " \t");
746 if (!*p)
747 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200748
749 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
750 /* payload pattern recognized here, this is not an arg anymore,
751 * the payload starts at the first byte that follows the zero
752 * after the pattern.
753 */
754 payload = p + strlen(PAYLOAD_PATTERN) + 1;
755 break;
756 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100757
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200758 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200759 while (1) {
760 p += strcspn(p, " \t\\");
761 /* escaped chars using backlashes (\) */
762 if (*p == '\\') {
763 if (!*++p)
764 break;
765 if (!*++p)
766 break;
767 } else {
768 break;
769 }
770 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200771 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100772
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200773 /* unescape backslashes (\) */
774 for (j = 0, k = 0; args[i][k]; k++) {
775 if (args[i][k] == '\\') {
776 if (args[i][k + 1] == '\\')
777 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100778 else
779 continue;
780 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200781 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100782 j++;
783 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200784 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100785
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200786 i++;
787 }
788 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200789 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100790 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200791 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100792
793 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100794 if (!kw ||
795 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100796 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
797 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100798 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100799 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100800 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100801 }
William Lallemand14721be2018-10-26 14:47:37 +0200802
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100803 /* don't handle expert mode commands if not in this mode. */
804 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
805 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200806 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100807 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200808
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100809 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
810 cli_err(appctx, "This command is restricted to experimental mode only.\n");
811 return 0;
812 }
813
Amaury Denoyellef4929922021-05-05 16:29:23 +0200814 if (kw->level == ACCESS_EXPERT)
815 mark_tainted(TAINTED_CLI_EXPERT_MODE);
816 else if (kw->level == ACCESS_EXPERIMENTAL)
817 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
818
Willy Tarreau41908562016-11-24 16:23:38 +0100819 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200820 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200821
822 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
823 goto fail;
824
825 /* kw->parse could set its own io_handler or io_release handler */
826 if (!appctx->io_handler)
827 goto fail;
828
829 appctx->st0 = CLI_ST_CALLBACK;
830 return 1;
831fail:
832 appctx->io_handler = NULL;
833 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100834 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100835}
836
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200837/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
838static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
839{
Willy Tarreau83061a82018-07-13 11:56:34 +0200840 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200841
842 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200843 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200844
845 tmp = get_trash_chunk();
846 chunk_reset(tmp);
847
848 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100849 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200850 chunk_printf(tmp, "[%d]: ", severity);
851 }
852 else {
853 switch (severity_output) {
854 case CLI_SEVERITY_NUMBER:
855 chunk_printf(tmp, "[%d]: ", severity);
856 break;
857 case CLI_SEVERITY_STRING:
858 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
859 break;
860 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100861 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200862 }
863 }
864 chunk_appendf(tmp, "%s", msg);
865
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200866 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200867}
868
William Lallemand74c24fb2016-11-21 17:18:36 +0100869/* This I/O handler runs as an applet embedded in a stream interface. It is
870 * used to processes I/O from/to the stats unix socket. The system relies on a
871 * state machine handling requests and various responses. We read a request,
872 * then we process it and send the response, and we possibly display a prompt.
873 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100874 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100875 * or not.
876 */
877static void cli_io_handler(struct appctx *appctx)
878{
Christopher Faulet908628c2022-03-25 16:43:49 +0100879 struct conn_stream *cs = appctx->owner;
880 struct channel *req = cs_oc(cs);
881 struct channel *res = cs_ic(cs);
882 struct bind_conf *bind_conf = strm_li(__cs_strm(cs))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100883 int reql;
884 int len;
885
Christopher Faulet908628c2022-03-25 16:43:49 +0100886 if (unlikely(cs->si->state == SI_ST_DIS || cs->si->state == SI_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100887 goto out;
888
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800889 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200890 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100891 /* buf.size==0 means we failed to get a buffer and were
892 * already subscribed to a wait list to get a buffer.
893 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100894 goto out;
895 }
896
William Lallemand74c24fb2016-11-21 17:18:36 +0100897 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100898 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100899 /* Stats output not initialized yet */
900 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200901 /* reset severity to default at init */
902 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100903 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100904 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100905 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100906 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100907 /* Let's close for real now. We just close the request
908 * side, the conditions below will complete if needed.
909 */
Christopher Faulet908628c2022-03-25 16:43:49 +0100910 si_shutw(cs->si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200911 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200912 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100913 break;
914 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100915 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200916 char *str;
917
918 /* use a trash chunk to store received data */
919 if (!appctx->chunk) {
920 appctx->chunk = alloc_trash_chunk();
921 if (!appctx->chunk) {
922 appctx->st0 = CLI_ST_END;
923 continue;
924 }
925 }
926
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200927 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200928
William Lallemand74c24fb2016-11-21 17:18:36 +0100929 /* ensure we have some output room left in the event we
930 * would want to return some info right after parsing.
931 */
Christopher Faulet908628c2022-03-25 16:43:49 +0100932 if (buffer_almost_full(cs_ib(cs))) {
933 si_rx_room_blk(cs->si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100934 break;
935 }
936
Willy Tarreau0011c252022-01-19 17:23:52 +0100937 /* payload doesn't take escapes nor does it end on semi-colons, so
938 * we use the regular getline. Normal mode however must stop on
939 * LFs and semi-colons that are not prefixed by a backslash. Note
940 * that we reserve one byte at the end to insert a trailing nul byte.
941 */
942
943 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Christopher Faulet908628c2022-03-25 16:43:49 +0100944 reql = co_getline(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100945 appctx->chunk->size - appctx->chunk->data - 1);
946 else
Christopher Faulet908628c2022-03-25 16:43:49 +0100947 reql = co_getdelim(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100948 appctx->chunk->size - appctx->chunk->data - 1,
949 "\n;", '\\');
950
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 if (reql <= 0) { /* closed or EOL not found */
952 if (reql == 0)
953 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100954 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100955 continue;
956 }
957
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200958 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
959 /* seek for a possible unescaped semi-colon. If we find
960 * one, we replace it with an LF and skip only this part.
961 */
962 for (len = 0; len < reql; len++) {
963 if (str[len] == '\\') {
964 len++;
965 continue;
966 }
967 if (str[len] == ';') {
968 str[len] = '\n';
969 reql = len + 1;
970 break;
971 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100972 }
973 }
974
975 /* now it is time to check that we have a full line,
976 * remove the trailing \n and possibly \r, then cut the
977 * line.
978 */
979 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200980 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100981 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100982 continue;
983 }
984
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200985 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100986 len--;
987
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200988 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200989 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200990
991 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200992 appctx->chunk->area[appctx->chunk->data] = '\n';
993 appctx->chunk->area[appctx->chunk->data + 1] = 0;
994 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200995 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100996
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100997 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200998
999 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1000 /* empty line */
1001 if (!len) {
1002 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001003 appctx->chunk->data -= 2;
1004 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001005 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001006 chunk_reset(appctx->chunk);
1007 /* NB: cli_sock_parse_request() may have put
1008 * another CLI_ST_O_* into appctx->st0.
1009 */
1010
1011 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001012 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001013 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001014 else {
1015 /*
1016 * Look for the "payload start" pattern at the end of a line
1017 * Its location is not remembered here, this is just to switch
1018 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001019 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001020 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001021 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001022 appctx->chunk->data++; // keep the trailing \0 after '<<'
1023 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001024 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001025 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001026 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001027 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001028 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001029 }
1030
1031 /* re-adjust req buffer */
Christopher Faulet908628c2022-03-25 16:43:49 +01001032 co_skip(cs_oc(cs), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001033 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1034 }
1035 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001036 const char *msg;
1037 int sev;
1038
William Lallemand74c24fb2016-11-21 17:18:36 +01001039 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001040 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001041 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001042 case CLI_ST_PRINT: /* print const message in msg */
1043 case CLI_ST_PRINT_ERR: /* print const error in msg */
1044 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1045 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
1046 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1047 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
1048 LOG_ERR : appctx->ctx.cli.severity;
1049 msg = appctx->ctx.cli.msg;
1050 }
1051 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1052 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
1053 LOG_ERR : appctx->ctx.cli.severity;
1054 msg = appctx->ctx.cli.err;
1055 if (!msg) {
1056 sev = LOG_ERR;
1057 msg = "Out of memory.\n";
1058 }
1059 }
1060 else {
1061 sev = LOG_ERR;
1062 msg = "Internal error.\n";
1063 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001064
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001065 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1066 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1067 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001068 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001069 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001070 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001071 }
1072 else
Christopher Faulet908628c2022-03-25 16:43:49 +01001073 si_rx_room_blk(cs->si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001074 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001075
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001076 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001077 if (appctx->io_handler)
1078 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001079 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001080 if (appctx->io_release) {
1081 appctx->io_release(appctx);
1082 appctx->io_release = NULL;
1083 }
1084 }
1085 break;
1086 default: /* abnormal state */
Christopher Faulet908628c2022-03-25 16:43:49 +01001087 cs->si->flags |= SI_FL_ERR;
William Lallemand74c24fb2016-11-21 17:18:36 +01001088 break;
1089 }
1090
1091 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001092 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001093 const char *prompt = "";
1094
1095 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1096 /*
1097 * when entering a payload with interactive mode, change the prompt
1098 * to emphasize that more data can still be sent
1099 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001100 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001101 prompt = "+ ";
1102 else
1103 prompt = "\n> ";
1104 }
1105 else {
William Lallemandad032882019-07-01 10:56:15 +02001106 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001107 prompt = "\n";
1108 }
1109
Christopher Faulet908628c2022-03-25 16:43:49 +01001110 if (ci_putstr(cs_ic(cs), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001111 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 else
Christopher Faulet908628c2022-03-25 16:43:49 +01001113 si_rx_room_blk(cs->si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001114 }
1115
1116 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001117 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001118 break;
1119
1120 /* Now we close the output if one of the writers did so,
1121 * or if we're not in interactive mode and the request
1122 * buffer is empty. This still allows pipelined requests
1123 * to be sent in non-interactive mode.
1124 */
William Lallemand3de09d52018-12-11 16:10:56 +01001125 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1126 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001127 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001128 continue;
1129 }
1130
1131 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001132 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001133 /* reactivate the \n at the end of the response for the next command */
1134 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001135
1136 /* this forces us to yield between pipelined commands and
1137 * avoid extremely long latencies (e.g. "del map" etc). In
1138 * addition this increases the likelihood that the stream
1139 * refills the buffer with new bytes in non-interactive
1140 * mode, avoiding to close on apparently empty commands.
1141 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001142 if (co_data(cs_oc(cs))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001143 appctx_wakeup(appctx);
1144 goto out;
1145 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001146 }
1147 }
1148
Christopher Faulet908628c2022-03-25 16:43:49 +01001149 if ((res->flags & CF_SHUTR) && (cs->si->state == SI_ST_EST)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001150 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet908628c2022-03-25 16:43:49 +01001151 __FUNCTION__, __LINE__, req->flags, res->flags, cs->si->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 /* Other side has closed, let's abort if we have no more processing to do
1153 * and nothing more to consume. This is comparable to a broken pipe, so
1154 * we forward the close to the request side so that it flows upstream to
1155 * the client.
1156 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001157 si_shutw(cs->si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001158 }
1159
Christopher Faulet908628c2022-03-25 16:43:49 +01001160 if ((req->flags & CF_SHUTW) && (cs->si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001161 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet908628c2022-03-25 16:43:49 +01001162 __FUNCTION__, __LINE__, req->flags, res->flags, cs->si->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001163 /* We have no more processing to do, and nothing more to send, and
1164 * the client side has closed. So we'll forward this state downstream
1165 * on the response buffer.
1166 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001167 si_shutr(cs->si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001168 res->flags |= CF_READ_NULL;
1169 }
1170
1171 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001172 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 +01001173 __FUNCTION__, __LINE__,
Christopher Faulet908628c2022-03-25 16:43:49 +01001174 cs->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 +01001175}
1176
William Lallemand74c24fb2016-11-21 17:18:36 +01001177/* This is called when the stream interface is closed. For instance, upon an
1178 * external abort, we won't call the i/o handler anymore so we may need to
1179 * remove back references to the stream currently being dumped.
1180 */
1181static void cli_release_handler(struct appctx *appctx)
1182{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001183 free_trash_chunk(appctx->chunk);
1184 appctx->chunk = NULL;
1185
William Lallemand74c24fb2016-11-21 17:18:36 +01001186 if (appctx->io_release) {
1187 appctx->io_release(appctx);
1188 appctx->io_release = NULL;
1189 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001190 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001191 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001193}
1194
1195/* This function dumps all environmnent variables to the buffer. It returns 0
1196 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001197 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1198 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001199 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001200static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001201{
Christopher Faulet908628c2022-03-25 16:43:49 +01001202 struct conn_stream *cs = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001203 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001204
Christopher Faulet908628c2022-03-25 16:43:49 +01001205 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001206 return 1;
1207
1208 chunk_reset(&trash);
1209
1210 /* we have two inner loops here, one for the proxy, the other one for
1211 * the buffer.
1212 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001213 while (*var) {
1214 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001215
Christopher Faulet908628c2022-03-25 16:43:49 +01001216 if (ci_putchk(cs_ic(cs), &trash) == -1) {
1217 si_rx_room_blk(cs->si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001218 return 0;
1219 }
1220 if (appctx->st2 == STAT_ST_END)
1221 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001222 var++;
1223 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001224 }
1225
1226 /* dump complete */
1227 return 1;
1228}
1229
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001230/* This function dumps all file descriptors states (or the requested one) to
1231 * the buffer. It returns 0 if the output buffer is full and it needs to be
1232 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1233 * It uses cli.i0 as the fd number to restart from.
1234 */
1235static int cli_io_handler_show_fd(struct appctx *appctx)
1236{
Christopher Faulet908628c2022-03-25 16:43:49 +01001237 struct conn_stream *cs = appctx->owner;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001238 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001239 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001240
Christopher Faulet908628c2022-03-25 16:43:49 +01001241 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001242 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001243
1244 chunk_reset(&trash);
1245
Willy Tarreauca1b1572018-12-18 15:45:11 +01001246 /* isolate the threads once per round. We're limited to a buffer worth
1247 * of output anyway, it cannot last very long.
1248 */
1249 thread_isolate();
1250
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001251 /* we have two inner loops here, one for the proxy, the other one for
1252 * the buffer.
1253 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001254 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001255 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001256 const struct listener *li = NULL;
1257 const struct server *sv = NULL;
1258 const struct proxy *px = NULL;
1259 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001260 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001261 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001262 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001263 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001264 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001265 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001266 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001267
1268 fdt = fdtab[fd];
1269
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001270 /* When DEBUG_FD is set, we also report closed FDs that have a
1271 * non-null event count to detect stuck ones.
1272 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001273 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001274#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001275 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001276#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001277 goto skip; // closed
1278 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001279 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001280 conn = (const struct connection *)fdt.owner;
1281 conn_flags = conn->flags;
1282 mux = conn->mux;
1283 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001284 xprt = conn->xprt;
1285 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001286 li = objt_listener(conn->target);
1287 sv = objt_server(conn->target);
1288 px = objt_proxy(conn->target);
1289 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001290 if (atleast2(fdt.thread_mask))
1291 suspicious = 1;
1292 if (conn->handle.fd != fd)
1293 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001294 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001295 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001296 li = fdt.owner;
1297
Willy Tarreaudacfde42021-01-21 09:07:29 +01001298 if (!fdt.thread_mask)
1299 suspicious = 1;
1300
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001301 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001302 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001303 fd,
1304 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001305 (fdt.state & FD_CLONED) ? 'C' : 'c',
1306 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001307 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1308 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1309 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1310 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1311 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001312 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1313 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1314 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1315 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1316 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1317 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001318 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001319 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001320 fdt.iocb);
1321 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001322
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001323 if (!fdt.owner) {
1324 chunk_appendf(&trash, ")");
1325 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001326 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001327 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001328
1329 if (conn->handle.fd != fd) {
1330 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1331 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001332 } else {
1333 struct sockaddr_storage sa;
1334 socklen_t salen;
1335
1336 salen = sizeof(sa);
1337 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1338 if (sa.ss_family == AF_INET)
1339 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1340 else if (sa.ss_family == AF_INET6)
1341 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1342 else if (sa.ss_family == AF_UNIX)
1343 chunk_appendf(&trash, " fam=unix");
1344 }
1345
1346 salen = sizeof(sa);
1347 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1348 if (sa.ss_family == AF_INET)
1349 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1350 else if (sa.ss_family == AF_INET6)
1351 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1352 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001353 }
1354
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001355 if (px)
1356 chunk_appendf(&trash, " px=%s", px->id);
1357 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001358 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001359 else if (li)
1360 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001361
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001362 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001363 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001364 if (!ctx)
1365 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001366 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001367 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001368 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001369 else
1370 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001371
1372 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001373 if (xprt) {
1374 if (xprt_ctx || xprt->show_fd)
1375 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1376 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001377 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001378 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001379 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001380 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001381 struct sockaddr_storage sa;
1382 socklen_t salen;
1383
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001384 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001385 listener_state_str(li),
1386 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001387
1388 salen = sizeof(sa);
1389 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1390 if (sa.ss_family == AF_INET)
1391 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1392 else if (sa.ss_family == AF_INET6)
1393 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1394 else if (sa.ss_family == AF_UNIX)
1395 chunk_appendf(&trash, " fam=unix");
1396 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001397 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001398 else
1399 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001400
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001401#ifdef DEBUG_FD
1402 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001403 if (fdtab[fd].event_count >= 1000000)
1404 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001405#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001406 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001407
Christopher Faulet908628c2022-03-25 16:43:49 +01001408 if (ci_putchk(cs_ic(cs), &trash) == -1) {
1409 si_rx_room_blk(cs->si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001410 appctx->ctx.cli.i0 = fd;
1411 ret = 0;
1412 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001413 }
1414 skip:
1415 if (appctx->st2 == STAT_ST_END)
1416 break;
1417
1418 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001419 }
1420
Willy Tarreauca1b1572018-12-18 15:45:11 +01001421 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001422 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001423
1424 thread_release();
1425 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001426}
1427
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001428/* This function dumps some activity counters used by developers and support to
1429 * rule out some hypothesis during bug reports. It returns 0 if the output
1430 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1431 * everything at once in the buffer and is not designed to do it in multiple
1432 * passes.
1433 */
1434static int cli_io_handler_show_activity(struct appctx *appctx)
1435{
Christopher Faulet908628c2022-03-25 16:43:49 +01001436 struct conn_stream *cs = appctx->owner;
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001437 int thr;
1438
Christopher Faulet908628c2022-03-25 16:43:49 +01001439 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001440 return 1;
1441
1442 chunk_reset(&trash);
1443
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001444#undef SHOW_TOT
1445#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001446 do { \
1447 unsigned int _v[MAX_THREADS]; \
1448 unsigned int _tot; \
1449 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001450 _tot = t = 0; \
1451 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001452 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001453 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001454 if (_nbt == 1) { \
1455 chunk_appendf(&trash, " %u\n", _tot); \
1456 break; \
1457 } \
1458 chunk_appendf(&trash, " %u [", _tot); \
1459 for (t = 0; t < _nbt; t++) \
1460 chunk_appendf(&trash, " %u", _v[t]); \
1461 chunk_appendf(&trash, " ]\n"); \
1462 } while (0)
1463
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001464#undef SHOW_AVG
1465#define SHOW_AVG(t, x) \
1466 do { \
1467 unsigned int _v[MAX_THREADS]; \
1468 unsigned int _tot; \
1469 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001470 _tot = t = 0; \
1471 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001472 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001473 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001474 if (_nbt == 1) { \
1475 chunk_appendf(&trash, " %u\n", _tot); \
1476 break; \
1477 } \
1478 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1479 for (t = 0; t < _nbt; t++) \
1480 chunk_appendf(&trash, " %u", _v[t]); \
1481 chunk_appendf(&trash, " ]\n"); \
1482 } while (0)
1483
Willy Tarreaua0211b82019-05-28 15:09:08 +02001484 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1485 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001486 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1487 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1488 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1489 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001490 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001491 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1492 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001493 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001494 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001495 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001496 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001497 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001498 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001499 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1500 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001501 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1502 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1503 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1504 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1505 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1506 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1507 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001508#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001509 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 +02001510 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001511#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001512
Willy Tarreaud6a78502019-05-27 07:03:38 +02001513#if defined(DEBUG_DEV)
1514 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001515 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1516 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1517 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001518#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001519
Christopher Faulet908628c2022-03-25 16:43:49 +01001520 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001521 chunk_reset(&trash);
1522 chunk_printf(&trash, "[output too large, cannot dump]\n");
Christopher Faulet908628c2022-03-25 16:43:49 +01001523 si_rx_room_blk(cs->si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001524 }
1525
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001526#undef SHOW_AVG
1527#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001528 /* dump complete */
1529 return 1;
1530}
1531
William Lallemandeceddf72016-12-15 18:06:44 +01001532/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001533 * CLI IO handler for `show cli sockets`.
1534 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001535 */
1536static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1537{
1538 struct bind_conf *bind_conf;
Christopher Faulet908628c2022-03-25 16:43:49 +01001539 struct conn_stream *cs = appctx->owner;
William Lallemandeceddf72016-12-15 18:06:44 +01001540
1541 chunk_reset(&trash);
1542
1543 switch (appctx->st2) {
1544 case STAT_ST_INIT:
1545 chunk_printf(&trash, "# socket lvl processes\n");
Christopher Faulet908628c2022-03-25 16:43:49 +01001546 if (ci_putchk(cs_ic(cs), &trash) == -1) {
1547 si_rx_room_blk(cs->si);
William Lallemandeceddf72016-12-15 18:06:44 +01001548 return 0;
1549 }
William Lallemandeceddf72016-12-15 18:06:44 +01001550 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001551 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001552
1553 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001554 if (global.cli_fe) {
1555 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001556 struct listener *l;
1557
1558 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001559 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001560 * if the current node is the first of the list
1561 */
1562
Willy Tarreau3af9d832016-12-16 12:58:09 +01001563 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001564 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001565 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001566 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001567 continue;
1568 }
1569
1570 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1571
1572 char addr[46];
1573 char port[6];
1574
Willy Tarreau37159062020-08-27 07:48:42 +02001575 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001576 const struct sockaddr_un *un;
1577
Willy Tarreau37159062020-08-27 07:48:42 +02001578 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001579 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001580 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001581 } else {
1582 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1583 }
Willy Tarreau37159062020-08-27 07:48:42 +02001584 } else if (l->rx.addr.ss_family == AF_INET) {
1585 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1586 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001587 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001588 } else if (l->rx.addr.ss_family == AF_INET6) {
1589 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1590 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001591 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001592 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1593 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001594 } else
William Lallemand26314342018-10-26 14:47:41 +02001595 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001596
William Lallemand07a62f72017-05-24 00:57:40 +02001597 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001598 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001599 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1600 chunk_appendf(&trash, "operator ");
1601 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1602 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001603 else
1604 chunk_appendf(&trash, " ");
1605
Willy Tarreau72faef32021-06-15 08:36:30 +02001606 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001607
Christopher Faulet908628c2022-03-25 16:43:49 +01001608 if (ci_putchk(cs_ic(cs), &trash) == -1) {
1609 si_rx_room_blk(cs->si);
William Lallemandeceddf72016-12-15 18:06:44 +01001610 return 0;
1611 }
1612 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001613 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001614 }
1615 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001616 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001617 default:
1618 appctx->st2 = STAT_ST_FIN;
1619 return 1;
1620 }
1621}
1622
1623
Willy Tarreau0a739292016-11-22 20:21:23 +01001624/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001625 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1626 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001627 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001628static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001629{
1630 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001631 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001632
1633 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1634 return 1;
1635
Willy Tarreauf6710f82016-12-16 17:45:44 +01001636 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001637
1638 if (*args[2]) {
1639 int len = strlen(args[2]);
1640
Willy Tarreauf6710f82016-12-16 17:45:44 +01001641 for (; *var; var++) {
1642 if (strncmp(*var, args[2], len) == 0 &&
1643 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001644 break;
1645 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001646 if (!*var)
1647 return cli_err(appctx, "Variable not found\n");
1648
Willy Tarreau0a739292016-11-22 20:21:23 +01001649 appctx->st2 = STAT_ST_END;
1650 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001651 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001652 return 0;
1653}
1654
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001655/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1656 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1657 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1658 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001659static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001660{
1661 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1662 return 1;
1663
1664 appctx->ctx.cli.i0 = 0;
1665
1666 if (*args[2]) {
1667 appctx->ctx.cli.i0 = atoi(args[2]);
1668 appctx->st2 = STAT_ST_END;
1669 }
1670 return 0;
1671}
1672
Willy Tarreau599852e2016-11-22 20:33:32 +01001673/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001674static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001675{
Christopher Faulet908628c2022-03-25 16:43:49 +01001676 struct stream *s = __cs_strm(appctx->owner);
Willy Tarreau599852e2016-11-22 20:33:32 +01001677
1678 if (strcmp(args[2], "cli") == 0) {
1679 unsigned timeout;
1680 const char *res;
1681
Willy Tarreau9d008692019-08-09 11:21:01 +02001682 if (!*args[3])
1683 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001684
1685 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001686 if (res || timeout < 1)
1687 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001688
1689 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1690 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1691 return 1;
1692 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001693
1694 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001695}
1696
Willy Tarreau2af99412016-11-23 11:10:59 +01001697/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001698static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001699{
1700 int v;
1701
1702 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1703 return 1;
1704
Willy Tarreau9d008692019-08-09 11:21:01 +02001705 if (!*args[3])
1706 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001707
1708 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001709 if (v > global.hardmaxconn)
1710 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001711
1712 /* check for unlimited values */
1713 if (v <= 0)
1714 v = global.hardmaxconn;
1715
1716 global.maxconn = v;
1717
1718 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001719 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001720
1721 return 1;
1722}
1723
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001724static int set_severity_output(int *target, char *argument)
1725{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001726 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001727 *target = CLI_SEVERITY_NONE;
1728 return 1;
1729 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001730 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001731 *target = CLI_SEVERITY_NUMBER;
1732 return 1;
1733 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001734 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001735 *target = CLI_SEVERITY_STRING;
1736 return 1;
1737 }
1738 return 0;
1739}
1740
1741/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001742static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001743{
1744 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1745 return 0;
1746
Willy Tarreau9d008692019-08-09 11:21:01 +02001747 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001748}
William Lallemandeceddf72016-12-15 18:06:44 +01001749
William Lallemand67a234f2018-12-13 09:05:45 +01001750
1751/* show the level of the current CLI session */
1752static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1753{
William Lallemand67a234f2018-12-13 09:05:45 +01001754 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001755 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001756 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001757 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001758 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001759 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001760 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001761 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001762}
1763
1764/* parse and set the CLI level dynamically */
1765static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1766{
William Lallemandad032882019-07-01 10:56:15 +02001767 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001768 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001769 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1770
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001771 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001772 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1773 return 1;
1774 }
1775 appctx->cli_level &= ~ACCESS_LVL_MASK;
1776 appctx->cli_level |= ACCESS_LVL_OPER;
1777
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001778 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001779 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1780 return 1;
1781 }
1782 appctx->cli_level &= ~ACCESS_LVL_MASK;
1783 appctx->cli_level |= ACCESS_LVL_USER;
1784 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001785 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001786 return 1;
1787}
1788
1789
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001790/* parse and set the CLI expert/experimental-mode dynamically */
1791static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001792{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001793 int level;
1794 char *level_str;
1795 char *output = NULL;
1796
William Lallemand7267f782022-02-01 16:08:50 +01001797 /* this will ask the applet to not output a \n after the command */
1798 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1799 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1800
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001801 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1802 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001803
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001804 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001805 level = ACCESS_EXPERT;
1806 level_str = "expert-mode";
1807 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001808 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001809 level = ACCESS_EXPERIMENTAL;
1810 level_str = "experimental-mode";
1811 }
William Lallemand2a171912022-02-02 11:43:20 +01001812 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1813 level = ACCESS_MCLI_DEBUG;
1814 level_str = "mcli-debug-mode";
1815 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001816 else {
1817 return 1;
1818 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001819
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001820 if (!*args[1]) {
1821 memprintf(&output, "%s is %s\n", level_str,
1822 (appctx->cli_level & level) ? "ON" : "OFF");
1823 return cli_dynmsg(appctx, LOG_INFO, output);
1824 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001825
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001826 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001827 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001828 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001829 return 1;
1830}
1831
William Lallemand740629e2021-12-14 15:22:29 +01001832/* shows HAProxy version */
1833static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1834{
1835 char *msg = NULL;
1836
1837 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1838}
1839
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001840int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001841{
1842 return 0;
1843}
1844
Willy Tarreau45c742b2016-11-24 14:51:17 +01001845/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001846static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001847{
1848 int v;
1849 int *res;
1850 int mul = 1;
1851
1852 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1853 return 1;
1854
1855 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1856 res = &global.cps_lim;
1857 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1858 res = &global.sps_lim;
1859#ifdef USE_OPENSSL
1860 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1861 res = &global.ssl_lim;
1862#endif
1863 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1864 res = &global.comp_rate_lim;
1865 mul = 1024;
1866 }
1867 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001868 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001869 "'set rate-limit' only supports :\n"
1870 " - 'connections global' to set the per-process maximum connection rate\n"
1871 " - 'sessions global' to set the per-process maximum session rate\n"
1872#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001873 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001874#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001875 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001876 }
1877
Willy Tarreau9d008692019-08-09 11:21:01 +02001878 if (!*args[4])
1879 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001880
1881 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001882 if (v < 0)
1883 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001884
1885 *res = v * mul;
1886
1887 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001888 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001889
1890 return 1;
1891}
1892
William Lallemandf6975e92017-05-26 17:42:10 +02001893/* parse the "expose-fd" argument on the bind lines */
1894static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1895{
1896 if (!*args[cur_arg + 1]) {
1897 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1898 return ERR_ALERT | ERR_FATAL;
1899 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001900 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001901 conf->level |= ACCESS_FD_LISTENERS;
1902 } else {
1903 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1904 args[cur_arg], args[cur_arg+1]);
1905 return ERR_ALERT | ERR_FATAL;
1906 }
1907
1908 return 0;
1909}
1910
William Lallemand74c24fb2016-11-21 17:18:36 +01001911/* parse the "level" argument on the bind lines */
1912static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1913{
1914 if (!*args[cur_arg + 1]) {
1915 memprintf(err, "'%s' : missing level", args[cur_arg]);
1916 return ERR_ALERT | ERR_FATAL;
1917 }
1918
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001919 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001920 conf->level &= ~ACCESS_LVL_MASK;
1921 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001922 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001923 conf->level &= ~ACCESS_LVL_MASK;
1924 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001925 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001926 conf->level &= ~ACCESS_LVL_MASK;
1927 conf->level |= ACCESS_LVL_ADMIN;
1928 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001929 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1930 args[cur_arg], args[cur_arg+1]);
1931 return ERR_ALERT | ERR_FATAL;
1932 }
1933
1934 return 0;
1935}
1936
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001937static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1938{
1939 if (!*args[cur_arg + 1]) {
1940 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1941 return ERR_ALERT | ERR_FATAL;
1942 }
1943
1944 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1945 return 0;
1946 else {
1947 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1948 args[cur_arg], args[cur_arg+1]);
1949 return ERR_ALERT | ERR_FATAL;
1950 }
1951}
1952
Olivier Houchardf886e342017-04-05 22:24:59 +02001953/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001954static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001955{
1956 char *cmsgbuf = NULL;
1957 unsigned char *tmpbuf = NULL;
1958 struct cmsghdr *cmsg;
Christopher Faulet908628c2022-03-25 16:43:49 +01001959 struct conn_stream *cs = appctx->owner;
1960 struct stream *s = __cs_strm(cs);
1961 struct connection *remote = cs_conn(cs_opposite(cs));
Olivier Houchardf886e342017-04-05 22:24:59 +02001962 struct msghdr msghdr;
1963 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001964 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001965 const char *ns_name, *if_name;
1966 unsigned char ns_nlen, if_nlen;
1967 int nb_queued;
1968 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001969 int *tmpfd;
1970 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001971 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001972 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001973 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001974 int ret;
1975
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001976 if (!remote) {
1977 ha_warning("Only works on real connections\n");
1978 goto out;
1979 }
1980
1981 fd = remote->handle.fd;
1982
Olivier Houchardf886e342017-04-05 22:24:59 +02001983 /* Temporary set the FD in blocking mode, that will make our life easier */
1984 old_fcntl = fcntl(fd, F_GETFL);
1985 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001986 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001987 goto out;
1988 }
1989 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1990 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001991 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001992 goto out;
1993 }
1994 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001995 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001996 goto out;
1997 }
Olivier Houchard54740872017-04-06 14:45:14 +02001998 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001999 iov.iov_base = &tot_fd_nb;
2000 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002001 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002002 goto out;
2003 memset(&msghdr, 0, sizeof(msghdr));
2004 /*
2005 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002006 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002007 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002008 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002009 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002010
Olivier Houchardf886e342017-04-05 22:24:59 +02002011 if (tot_fd_nb == 0)
2012 goto out;
2013
2014 /* First send the total number of file descriptors, so that the
2015 * receiving end knows what to expect.
2016 */
2017 msghdr.msg_iov = &iov;
2018 msghdr.msg_iovlen = 1;
2019 ret = sendmsg(fd, &msghdr, 0);
2020 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002021 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002022 goto out;
2023 }
2024
2025 /* Now send the fds */
2026 msghdr.msg_control = cmsgbuf;
2027 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2028 cmsg = CMSG_FIRSTHDR(&msghdr);
2029 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2030 cmsg->cmsg_level = SOL_SOCKET;
2031 cmsg->cmsg_type = SCM_RIGHTS;
2032 tmpfd = (int *)CMSG_DATA(cmsg);
2033
Olivier Houchardf886e342017-04-05 22:24:59 +02002034 /* For each socket, e message is sent, containing the following :
2035 * Size of the namespace name (or 0 if none), as an unsigned char.
2036 * The namespace name, if any
2037 * Size of the interface name (or 0 if none), as an unsigned char
2038 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002039 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002040 */
2041 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002042 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002043 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002044 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002045 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002046 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002047 goto out;
2048 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002049
2050 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002051 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002052 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002053 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002054 continue;
2055
2056 ns_name = if_name = "";
2057 ns_nlen = if_nlen = 0;
2058
2059 /* for now we can only retrieve namespaces and interfaces from
2060 * pure listeners.
2061 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002062 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002063 const struct listener *l = fdtab[cur_fd].owner;
2064
Willy Tarreau818a92e2020-09-03 07:50:19 +02002065 if (l->rx.settings->interface) {
2066 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002067 if_nlen = strlen(if_name);
2068 }
2069
2070#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002071 if (l->rx.settings->netns) {
2072 ns_name = l->rx.settings->netns->node.key;
2073 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002074 }
2075#endif
2076 }
2077
2078 /* put the FD into the CMSG_DATA */
2079 tmpfd[nb_queued++] = cur_fd;
2080
2081 /* first block is <ns_name_len> <ns_name> */
2082 tmpbuf[curoff++] = ns_nlen;
2083 if (ns_nlen)
2084 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2085 curoff += ns_nlen;
2086
2087 /* second block is <if_name_len> <if_name> */
2088 tmpbuf[curoff++] = if_nlen;
2089 if (if_nlen)
2090 memcpy(tmpbuf + curoff, if_name, if_nlen);
2091 curoff += if_nlen;
2092
2093 /* we used to send the listener options here before 2.3 */
2094 memset(tmpbuf + curoff, 0, sizeof(int));
2095 curoff += sizeof(int);
2096
2097 /* there's a limit to how many FDs may be sent at once */
2098 if (nb_queued == MAX_SEND_FD) {
2099 iov.iov_len = curoff;
2100 if (sendmsg(fd, &msghdr, 0) != curoff) {
2101 ha_warning("Failed to transfer sockets\n");
2102 return -1;
2103 }
2104
2105 /* Wait for an ack */
2106 do {
2107 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2108 } while (ret == -1 && errno == EINTR);
2109
2110 if (ret <= 0) {
2111 ha_warning("Unexpected error while transferring sockets\n");
2112 return -1;
2113 }
2114 curoff = 0;
2115 nb_queued = 0;
2116 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002117 }
2118
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002119 /* flush pending stuff */
2120 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002121 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002122 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2123 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002124 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002125 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002126 goto out;
2127 }
2128 }
2129
2130out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002131 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002132 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002133 goto out;
2134 }
2135 appctx->st0 = CLI_ST_END;
2136 free(cmsgbuf);
2137 free(tmpbuf);
2138 return 1;
2139}
2140
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002141static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2142{
2143 if (*args[0] == 'h')
2144 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002145 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002146 else if (*args[0] == 'p')
2147 /* prompt */
2148 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2149 else if (*args[0] == 'q')
2150 /* quit */
2151 appctx->st0 = CLI_ST_END;
2152
2153 return 1;
2154}
Olivier Houchardf886e342017-04-05 22:24:59 +02002155
William Lallemand2f4ce202018-10-26 14:47:47 +02002156void pcli_write_prompt(struct stream *s)
2157{
2158 struct buffer *msg = get_trash_chunk();
Christopher Faulet908628c2022-03-25 16:43:49 +01002159 struct channel *oc = cs_oc(s->csf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002160
William Lallemanddc12c2e2018-12-13 09:05:46 +01002161 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002162 return;
2163
William Lallemanddc12c2e2018-12-13 09:05:46 +01002164 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002165 chunk_appendf(msg, "+ ");
2166 } else {
2167 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002168 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002169 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002170 else
William Lallemanddae12c72022-02-02 14:13:54 +01002171 chunk_appendf(msg, "%d", s->pcli_next_pid);
2172
2173 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2174 chunk_appendf(msg, "(");
2175
2176 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2177 chunk_appendf(msg, "x");
2178
2179 if (s->pcli_flags & ACCESS_EXPERT)
2180 chunk_appendf(msg, "e");
2181
2182 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2183 chunk_appendf(msg, "d");
2184
2185 chunk_appendf(msg, ")");
2186 }
2187
2188 chunk_appendf(msg, "> ");
2189
2190
William Lallemandebf61802018-12-11 16:10:57 +01002191 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002192 co_inject(oc, msg->area, msg->data);
2193}
2194
William Lallemand291810d2018-10-26 14:47:38 +02002195
William Lallemandcf62f7e2018-10-26 14:47:40 +02002196/* The pcli_* functions are used for the CLI proxy in the master */
2197
William Lallemanddeeaa592018-10-26 14:47:48 +02002198void pcli_reply_and_close(struct stream *s, const char *msg)
2199{
2200 struct buffer *buf = get_trash_chunk();
2201
2202 chunk_initstr(buf, msg);
Christopher Faulet0c247df2021-12-23 13:29:48 +01002203 si_retnclose(cs_si(s->csf), buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002204}
2205
William Lallemand291810d2018-10-26 14:47:38 +02002206static enum obj_type *pcli_pid_to_server(int proc_pid)
2207{
2208 struct mworker_proc *child;
2209
William Lallemand99e0bb92020-11-05 10:28:53 +01002210 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002211 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002212 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002213
William Lallemand291810d2018-10-26 14:47:38 +02002214 list_for_each_entry(child, &proc_list, list) {
2215 if (child->pid == proc_pid){
2216 return &child->srv->obj_type;
2217 }
2218 }
2219 return NULL;
2220}
2221
2222/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2223 * Return:
2224 * 0: master
2225 * > 0: pid of a worker
2226 * < 0: didn't find a worker
2227 */
2228static int pcli_prefix_to_pid(const char *prefix)
2229{
2230 int proc_pid;
2231 struct mworker_proc *child;
2232 char *errtol = NULL;
2233
2234 if (*prefix != '@') /* not a prefix, should not happen */
2235 return -1;
2236
2237 prefix++;
2238 if (!*prefix) /* sent @ alone, return the master */
2239 return 0;
2240
2241 if (strcmp("master", prefix) == 0) {
2242 return 0;
2243 } else if (*prefix == '!') {
2244 prefix++;
2245 if (!*prefix)
2246 return -1;
2247
2248 proc_pid = strtol(prefix, &errtol, 10);
2249 if (*errtol != '\0')
2250 return -1;
2251 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002252 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002253 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002254 if (child->pid == proc_pid){
2255 return child->pid;
2256 }
2257 }
2258 } else {
2259 struct mworker_proc *chosen = NULL;
2260 /* this is a relative pid */
2261
2262 proc_pid = strtol(prefix, &errtol, 10);
2263 if (*errtol != '\0')
2264 return -1;
2265
2266 if (proc_pid == 0) /* return the master */
2267 return 0;
2268
2269 /* chose the right process, the current one is the one with the
2270 least number of reloads */
2271 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002272 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002273 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002274 if (child->reloads == 0)
2275 return child->pid;
2276 else if (chosen == NULL || child->reloads < chosen->reloads)
2277 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002278 }
2279 if (chosen)
2280 return chosen->pid;
2281 }
2282 return -1;
2283}
2284
William Lallemandbddd33a2018-12-11 16:10:53 +01002285/* Return::
2286 * >= 0 : number of words to escape
2287 * = -1 : error
2288 */
2289
2290int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2291{
2292 if (argl < 1)
2293 return 0;
2294
2295 /* there is a prefix */
2296 if (args[0][0] == '@') {
2297 int target_pid = pcli_prefix_to_pid(args[0]);
2298
2299 if (target_pid == -1) {
2300 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2301 return -1;
2302 }
2303
2304 /* if the prefix is alone, define a default target */
2305 if (argl == 1)
2306 s->pcli_next_pid = target_pid;
2307 else
2308 *next_pid = target_pid;
2309 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002310 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002311 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002312 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002313
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002314 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002315 channel_shutr_now(&s->req);
2316 channel_shutw_now(&s->res);
2317 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002318 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002319 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2320 memprintf(errmsg, "Permission denied!\n");
2321 return -1;
2322 }
2323 s->pcli_flags &= ~ACCESS_LVL_MASK;
2324 s->pcli_flags |= ACCESS_LVL_OPER;
2325 return argl;
2326
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002327 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002328 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2329 memprintf(errmsg, "Permission denied!\n");
2330 return -1;
2331 }
2332 s->pcli_flags &= ~ACCESS_LVL_MASK;
2333 s->pcli_flags |= ACCESS_LVL_USER;
2334 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002335
2336 } else if (strcmp(args[0], "expert-mode") == 0) {
2337 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2338 memprintf(errmsg, "Permission denied!\n");
2339 return -1;
2340 }
2341
2342 s->pcli_flags &= ~ACCESS_EXPERT;
2343 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2344 s->pcli_flags |= ACCESS_EXPERT;
2345 return argl;
2346
2347 } else if (strcmp(args[0], "experimental-mode") == 0) {
2348 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2349 memprintf(errmsg, "Permission denied!\n");
2350 return -1;
2351 }
2352 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2353 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2354 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2355 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002356 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2357 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2358 memprintf(errmsg, "Permission denied!\n");
2359 return -1;
2360 }
2361 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2362 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2363 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2364 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002365 }
2366
2367 return 0;
2368}
2369
2370/*
2371 * Parse the CLI request:
2372 * - It does basically the same as the cli_io_handler, but as a proxy
2373 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002374 *
2375 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002376 * - the number of characters to forward or
2377 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002378 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002379int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002380{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002381 char *str;
2382 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002383 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002384 int argl; /* number of args */
2385 char *p;
2386 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002387 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002388 int wtrim = 0; /* number of words to trim */
2389 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002390 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002391 int i = 0;
2392
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002393 /* we cannot deal with a wrapping buffer, so let's take care of this
2394 * first.
2395 */
2396 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2397 b_slow_realign(&req->buf, trash.area, co_data(req));
2398
2399 str = (char *)ci_head(req);
2400 end = (char *)ci_stop(req);
2401
William Lallemandbddd33a2018-12-11 16:10:53 +01002402 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002403
William Lallemanddc12c2e2018-12-13 09:05:46 +01002404 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002405
2406 /* Looks for the end of one command */
2407 while (p+reql < end) {
2408 /* handle escaping */
2409 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002410 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002411 continue;
2412 }
2413 if (p[reql] == ';' || p[reql] == '\n') {
2414 /* found the end of the command */
2415 p[reql] = '\n';
2416 reql++;
2417 break;
2418 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002419 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002420 }
William Lallemandebf61802018-12-11 16:10:57 +01002421 } else {
2422 while (p+reql < end) {
2423 if (p[reql] == '\n') {
2424 /* found the end of the line */
2425 reql++;
2426 break;
2427 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002428 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002429 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002430 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002431
William Lallemandbddd33a2018-12-11 16:10:53 +01002432 /* set end to first byte after the end of the command */
2433 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434
William Lallemandbddd33a2018-12-11 16:10:53 +01002435 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002436 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002437 return -1;
2438 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002439
William Lallemand3301f3e2018-12-13 09:05:48 +01002440 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2441 if (reql == 1) /* last line of the payload */
2442 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002443 return reql;
2444 }
2445
William Lallemandbddd33a2018-12-11 16:10:53 +01002446 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002449 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 /* skip leading spaces/tabs */
2451 p += strspn(p, " \t");
2452 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002453 break;
2454
William Lallemandbddd33a2018-12-11 16:10:53 +01002455 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002456 while (1) {
2457 p += strcspn(p, " \t\\");
2458 /* escaped chars using backlashes (\) */
2459 if (*p == '\\') {
2460 if (!*++p)
2461 break;
2462 if (!*++p)
2463 break;
2464 } else {
2465 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002467 }
William Lallemandfe249c32020-06-18 18:03:57 +02002468 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002469 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002470 }
2471
William Lallemandbddd33a2018-12-11 16:10:53 +01002472 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002473
Willy Tarreauf14c7572021-03-13 10:59:23 +01002474 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002475 args[i] = NULL;
2476
2477 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2478
2479 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002480 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002481 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002482 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002483 if (*p == '\0')
2484 *p = ' ';
2485 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002486 }
2487
William Lallemand3301f3e2018-12-13 09:05:48 +01002488 payload = strstr(str, PAYLOAD_PATTERN);
2489 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2490 /* if the payload pattern is at the end */
2491 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002492 }
2493
William Lallemandbddd33a2018-12-11 16:10:53 +01002494 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002495
William Lallemandbddd33a2018-12-11 16:10:53 +01002496 if (wtrim > 0) {
2497 trim = &args[wtrim][0];
2498 if (trim == NULL) /* if this was the last word in the table */
2499 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002500
William Lallemandbddd33a2018-12-11 16:10:53 +01002501 b_del(&req->buf, trim - str);
2502
William Lallemandb7ea1412018-12-13 09:05:47 +01002503 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002504 } else if (wtrim < 0) {
2505 /* parsing error */
2506 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002507 } else {
2508 /* the whole string */
2509 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002510 }
2511
William Lallemandb7ea1412018-12-13 09:05:47 +01002512 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002513
2514 /* the mcli-debug-mode is only sent to the applet of the master */
2515 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2516 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2517 ret += strlen("mcli-debug-mode on -") + 2;
2518 }
William Lallemand7267f782022-02-01 16:08:50 +01002519 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2520 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2521 ret += strlen("experimental-mode on -") + 2;
2522 }
2523 if (s->pcli_flags & ACCESS_EXPERT) {
2524 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2525 ret += strlen("expert-mode on -") + 2;
2526 }
2527
William Lallemandb7ea1412018-12-13 09:05:47 +01002528 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2529 goto end;
2530 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002531 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2532 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002533 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002534 ci_insert_line2(req, 0, "user -", strlen("user -"));
2535 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002536 }
2537 }
2538end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002539
William Lallemandb7ea1412018-12-13 09:05:47 +01002540 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002541}
2542
2543int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2544{
William Lallemandbddd33a2018-12-11 16:10:53 +01002545 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002546 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002547 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002548
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002549 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002550 * current one. Just wait. At this stage, errors should be handled by
2551 * the response analyzer.
2552 */
2553 if (s->res.analysers & AN_RES_WAIT_CLI)
2554 return 0;
2555
William Lallemandb7ea1412018-12-13 09:05:47 +01002556 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2557 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2558
William Lallemandcf62f7e2018-10-26 14:47:40 +02002559read_again:
2560 /* if the channel is closed for read, we won't receive any more data
2561 from the client, but we don't want to forward this close to the
2562 server */
2563 channel_dont_close(req);
2564
2565 /* We don't know yet to which server we will connect */
2566 channel_dont_connect(req);
2567
William Lallemandcf62f7e2018-10-26 14:47:40 +02002568 req->flags |= CF_READ_DONTWAIT;
2569
2570 /* need more data */
2571 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002572 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002573
2574 /* If there is data available for analysis, log the end of the idle time. */
2575 if (c_data(req) && s->logs.t_idle == -1)
2576 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2577
William Lallemandbddd33a2018-12-11 16:10:53 +01002578 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002579 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002580 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002581 /* enough data */
2582
William Lallemandcf62f7e2018-10-26 14:47:40 +02002583 /* forward only 1 command */
2584 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002585
William Lallemanddc12c2e2018-12-13 09:05:46 +01002586 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002587 /* we send only 1 command per request, and we write close after it */
2588 channel_shutw_now(req);
2589 } else {
2590 pcli_write_prompt(s);
2591 }
2592
2593 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002594 s->res.analysers |= AN_RES_WAIT_CLI;
2595
William Lallemandebf61802018-12-11 16:10:57 +01002596 if (!(s->flags & SF_ASSIGNED)) {
2597 if (next_pid > -1)
2598 target_pid = next_pid;
2599 else
2600 target_pid = s->pcli_next_pid;
2601 /* we can connect now */
2602 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002603
William Lallemanddcbe7b92021-12-10 14:14:53 +01002604 if (!s->target)
2605 goto server_disconnect;
2606
William Lallemandebf61802018-12-11 16:10:57 +01002607 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2608 channel_auto_connect(req);
2609 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002610
2611 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002612 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002613 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002614 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002615 } else if (to_forward == -1) {
2616 if (errmsg) {
2617 /* there was an error during the parsing */
2618 pcli_reply_and_close(s, errmsg);
2619 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2620 return 0;
2621 }
2622 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002623 }
2624
2625 return 0;
2626
2627send_help:
2628 b_reset(&req->buf);
2629 b_putblk(&req->buf, "help\n", 5);
2630 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002631
Christopher Faulet0f727da2022-01-18 08:44:23 +01002632missing_data:
2633 if (req->flags & CF_SHUTR) {
2634 /* There is no more request or a only a partial one and we
2635 * receive a close from the client, we can leave */
2636 channel_shutw_now(&s->res);
2637 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2638 return 1;
2639 }
2640 else if (channel_full(req, global.tune.maxrewrite)) {
2641 /* buffer is full and we didn't catch the end of a command */
2642 goto send_help;
2643 }
2644 return 0;
2645
William Lallemanddcbe7b92021-12-10 14:14:53 +01002646server_disconnect:
2647 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2648 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002649}
2650
2651int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2652{
2653 struct proxy *fe = strm_fe(s);
2654 struct proxy *be = s->be;
2655
Christopher Faulete8cefac2022-03-07 18:20:21 +01002656 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2657 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002658 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002659 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002660 s->res.analysers &= ~AN_RES_WAIT_CLI;
2661 return 0;
2662 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002663 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2664 rep->flags |= CF_NEVER_WAIT;
2665
2666 /* don't forward the close */
2667 channel_dont_close(&s->res);
2668 channel_dont_close(&s->req);
2669
William Lallemanddc12c2e2018-12-13 09:05:46 +01002670 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002671 s->res.analysers &= ~AN_RES_WAIT_CLI;
2672 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2673 return 0;
2674 }
2675
William Lallemandcf62f7e2018-10-26 14:47:40 +02002676 /* forward the data */
2677 if (ci_data(rep)) {
2678 c_adv(rep, ci_data(rep));
2679 return 0;
2680 }
2681
2682 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2683 /* stream cleanup */
2684
William Lallemand2f4ce202018-10-26 14:47:47 +02002685 pcli_write_prompt(s);
2686
Christopher Faulet0c247df2021-12-23 13:29:48 +01002687 cs_si(s->csb)->flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2688 si_shutr(cs_si(s->csb));
2689 si_shutw(cs_si(s->csb));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002690
2691 /*
2692 * starting from there this the same code as
2693 * http_end_txn_clean_session().
2694 *
2695 * It allows to do frontend keepalive while reconnecting to a
2696 * new server for each request.
2697 */
2698
2699 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002700 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002701 if (unlikely(s->srv_conn))
2702 sess_change_server(s, NULL);
2703 }
2704
2705 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2706 stream_process_counters(s);
2707
2708 /* don't count other requests' data */
2709 s->logs.bytes_in -= ci_data(&s->req);
2710 s->logs.bytes_out -= ci_data(&s->res);
2711
2712 /* we may need to know the position in the queue */
2713 pendconn_free(s);
2714
2715 /* let's do a final log if we need it */
2716 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2717 !(s->flags & SF_MONITOR) &&
2718 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2719 s->do_log(s);
2720 }
2721
2722 /* stop tracking content-based counters */
2723 stream_stop_content_counters(s);
2724 stream_update_time_stats(s);
2725
2726 s->logs.accept_date = date; /* user-visible date for logging */
2727 s->logs.tv_accept = now; /* corrected date for internal use */
2728 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2729 s->logs.t_idle = -1;
2730 tv_zero(&s->logs.tv_request);
2731 s->logs.t_queue = -1;
2732 s->logs.t_connect = -1;
2733 s->logs.t_data = -1;
2734 s->logs.t_close = 0;
2735 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2736 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2737
2738 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2739 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2740
2741 stream_del_srv_conn(s);
2742 if (objt_server(s->target)) {
2743 if (s->flags & SF_CURR_SESS) {
2744 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002745 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002746 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002747 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002748 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002749 }
2750
2751 s->target = NULL;
2752
2753 /* only release our endpoint if we don't intend to reuse the
2754 * connection.
2755 */
Christopher Faulet0c247df2021-12-23 13:29:48 +01002756 if (!si_conn_ready(cs_si(s->csb))) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002757 s->srv_conn = NULL;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002758 if (cs_reset_endp(s->csb) < 0) {
2759 if (!cs_si(s->csb)->err_type)
2760 cs_si(s->csb)->err_type = SI_ET_CONN_OTHER;
2761 if (s->srv_error)
2762 s->srv_error(s, cs_si(s->csb));
2763 return 1;
2764 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002765 }
2766
Christopher Faulet0c247df2021-12-23 13:29:48 +01002767 sockaddr_free(&(cs_si(s->csb)->dst));
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002768
Christopher Faulet0c247df2021-12-23 13:29:48 +01002769 cs_si(s->csb)->state = cs_si(s->csb)->prev_state = SI_ST_INI;
2770 cs_si(s->csb)->err_type = SI_ET_NONE;
Christopher Faulet0c247df2021-12-23 13:29:48 +01002771 cs_si(s->csb)->exp = TICK_ETERNITY;
2772 cs_si(s->csb)->flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet22dc2482019-07-16 14:43:08 +02002773 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 +02002774 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 +02002775 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2776 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2777 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002778 s->conn_retries = 0; /* used for logging too */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002779 /* reinitialise the current rule list pointer to NULL. We are sure that
2780 * any rulelist match the NULL pointer.
2781 */
2782 s->current_rule_list = NULL;
2783
2784 s->be = strm_fe(s);
2785 s->logs.logwait = strm_fe(s)->to_log;
2786 s->logs.level = 0;
2787 stream_del_srv_conn(s);
2788 s->target = NULL;
2789 /* re-init store persistence */
2790 s->store_count = 0;
2791 s->uniq_id = global.req_count++;
2792
2793 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2794
2795 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2796
William Lallemandcf62f7e2018-10-26 14:47:40 +02002797 s->res.analysers &= ~AN_RES_WAIT_CLI;
2798
2799 /* We must trim any excess data from the response buffer, because we
2800 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002801 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002802 * we want those data to come along with next response. A typical
2803 * example of such data would be from a buggy server responding to
2804 * a HEAD with some data, or sending more than the advertised
2805 * content-length.
2806 */
2807 if (unlikely(ci_data(&s->res)))
2808 b_set_data(&s->res.buf, co_data(&s->res));
2809
2810 /* Now we can realign the response buffer */
2811 c_realign_if_empty(&s->res);
2812
2813 s->req.rto = strm_fe(s)->timeout.client;
2814 s->req.wto = TICK_ETERNITY;
2815
2816 s->res.rto = TICK_ETERNITY;
2817 s->res.wto = strm_fe(s)->timeout.client;
2818
2819 s->req.rex = TICK_ETERNITY;
2820 s->req.wex = TICK_ETERNITY;
2821 s->req.analyse_exp = TICK_ETERNITY;
2822 s->res.rex = TICK_ETERNITY;
2823 s->res.wex = TICK_ETERNITY;
2824 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet0c247df2021-12-23 13:29:48 +01002825 cs_si(s->csb)->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002826
2827 /* we're removing the analysers, we MUST re-enable events detection.
2828 * We don't enable close on the response channel since it's either
2829 * already closed, or in keep-alive with an idle connection handler.
2830 */
2831 channel_auto_read(&s->req);
2832 channel_auto_close(&s->req);
2833 channel_auto_read(&s->res);
2834
2835
2836 return 1;
2837 }
2838 return 0;
2839}
2840
William Lallemand8a022572018-10-26 14:47:35 +02002841/*
2842 * The mworker functions are used to initialize the CLI in the master process
2843 */
2844
William Lallemand309dc9a2018-10-26 14:47:45 +02002845 /*
2846 * Stop the mworker proxy
2847 */
2848void mworker_cli_proxy_stop()
2849{
William Lallemand550db6d2018-11-06 17:37:12 +01002850 if (mworker_proxy)
2851 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002852}
2853
William Lallemand8a022572018-10-26 14:47:35 +02002854/*
2855 * Create the mworker CLI proxy
2856 */
2857int mworker_cli_proxy_create()
2858{
2859 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002860 char *msg = NULL;
2861 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002862
William Lallemandae787ba2021-07-29 15:13:22 +02002863 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002864 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002865 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002866
William Lallemandcf62f7e2018-10-26 14:47:40 +02002867 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002868 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2869 mworker_proxy->timeout.client = 0; /* no timeout */
2870 mworker_proxy->conf.file = strdup("MASTER");
2871 mworker_proxy->conf.line = 0;
2872 mworker_proxy->accept = frontend_accept;
2873 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2874
2875 /* Does not init the default target the CLI applet, but must be done in
2876 * the request parsing code */
2877 mworker_proxy->default_target = NULL;
2878
William Lallemand8a022572018-10-26 14:47:35 +02002879 /* create all servers using the mworker_proc list */
2880 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002881 struct server *newsrv = NULL;
2882 struct sockaddr_storage *sk;
2883 int port1, port2, port;
2884 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002885
William Lallemanda31b09e2020-01-14 15:25:02 +01002886 /* only the workers support the master CLI */
2887 if (!(child->options & PROC_O_TYPE_WORKER))
2888 continue;
2889
William Lallemand8a022572018-10-26 14:47:35 +02002890 newsrv = new_server(mworker_proxy);
2891 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002892 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002893
2894 /* we don't know the new pid yet */
2895 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002896 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002897 else
2898 memprintf(&msg, "old-%d", child->pid);
2899
2900 newsrv->next = mworker_proxy->srv;
2901 mworker_proxy->srv = newsrv;
2902 newsrv->conf.file = strdup(msg);
2903 newsrv->id = strdup(msg);
2904 newsrv->conf.line = 0;
2905
2906 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002907 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002908 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002909 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002910 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002911 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002912
Willy Tarreau5fc93282020-09-16 18:25:03 +02002913 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002914 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002915 }
2916
2917 /* no port specified */
2918 newsrv->flags |= SRV_F_MAPPORTS;
2919 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002920 /* don't let the server participate to load balancing */
2921 newsrv->iweight = 0;
2922 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002923 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002924
2925 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002926 }
William Lallemandae787ba2021-07-29 15:13:22 +02002927
2928 mworker_proxy->next = proxies_list;
2929 proxies_list = mworker_proxy;
2930
William Lallemand8a022572018-10-26 14:47:35 +02002931 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002932
2933error:
William Lallemand744a0892018-11-22 16:46:51 +01002934
2935 list_for_each_entry(child, &proc_list, list) {
2936 free((char *)child->srv->conf.file); /* cast because of const char * */
2937 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002938 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002939 }
William Lallemandae787ba2021-07-29 15:13:22 +02002940 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002941 free(msg);
2942
William Lallemandae787ba2021-07-29 15:13:22 +02002943error_proxy:
2944 ha_alert("%s\n", errmsg);
2945 free(errmsg);
2946
William Lallemand744a0892018-11-22 16:46:51 +01002947 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002948}
Olivier Houchardf886e342017-04-05 22:24:59 +02002949
William Lallemandce83b4a2018-10-26 14:47:30 +02002950/*
William Lallemande7361152018-10-26 14:47:36 +02002951 * Create a new listener for the master CLI proxy
2952 */
2953int mworker_cli_proxy_new_listener(char *line)
2954{
2955 struct bind_conf *bind_conf;
2956 struct listener *l;
2957 char *err = NULL;
2958 char *args[MAX_LINE_ARGS + 1];
2959 int arg;
2960 int cur_arg;
2961
William Lallemand2e945c82019-11-25 09:58:37 +01002962 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002963 args[0] = line;
2964
2965 /* args is a bind configuration with spaces replaced by commas */
2966 while (*line && arg < MAX_LINE_ARGS) {
2967
2968 if (*line == ',') {
2969 *line++ = '\0';
2970 while (*line == ',')
2971 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002972 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002973 }
2974 line++;
2975 }
2976
William Lallemand2e945c82019-11-25 09:58:37 +01002977 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002978
2979 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002980 if (!bind_conf)
2981 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002982
2983 bind_conf->level &= ~ACCESS_LVL_MASK;
2984 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002985 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002986
2987 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2988 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002989 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002990 }
2991
2992 cur_arg = 1;
2993
2994 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002995 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002996 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002997
2998 kw = bind_find_kw(args[cur_arg]);
2999 if (kw) {
3000 if (!kw->parse) {
3001 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3002 args[0], args[1], args[cur_arg]);
3003 goto err;
3004 }
3005
Willy Tarreau4975d142021-03-13 11:00:33 +01003006 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003007 if (err)
3008 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3009 else
3010 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3011 args[0], args[1], args[cur_arg]);
3012 goto err;
3013 }
3014
3015 cur_arg += 1 + kw->skip;
3016 continue;
3017 }
3018
Willy Tarreau433b05f2021-03-12 10:14:07 +01003019 best = bind_find_best_kw(args[cur_arg]);
3020 if (best)
3021 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3022 args[0], args[1], args[cur_arg], best);
3023 else
3024 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3025 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003026 goto err;
3027 }
3028
3029
3030 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003031 l->accept = session_accept_fd;
3032 l->default_target = mworker_proxy->default_target;
3033 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003034 l->options |= LI_O_UNLIMITED;
3035 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003036 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003037 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003038 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003039 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003040
3041 return 0;
3042
3043err:
3044 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003045 free(err);
3046 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003047 return -1;
3048
3049}
3050
3051/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003052 * Create a new CLI socket using a socketpair for a worker process
3053 * <mworker_proc> is the process structure, and <proc> is the process number
3054 */
3055int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3056{
3057 struct bind_conf *bind_conf;
3058 struct listener *l;
3059 char *path = NULL;
3060 char *err = NULL;
3061
3062 /* master pipe to ensure the master is still alive */
3063 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3064 ha_alert("Cannot create worker socketpair.\n");
3065 return -1;
3066 }
3067
3068 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003069 if (!global.cli_fe) {
3070 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003071 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003072 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003073 }
3074 }
3075
Willy Tarreau4975d142021-03-13 11:00:33 +01003076 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003077 if (!bind_conf)
3078 goto error;
3079
William Lallemandce83b4a2018-10-26 14:47:30 +02003080 bind_conf->level &= ~ACCESS_LVL_MASK;
3081 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003082 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003083
William Lallemandce83b4a2018-10-26 14:47:30 +02003084 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3085 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003086 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003087 }
3088
Willy Tarreau4975d142021-03-13 11:00:33 +01003089 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003090 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003091 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003092 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003093 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003094 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003095
3096 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003097 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003098 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003099 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003100 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003101 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003102 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003103 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003104 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 }
3106
3107 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003108
3109error:
3110 close(mworker_proc->ipc_fd[0]);
3111 close(mworker_proc->ipc_fd[1]);
3112 free(err);
3113
3114 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003115}
3116
William Lallemand74c24fb2016-11-21 17:18:36 +01003117static struct applet cli_applet = {
3118 .obj_type = OBJ_TYPE_APPLET,
3119 .name = "<CLI>", /* used for logging */
3120 .fct = cli_io_handler,
3121 .release = cli_release_handler,
3122};
3123
William Lallemand99e0bb92020-11-05 10:28:53 +01003124/* master CLI */
3125static struct applet mcli_applet = {
3126 .obj_type = OBJ_TYPE_APPLET,
3127 .name = "<MCLI>", /* used for logging */
3128 .fct = cli_io_handler,
3129 .release = cli_release_handler,
3130};
3131
Willy Tarreau0a739292016-11-22 20:21:23 +01003132/* register cli keywords */
3133static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003134 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3135 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3136 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3137 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003138 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3139 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003140 { { "mcli-debug-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER_ONLY }, // not listed
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003141 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3142 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3143 { { "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 },
3144 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3145 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3146 { { "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 },
3147 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3148 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use or a specific one", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
3149 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003150 { { "show", "version", NULL }, "show version : show version of the current process", cli_parse_show_version, NULL, NULL, NULL, ACCESS_MASTER },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003151 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3152 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau0a739292016-11-22 20:21:23 +01003153 {{},}
3154}};
3155
Willy Tarreau0108d902018-11-25 19:14:37 +01003156INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3157
William Lallemand74c24fb2016-11-21 17:18:36 +01003158static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003159 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003160 { 0, NULL, NULL },
3161}};
3162
Willy Tarreau0108d902018-11-25 19:14:37 +01003163INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3164
William Lallemand74c24fb2016-11-21 17:18:36 +01003165static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003166 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3167 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003168 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003169 { NULL, NULL, 0 },
3170}};
3171
Willy Tarreau0108d902018-11-25 19:14:37 +01003172INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003173
3174/*
3175 * Local variables:
3176 * c-indent-level: 8
3177 * c-basic-offset: 8
3178 * End:
3179 */