blob: 7bc579adc4d4885e891adfa6b65db2d3bf329301 [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>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020031#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020032#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 Tarreaucea0e1b2020-06-04 17:25:40 +020062#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020063#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020064#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020065#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020066#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010067
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020068#define PAYLOAD_PATTERN "<<"
69
William Lallemand74c24fb2016-11-21 17:18:36 +010070static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010071static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010072
Willy Tarreau4975d142021-03-13 11:00:33 +010073static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010074 "Permission denied\n"
75 "";
76
77
Christopher Faulet1bc04c72017-10-29 20:14:08 +010078static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010079
80/* List head of cli keywords */
81static struct cli_kw_list cli_keywords = {
82 .list = LIST_HEAD_INIT(cli_keywords.list)
83};
84
85extern const char *stat_status_codes[];
86
Eric Salama1b8dacc2021-03-16 15:12:17 +010087struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +020088
Willy Tarreau92fbbcc2021-05-09 21:45:29 +020089static int cmp_kw_entries(const void *a, const void *b)
90{
91 const struct cli_kw *l = *(const struct cli_kw **)a;
92 const struct cli_kw *r = *(const struct cli_kw **)b;
93
94 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
95}
96
Willy Tarreaub96a74c2021-03-12 17:13:28 +010097/* This will show the help message and list the commands supported at the
98 * current level that match all of the first words of <args> if args is not
99 * NULL, or all args if none matches or if args is null.
100 */
101static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100102{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200103 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100104 struct cli_kw_list *kw_list;
105 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200106 struct buffer *tmp = get_trash_chunk();
107 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100108 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100109 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200110 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100111 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200112 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100113
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100114 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100115
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200116 if (args && *args && strcmp(*args, "help") == 0) {
117 args++;
118 ishelp = 1;
119 }
120
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100121 /* first, let's measure the longest match */
122 list_for_each_entry(kw_list, &cli_keywords.list, list) {
123 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100124 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100125 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100126 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
127 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100128 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
129 continue;
130
131 /* OK this command is visible */
132 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
133 if (!kw->str_kw[idx])
134 break; // end of keyword
135 if (!args || !args[idx] || !*args[idx])
136 break; // end of command line
137 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
138 break;
139 if (idx + 1 > length)
140 length = idx + 1;
141 }
142 }
143 }
144
Willy Tarreaub7364582021-03-12 18:24:46 +0100145 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100146 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200147 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100148 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200149 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100150 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
151 else // partial match
152 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
153
Willy Tarreaub7364582021-03-12 18:24:46 +0100154 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
155 matches[idx].kw = NULL;
156 matches[idx].dist = INT_MAX;
157 }
158
159 /* In case of partial match we'll look for the best matching entries
160 * starting from position <length>
161 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100162 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100163 list_for_each_entry(kw_list, &cli_keywords.list, list) {
164 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100165 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100166 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100167 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
168 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
169 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100170 continue;
171
172 for (idx = 0; idx < length; idx++) {
173 if (!kw->str_kw[idx])
174 break; // end of keyword
175 if (!args || !args[idx] || !*args[idx])
176 break; // end of command line
177 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
178 break;
179 }
180
181 /* extra non-matching words are fuzzy-matched */
182 if (kw->usage && idx == length && args[idx] && *args[idx]) {
183 uint8_t word_sig[1024];
184 uint8_t list_sig[1024];
185 int dist = 0;
186 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100187 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100188
189 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100190 * on the remaining words. For this we're computing the signature
191 * of everything that remains and the cumulated length of the
192 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100193 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100194 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100195 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
196 update_word_fingerprint(word_sig, args[i]);
197 totlen += strlen(args[i]);
198 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100199
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100200 memset(list_sig, 0, sizeof(list_sig));
201 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
202 update_word_fingerprint(list_sig, kw->str_kw[i]);
203 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100204 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100205
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100206 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100207
208 /* insert this one at its place if relevant, in order to keep only
209 * the best matches.
210 */
211 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100212 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100213 matches[CLI_MAX_MATCHES-1] = swp;
214 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
215 if (matches[idx+1].dist >= matches[idx].dist)
216 break;
217 matches[idx+1] = matches[idx];
218 matches[idx] = swp;
219 }
220 }
221 }
222 }
223 }
224 }
225
Willy Tarreauec197e82021-03-15 10:35:04 +0100226 if (matches[0].kw) {
227 /* we have fuzzy matches, let's propose them */
228 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
229 kw = matches[idx].kw;
230 if (!kw)
231 break;
232
233 /* stop the dump if some words look very unlikely candidates */
234 if (matches[idx].dist > 5*matches[0].dist/2)
235 break;
236
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200237 if (help_entries < CLI_MAX_HELP_ENTRIES)
238 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100239 }
240 }
241
William Lallemand74c24fb2016-11-21 17:18:36 +0100242 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100243 /* no full dump if we've already found nice candidates */
244 if (matches[0].kw)
245 break;
246
Willy Tarreau91bc3592021-03-12 15:20:39 +0100247 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200248
Willy Tarreau91bc3592021-03-12 15:20:39 +0100249 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100250 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100251 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100252 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100253 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200254
William Lallemand2a171912022-02-02 11:43:20 +0100255 /* in master, if the CLI don't have the
256 * ACCESS_MCLI_DEBUG don't display commands that have
257 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100258 */
William Lallemand2a171912022-02-02 11:43:20 +0100259 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
260 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
261 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100262 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200263
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100264 for (idx = 0; idx < length; idx++) {
265 if (!kw->str_kw[idx])
266 break; // end of keyword
267 if (!args || !args[idx] || !*args[idx])
268 break; // end of command line
269 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
270 break;
271 }
272
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200273 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
274 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100275 }
276 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100277
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200278 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
279
280 for (idx = 0; idx < help_entries; idx++)
281 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
282
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100283 /* always show the prompt/help/quit commands */
284 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200285 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200286 " prompt : toggle interactive mode with prompt\n"
287 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100288
William Lallemand74c24fb2016-11-21 17:18:36 +0100289 chunk_init(&out, NULL, 0);
290 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200291 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200292
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100293 appctx->ctx.cli.severity = LOG_INFO;
294 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200295 appctx->st0 = CLI_ST_PRINT;
296
William Lallemand74c24fb2016-11-21 17:18:36 +0100297 return dynamic_usage_msg;
298}
299
300struct cli_kw* cli_find_kw(char **args)
301{
302 struct cli_kw_list *kw_list;
303 struct cli_kw *kw;/* current cli_kw */
304 char **tmp_args;
305 const char **tmp_str_kw;
306 int found = 0;
307
308 if (LIST_ISEMPTY(&cli_keywords.list))
309 return NULL;
310
311 list_for_each_entry(kw_list, &cli_keywords.list, list) {
312 kw = &kw_list->kw[0];
313 while (*kw->str_kw) {
314 tmp_args = args;
315 tmp_str_kw = kw->str_kw;
316 while (*tmp_str_kw) {
317 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
318 found = 1;
319 } else {
320 found = 0;
321 break;
322 }
323 tmp_args++;
324 tmp_str_kw++;
325 }
326 if (found)
327 return (kw);
328 kw++;
329 }
330 }
331 return NULL;
332}
333
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100334struct cli_kw* cli_find_kw_exact(char **args)
335{
336 struct cli_kw_list *kw_list;
337 int found = 0;
338 int i;
339 int j;
340
341 if (LIST_ISEMPTY(&cli_keywords.list))
342 return NULL;
343
344 list_for_each_entry(kw_list, &cli_keywords.list, list) {
345 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
346 found = 1;
347 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
348 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
349 break;
350 }
351 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
352 found = 0;
353 break;
354 }
355 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
356 found = 0;
357 break;
358 }
359 }
360 if (found)
361 return &kw_list->kw[i];
362 }
363 }
364 return NULL;
365}
366
William Lallemand74c24fb2016-11-21 17:18:36 +0100367void cli_register_kw(struct cli_kw_list *kw_list)
368{
Willy Tarreau2b718102021-04-21 07:32:39 +0200369 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100370}
371
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200372/* list all known keywords on stdout, one per line */
373void cli_list_keywords(void)
374{
375 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200376 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200377 int idx;
378
Willy Tarreau44651712022-03-30 12:02:35 +0200379 for (kwn = kwp = NULL;; kwp = kwn) {
380 list_for_each_entry(kw_list, &cli_keywords.list, list) {
381 /* note: we sort based on the usage message when available,
382 * otherwise we fall back to the first keyword.
383 */
384 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
385 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
386 kw->usage ? kw->usage : kw->str_kw[0],
387 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
388 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200389 }
Willy Tarreau44651712022-03-30 12:02:35 +0200390 }
391
392 if (kwn == kwp)
393 break;
394
395 for (idx = 0; kwn->str_kw[idx]; idx++) {
396 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200397 }
Willy Tarreau44651712022-03-30 12:02:35 +0200398 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
399 printf("[MASTER] ");
400 if (!(kwn->level & ACCESS_MASTER_ONLY))
401 printf("[WORKER] ");
402 if (kwn->level & ACCESS_EXPERT)
403 printf("[EXPERT] ");
404 if (kwn->level & ACCESS_EXPERIMENTAL)
405 printf("[EXPERIM] ");
406 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200407 }
408}
William Lallemand74c24fb2016-11-21 17:18:36 +0100409
410/* allocate a new stats frontend named <name>, and return it
411 * (or NULL in case of lack of memory).
412 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100413static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100414{
415 struct proxy *fe;
416
417 fe = calloc(1, sizeof(*fe));
418 if (!fe)
419 return NULL;
420
421 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100422 fe->next = proxies_list;
423 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100424 fe->last_change = now.tv_sec;
425 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200426 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100427 fe->maxconn = 10; /* default to 10 concurrent connections */
428 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
429 fe->conf.file = strdup(file);
430 fe->conf.line = line;
431 fe->accept = frontend_accept;
432 fe->default_target = &cli_applet.obj_type;
433
434 /* the stats frontend is the only one able to assign ID #0 */
435 fe->conf.id.key = fe->uuid = 0;
436 eb32_insert(&used_proxy_id, &fe->conf.id);
437 return fe;
438}
439
440/* This function parses a "stats" statement in the "global" section. It returns
441 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
442 * error message into the <err> buffer which will be preallocated. The trailing
443 * '\n' must not be written. The function must be called with <args> pointing to
444 * the first word after "stats".
445 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100446static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
447 const struct proxy *defpx, const char *file, int line,
448 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100449{
450 struct bind_conf *bind_conf;
451 struct listener *l;
452
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100453 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100454 int cur_arg;
455
456 if (*args[2] == 0) {
457 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
458 return -1;
459 }
460
Willy Tarreau4975d142021-03-13 11:00:33 +0100461 if (!global.cli_fe) {
462 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100463 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
464 return -1;
465 }
466 }
467
Willy Tarreau4975d142021-03-13 11:00:33 +0100468 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200469 if (!bind_conf) {
470 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
471 return -1;
472 }
William Lallemand07a62f72017-05-24 00:57:40 +0200473 bind_conf->level &= ~ACCESS_LVL_MASK;
474 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100475
Willy Tarreau4975d142021-03-13 11:00:33 +0100476 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100477 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
478 file, line, args[0], args[1], err && *err ? *err : "error");
479 return -1;
480 }
481
482 cur_arg = 3;
483 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100484 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100485 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100486 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100487
488 kw = bind_find_kw(args[cur_arg]);
489 if (kw) {
490 if (!kw->parse) {
491 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
492 args[0], args[1], args[cur_arg]);
493 return -1;
494 }
495
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100496 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
497
498 /* FIXME: this is ugly, we don't have a way to collect warnings,
499 * yet some important bind keywords may report warnings that we
500 * must display.
501 */
502 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
503 indent_msg(err, 2);
504 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
505 ha_free(err);
506 }
507
508 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100509 if (err && *err)
510 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
511 else
512 memprintf(err, "'%s %s' : error encountered while processing '%s'",
513 args[0], args[1], args[cur_arg]);
514 return -1;
515 }
516
517 cur_arg += 1 + kw->skip;
518 continue;
519 }
520
Willy Tarreau433b05f2021-03-12 10:14:07 +0100521 best = bind_find_best_kw(args[cur_arg]);
522 if (best)
523 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
524 args[0], args[1], args[cur_arg], best);
525 else
526 memprintf(err, "'%s %s' : unknown keyword '%s'.",
527 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100528 return -1;
529 }
530
531 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100532 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100533 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100534 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
535 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100536 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100537 }
538 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100539 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100540 unsigned timeout;
541 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
542
Willy Tarreau9faebe32019-06-07 19:00:37 +0200543 if (res == PARSE_TIME_OVER) {
544 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
545 args[2], args[0], args[1]);
546 return -1;
547 }
548 else if (res == PARSE_TIME_UNDER) {
549 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
550 args[2], args[0], args[1]);
551 return -1;
552 }
553 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100554 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
555 return -1;
556 }
557
558 if (!timeout) {
559 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
560 return -1;
561 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100562 if (!global.cli_fe) {
563 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100564 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
565 return -1;
566 }
567 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100568 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100569 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100570 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100571 int maxconn = atol(args[2]);
572
573 if (maxconn <= 0) {
574 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
575 return -1;
576 }
577
Willy Tarreau4975d142021-03-13 11:00:33 +0100578 if (!global.cli_fe) {
579 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100580 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
581 return -1;
582 }
583 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100584 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100585 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100586 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 int cur_arg = 2;
588 unsigned long set = 0;
589
Willy Tarreau4975d142021-03-13 11:00:33 +0100590 if (!global.cli_fe) {
591 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100592 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
593 return -1;
594 }
595 }
596
597 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100598 if (strcmp(args[cur_arg], "all") == 0) {
599 set = 0;
600 break;
601 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200602 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100603 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100604 return -1;
605 }
606 cur_arg++;
607 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100608 }
609 else {
610 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
611 return -1;
612 }
613 return 0;
614}
615
William Lallemand33d29e22019-04-01 11:30:06 +0200616/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200617 * This function exports the bound addresses of a <frontend> in the environment
618 * variable <varname>. Those addresses are separated by semicolons and prefixed
619 * with their type (abns@, unix@, sockpair@ etc)
620 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200621 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200622int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200623{
624 struct buffer *trash = get_trash_chunk();
625 struct bind_conf *bind_conf;
626
William Lallemand9a37fd02019-04-12 16:09:24 +0200627 if (frontend) {
628 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200629 struct listener *l;
630
631 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
632 char addr[46];
633 char port[6];
634
William Lallemand620072b2019-04-12 16:09:25 +0200635 /* separate listener by semicolons */
636 if (trash->data)
637 chunk_appendf(trash, ";");
638
Willy Tarreau37159062020-08-27 07:48:42 +0200639 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200640 const struct sockaddr_un *un;
641
Willy Tarreau37159062020-08-27 07:48:42 +0200642 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200643 if (un->sun_path[0] == '\0') {
644 chunk_appendf(trash, "abns@%s", un->sun_path+1);
645 } else {
646 chunk_appendf(trash, "unix@%s", un->sun_path);
647 }
Willy Tarreau37159062020-08-27 07:48:42 +0200648 } else if (l->rx.addr.ss_family == AF_INET) {
649 addr_to_str(&l->rx.addr, addr, sizeof(addr));
650 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200651 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200652 } else if (l->rx.addr.ss_family == AF_INET6) {
653 addr_to_str(&l->rx.addr, addr, sizeof(addr));
654 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200655 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200656 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
657 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200658 }
William Lallemand33d29e22019-04-01 11:30:06 +0200659 }
660 }
661 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200662 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200663 return -1;
664 }
665
666 return 0;
667}
668
William Lallemand9a37fd02019-04-12 16:09:24 +0200669int cli_socket_setenv()
670{
Willy Tarreau4975d142021-03-13 11:00:33 +0100671 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200672 return -1;
673 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
674 return -1;
675
676 return 0;
677}
678
William Lallemand33d29e22019-04-01 11:30:06 +0200679REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
680
Willy Tarreaude57a572016-11-23 17:01:39 +0100681/* Verifies that the CLI at least has a level at least as high as <level>
682 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
683 * failure, an error message is prepared and the appctx's state is adjusted
684 * to print it so that a return 1 is enough to abort any processing.
685 */
686int cli_has_level(struct appctx *appctx, int level)
687{
Willy Tarreaude57a572016-11-23 17:01:39 +0100688
William Lallemandf630d012018-12-13 09:05:44 +0100689 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100690 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100691 return 0;
692 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100693 return 1;
694}
695
William Lallemandb7ea1412018-12-13 09:05:47 +0100696/* same as cli_has_level but for the CLI proxy and without error message */
697int pcli_has_level(struct stream *s, int level)
698{
699 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
700 return 0;
701 }
702 return 1;
703}
704
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200705/* Returns severity_output for the current session if set, or default for the socket */
706static int cli_get_severity_output(struct appctx *appctx)
707{
708 if (appctx->cli_severity_output)
709 return appctx->cli_severity_output;
Christopher Faulet908628c2022-03-25 16:43:49 +0100710 return strm_li(__cs_strm(appctx->owner))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200711}
William Lallemand74c24fb2016-11-21 17:18:36 +0100712
Willy Tarreau41908562016-11-24 16:23:38 +0100713/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100714 * from the CLI's IO handler running in an appctx context. The function returns
715 * 1 if the request was understood, otherwise zero (in which case an error
716 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100717 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
718 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
719 * have its own I/O handler called again. Most of the time, parsers will only
720 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100721 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
722 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100723 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200724static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100725{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100726 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200727 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100728 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100729
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 appctx->st2 = 0;
Willy Tarreauf12f32a2022-05-02 14:57:03 +0200731
732 /* temporary for 2.6: let's make sure we clean the whole shared
733 * context.
734 */
735 if (sizeof(appctx->ctx) > sizeof(appctx->svc))
736 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
737 else
738 memset(&appctx->svc, 0, sizeof(appctx->svc));
William Lallemand74c24fb2016-11-21 17:18:36 +0100739
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200740 p = appctx->chunk->area;
741 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200744 * Get pointers on words.
745 * One extra slot is reserved to store a pointer on a null byte.
746 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100747 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100749
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200750 /* skip leading spaces/tabs */
751 p += strspn(p, " \t");
752 if (!*p)
753 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200754
755 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
756 /* payload pattern recognized here, this is not an arg anymore,
757 * the payload starts at the first byte that follows the zero
758 * after the pattern.
759 */
760 payload = p + strlen(PAYLOAD_PATTERN) + 1;
761 break;
762 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100763
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200764 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200765 while (1) {
766 p += strcspn(p, " \t\\");
767 /* escaped chars using backlashes (\) */
768 if (*p == '\\') {
769 if (!*++p)
770 break;
771 if (!*++p)
772 break;
773 } else {
774 break;
775 }
776 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200777 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100778
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200779 /* unescape backslashes (\) */
780 for (j = 0, k = 0; args[i][k]; k++) {
781 if (args[i][k] == '\\') {
782 if (args[i][k + 1] == '\\')
783 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100784 else
785 continue;
786 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200787 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100788 j++;
789 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200790 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100791
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200792 i++;
793 }
794 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200795 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100796 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200797 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100798
799 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100800 if (!kw ||
801 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100802 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
803 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100804 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100805 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100806 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100807 }
William Lallemand14721be2018-10-26 14:47:37 +0200808
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100809 /* don't handle expert mode commands if not in this mode. */
810 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
811 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200812 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100813 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200814
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100815 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
816 cli_err(appctx, "This command is restricted to experimental mode only.\n");
817 return 0;
818 }
819
Amaury Denoyellef4929922021-05-05 16:29:23 +0200820 if (kw->level == ACCESS_EXPERT)
821 mark_tainted(TAINTED_CLI_EXPERT_MODE);
822 else if (kw->level == ACCESS_EXPERIMENTAL)
823 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
824
Willy Tarreau41908562016-11-24 16:23:38 +0100825 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200826 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200827
828 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
829 goto fail;
830
831 /* kw->parse could set its own io_handler or io_release handler */
832 if (!appctx->io_handler)
833 goto fail;
834
835 appctx->st0 = CLI_ST_CALLBACK;
836 return 1;
837fail:
838 appctx->io_handler = NULL;
839 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100840 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100841}
842
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200843/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
844static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
845{
Willy Tarreau83061a82018-07-13 11:56:34 +0200846 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200847
848 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200849 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200850
851 tmp = get_trash_chunk();
852 chunk_reset(tmp);
853
854 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100855 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200856 chunk_printf(tmp, "[%d]: ", severity);
857 }
858 else {
859 switch (severity_output) {
860 case CLI_SEVERITY_NUMBER:
861 chunk_printf(tmp, "[%d]: ", severity);
862 break;
863 case CLI_SEVERITY_STRING:
864 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
865 break;
866 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100867 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200868 }
869 }
870 chunk_appendf(tmp, "%s", msg);
871
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200872 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200873}
874
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +0200875/* This I/O handler runs as an applet embedded in a conn-stream. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100876 * used to processes I/O from/to the stats unix socket. The system relies on a
877 * state machine handling requests and various responses. We read a request,
878 * then we process it and send the response, and we possibly display a prompt.
879 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100880 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100881 * or not.
882 */
883static void cli_io_handler(struct appctx *appctx)
884{
Christopher Faulet908628c2022-03-25 16:43:49 +0100885 struct conn_stream *cs = appctx->owner;
886 struct channel *req = cs_oc(cs);
887 struct channel *res = cs_ic(cs);
888 struct bind_conf *bind_conf = strm_li(__cs_strm(cs))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100889 int reql;
890 int len;
891
Christopher Faulet62e75742022-03-31 09:16:34 +0200892 if (unlikely(cs->state == CS_ST_DIS || cs->state == CS_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100893 goto out;
894
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800895 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200896 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100897 /* buf.size==0 means we failed to get a buffer and were
898 * already subscribed to a wait list to get a buffer.
899 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100900 goto out;
901 }
902
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100904 if (appctx->st0 == CLI_ST_INIT) {
Willy Tarreau7bf20ca2022-05-03 17:02:03 +0200905 /* CLI/stats not initialized yet */
906 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200907 /* reset severity to default at init */
908 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100909 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100910 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100911 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100912 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100913 /* Let's close for real now. We just close the request
914 * side, the conditions below will complete if needed.
915 */
Christopher Fauletda098e62022-03-31 17:44:45 +0200916 cs_shutw(cs);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200917 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200918 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100919 break;
920 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100921 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200922 char *str;
923
924 /* use a trash chunk to store received data */
925 if (!appctx->chunk) {
926 appctx->chunk = alloc_trash_chunk();
927 if (!appctx->chunk) {
928 appctx->st0 = CLI_ST_END;
929 continue;
930 }
931 }
932
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200933 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200934
William Lallemand74c24fb2016-11-21 17:18:36 +0100935 /* ensure we have some output room left in the event we
936 * would want to return some info right after parsing.
937 */
Christopher Faulet908628c2022-03-25 16:43:49 +0100938 if (buffer_almost_full(cs_ib(cs))) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +0200939 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +0100940 break;
941 }
942
Willy Tarreau0011c252022-01-19 17:23:52 +0100943 /* payload doesn't take escapes nor does it end on semi-colons, so
944 * we use the regular getline. Normal mode however must stop on
945 * LFs and semi-colons that are not prefixed by a backslash. Note
946 * that we reserve one byte at the end to insert a trailing nul byte.
947 */
948
949 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Christopher Faulet908628c2022-03-25 16:43:49 +0100950 reql = co_getline(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100951 appctx->chunk->size - appctx->chunk->data - 1);
952 else
Christopher Faulet908628c2022-03-25 16:43:49 +0100953 reql = co_getdelim(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100954 appctx->chunk->size - appctx->chunk->data - 1,
955 "\n;", '\\');
956
William Lallemand74c24fb2016-11-21 17:18:36 +0100957 if (reql <= 0) { /* closed or EOL not found */
958 if (reql == 0)
959 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100960 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100961 continue;
962 }
963
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200964 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
965 /* seek for a possible unescaped semi-colon. If we find
966 * one, we replace it with an LF and skip only this part.
967 */
968 for (len = 0; len < reql; len++) {
969 if (str[len] == '\\') {
970 len++;
971 continue;
972 }
973 if (str[len] == ';') {
974 str[len] = '\n';
975 reql = len + 1;
976 break;
977 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100978 }
979 }
980
981 /* now it is time to check that we have a full line,
982 * remove the trailing \n and possibly \r, then cut the
983 * line.
984 */
985 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200986 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100987 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100988 continue;
989 }
990
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200991 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100992 len--;
993
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200994 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200995 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200996
997 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200998 appctx->chunk->area[appctx->chunk->data] = '\n';
999 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1000 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001001 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001002
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001003 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001004
1005 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1006 /* empty line */
1007 if (!len) {
1008 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001009 appctx->chunk->data -= 2;
1010 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001011 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001012 chunk_reset(appctx->chunk);
1013 /* NB: cli_sock_parse_request() may have put
1014 * another CLI_ST_O_* into appctx->st0.
1015 */
1016
1017 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001018 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001019 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001020 else {
1021 /*
1022 * Look for the "payload start" pattern at the end of a line
1023 * Its location is not remembered here, this is just to switch
1024 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001025 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001026 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001027 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001028 appctx->chunk->data++; // keep the trailing \0 after '<<'
1029 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001030 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001031 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001032 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001033 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001034 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001035 }
1036
1037 /* re-adjust req buffer */
Christopher Faulet908628c2022-03-25 16:43:49 +01001038 co_skip(cs_oc(cs), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001039 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1040 }
1041 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001042 const char *msg;
1043 int sev;
1044
William Lallemand74c24fb2016-11-21 17:18:36 +01001045 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001046 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001047 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001048 case CLI_ST_PRINT: /* print const message in msg */
1049 case CLI_ST_PRINT_ERR: /* print const error in msg */
1050 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1051 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
1052 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1053 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
1054 LOG_ERR : appctx->ctx.cli.severity;
1055 msg = appctx->ctx.cli.msg;
1056 }
1057 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1058 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
1059 LOG_ERR : appctx->ctx.cli.severity;
1060 msg = appctx->ctx.cli.err;
1061 if (!msg) {
1062 sev = LOG_ERR;
1063 msg = "Out of memory.\n";
1064 }
1065 }
1066 else {
1067 sev = LOG_ERR;
1068 msg = "Internal error.\n";
1069 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001070
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001071 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1072 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1073 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001074 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001075 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001076 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001077 }
1078 else
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001079 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001080 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001081
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001082 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001083 if (appctx->io_handler)
1084 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001085 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001086 if (appctx->io_release) {
1087 appctx->io_release(appctx);
1088 appctx->io_release = NULL;
1089 }
1090 }
1091 break;
1092 default: /* abnormal state */
Christopher Faulet6cd56d52022-03-30 10:47:32 +02001093 cs->endp->flags |= CS_EP_ERROR;
William Lallemand74c24fb2016-11-21 17:18:36 +01001094 break;
1095 }
1096
1097 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001098 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001099 const char *prompt = "";
1100
1101 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1102 /*
1103 * when entering a payload with interactive mode, change the prompt
1104 * to emphasize that more data can still be sent
1105 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001106 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001107 prompt = "+ ";
1108 else
1109 prompt = "\n> ";
1110 }
1111 else {
William Lallemandad032882019-07-01 10:56:15 +02001112 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001113 prompt = "\n";
1114 }
1115
Christopher Faulet908628c2022-03-25 16:43:49 +01001116 if (ci_putstr(cs_ic(cs), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001117 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001118 else
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001119 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001120 }
1121
1122 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001123 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001124 break;
1125
1126 /* Now we close the output if one of the writers did so,
1127 * or if we're not in interactive mode and the request
1128 * buffer is empty. This still allows pipelined requests
1129 * to be sent in non-interactive mode.
1130 */
William Lallemand3de09d52018-12-11 16:10:56 +01001131 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1132 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001133 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001134 continue;
1135 }
1136
1137 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001138 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001139 /* reactivate the \n at the end of the response for the next command */
1140 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001141
1142 /* this forces us to yield between pipelined commands and
1143 * avoid extremely long latencies (e.g. "del map" etc). In
1144 * addition this increases the likelihood that the stream
1145 * refills the buffer with new bytes in non-interactive
1146 * mode, avoiding to close on apparently empty commands.
1147 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001148 if (co_data(cs_oc(cs))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001149 appctx_wakeup(appctx);
1150 goto out;
1151 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 }
1153 }
1154
Christopher Faulet62e75742022-03-31 09:16:34 +02001155 if ((res->flags & CF_SHUTR) && (cs->state == CS_ST_EST)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001156 DPRINTF(stderr, "%s@%d: cs to buf closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001157 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001158 /* Other side has closed, let's abort if we have no more processing to do
1159 * and nothing more to consume. This is comparable to a broken pipe, so
1160 * we forward the close to the request side so that it flows upstream to
1161 * the client.
1162 */
Christopher Fauletda098e62022-03-31 17:44:45 +02001163 cs_shutw(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001164 }
1165
Christopher Faulet62e75742022-03-31 09:16:34 +02001166 if ((req->flags & CF_SHUTW) && (cs->state == CS_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001167 DPRINTF(stderr, "%s@%d: buf to cs closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001168 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001169 /* We have no more processing to do, and nothing more to send, and
1170 * the client side has closed. So we'll forward this state downstream
1171 * on the response buffer.
1172 */
Christopher Fauletda098e62022-03-31 17:44:45 +02001173 cs_shutr(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001174 res->flags |= CF_READ_NULL;
1175 }
1176
1177 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001178 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 +01001179 __FUNCTION__, __LINE__,
Christopher Faulet62e75742022-03-31 09:16:34 +02001180 cs->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001181}
1182
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001183/* This is called when the conn-stream is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001184 * external abort, we won't call the i/o handler anymore so we may need to
1185 * remove back references to the stream currently being dumped.
1186 */
1187static void cli_release_handler(struct appctx *appctx)
1188{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001189 free_trash_chunk(appctx->chunk);
1190 appctx->chunk = NULL;
1191
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 if (appctx->io_release) {
1193 appctx->io_release(appctx);
1194 appctx->io_release = NULL;
1195 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001196 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001197 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001198 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001199}
1200
1201/* This function dumps all environmnent variables to the buffer. It returns 0
1202 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001203 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1204 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001205 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001206static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001207{
Christopher Faulet908628c2022-03-25 16:43:49 +01001208 struct conn_stream *cs = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001209 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001210
Christopher Faulet908628c2022-03-25 16:43:49 +01001211 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001212 return 1;
1213
1214 chunk_reset(&trash);
1215
1216 /* we have two inner loops here, one for the proxy, the other one for
1217 * the buffer.
1218 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001219 while (*var) {
1220 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001221
Christopher Faulet908628c2022-03-25 16:43:49 +01001222 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001223 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001224 return 0;
1225 }
1226 if (appctx->st2 == STAT_ST_END)
1227 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001228 var++;
1229 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001230 }
1231
1232 /* dump complete */
1233 return 1;
1234}
1235
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001236/* This function dumps all file descriptors states (or the requested one) to
1237 * the buffer. It returns 0 if the output buffer is full and it needs to be
1238 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1239 * It uses cli.i0 as the fd number to restart from.
1240 */
1241static int cli_io_handler_show_fd(struct appctx *appctx)
1242{
Christopher Faulet908628c2022-03-25 16:43:49 +01001243 struct conn_stream *cs = appctx->owner;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001244 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001245 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001246
Christopher Faulet908628c2022-03-25 16:43:49 +01001247 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001248 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001249
1250 chunk_reset(&trash);
1251
Willy Tarreauca1b1572018-12-18 15:45:11 +01001252 /* isolate the threads once per round. We're limited to a buffer worth
1253 * of output anyway, it cannot last very long.
1254 */
1255 thread_isolate();
1256
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001257 /* we have two inner loops here, one for the proxy, the other one for
1258 * the buffer.
1259 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001260 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001261 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001262 const struct listener *li = NULL;
1263 const struct server *sv = NULL;
1264 const struct proxy *px = NULL;
1265 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001266 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001267 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001268 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001269 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001270 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001271 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001272 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001273
1274 fdt = fdtab[fd];
1275
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001276 /* When DEBUG_FD is set, we also report closed FDs that have a
1277 * non-null event count to detect stuck ones.
1278 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001279 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001280#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001281 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001282#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001283 goto skip; // closed
1284 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001285 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001286 conn = (const struct connection *)fdt.owner;
1287 conn_flags = conn->flags;
1288 mux = conn->mux;
1289 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001290 xprt = conn->xprt;
1291 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001292 li = objt_listener(conn->target);
1293 sv = objt_server(conn->target);
1294 px = objt_proxy(conn->target);
1295 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001296 if (atleast2(fdt.thread_mask))
1297 suspicious = 1;
1298 if (conn->handle.fd != fd)
1299 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001300 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001301 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001302 li = fdt.owner;
1303
Willy Tarreaudacfde42021-01-21 09:07:29 +01001304 if (!fdt.thread_mask)
1305 suspicious = 1;
1306
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001307 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001308 " %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 +02001309 fd,
1310 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001311 (fdt.state & FD_CLONED) ? 'C' : 'c',
1312 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001313 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1314 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1315 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1316 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1317 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001318 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1319 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1320 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1321 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1322 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1323 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001324 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001325 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001326 fdt.iocb);
1327 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001328
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001329 if (!fdt.owner) {
1330 chunk_appendf(&trash, ")");
1331 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001332 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001333 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001334
1335 if (conn->handle.fd != fd) {
1336 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1337 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001338 } else {
1339 struct sockaddr_storage sa;
1340 socklen_t salen;
1341
1342 salen = sizeof(sa);
1343 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1344 if (sa.ss_family == AF_INET)
1345 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1346 else if (sa.ss_family == AF_INET6)
1347 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1348 else if (sa.ss_family == AF_UNIX)
1349 chunk_appendf(&trash, " fam=unix");
1350 }
1351
1352 salen = sizeof(sa);
1353 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1354 if (sa.ss_family == AF_INET)
1355 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1356 else if (sa.ss_family == AF_INET6)
1357 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1358 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001359 }
1360
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001361 if (px)
1362 chunk_appendf(&trash, " px=%s", px->id);
1363 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001364 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001365 else if (li)
1366 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001367
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001368 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001369 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001370 if (!ctx)
1371 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001372 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001373 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001374 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001375 else
1376 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001377
1378 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001379 if (xprt) {
1380 if (xprt_ctx || xprt->show_fd)
1381 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1382 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001383 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001384 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001385 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001386 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001387 struct sockaddr_storage sa;
1388 socklen_t salen;
1389
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001390 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001391 listener_state_str(li),
1392 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001393
1394 salen = sizeof(sa);
1395 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1396 if (sa.ss_family == AF_INET)
1397 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1398 else if (sa.ss_family == AF_INET6)
1399 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1400 else if (sa.ss_family == AF_UNIX)
1401 chunk_appendf(&trash, " fam=unix");
1402 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001403 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001404 else
1405 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001406
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001407#ifdef DEBUG_FD
1408 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001409 if (fdtab[fd].event_count >= 1000000)
1410 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001411#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001412 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001413
Christopher Faulet908628c2022-03-25 16:43:49 +01001414 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001415 cs_rx_room_blk(cs);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001416 appctx->ctx.cli.i0 = fd;
1417 ret = 0;
1418 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001419 }
1420 skip:
1421 if (appctx->st2 == STAT_ST_END)
1422 break;
1423
1424 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001425 }
1426
Willy Tarreauca1b1572018-12-18 15:45:11 +01001427 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001428 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001429
1430 thread_release();
1431 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001432}
1433
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001434/* This function dumps some activity counters used by developers and support to
1435 * rule out some hypothesis during bug reports. It returns 0 if the output
1436 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1437 * everything at once in the buffer and is not designed to do it in multiple
1438 * passes.
1439 */
1440static int cli_io_handler_show_activity(struct appctx *appctx)
1441{
Christopher Faulet908628c2022-03-25 16:43:49 +01001442 struct conn_stream *cs = appctx->owner;
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001443 int thr;
1444
Christopher Faulet908628c2022-03-25 16:43:49 +01001445 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001446 return 1;
1447
1448 chunk_reset(&trash);
1449
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001450#undef SHOW_TOT
1451#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001452 do { \
1453 unsigned int _v[MAX_THREADS]; \
1454 unsigned int _tot; \
1455 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001456 _tot = t = 0; \
1457 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001458 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001459 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001460 if (_nbt == 1) { \
1461 chunk_appendf(&trash, " %u\n", _tot); \
1462 break; \
1463 } \
1464 chunk_appendf(&trash, " %u [", _tot); \
1465 for (t = 0; t < _nbt; t++) \
1466 chunk_appendf(&trash, " %u", _v[t]); \
1467 chunk_appendf(&trash, " ]\n"); \
1468 } while (0)
1469
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001470#undef SHOW_AVG
1471#define SHOW_AVG(t, x) \
1472 do { \
1473 unsigned int _v[MAX_THREADS]; \
1474 unsigned int _tot; \
1475 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001476 _tot = t = 0; \
1477 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001478 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001479 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001480 if (_nbt == 1) { \
1481 chunk_appendf(&trash, " %u\n", _tot); \
1482 break; \
1483 } \
1484 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1485 for (t = 0; t < _nbt; t++) \
1486 chunk_appendf(&trash, " %u", _v[t]); \
1487 chunk_appendf(&trash, " ]\n"); \
1488 } while (0)
1489
Willy Tarreaua0211b82019-05-28 15:09:08 +02001490 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1491 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001492 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1493 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1494 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1495 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001496 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001497 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1498 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001499 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001500 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001501 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001502 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001503 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001504 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001505 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1506 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001507 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1508 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1509 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1510 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1511 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1512 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1513 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001514#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001515 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 +02001516 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001517#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001518
Willy Tarreaud6a78502019-05-27 07:03:38 +02001519#if defined(DEBUG_DEV)
1520 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001521 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1522 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1523 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001524#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001525
Christopher Faulet908628c2022-03-25 16:43:49 +01001526 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001527 chunk_reset(&trash);
1528 chunk_printf(&trash, "[output too large, cannot dump]\n");
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001529 cs_rx_room_blk(cs);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001530 }
1531
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001532#undef SHOW_AVG
1533#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001534 /* dump complete */
1535 return 1;
1536}
1537
William Lallemandeceddf72016-12-15 18:06:44 +01001538/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001539 * CLI IO handler for `show cli sockets`.
Willy Tarreau241a0062022-05-05 18:29:25 +02001540 * Uses ctx.cli.p0 to store the bind_conf pointer, and cli.p1 for the listener.
William Lallemandeceddf72016-12-15 18:06:44 +01001541 */
1542static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1543{
Willy Tarreau241a0062022-05-05 18:29:25 +02001544 struct bind_conf *bind_conf = appctx->ctx.cli.p0;
Christopher Faulet908628c2022-03-25 16:43:49 +01001545 struct conn_stream *cs = appctx->owner;
William Lallemandeceddf72016-12-15 18:06:44 +01001546
1547 chunk_reset(&trash);
1548
1549 switch (appctx->st2) {
1550 case STAT_ST_INIT:
1551 chunk_printf(&trash, "# socket lvl processes\n");
Christopher Faulet908628c2022-03-25 16:43:49 +01001552 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001553 cs_rx_room_blk(cs);
William Lallemandeceddf72016-12-15 18:06:44 +01001554 return 0;
1555 }
William Lallemandeceddf72016-12-15 18:06:44 +01001556 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001557 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001558
1559 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001560 if (global.cli_fe) {
Willy Tarreau241a0062022-05-05 18:29:25 +02001561 if (!bind_conf)
1562 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001563
Willy Tarreau241a0062022-05-05 18:29:25 +02001564 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
1565 struct listener *l = appctx->ctx.cli.p1;
William Lallemandeceddf72016-12-15 18:06:44 +01001566
Willy Tarreau241a0062022-05-05 18:29:25 +02001567 if (!l)
1568 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001569
Willy Tarreau241a0062022-05-05 18:29:25 +02001570 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
William Lallemandeceddf72016-12-15 18:06:44 +01001571 char addr[46];
1572 char port[6];
1573
Willy Tarreau37159062020-08-27 07:48:42 +02001574 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001575 const struct sockaddr_un *un;
1576
Willy Tarreau37159062020-08-27 07:48:42 +02001577 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001578 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001579 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001580 } else {
1581 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1582 }
Willy Tarreau37159062020-08-27 07:48:42 +02001583 } else if (l->rx.addr.ss_family == AF_INET) {
1584 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1585 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001586 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001587 } else if (l->rx.addr.ss_family == AF_INET6) {
1588 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1589 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001590 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001591 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1592 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001593 } else
William Lallemand26314342018-10-26 14:47:41 +02001594 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001595
William Lallemand07a62f72017-05-24 00:57:40 +02001596 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001597 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001598 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1599 chunk_appendf(&trash, "operator ");
1600 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1601 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001602 else
1603 chunk_appendf(&trash, " ");
1604
Willy Tarreau72faef32021-06-15 08:36:30 +02001605 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001606
Christopher Faulet908628c2022-03-25 16:43:49 +01001607 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreau241a0062022-05-05 18:29:25 +02001608 /* buffer full, we must yield */
1609 appctx->ctx.cli.p0 = bind_conf;
1610 appctx->ctx.cli.p1 = l;
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001611 cs_rx_room_blk(cs);
William Lallemandeceddf72016-12-15 18:06:44 +01001612 return 0;
1613 }
1614 }
William Lallemandeceddf72016-12-15 18:06:44 +01001615 }
1616 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001617 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001618 default:
1619 appctx->st2 = STAT_ST_FIN;
1620 return 1;
1621 }
1622}
1623
1624
Willy Tarreau0a739292016-11-22 20:21:23 +01001625/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001626 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1627 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001628 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001629static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001630{
1631 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001632 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001633
1634 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1635 return 1;
1636
Willy Tarreauf6710f82016-12-16 17:45:44 +01001637 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001638
1639 if (*args[2]) {
1640 int len = strlen(args[2]);
1641
Willy Tarreauf6710f82016-12-16 17:45:44 +01001642 for (; *var; var++) {
1643 if (strncmp(*var, args[2], len) == 0 &&
1644 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001645 break;
1646 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001647 if (!*var)
1648 return cli_err(appctx, "Variable not found\n");
1649
Willy Tarreau0a739292016-11-22 20:21:23 +01001650 appctx->st2 = STAT_ST_END;
1651 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001652 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001653 return 0;
1654}
1655
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001656/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1657 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1658 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1659 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001660static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001661{
1662 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1663 return 1;
1664
1665 appctx->ctx.cli.i0 = 0;
1666
1667 if (*args[2]) {
1668 appctx->ctx.cli.i0 = atoi(args[2]);
1669 appctx->st2 = STAT_ST_END;
1670 }
1671 return 0;
1672}
1673
Willy Tarreau599852e2016-11-22 20:33:32 +01001674/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001675static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001676{
Christopher Faulet908628c2022-03-25 16:43:49 +01001677 struct stream *s = __cs_strm(appctx->owner);
Willy Tarreau599852e2016-11-22 20:33:32 +01001678
1679 if (strcmp(args[2], "cli") == 0) {
1680 unsigned timeout;
1681 const char *res;
1682
Willy Tarreau9d008692019-08-09 11:21:01 +02001683 if (!*args[3])
1684 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001685
1686 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001687 if (res || timeout < 1)
1688 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001689
1690 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1691 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1692 return 1;
1693 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001694
1695 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001696}
1697
Willy Tarreau2af99412016-11-23 11:10:59 +01001698/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001699static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001700{
1701 int v;
1702
1703 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1704 return 1;
1705
Willy Tarreau9d008692019-08-09 11:21:01 +02001706 if (!*args[3])
1707 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001708
1709 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001710 if (v > global.hardmaxconn)
1711 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001712
1713 /* check for unlimited values */
1714 if (v <= 0)
1715 v = global.hardmaxconn;
1716
1717 global.maxconn = v;
1718
1719 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001720 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001721
1722 return 1;
1723}
1724
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001725static int set_severity_output(int *target, char *argument)
1726{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001727 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001728 *target = CLI_SEVERITY_NONE;
1729 return 1;
1730 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001731 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001732 *target = CLI_SEVERITY_NUMBER;
1733 return 1;
1734 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001735 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001736 *target = CLI_SEVERITY_STRING;
1737 return 1;
1738 }
1739 return 0;
1740}
1741
1742/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001743static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001744{
1745 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1746 return 0;
1747
Willy Tarreau9d008692019-08-09 11:21:01 +02001748 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001749}
William Lallemandeceddf72016-12-15 18:06:44 +01001750
William Lallemand67a234f2018-12-13 09:05:45 +01001751
1752/* show the level of the current CLI session */
1753static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1754{
William Lallemand67a234f2018-12-13 09:05:45 +01001755 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001756 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001757 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001758 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001759 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001760 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001761 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001762 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001763}
1764
1765/* parse and set the CLI level dynamically */
1766static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1767{
William Lallemandad032882019-07-01 10:56:15 +02001768 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001769 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001770 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1771
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001772 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001773 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1774 return 1;
1775 }
1776 appctx->cli_level &= ~ACCESS_LVL_MASK;
1777 appctx->cli_level |= ACCESS_LVL_OPER;
1778
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001779 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001780 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1781 return 1;
1782 }
1783 appctx->cli_level &= ~ACCESS_LVL_MASK;
1784 appctx->cli_level |= ACCESS_LVL_USER;
1785 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001786 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001787 return 1;
1788}
1789
1790
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001791/* parse and set the CLI expert/experimental-mode dynamically */
1792static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001793{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001794 int level;
1795 char *level_str;
1796 char *output = NULL;
1797
William Lallemand7267f782022-02-01 16:08:50 +01001798 /* this will ask the applet to not output a \n after the command */
1799 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1800 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1801
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001802 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1803 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001804
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001805 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001806 level = ACCESS_EXPERT;
1807 level_str = "expert-mode";
1808 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001809 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001810 level = ACCESS_EXPERIMENTAL;
1811 level_str = "experimental-mode";
1812 }
William Lallemand2a171912022-02-02 11:43:20 +01001813 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1814 level = ACCESS_MCLI_DEBUG;
1815 level_str = "mcli-debug-mode";
1816 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001817 else {
1818 return 1;
1819 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001820
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001821 if (!*args[1]) {
1822 memprintf(&output, "%s is %s\n", level_str,
1823 (appctx->cli_level & level) ? "ON" : "OFF");
1824 return cli_dynmsg(appctx, LOG_INFO, output);
1825 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001826
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001827 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001828 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001829 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001830 return 1;
1831}
1832
William Lallemand740629e2021-12-14 15:22:29 +01001833/* shows HAProxy version */
1834static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1835{
1836 char *msg = NULL;
1837
1838 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1839}
1840
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001841int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001842{
1843 return 0;
1844}
1845
Willy Tarreau45c742b2016-11-24 14:51:17 +01001846/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001847static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001848{
1849 int v;
1850 int *res;
1851 int mul = 1;
1852
1853 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1854 return 1;
1855
1856 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1857 res = &global.cps_lim;
1858 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1859 res = &global.sps_lim;
1860#ifdef USE_OPENSSL
1861 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1862 res = &global.ssl_lim;
1863#endif
1864 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1865 res = &global.comp_rate_lim;
1866 mul = 1024;
1867 }
1868 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001869 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001870 "'set rate-limit' only supports :\n"
1871 " - 'connections global' to set the per-process maximum connection rate\n"
1872 " - 'sessions global' to set the per-process maximum session rate\n"
1873#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001874 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001875#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001876 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001877 }
1878
Willy Tarreau9d008692019-08-09 11:21:01 +02001879 if (!*args[4])
1880 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001881
1882 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001883 if (v < 0)
1884 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001885
1886 *res = v * mul;
1887
1888 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001889 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001890
1891 return 1;
1892}
1893
William Lallemandf6975e92017-05-26 17:42:10 +02001894/* parse the "expose-fd" argument on the bind lines */
1895static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1896{
1897 if (!*args[cur_arg + 1]) {
1898 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1899 return ERR_ALERT | ERR_FATAL;
1900 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001901 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001902 conf->level |= ACCESS_FD_LISTENERS;
1903 } else {
1904 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1905 args[cur_arg], args[cur_arg+1]);
1906 return ERR_ALERT | ERR_FATAL;
1907 }
1908
1909 return 0;
1910}
1911
William Lallemand74c24fb2016-11-21 17:18:36 +01001912/* parse the "level" argument on the bind lines */
1913static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1914{
1915 if (!*args[cur_arg + 1]) {
1916 memprintf(err, "'%s' : missing level", args[cur_arg]);
1917 return ERR_ALERT | ERR_FATAL;
1918 }
1919
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001920 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001921 conf->level &= ~ACCESS_LVL_MASK;
1922 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001923 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001924 conf->level &= ~ACCESS_LVL_MASK;
1925 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001926 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001927 conf->level &= ~ACCESS_LVL_MASK;
1928 conf->level |= ACCESS_LVL_ADMIN;
1929 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001930 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1931 args[cur_arg], args[cur_arg+1]);
1932 return ERR_ALERT | ERR_FATAL;
1933 }
1934
1935 return 0;
1936}
1937
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001938static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1939{
1940 if (!*args[cur_arg + 1]) {
1941 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1942 return ERR_ALERT | ERR_FATAL;
1943 }
1944
1945 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1946 return 0;
1947 else {
1948 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1949 args[cur_arg], args[cur_arg+1]);
1950 return ERR_ALERT | ERR_FATAL;
1951 }
1952}
1953
Olivier Houchardf886e342017-04-05 22:24:59 +02001954/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001955static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001956{
1957 char *cmsgbuf = NULL;
1958 unsigned char *tmpbuf = NULL;
1959 struct cmsghdr *cmsg;
Christopher Faulet908628c2022-03-25 16:43:49 +01001960 struct conn_stream *cs = appctx->owner;
1961 struct stream *s = __cs_strm(cs);
1962 struct connection *remote = cs_conn(cs_opposite(cs));
Olivier Houchardf886e342017-04-05 22:24:59 +02001963 struct msghdr msghdr;
1964 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001965 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001966 const char *ns_name, *if_name;
1967 unsigned char ns_nlen, if_nlen;
1968 int nb_queued;
1969 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001970 int *tmpfd;
1971 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001972 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001973 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001974 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001975 int ret;
1976
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001977 if (!remote) {
1978 ha_warning("Only works on real connections\n");
1979 goto out;
1980 }
1981
1982 fd = remote->handle.fd;
1983
Olivier Houchardf886e342017-04-05 22:24:59 +02001984 /* Temporary set the FD in blocking mode, that will make our life easier */
1985 old_fcntl = fcntl(fd, F_GETFL);
1986 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001987 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001988 goto out;
1989 }
1990 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1991 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001992 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001993 goto out;
1994 }
1995 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001996 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001997 goto out;
1998 }
Olivier Houchard54740872017-04-06 14:45:14 +02001999 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 iov.iov_base = &tot_fd_nb;
2001 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002002 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002003 goto out;
2004 memset(&msghdr, 0, sizeof(msghdr));
2005 /*
2006 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002007 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002008 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002009 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002010 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002011
Olivier Houchardf886e342017-04-05 22:24:59 +02002012 if (tot_fd_nb == 0)
2013 goto out;
2014
2015 /* First send the total number of file descriptors, so that the
2016 * receiving end knows what to expect.
2017 */
2018 msghdr.msg_iov = &iov;
2019 msghdr.msg_iovlen = 1;
2020 ret = sendmsg(fd, &msghdr, 0);
2021 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002022 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002023 goto out;
2024 }
2025
2026 /* Now send the fds */
2027 msghdr.msg_control = cmsgbuf;
2028 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2029 cmsg = CMSG_FIRSTHDR(&msghdr);
2030 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2031 cmsg->cmsg_level = SOL_SOCKET;
2032 cmsg->cmsg_type = SCM_RIGHTS;
2033 tmpfd = (int *)CMSG_DATA(cmsg);
2034
Olivier Houchardf886e342017-04-05 22:24:59 +02002035 /* For each socket, e message is sent, containing the following :
2036 * Size of the namespace name (or 0 if none), as an unsigned char.
2037 * The namespace name, if any
2038 * Size of the interface name (or 0 if none), as an unsigned char
2039 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002040 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002041 */
2042 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002043 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002044 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002045 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002046 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002047 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002048 goto out;
2049 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002050
2051 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002052 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002053 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002054 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002055 continue;
2056
2057 ns_name = if_name = "";
2058 ns_nlen = if_nlen = 0;
2059
2060 /* for now we can only retrieve namespaces and interfaces from
2061 * pure listeners.
2062 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002063 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002064 const struct listener *l = fdtab[cur_fd].owner;
2065
Willy Tarreau818a92e2020-09-03 07:50:19 +02002066 if (l->rx.settings->interface) {
2067 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002068 if_nlen = strlen(if_name);
2069 }
2070
2071#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002072 if (l->rx.settings->netns) {
2073 ns_name = l->rx.settings->netns->node.key;
2074 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002075 }
2076#endif
2077 }
2078
2079 /* put the FD into the CMSG_DATA */
2080 tmpfd[nb_queued++] = cur_fd;
2081
2082 /* first block is <ns_name_len> <ns_name> */
2083 tmpbuf[curoff++] = ns_nlen;
2084 if (ns_nlen)
2085 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2086 curoff += ns_nlen;
2087
2088 /* second block is <if_name_len> <if_name> */
2089 tmpbuf[curoff++] = if_nlen;
2090 if (if_nlen)
2091 memcpy(tmpbuf + curoff, if_name, if_nlen);
2092 curoff += if_nlen;
2093
2094 /* we used to send the listener options here before 2.3 */
2095 memset(tmpbuf + curoff, 0, sizeof(int));
2096 curoff += sizeof(int);
2097
2098 /* there's a limit to how many FDs may be sent at once */
2099 if (nb_queued == MAX_SEND_FD) {
2100 iov.iov_len = curoff;
2101 if (sendmsg(fd, &msghdr, 0) != curoff) {
2102 ha_warning("Failed to transfer sockets\n");
2103 return -1;
2104 }
2105
2106 /* Wait for an ack */
2107 do {
2108 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2109 } while (ret == -1 && errno == EINTR);
2110
2111 if (ret <= 0) {
2112 ha_warning("Unexpected error while transferring sockets\n");
2113 return -1;
2114 }
2115 curoff = 0;
2116 nb_queued = 0;
2117 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002118 }
2119
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002120 /* flush pending stuff */
2121 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002122 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002123 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2124 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002125 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002126 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002127 goto out;
2128 }
2129 }
2130
2131out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002132 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002133 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002134 goto out;
2135 }
2136 appctx->st0 = CLI_ST_END;
2137 free(cmsgbuf);
2138 free(tmpbuf);
2139 return 1;
2140}
2141
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002142static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2143{
2144 if (*args[0] == 'h')
2145 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002146 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002147 else if (*args[0] == 'p')
2148 /* prompt */
2149 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2150 else if (*args[0] == 'q')
2151 /* quit */
2152 appctx->st0 = CLI_ST_END;
2153
2154 return 1;
2155}
Olivier Houchardf886e342017-04-05 22:24:59 +02002156
William Lallemand2f4ce202018-10-26 14:47:47 +02002157void pcli_write_prompt(struct stream *s)
2158{
2159 struct buffer *msg = get_trash_chunk();
Christopher Faulet908628c2022-03-25 16:43:49 +01002160 struct channel *oc = cs_oc(s->csf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002161
William Lallemanddc12c2e2018-12-13 09:05:46 +01002162 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002163 return;
2164
William Lallemanddc12c2e2018-12-13 09:05:46 +01002165 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002166 chunk_appendf(msg, "+ ");
2167 } else {
2168 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002169 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002170 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002171 else
William Lallemanddae12c72022-02-02 14:13:54 +01002172 chunk_appendf(msg, "%d", s->pcli_next_pid);
2173
2174 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2175 chunk_appendf(msg, "(");
2176
2177 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2178 chunk_appendf(msg, "x");
2179
2180 if (s->pcli_flags & ACCESS_EXPERT)
2181 chunk_appendf(msg, "e");
2182
2183 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2184 chunk_appendf(msg, "d");
2185
2186 chunk_appendf(msg, ")");
2187 }
2188
2189 chunk_appendf(msg, "> ");
2190
2191
William Lallemandebf61802018-12-11 16:10:57 +01002192 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002193 co_inject(oc, msg->area, msg->data);
2194}
2195
William Lallemand291810d2018-10-26 14:47:38 +02002196
William Lallemandcf62f7e2018-10-26 14:47:40 +02002197/* The pcli_* functions are used for the CLI proxy in the master */
2198
William Lallemanddeeaa592018-10-26 14:47:48 +02002199void pcli_reply_and_close(struct stream *s, const char *msg)
2200{
2201 struct buffer *buf = get_trash_chunk();
2202
2203 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002204 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002205}
2206
William Lallemand291810d2018-10-26 14:47:38 +02002207static enum obj_type *pcli_pid_to_server(int proc_pid)
2208{
2209 struct mworker_proc *child;
2210
William Lallemand99e0bb92020-11-05 10:28:53 +01002211 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002212 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002213 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002214
William Lallemand291810d2018-10-26 14:47:38 +02002215 list_for_each_entry(child, &proc_list, list) {
2216 if (child->pid == proc_pid){
2217 return &child->srv->obj_type;
2218 }
2219 }
2220 return NULL;
2221}
2222
2223/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2224 * Return:
2225 * 0: master
2226 * > 0: pid of a worker
2227 * < 0: didn't find a worker
2228 */
2229static int pcli_prefix_to_pid(const char *prefix)
2230{
2231 int proc_pid;
2232 struct mworker_proc *child;
2233 char *errtol = NULL;
2234
2235 if (*prefix != '@') /* not a prefix, should not happen */
2236 return -1;
2237
2238 prefix++;
2239 if (!*prefix) /* sent @ alone, return the master */
2240 return 0;
2241
2242 if (strcmp("master", prefix) == 0) {
2243 return 0;
2244 } else if (*prefix == '!') {
2245 prefix++;
2246 if (!*prefix)
2247 return -1;
2248
2249 proc_pid = strtol(prefix, &errtol, 10);
2250 if (*errtol != '\0')
2251 return -1;
2252 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002253 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002254 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002255 if (child->pid == proc_pid){
2256 return child->pid;
2257 }
2258 }
2259 } else {
2260 struct mworker_proc *chosen = NULL;
2261 /* this is a relative pid */
2262
2263 proc_pid = strtol(prefix, &errtol, 10);
2264 if (*errtol != '\0')
2265 return -1;
2266
2267 if (proc_pid == 0) /* return the master */
2268 return 0;
2269
2270 /* chose the right process, the current one is the one with the
2271 least number of reloads */
2272 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002273 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002274 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002275 if (child->reloads == 0)
2276 return child->pid;
2277 else if (chosen == NULL || child->reloads < chosen->reloads)
2278 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002279 }
2280 if (chosen)
2281 return chosen->pid;
2282 }
2283 return -1;
2284}
2285
William Lallemandbddd33a2018-12-11 16:10:53 +01002286/* Return::
2287 * >= 0 : number of words to escape
2288 * = -1 : error
2289 */
2290
2291int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2292{
2293 if (argl < 1)
2294 return 0;
2295
2296 /* there is a prefix */
2297 if (args[0][0] == '@') {
2298 int target_pid = pcli_prefix_to_pid(args[0]);
2299
2300 if (target_pid == -1) {
2301 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2302 return -1;
2303 }
2304
2305 /* if the prefix is alone, define a default target */
2306 if (argl == 1)
2307 s->pcli_next_pid = target_pid;
2308 else
2309 *next_pid = target_pid;
2310 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002311 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002312 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002313 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002314
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002315 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002316 channel_shutr_now(&s->req);
2317 channel_shutw_now(&s->res);
2318 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002319 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002320 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2321 memprintf(errmsg, "Permission denied!\n");
2322 return -1;
2323 }
2324 s->pcli_flags &= ~ACCESS_LVL_MASK;
2325 s->pcli_flags |= ACCESS_LVL_OPER;
2326 return argl;
2327
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002328 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002329 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2330 memprintf(errmsg, "Permission denied!\n");
2331 return -1;
2332 }
2333 s->pcli_flags &= ~ACCESS_LVL_MASK;
2334 s->pcli_flags |= ACCESS_LVL_USER;
2335 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002336
2337 } else if (strcmp(args[0], "expert-mode") == 0) {
2338 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2339 memprintf(errmsg, "Permission denied!\n");
2340 return -1;
2341 }
2342
2343 s->pcli_flags &= ~ACCESS_EXPERT;
2344 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2345 s->pcli_flags |= ACCESS_EXPERT;
2346 return argl;
2347
2348 } else if (strcmp(args[0], "experimental-mode") == 0) {
2349 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2350 memprintf(errmsg, "Permission denied!\n");
2351 return -1;
2352 }
2353 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2354 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2355 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2356 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002357 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2358 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2359 memprintf(errmsg, "Permission denied!\n");
2360 return -1;
2361 }
2362 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2363 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2364 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2365 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002366 }
2367
2368 return 0;
2369}
2370
2371/*
2372 * Parse the CLI request:
2373 * - It does basically the same as the cli_io_handler, but as a proxy
2374 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002375 *
2376 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002377 * - the number of characters to forward or
2378 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002379 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002380int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002381{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002382 char *str;
2383 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002384 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002385 int argl; /* number of args */
2386 char *p;
2387 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002388 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002389 int wtrim = 0; /* number of words to trim */
2390 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002391 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002392 int i = 0;
2393
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002394 /* we cannot deal with a wrapping buffer, so let's take care of this
2395 * first.
2396 */
2397 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2398 b_slow_realign(&req->buf, trash.area, co_data(req));
2399
2400 str = (char *)ci_head(req);
2401 end = (char *)ci_stop(req);
2402
William Lallemandbddd33a2018-12-11 16:10:53 +01002403 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002404
William Lallemanddc12c2e2018-12-13 09:05:46 +01002405 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002406
2407 /* Looks for the end of one command */
2408 while (p+reql < end) {
2409 /* handle escaping */
2410 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002411 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002412 continue;
2413 }
2414 if (p[reql] == ';' || p[reql] == '\n') {
2415 /* found the end of the command */
2416 p[reql] = '\n';
2417 reql++;
2418 break;
2419 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002420 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002421 }
William Lallemandebf61802018-12-11 16:10:57 +01002422 } else {
2423 while (p+reql < end) {
2424 if (p[reql] == '\n') {
2425 /* found the end of the line */
2426 reql++;
2427 break;
2428 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002429 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002430 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002431 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432
William Lallemandbddd33a2018-12-11 16:10:53 +01002433 /* set end to first byte after the end of the command */
2434 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002435
William Lallemandbddd33a2018-12-11 16:10:53 +01002436 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002437 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002438 return -1;
2439 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002440
William Lallemand3301f3e2018-12-13 09:05:48 +01002441 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2442 if (reql == 1) /* last line of the payload */
2443 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002444 return reql;
2445 }
2446
William Lallemandbddd33a2018-12-11 16:10:53 +01002447 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448
William Lallemandbddd33a2018-12-11 16:10:53 +01002449 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002450 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002451 /* skip leading spaces/tabs */
2452 p += strspn(p, " \t");
2453 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002454 break;
2455
William Lallemandbddd33a2018-12-11 16:10:53 +01002456 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002457 while (1) {
2458 p += strcspn(p, " \t\\");
2459 /* escaped chars using backlashes (\) */
2460 if (*p == '\\') {
2461 if (!*++p)
2462 break;
2463 if (!*++p)
2464 break;
2465 } else {
2466 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002467 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002468 }
William Lallemandfe249c32020-06-18 18:03:57 +02002469 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002470 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002471 }
2472
William Lallemandbddd33a2018-12-11 16:10:53 +01002473 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002474
Willy Tarreauf14c7572021-03-13 10:59:23 +01002475 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002476 args[i] = NULL;
2477
2478 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2479
2480 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002481 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002482 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002483 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002484 if (*p == '\0')
2485 *p = ' ';
2486 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002487 }
2488
William Lallemand3301f3e2018-12-13 09:05:48 +01002489 payload = strstr(str, PAYLOAD_PATTERN);
2490 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2491 /* if the payload pattern is at the end */
2492 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002493 }
2494
William Lallemandbddd33a2018-12-11 16:10:53 +01002495 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002496
William Lallemandbddd33a2018-12-11 16:10:53 +01002497 if (wtrim > 0) {
2498 trim = &args[wtrim][0];
2499 if (trim == NULL) /* if this was the last word in the table */
2500 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002501
William Lallemandbddd33a2018-12-11 16:10:53 +01002502 b_del(&req->buf, trim - str);
2503
William Lallemandb7ea1412018-12-13 09:05:47 +01002504 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002505 } else if (wtrim < 0) {
2506 /* parsing error */
2507 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002508 } else {
2509 /* the whole string */
2510 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002511 }
2512
William Lallemandb7ea1412018-12-13 09:05:47 +01002513 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002514
2515 /* the mcli-debug-mode is only sent to the applet of the master */
2516 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2517 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2518 ret += strlen("mcli-debug-mode on -") + 2;
2519 }
William Lallemand7267f782022-02-01 16:08:50 +01002520 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2521 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2522 ret += strlen("experimental-mode on -") + 2;
2523 }
2524 if (s->pcli_flags & ACCESS_EXPERT) {
2525 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2526 ret += strlen("expert-mode on -") + 2;
2527 }
2528
William Lallemandb7ea1412018-12-13 09:05:47 +01002529 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2530 goto end;
2531 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002532 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2533 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002534 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002535 ci_insert_line2(req, 0, "user -", strlen("user -"));
2536 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002537 }
2538 }
2539end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002540
William Lallemandb7ea1412018-12-13 09:05:47 +01002541 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002542}
2543
2544int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2545{
William Lallemandbddd33a2018-12-11 16:10:53 +01002546 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002547 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002548 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002549
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002550 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002551 * current one. Just wait. At this stage, errors should be handled by
2552 * the response analyzer.
2553 */
2554 if (s->res.analysers & AN_RES_WAIT_CLI)
2555 return 0;
2556
William Lallemandb7ea1412018-12-13 09:05:47 +01002557 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2558 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2559
William Lallemandcf62f7e2018-10-26 14:47:40 +02002560read_again:
2561 /* if the channel is closed for read, we won't receive any more data
2562 from the client, but we don't want to forward this close to the
2563 server */
2564 channel_dont_close(req);
2565
2566 /* We don't know yet to which server we will connect */
2567 channel_dont_connect(req);
2568
William Lallemandcf62f7e2018-10-26 14:47:40 +02002569 req->flags |= CF_READ_DONTWAIT;
2570
2571 /* need more data */
2572 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002573 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002574
2575 /* If there is data available for analysis, log the end of the idle time. */
2576 if (c_data(req) && s->logs.t_idle == -1)
2577 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2578
William Lallemandbddd33a2018-12-11 16:10:53 +01002579 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002580 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002581 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002582 /* enough data */
2583
William Lallemandcf62f7e2018-10-26 14:47:40 +02002584 /* forward only 1 command */
2585 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002586
William Lallemanddc12c2e2018-12-13 09:05:46 +01002587 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002588 /* we send only 1 command per request, and we write close after it */
2589 channel_shutw_now(req);
2590 } else {
2591 pcli_write_prompt(s);
2592 }
2593
2594 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002595 s->res.analysers |= AN_RES_WAIT_CLI;
2596
William Lallemandebf61802018-12-11 16:10:57 +01002597 if (!(s->flags & SF_ASSIGNED)) {
2598 if (next_pid > -1)
2599 target_pid = next_pid;
2600 else
2601 target_pid = s->pcli_next_pid;
2602 /* we can connect now */
2603 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002604
William Lallemanddcbe7b92021-12-10 14:14:53 +01002605 if (!s->target)
2606 goto server_disconnect;
2607
William Lallemandebf61802018-12-11 16:10:57 +01002608 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2609 channel_auto_connect(req);
2610 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002611
2612 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002613 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002614 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002615 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002616 } else if (to_forward == -1) {
2617 if (errmsg) {
2618 /* there was an error during the parsing */
2619 pcli_reply_and_close(s, errmsg);
2620 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2621 return 0;
2622 }
2623 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002624 }
2625
2626 return 0;
2627
2628send_help:
2629 b_reset(&req->buf);
2630 b_putblk(&req->buf, "help\n", 5);
2631 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002632
Christopher Faulet0f727da2022-01-18 08:44:23 +01002633missing_data:
2634 if (req->flags & CF_SHUTR) {
2635 /* There is no more request or a only a partial one and we
2636 * receive a close from the client, we can leave */
2637 channel_shutw_now(&s->res);
2638 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2639 return 1;
2640 }
2641 else if (channel_full(req, global.tune.maxrewrite)) {
2642 /* buffer is full and we didn't catch the end of a command */
2643 goto send_help;
2644 }
2645 return 0;
2646
William Lallemanddcbe7b92021-12-10 14:14:53 +01002647server_disconnect:
2648 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2649 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002650}
2651
2652int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2653{
2654 struct proxy *fe = strm_fe(s);
2655 struct proxy *be = s->be;
2656
Christopher Faulete8cefac2022-03-07 18:20:21 +01002657 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2658 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002659 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002660 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002661 s->res.analysers &= ~AN_RES_WAIT_CLI;
2662 return 0;
2663 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002664 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2665 rep->flags |= CF_NEVER_WAIT;
2666
2667 /* don't forward the close */
2668 channel_dont_close(&s->res);
2669 channel_dont_close(&s->req);
2670
William Lallemanddc12c2e2018-12-13 09:05:46 +01002671 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002672 s->res.analysers &= ~AN_RES_WAIT_CLI;
2673 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2674 return 0;
2675 }
2676
William Lallemandcf62f7e2018-10-26 14:47:40 +02002677 /* forward the data */
2678 if (ci_data(rep)) {
2679 c_adv(rep, ci_data(rep));
2680 return 0;
2681 }
2682
2683 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2684 /* stream cleanup */
2685
William Lallemand2f4ce202018-10-26 14:47:47 +02002686 pcli_write_prompt(s);
2687
Christopher Faulet8abe7122022-03-30 15:10:18 +02002688 s->csb->flags |= CS_FL_NOLINGER | CS_FL_NOHALF;
Christopher Fauletda098e62022-03-31 17:44:45 +02002689 cs_shutr(s->csb);
2690 cs_shutw(s->csb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002691
2692 /*
2693 * starting from there this the same code as
2694 * http_end_txn_clean_session().
2695 *
2696 * It allows to do frontend keepalive while reconnecting to a
2697 * new server for each request.
2698 */
2699
2700 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002701 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002702 if (unlikely(s->srv_conn))
2703 sess_change_server(s, NULL);
2704 }
2705
2706 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2707 stream_process_counters(s);
2708
2709 /* don't count other requests' data */
2710 s->logs.bytes_in -= ci_data(&s->req);
2711 s->logs.bytes_out -= ci_data(&s->res);
2712
2713 /* we may need to know the position in the queue */
2714 pendconn_free(s);
2715
2716 /* let's do a final log if we need it */
2717 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2718 !(s->flags & SF_MONITOR) &&
2719 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2720 s->do_log(s);
2721 }
2722
2723 /* stop tracking content-based counters */
2724 stream_stop_content_counters(s);
2725 stream_update_time_stats(s);
2726
2727 s->logs.accept_date = date; /* user-visible date for logging */
2728 s->logs.tv_accept = now; /* corrected date for internal use */
2729 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2730 s->logs.t_idle = -1;
2731 tv_zero(&s->logs.tv_request);
2732 s->logs.t_queue = -1;
2733 s->logs.t_connect = -1;
2734 s->logs.t_data = -1;
2735 s->logs.t_close = 0;
2736 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2737 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2738
2739 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2740 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2741
2742 stream_del_srv_conn(s);
2743 if (objt_server(s->target)) {
2744 if (s->flags & SF_CURR_SESS) {
2745 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002746 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002747 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002748 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002749 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002750 }
2751
2752 s->target = NULL;
2753
2754 /* only release our endpoint if we don't intend to reuse the
2755 * connection.
2756 */
Christopher Faulete39a4df2022-03-31 09:58:41 +02002757 if (!cs_conn_ready(s->csb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002758 s->srv_conn = NULL;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002759 if (cs_reset_endp(s->csb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002760 if (!s->conn_err_type)
2761 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002762 if (s->srv_error)
Christopher Faulet0eb32c02022-04-04 11:06:31 +02002763 s->srv_error(s, s->csb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002764 return 1;
2765 }
Christopher Fauleta6c4a482022-04-28 18:25:24 +02002766 s->csb->endp->flags &= CS_EP_DETACHED;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002767 }
2768
Christopher Faulet8da67aa2022-03-29 17:53:09 +02002769 sockaddr_free(&s->csb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002770
Christopher Faulet62e75742022-03-31 09:16:34 +02002771 cs_set_state(s->csb, CS_ST_INI);
Christopher Faulet974da9f2022-03-30 15:30:03 +02002772 s->csb->flags &= CS_FL_ISBACK | CS_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);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002775 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002776 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 */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002779 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002780 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002781 /* reinitialise the current rule list pointer to NULL. We are sure that
2782 * any rulelist match the NULL pointer.
2783 */
2784 s->current_rule_list = NULL;
2785
2786 s->be = strm_fe(s);
2787 s->logs.logwait = strm_fe(s)->to_log;
2788 s->logs.level = 0;
2789 stream_del_srv_conn(s);
2790 s->target = NULL;
2791 /* re-init store persistence */
2792 s->store_count = 0;
2793 s->uniq_id = global.req_count++;
2794
2795 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2796
2797 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2798
William Lallemandcf62f7e2018-10-26 14:47:40 +02002799 s->res.analysers &= ~AN_RES_WAIT_CLI;
2800
2801 /* We must trim any excess data from the response buffer, because we
2802 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002803 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002804 * we want those data to come along with next response. A typical
2805 * example of such data would be from a buggy server responding to
2806 * a HEAD with some data, or sending more than the advertised
2807 * content-length.
2808 */
2809 if (unlikely(ci_data(&s->res)))
2810 b_set_data(&s->res.buf, co_data(&s->res));
2811
2812 /* Now we can realign the response buffer */
2813 c_realign_if_empty(&s->res);
2814
2815 s->req.rto = strm_fe(s)->timeout.client;
2816 s->req.wto = TICK_ETERNITY;
2817
2818 s->res.rto = TICK_ETERNITY;
2819 s->res.wto = strm_fe(s)->timeout.client;
2820
2821 s->req.rex = TICK_ETERNITY;
2822 s->req.wex = TICK_ETERNITY;
2823 s->req.analyse_exp = TICK_ETERNITY;
2824 s->res.rex = TICK_ETERNITY;
2825 s->res.wex = TICK_ETERNITY;
2826 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet1d987772022-03-29 18:03:35 +02002827 s->csb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002828
2829 /* we're removing the analysers, we MUST re-enable events detection.
2830 * We don't enable close on the response channel since it's either
2831 * already closed, or in keep-alive with an idle connection handler.
2832 */
2833 channel_auto_read(&s->req);
2834 channel_auto_close(&s->req);
2835 channel_auto_read(&s->res);
2836
2837
2838 return 1;
2839 }
2840 return 0;
2841}
2842
William Lallemand8a022572018-10-26 14:47:35 +02002843/*
2844 * The mworker functions are used to initialize the CLI in the master process
2845 */
2846
William Lallemand309dc9a2018-10-26 14:47:45 +02002847 /*
2848 * Stop the mworker proxy
2849 */
2850void mworker_cli_proxy_stop()
2851{
William Lallemand550db6d2018-11-06 17:37:12 +01002852 if (mworker_proxy)
2853 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002854}
2855
William Lallemand8a022572018-10-26 14:47:35 +02002856/*
2857 * Create the mworker CLI proxy
2858 */
2859int mworker_cli_proxy_create()
2860{
2861 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002862 char *msg = NULL;
2863 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002864
William Lallemandae787ba2021-07-29 15:13:22 +02002865 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002866 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002867 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002868
William Lallemandcf62f7e2018-10-26 14:47:40 +02002869 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002870 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2871 mworker_proxy->timeout.client = 0; /* no timeout */
2872 mworker_proxy->conf.file = strdup("MASTER");
2873 mworker_proxy->conf.line = 0;
2874 mworker_proxy->accept = frontend_accept;
2875 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2876
2877 /* Does not init the default target the CLI applet, but must be done in
2878 * the request parsing code */
2879 mworker_proxy->default_target = NULL;
2880
William Lallemand8a022572018-10-26 14:47:35 +02002881 /* create all servers using the mworker_proc list */
2882 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002883 struct server *newsrv = NULL;
2884 struct sockaddr_storage *sk;
2885 int port1, port2, port;
2886 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002887
William Lallemanda31b09e2020-01-14 15:25:02 +01002888 /* only the workers support the master CLI */
2889 if (!(child->options & PROC_O_TYPE_WORKER))
2890 continue;
2891
William Lallemand8a022572018-10-26 14:47:35 +02002892 newsrv = new_server(mworker_proxy);
2893 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002894 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002895
2896 /* we don't know the new pid yet */
2897 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002898 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002899 else
2900 memprintf(&msg, "old-%d", child->pid);
2901
2902 newsrv->next = mworker_proxy->srv;
2903 mworker_proxy->srv = newsrv;
2904 newsrv->conf.file = strdup(msg);
2905 newsrv->id = strdup(msg);
2906 newsrv->conf.line = 0;
2907
2908 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002909 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002910 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002911 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002912 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002913 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002914
Willy Tarreau5fc93282020-09-16 18:25:03 +02002915 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002916 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002917 }
2918
2919 /* no port specified */
2920 newsrv->flags |= SRV_F_MAPPORTS;
2921 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002922 /* don't let the server participate to load balancing */
2923 newsrv->iweight = 0;
2924 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002925 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002926
2927 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002928 }
William Lallemandae787ba2021-07-29 15:13:22 +02002929
2930 mworker_proxy->next = proxies_list;
2931 proxies_list = mworker_proxy;
2932
William Lallemand8a022572018-10-26 14:47:35 +02002933 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002934
2935error:
William Lallemand744a0892018-11-22 16:46:51 +01002936
2937 list_for_each_entry(child, &proc_list, list) {
2938 free((char *)child->srv->conf.file); /* cast because of const char * */
2939 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002940 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002941 }
William Lallemandae787ba2021-07-29 15:13:22 +02002942 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002943 free(msg);
2944
William Lallemandae787ba2021-07-29 15:13:22 +02002945error_proxy:
2946 ha_alert("%s\n", errmsg);
2947 free(errmsg);
2948
William Lallemand744a0892018-11-22 16:46:51 +01002949 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002950}
Olivier Houchardf886e342017-04-05 22:24:59 +02002951
William Lallemandce83b4a2018-10-26 14:47:30 +02002952/*
William Lallemande7361152018-10-26 14:47:36 +02002953 * Create a new listener for the master CLI proxy
2954 */
2955int mworker_cli_proxy_new_listener(char *line)
2956{
2957 struct bind_conf *bind_conf;
2958 struct listener *l;
2959 char *err = NULL;
2960 char *args[MAX_LINE_ARGS + 1];
2961 int arg;
2962 int cur_arg;
2963
William Lallemand2e945c82019-11-25 09:58:37 +01002964 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002965 args[0] = line;
2966
2967 /* args is a bind configuration with spaces replaced by commas */
2968 while (*line && arg < MAX_LINE_ARGS) {
2969
2970 if (*line == ',') {
2971 *line++ = '\0';
2972 while (*line == ',')
2973 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002974 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002975 }
2976 line++;
2977 }
2978
William Lallemand2e945c82019-11-25 09:58:37 +01002979 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002980
2981 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002982 if (!bind_conf)
2983 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002984
2985 bind_conf->level &= ~ACCESS_LVL_MASK;
2986 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002987 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002988
2989 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2990 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002991 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002992 }
2993
2994 cur_arg = 1;
2995
2996 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002997 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002998 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002999
3000 kw = bind_find_kw(args[cur_arg]);
3001 if (kw) {
3002 if (!kw->parse) {
3003 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3004 args[0], args[1], args[cur_arg]);
3005 goto err;
3006 }
3007
Willy Tarreau4975d142021-03-13 11:00:33 +01003008 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003009 if (err)
3010 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3011 else
3012 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3013 args[0], args[1], args[cur_arg]);
3014 goto err;
3015 }
3016
3017 cur_arg += 1 + kw->skip;
3018 continue;
3019 }
3020
Willy Tarreau433b05f2021-03-12 10:14:07 +01003021 best = bind_find_best_kw(args[cur_arg]);
3022 if (best)
3023 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3024 args[0], args[1], args[cur_arg], best);
3025 else
3026 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3027 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003028 goto err;
3029 }
3030
3031
3032 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003033 l->accept = session_accept_fd;
3034 l->default_target = mworker_proxy->default_target;
3035 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003036 l->options |= LI_O_UNLIMITED;
3037 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003038 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003039 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003040 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003041 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003042
3043 return 0;
3044
3045err:
3046 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003047 free(err);
3048 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003049 return -1;
3050
3051}
3052
3053/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003054 * Create a new CLI socket using a socketpair for a worker process
3055 * <mworker_proc> is the process structure, and <proc> is the process number
3056 */
3057int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3058{
3059 struct bind_conf *bind_conf;
3060 struct listener *l;
3061 char *path = NULL;
3062 char *err = NULL;
3063
3064 /* master pipe to ensure the master is still alive */
3065 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3066 ha_alert("Cannot create worker socketpair.\n");
3067 return -1;
3068 }
3069
3070 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003071 if (!global.cli_fe) {
3072 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003073 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003074 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003075 }
3076 }
3077
Willy Tarreau4975d142021-03-13 11:00:33 +01003078 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003079 if (!bind_conf)
3080 goto error;
3081
William Lallemandce83b4a2018-10-26 14:47:30 +02003082 bind_conf->level &= ~ACCESS_LVL_MASK;
3083 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003084 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003085
William Lallemandce83b4a2018-10-26 14:47:30 +02003086 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3087 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003088 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003089 }
3090
Willy Tarreau4975d142021-03-13 11:00:33 +01003091 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003092 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003093 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003094 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003095 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003096 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003097
3098 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003099 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003100 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003101 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003102 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003103 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003104 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003106 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003107 }
3108
3109 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003110
3111error:
3112 close(mworker_proc->ipc_fd[0]);
3113 close(mworker_proc->ipc_fd[1]);
3114 free(err);
3115
3116 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003117}
3118
William Lallemand74c24fb2016-11-21 17:18:36 +01003119static struct applet cli_applet = {
3120 .obj_type = OBJ_TYPE_APPLET,
3121 .name = "<CLI>", /* used for logging */
3122 .fct = cli_io_handler,
3123 .release = cli_release_handler,
3124};
3125
William Lallemand99e0bb92020-11-05 10:28:53 +01003126/* master CLI */
3127static struct applet mcli_applet = {
3128 .obj_type = OBJ_TYPE_APPLET,
3129 .name = "<MCLI>", /* used for logging */
3130 .fct = cli_io_handler,
3131 .release = cli_release_handler,
3132};
3133
Willy Tarreau0a739292016-11-22 20:21:23 +01003134/* register cli keywords */
3135static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003136 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3137 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3138 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3139 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003140 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3141 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003142 { { "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 +02003143 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3144 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3145 { { "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 },
3146 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3147 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3148 { { "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 },
3149 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3150 { { "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 },
3151 { { "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 +01003152 { { "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 +02003153 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3154 { { "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 +01003155 {{},}
3156}};
3157
Willy Tarreau0108d902018-11-25 19:14:37 +01003158INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3159
William Lallemand74c24fb2016-11-21 17:18:36 +01003160static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003161 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003162 { 0, NULL, NULL },
3163}};
3164
Willy Tarreau0108d902018-11-25 19:14:37 +01003165INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3166
William Lallemand74c24fb2016-11-21 17:18:36 +01003167static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003168 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3169 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003170 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003171 { NULL, NULL, 0 },
3172}};
3173
Willy Tarreau0108d902018-11-25 19:14:37 +01003174INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003175
3176/*
3177 * Local variables:
3178 * c-indent-level: 8
3179 * c-basic-offset: 8
3180 * End:
3181 */