blob: f13cfd00d422ef3342ea1a12d38195a658fecf10 [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 Tarreau307dbb32022-05-05 17:45:52 +020089/* CLI context for the "show env" command */
90struct show_env_ctx {
91 char **var; /* first variable to show */
92 int show_one; /* stop after showing the first one */
93};
94
Willy Tarreau741a5a92022-05-05 17:56:58 +020095/* CLI context for the "show fd" command */
96struct show_fd_ctx {
97 int fd; /* first FD to show */
98 int show_one; /* stop after showing one FD */
99};
100
Willy Tarreaub128f492022-05-05 19:11:05 +0200101/* CLI context for the "show cli sockets" command */
102struct show_sock_ctx {
103 struct bind_conf *bind_conf;
104 struct listener *listener;
105};
106
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200107static int cmp_kw_entries(const void *a, const void *b)
108{
109 const struct cli_kw *l = *(const struct cli_kw **)a;
110 const struct cli_kw *r = *(const struct cli_kw **)b;
111
112 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
113}
114
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100115/* This will show the help message and list the commands supported at the
116 * current level that match all of the first words of <args> if args is not
117 * NULL, or all args if none matches or if args is null.
118 */
119static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100120{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200121 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100122 struct cli_kw_list *kw_list;
123 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200124 struct buffer *tmp = get_trash_chunk();
125 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100126 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100127 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200128 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100129 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200130 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100131
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100132 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100133
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200134 if (args && *args && strcmp(*args, "help") == 0) {
135 args++;
136 ishelp = 1;
137 }
138
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100139 /* first, let's measure the longest match */
140 list_for_each_entry(kw_list, &cli_keywords.list, list) {
141 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100142 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100143 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100144 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
145 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100146 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
147 continue;
148
149 /* OK this command is visible */
150 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
151 if (!kw->str_kw[idx])
152 break; // end of keyword
153 if (!args || !args[idx] || !*args[idx])
154 break; // end of command line
155 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
156 break;
157 if (idx + 1 > length)
158 length = idx + 1;
159 }
160 }
161 }
162
Willy Tarreaub7364582021-03-12 18:24:46 +0100163 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100164 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200165 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100166 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200167 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100168 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
169 else // partial match
170 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
171
Willy Tarreaub7364582021-03-12 18:24:46 +0100172 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
173 matches[idx].kw = NULL;
174 matches[idx].dist = INT_MAX;
175 }
176
177 /* In case of partial match we'll look for the best matching entries
178 * starting from position <length>
179 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100180 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100181 list_for_each_entry(kw_list, &cli_keywords.list, list) {
182 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100183 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100184 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100185 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
186 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
187 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100188 continue;
189
190 for (idx = 0; idx < length; idx++) {
191 if (!kw->str_kw[idx])
192 break; // end of keyword
193 if (!args || !args[idx] || !*args[idx])
194 break; // end of command line
195 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
196 break;
197 }
198
199 /* extra non-matching words are fuzzy-matched */
200 if (kw->usage && idx == length && args[idx] && *args[idx]) {
201 uint8_t word_sig[1024];
202 uint8_t list_sig[1024];
203 int dist = 0;
204 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100205 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100206
207 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100208 * on the remaining words. For this we're computing the signature
209 * of everything that remains and the cumulated length of the
210 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100211 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100212 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100213 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
214 update_word_fingerprint(word_sig, args[i]);
215 totlen += strlen(args[i]);
216 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100217
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100218 memset(list_sig, 0, sizeof(list_sig));
219 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
220 update_word_fingerprint(list_sig, kw->str_kw[i]);
221 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100222 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100223
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100224 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100225
226 /* insert this one at its place if relevant, in order to keep only
227 * the best matches.
228 */
229 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100230 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100231 matches[CLI_MAX_MATCHES-1] = swp;
232 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
233 if (matches[idx+1].dist >= matches[idx].dist)
234 break;
235 matches[idx+1] = matches[idx];
236 matches[idx] = swp;
237 }
238 }
239 }
240 }
241 }
242 }
243
Willy Tarreauec197e82021-03-15 10:35:04 +0100244 if (matches[0].kw) {
245 /* we have fuzzy matches, let's propose them */
246 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
247 kw = matches[idx].kw;
248 if (!kw)
249 break;
250
251 /* stop the dump if some words look very unlikely candidates */
252 if (matches[idx].dist > 5*matches[0].dist/2)
253 break;
254
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200255 if (help_entries < CLI_MAX_HELP_ENTRIES)
256 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100257 }
258 }
259
William Lallemand74c24fb2016-11-21 17:18:36 +0100260 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100261 /* no full dump if we've already found nice candidates */
262 if (matches[0].kw)
263 break;
264
Willy Tarreau91bc3592021-03-12 15:20:39 +0100265 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200266
Willy Tarreau91bc3592021-03-12 15:20:39 +0100267 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100268 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100269 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100270 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100271 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200272
William Lallemand2a171912022-02-02 11:43:20 +0100273 /* in master, if the CLI don't have the
274 * ACCESS_MCLI_DEBUG don't display commands that have
275 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100276 */
William Lallemand2a171912022-02-02 11:43:20 +0100277 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
278 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
279 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100280 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200281
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100282 for (idx = 0; idx < length; idx++) {
283 if (!kw->str_kw[idx])
284 break; // end of keyword
285 if (!args || !args[idx] || !*args[idx])
286 break; // end of command line
287 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
288 break;
289 }
290
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200291 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
292 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100293 }
294 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100295
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200296 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
297
298 for (idx = 0; idx < help_entries; idx++)
299 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
300
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100301 /* always show the prompt/help/quit commands */
302 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200303 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200304 " prompt : toggle interactive mode with prompt\n"
305 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100306
William Lallemand74c24fb2016-11-21 17:18:36 +0100307 chunk_init(&out, NULL, 0);
308 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200309 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200310
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100311 appctx->ctx.cli.severity = LOG_INFO;
312 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200313 appctx->st0 = CLI_ST_PRINT;
314
William Lallemand74c24fb2016-11-21 17:18:36 +0100315 return dynamic_usage_msg;
316}
317
318struct cli_kw* cli_find_kw(char **args)
319{
320 struct cli_kw_list *kw_list;
321 struct cli_kw *kw;/* current cli_kw */
322 char **tmp_args;
323 const char **tmp_str_kw;
324 int found = 0;
325
326 if (LIST_ISEMPTY(&cli_keywords.list))
327 return NULL;
328
329 list_for_each_entry(kw_list, &cli_keywords.list, list) {
330 kw = &kw_list->kw[0];
331 while (*kw->str_kw) {
332 tmp_args = args;
333 tmp_str_kw = kw->str_kw;
334 while (*tmp_str_kw) {
335 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
336 found = 1;
337 } else {
338 found = 0;
339 break;
340 }
341 tmp_args++;
342 tmp_str_kw++;
343 }
344 if (found)
345 return (kw);
346 kw++;
347 }
348 }
349 return NULL;
350}
351
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100352struct cli_kw* cli_find_kw_exact(char **args)
353{
354 struct cli_kw_list *kw_list;
355 int found = 0;
356 int i;
357 int j;
358
359 if (LIST_ISEMPTY(&cli_keywords.list))
360 return NULL;
361
362 list_for_each_entry(kw_list, &cli_keywords.list, list) {
363 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
364 found = 1;
365 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
366 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
367 break;
368 }
369 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
370 found = 0;
371 break;
372 }
373 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
374 found = 0;
375 break;
376 }
377 }
378 if (found)
379 return &kw_list->kw[i];
380 }
381 }
382 return NULL;
383}
384
William Lallemand74c24fb2016-11-21 17:18:36 +0100385void cli_register_kw(struct cli_kw_list *kw_list)
386{
Willy Tarreau2b718102021-04-21 07:32:39 +0200387 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100388}
389
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200390/* list all known keywords on stdout, one per line */
391void cli_list_keywords(void)
392{
393 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200394 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200395 int idx;
396
Willy Tarreau44651712022-03-30 12:02:35 +0200397 for (kwn = kwp = NULL;; kwp = kwn) {
398 list_for_each_entry(kw_list, &cli_keywords.list, list) {
399 /* note: we sort based on the usage message when available,
400 * otherwise we fall back to the first keyword.
401 */
402 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
403 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
404 kw->usage ? kw->usage : kw->str_kw[0],
405 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
406 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200407 }
Willy Tarreau44651712022-03-30 12:02:35 +0200408 }
409
410 if (kwn == kwp)
411 break;
412
413 for (idx = 0; kwn->str_kw[idx]; idx++) {
414 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200415 }
Willy Tarreau44651712022-03-30 12:02:35 +0200416 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
417 printf("[MASTER] ");
418 if (!(kwn->level & ACCESS_MASTER_ONLY))
419 printf("[WORKER] ");
420 if (kwn->level & ACCESS_EXPERT)
421 printf("[EXPERT] ");
422 if (kwn->level & ACCESS_EXPERIMENTAL)
423 printf("[EXPERIM] ");
424 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200425 }
426}
William Lallemand74c24fb2016-11-21 17:18:36 +0100427
428/* allocate a new stats frontend named <name>, and return it
429 * (or NULL in case of lack of memory).
430 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100431static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100432{
433 struct proxy *fe;
434
435 fe = calloc(1, sizeof(*fe));
436 if (!fe)
437 return NULL;
438
439 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100440 fe->next = proxies_list;
441 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100442 fe->last_change = now.tv_sec;
443 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200444 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100445 fe->maxconn = 10; /* default to 10 concurrent connections */
446 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
447 fe->conf.file = strdup(file);
448 fe->conf.line = line;
449 fe->accept = frontend_accept;
450 fe->default_target = &cli_applet.obj_type;
451
452 /* the stats frontend is the only one able to assign ID #0 */
453 fe->conf.id.key = fe->uuid = 0;
454 eb32_insert(&used_proxy_id, &fe->conf.id);
455 return fe;
456}
457
458/* This function parses a "stats" statement in the "global" section. It returns
459 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
460 * error message into the <err> buffer which will be preallocated. The trailing
461 * '\n' must not be written. The function must be called with <args> pointing to
462 * the first word after "stats".
463 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100464static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
465 const struct proxy *defpx, const char *file, int line,
466 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100467{
468 struct bind_conf *bind_conf;
469 struct listener *l;
470
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100471 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100472 int cur_arg;
473
474 if (*args[2] == 0) {
475 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
476 return -1;
477 }
478
Willy Tarreau4975d142021-03-13 11:00:33 +0100479 if (!global.cli_fe) {
480 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100481 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
482 return -1;
483 }
484 }
485
Willy Tarreau4975d142021-03-13 11:00:33 +0100486 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200487 if (!bind_conf) {
488 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
489 return -1;
490 }
William Lallemand07a62f72017-05-24 00:57:40 +0200491 bind_conf->level &= ~ACCESS_LVL_MASK;
492 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100493
Willy Tarreau4975d142021-03-13 11:00:33 +0100494 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100495 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
496 file, line, args[0], args[1], err && *err ? *err : "error");
497 return -1;
498 }
499
500 cur_arg = 3;
501 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100502 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100503 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100504 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100505
506 kw = bind_find_kw(args[cur_arg]);
507 if (kw) {
508 if (!kw->parse) {
509 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
510 args[0], args[1], args[cur_arg]);
511 return -1;
512 }
513
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100514 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
515
516 /* FIXME: this is ugly, we don't have a way to collect warnings,
517 * yet some important bind keywords may report warnings that we
518 * must display.
519 */
520 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
521 indent_msg(err, 2);
522 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
523 ha_free(err);
524 }
525
526 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100527 if (err && *err)
528 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
529 else
530 memprintf(err, "'%s %s' : error encountered while processing '%s'",
531 args[0], args[1], args[cur_arg]);
532 return -1;
533 }
534
535 cur_arg += 1 + kw->skip;
536 continue;
537 }
538
Willy Tarreau433b05f2021-03-12 10:14:07 +0100539 best = bind_find_best_kw(args[cur_arg]);
540 if (best)
541 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
542 args[0], args[1], args[cur_arg], best);
543 else
544 memprintf(err, "'%s %s' : unknown keyword '%s'.",
545 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100546 return -1;
547 }
548
549 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100550 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100551 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100552 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
553 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100554 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100555 }
556 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100557 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100558 unsigned timeout;
559 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
560
Willy Tarreau9faebe32019-06-07 19:00:37 +0200561 if (res == PARSE_TIME_OVER) {
562 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
563 args[2], args[0], args[1]);
564 return -1;
565 }
566 else if (res == PARSE_TIME_UNDER) {
567 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
568 args[2], args[0], args[1]);
569 return -1;
570 }
571 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100572 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
573 return -1;
574 }
575
576 if (!timeout) {
577 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
578 return -1;
579 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100580 if (!global.cli_fe) {
581 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100582 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
583 return -1;
584 }
585 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100586 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100588 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100589 int maxconn = atol(args[2]);
590
591 if (maxconn <= 0) {
592 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
593 return -1;
594 }
595
Willy Tarreau4975d142021-03-13 11:00:33 +0100596 if (!global.cli_fe) {
597 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100598 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
599 return -1;
600 }
601 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100602 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100603 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100604 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100605 int cur_arg = 2;
606 unsigned long set = 0;
607
Willy Tarreau4975d142021-03-13 11:00:33 +0100608 if (!global.cli_fe) {
609 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100610 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
611 return -1;
612 }
613 }
614
615 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100616 if (strcmp(args[cur_arg], "all") == 0) {
617 set = 0;
618 break;
619 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200620 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100621 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100622 return -1;
623 }
624 cur_arg++;
625 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100626 }
627 else {
628 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
629 return -1;
630 }
631 return 0;
632}
633
William Lallemand33d29e22019-04-01 11:30:06 +0200634/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200635 * This function exports the bound addresses of a <frontend> in the environment
636 * variable <varname>. Those addresses are separated by semicolons and prefixed
637 * with their type (abns@, unix@, sockpair@ etc)
638 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200639 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200640int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200641{
642 struct buffer *trash = get_trash_chunk();
643 struct bind_conf *bind_conf;
644
William Lallemand9a37fd02019-04-12 16:09:24 +0200645 if (frontend) {
646 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200647 struct listener *l;
648
649 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
650 char addr[46];
651 char port[6];
652
William Lallemand620072b2019-04-12 16:09:25 +0200653 /* separate listener by semicolons */
654 if (trash->data)
655 chunk_appendf(trash, ";");
656
Willy Tarreau37159062020-08-27 07:48:42 +0200657 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200658 const struct sockaddr_un *un;
659
Willy Tarreau37159062020-08-27 07:48:42 +0200660 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200661 if (un->sun_path[0] == '\0') {
662 chunk_appendf(trash, "abns@%s", un->sun_path+1);
663 } else {
664 chunk_appendf(trash, "unix@%s", un->sun_path);
665 }
Willy Tarreau37159062020-08-27 07:48:42 +0200666 } else if (l->rx.addr.ss_family == AF_INET) {
667 addr_to_str(&l->rx.addr, addr, sizeof(addr));
668 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200669 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200670 } else if (l->rx.addr.ss_family == AF_INET6) {
671 addr_to_str(&l->rx.addr, addr, sizeof(addr));
672 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200673 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200674 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
675 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200676 }
William Lallemand33d29e22019-04-01 11:30:06 +0200677 }
678 }
679 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200680 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200681 return -1;
682 }
683
684 return 0;
685}
686
William Lallemand9a37fd02019-04-12 16:09:24 +0200687int cli_socket_setenv()
688{
Willy Tarreau4975d142021-03-13 11:00:33 +0100689 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200690 return -1;
691 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
692 return -1;
693
694 return 0;
695}
696
William Lallemand33d29e22019-04-01 11:30:06 +0200697REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
698
Willy Tarreaude57a572016-11-23 17:01:39 +0100699/* Verifies that the CLI at least has a level at least as high as <level>
700 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
701 * failure, an error message is prepared and the appctx's state is adjusted
702 * to print it so that a return 1 is enough to abort any processing.
703 */
704int cli_has_level(struct appctx *appctx, int level)
705{
Willy Tarreaude57a572016-11-23 17:01:39 +0100706
William Lallemandf630d012018-12-13 09:05:44 +0100707 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100708 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100709 return 0;
710 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100711 return 1;
712}
713
William Lallemandb7ea1412018-12-13 09:05:47 +0100714/* same as cli_has_level but for the CLI proxy and without error message */
715int pcli_has_level(struct stream *s, int level)
716{
717 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
718 return 0;
719 }
720 return 1;
721}
722
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200723/* Returns severity_output for the current session if set, or default for the socket */
724static int cli_get_severity_output(struct appctx *appctx)
725{
726 if (appctx->cli_severity_output)
727 return appctx->cli_severity_output;
Christopher Faulet908628c2022-03-25 16:43:49 +0100728 return strm_li(__cs_strm(appctx->owner))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200729}
William Lallemand74c24fb2016-11-21 17:18:36 +0100730
Willy Tarreau41908562016-11-24 16:23:38 +0100731/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100732 * from the CLI's IO handler running in an appctx context. The function returns
733 * 1 if the request was understood, otherwise zero (in which case an error
734 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100735 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
736 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
737 * have its own I/O handler called again. Most of the time, parsers will only
738 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100739 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
740 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100741 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100743{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100744 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200745 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100746 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100747
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 appctx->st2 = 0;
Willy Tarreauf12f32a2022-05-02 14:57:03 +0200749
750 /* temporary for 2.6: let's make sure we clean the whole shared
751 * context.
752 */
753 if (sizeof(appctx->ctx) > sizeof(appctx->svc))
754 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
755 else
756 memset(&appctx->svc, 0, sizeof(appctx->svc));
William Lallemand74c24fb2016-11-21 17:18:36 +0100757
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200758 p = appctx->chunk->area;
759 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100760
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200761 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200762 * Get pointers on words.
763 * One extra slot is reserved to store a pointer on a null byte.
764 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100765 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200766 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100767
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200768 /* skip leading spaces/tabs */
769 p += strspn(p, " \t");
770 if (!*p)
771 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200772
773 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
774 /* payload pattern recognized here, this is not an arg anymore,
775 * the payload starts at the first byte that follows the zero
776 * after the pattern.
777 */
778 payload = p + strlen(PAYLOAD_PATTERN) + 1;
779 break;
780 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100781
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200782 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200783 while (1) {
784 p += strcspn(p, " \t\\");
785 /* escaped chars using backlashes (\) */
786 if (*p == '\\') {
787 if (!*++p)
788 break;
789 if (!*++p)
790 break;
791 } else {
792 break;
793 }
794 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200795 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100796
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200797 /* unescape backslashes (\) */
798 for (j = 0, k = 0; args[i][k]; k++) {
799 if (args[i][k] == '\\') {
800 if (args[i][k + 1] == '\\')
801 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100802 else
803 continue;
804 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200805 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100806 j++;
807 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200808 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100809
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200810 i++;
811 }
812 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200813 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100814 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200815 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100816
817 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100818 if (!kw ||
819 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100820 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
821 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100822 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100823 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100824 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100825 }
William Lallemand14721be2018-10-26 14:47:37 +0200826
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100827 /* don't handle expert mode commands if not in this mode. */
828 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
829 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200830 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100831 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200832
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100833 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
834 cli_err(appctx, "This command is restricted to experimental mode only.\n");
835 return 0;
836 }
837
Amaury Denoyellef4929922021-05-05 16:29:23 +0200838 if (kw->level == ACCESS_EXPERT)
839 mark_tainted(TAINTED_CLI_EXPERT_MODE);
840 else if (kw->level == ACCESS_EXPERIMENTAL)
841 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
842
Willy Tarreau41908562016-11-24 16:23:38 +0100843 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200844 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200845
846 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
847 goto fail;
848
849 /* kw->parse could set its own io_handler or io_release handler */
850 if (!appctx->io_handler)
851 goto fail;
852
853 appctx->st0 = CLI_ST_CALLBACK;
854 return 1;
855fail:
856 appctx->io_handler = NULL;
857 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100858 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100859}
860
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200861/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
862static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
863{
Willy Tarreau83061a82018-07-13 11:56:34 +0200864 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200865
866 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200867 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200868
869 tmp = get_trash_chunk();
870 chunk_reset(tmp);
871
872 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100873 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200874 chunk_printf(tmp, "[%d]: ", severity);
875 }
876 else {
877 switch (severity_output) {
878 case CLI_SEVERITY_NUMBER:
879 chunk_printf(tmp, "[%d]: ", severity);
880 break;
881 case CLI_SEVERITY_STRING:
882 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
883 break;
884 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100885 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200886 }
887 }
888 chunk_appendf(tmp, "%s", msg);
889
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200890 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200891}
892
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +0200893/* This I/O handler runs as an applet embedded in a conn-stream. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100894 * used to processes I/O from/to the stats unix socket. The system relies on a
895 * state machine handling requests and various responses. We read a request,
896 * then we process it and send the response, and we possibly display a prompt.
897 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100898 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100899 * or not.
900 */
901static void cli_io_handler(struct appctx *appctx)
902{
Christopher Faulet908628c2022-03-25 16:43:49 +0100903 struct conn_stream *cs = appctx->owner;
904 struct channel *req = cs_oc(cs);
905 struct channel *res = cs_ic(cs);
906 struct bind_conf *bind_conf = strm_li(__cs_strm(cs))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100907 int reql;
908 int len;
909
Christopher Faulet62e75742022-03-31 09:16:34 +0200910 if (unlikely(cs->state == CS_ST_DIS || cs->state == CS_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100911 goto out;
912
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800913 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200914 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100915 /* buf.size==0 means we failed to get a buffer and were
916 * already subscribed to a wait list to get a buffer.
917 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100918 goto out;
919 }
920
William Lallemand74c24fb2016-11-21 17:18:36 +0100921 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100922 if (appctx->st0 == CLI_ST_INIT) {
Willy Tarreau7bf20ca2022-05-03 17:02:03 +0200923 /* CLI/stats not initialized yet */
924 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200925 /* reset severity to default at init */
926 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100927 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100928 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100929 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100930 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100931 /* Let's close for real now. We just close the request
932 * side, the conditions below will complete if needed.
933 */
Christopher Fauletda098e62022-03-31 17:44:45 +0200934 cs_shutw(cs);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200935 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200936 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100937 break;
938 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100939 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200940 char *str;
941
942 /* use a trash chunk to store received data */
943 if (!appctx->chunk) {
944 appctx->chunk = alloc_trash_chunk();
945 if (!appctx->chunk) {
946 appctx->st0 = CLI_ST_END;
947 continue;
948 }
949 }
950
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200951 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200952
William Lallemand74c24fb2016-11-21 17:18:36 +0100953 /* ensure we have some output room left in the event we
954 * would want to return some info right after parsing.
955 */
Christopher Faulet908628c2022-03-25 16:43:49 +0100956 if (buffer_almost_full(cs_ib(cs))) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +0200957 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +0100958 break;
959 }
960
Willy Tarreau0011c252022-01-19 17:23:52 +0100961 /* payload doesn't take escapes nor does it end on semi-colons, so
962 * we use the regular getline. Normal mode however must stop on
963 * LFs and semi-colons that are not prefixed by a backslash. Note
964 * that we reserve one byte at the end to insert a trailing nul byte.
965 */
966
967 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Christopher Faulet908628c2022-03-25 16:43:49 +0100968 reql = co_getline(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100969 appctx->chunk->size - appctx->chunk->data - 1);
970 else
Christopher Faulet908628c2022-03-25 16:43:49 +0100971 reql = co_getdelim(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100972 appctx->chunk->size - appctx->chunk->data - 1,
973 "\n;", '\\');
974
William Lallemand74c24fb2016-11-21 17:18:36 +0100975 if (reql <= 0) { /* closed or EOL not found */
976 if (reql == 0)
977 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100978 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100979 continue;
980 }
981
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200982 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
983 /* seek for a possible unescaped semi-colon. If we find
984 * one, we replace it with an LF and skip only this part.
985 */
986 for (len = 0; len < reql; len++) {
987 if (str[len] == '\\') {
988 len++;
989 continue;
990 }
991 if (str[len] == ';') {
992 str[len] = '\n';
993 reql = len + 1;
994 break;
995 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100996 }
997 }
998
999 /* now it is time to check that we have a full line,
1000 * remove the trailing \n and possibly \r, then cut the
1001 * line.
1002 */
1003 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001004 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001005 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001006 continue;
1007 }
1008
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001009 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +01001010 len--;
1011
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001012 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001013 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001014
1015 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001016 appctx->chunk->area[appctx->chunk->data] = '\n';
1017 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1018 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001019 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001020
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001021 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001022
1023 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1024 /* empty line */
1025 if (!len) {
1026 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001027 appctx->chunk->data -= 2;
1028 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001029 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001030 chunk_reset(appctx->chunk);
1031 /* NB: cli_sock_parse_request() may have put
1032 * another CLI_ST_O_* into appctx->st0.
1033 */
1034
1035 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001036 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001037 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001038 else {
1039 /*
1040 * Look for the "payload start" pattern at the end of a line
1041 * Its location is not remembered here, this is just to switch
1042 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001043 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001044 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001045 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001046 appctx->chunk->data++; // keep the trailing \0 after '<<'
1047 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001048 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001049 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001050 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001051 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001052 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001053 }
1054
1055 /* re-adjust req buffer */
Christopher Faulet908628c2022-03-25 16:43:49 +01001056 co_skip(cs_oc(cs), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001057 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1058 }
1059 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001060 const char *msg;
1061 int sev;
1062
William Lallemand74c24fb2016-11-21 17:18:36 +01001063 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001064 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001065 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001066 case CLI_ST_PRINT: /* print const message in msg */
1067 case CLI_ST_PRINT_ERR: /* print const error in msg */
1068 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1069 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
1070 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1071 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
1072 LOG_ERR : appctx->ctx.cli.severity;
1073 msg = appctx->ctx.cli.msg;
1074 }
1075 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1076 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
1077 LOG_ERR : appctx->ctx.cli.severity;
1078 msg = appctx->ctx.cli.err;
1079 if (!msg) {
1080 sev = LOG_ERR;
1081 msg = "Out of memory.\n";
1082 }
1083 }
1084 else {
1085 sev = LOG_ERR;
1086 msg = "Internal error.\n";
1087 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001088
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1090 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1091 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001092 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001093 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001094 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001095 }
1096 else
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001097 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001099
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001100 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001101 if (appctx->io_handler)
1102 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001103 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001104 if (appctx->io_release) {
1105 appctx->io_release(appctx);
1106 appctx->io_release = NULL;
1107 }
1108 }
1109 break;
1110 default: /* abnormal state */
Christopher Faulet6cd56d52022-03-30 10:47:32 +02001111 cs->endp->flags |= CS_EP_ERROR;
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 break;
1113 }
1114
1115 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001116 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001117 const char *prompt = "";
1118
1119 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1120 /*
1121 * when entering a payload with interactive mode, change the prompt
1122 * to emphasize that more data can still be sent
1123 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001124 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001125 prompt = "+ ";
1126 else
1127 prompt = "\n> ";
1128 }
1129 else {
William Lallemandad032882019-07-01 10:56:15 +02001130 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001131 prompt = "\n";
1132 }
1133
Christopher Faulet908628c2022-03-25 16:43:49 +01001134 if (ci_putstr(cs_ic(cs), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001135 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001136 else
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001137 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001138 }
1139
1140 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001141 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001142 break;
1143
1144 /* Now we close the output if one of the writers did so,
1145 * or if we're not in interactive mode and the request
1146 * buffer is empty. This still allows pipelined requests
1147 * to be sent in non-interactive mode.
1148 */
William Lallemand3de09d52018-12-11 16:10:56 +01001149 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1150 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001151 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 continue;
1153 }
1154
1155 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001156 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001157 /* reactivate the \n at the end of the response for the next command */
1158 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001159
1160 /* this forces us to yield between pipelined commands and
1161 * avoid extremely long latencies (e.g. "del map" etc). In
1162 * addition this increases the likelihood that the stream
1163 * refills the buffer with new bytes in non-interactive
1164 * mode, avoiding to close on apparently empty commands.
1165 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001166 if (co_data(cs_oc(cs))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001167 appctx_wakeup(appctx);
1168 goto out;
1169 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001170 }
1171 }
1172
Christopher Faulet62e75742022-03-31 09:16:34 +02001173 if ((res->flags & CF_SHUTR) && (cs->state == CS_ST_EST)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001174 DPRINTF(stderr, "%s@%d: cs to buf closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001175 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001176 /* Other side has closed, let's abort if we have no more processing to do
1177 * and nothing more to consume. This is comparable to a broken pipe, so
1178 * we forward the close to the request side so that it flows upstream to
1179 * the client.
1180 */
Christopher Fauletda098e62022-03-31 17:44:45 +02001181 cs_shutw(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001182 }
1183
Christopher Faulet62e75742022-03-31 09:16:34 +02001184 if ((req->flags & CF_SHUTW) && (cs->state == CS_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001185 DPRINTF(stderr, "%s@%d: buf to cs closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001186 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001187 /* We have no more processing to do, and nothing more to send, and
1188 * the client side has closed. So we'll forward this state downstream
1189 * on the response buffer.
1190 */
Christopher Fauletda098e62022-03-31 17:44:45 +02001191 cs_shutr(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 res->flags |= CF_READ_NULL;
1193 }
1194
1195 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001196 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 +01001197 __FUNCTION__, __LINE__,
Christopher Faulet62e75742022-03-31 09:16:34 +02001198 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 +01001199}
1200
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001201/* This is called when the conn-stream is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001202 * external abort, we won't call the i/o handler anymore so we may need to
1203 * remove back references to the stream currently being dumped.
1204 */
1205static void cli_release_handler(struct appctx *appctx)
1206{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001207 free_trash_chunk(appctx->chunk);
1208 appctx->chunk = NULL;
1209
William Lallemand74c24fb2016-11-21 17:18:36 +01001210 if (appctx->io_release) {
1211 appctx->io_release(appctx);
1212 appctx->io_release = NULL;
1213 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001214 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001215 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001216 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001217}
1218
1219/* This function dumps all environmnent variables to the buffer. It returns 0
1220 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001221 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1222 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001223 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001224static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001225{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001226 struct show_env_ctx *ctx = appctx->svcctx;
Christopher Faulet908628c2022-03-25 16:43:49 +01001227 struct conn_stream *cs = appctx->owner;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001228 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001229
Christopher Faulet908628c2022-03-25 16:43:49 +01001230 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001231 return 1;
1232
1233 chunk_reset(&trash);
1234
1235 /* we have two inner loops here, one for the proxy, the other one for
1236 * the buffer.
1237 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001238 while (*var) {
1239 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001240
Christopher Faulet908628c2022-03-25 16:43:49 +01001241 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001242 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001243 return 0;
1244 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001245 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001246 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001247 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001248 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001249 }
1250
1251 /* dump complete */
1252 return 1;
1253}
1254
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001255/* This function dumps all file descriptors states (or the requested one) to
1256 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001257 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1258 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1259 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001260 */
1261static int cli_io_handler_show_fd(struct appctx *appctx)
1262{
Christopher Faulet908628c2022-03-25 16:43:49 +01001263 struct conn_stream *cs = appctx->owner;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001264 struct show_fd_ctx *fdctx = appctx->svcctx;
1265 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001266 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001267
Christopher Faulet908628c2022-03-25 16:43:49 +01001268 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001269 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001270
1271 chunk_reset(&trash);
1272
Willy Tarreauca1b1572018-12-18 15:45:11 +01001273 /* isolate the threads once per round. We're limited to a buffer worth
1274 * of output anyway, it cannot last very long.
1275 */
1276 thread_isolate();
1277
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001278 /* we have two inner loops here, one for the proxy, the other one for
1279 * the buffer.
1280 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001281 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001282 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001283 const struct listener *li = NULL;
1284 const struct server *sv = NULL;
1285 const struct proxy *px = NULL;
1286 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001287 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001288 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001289 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001290 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001291 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001292 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001293 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001294
1295 fdt = fdtab[fd];
1296
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001297 /* When DEBUG_FD is set, we also report closed FDs that have a
1298 * non-null event count to detect stuck ones.
1299 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001300 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001301#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001302 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001303#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001304 goto skip; // closed
1305 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001306 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001307 conn = (const struct connection *)fdt.owner;
1308 conn_flags = conn->flags;
1309 mux = conn->mux;
1310 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001311 xprt = conn->xprt;
1312 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001313 li = objt_listener(conn->target);
1314 sv = objt_server(conn->target);
1315 px = objt_proxy(conn->target);
1316 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001317 if (atleast2(fdt.thread_mask))
1318 suspicious = 1;
1319 if (conn->handle.fd != fd)
1320 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001321 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001322 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001323 li = fdt.owner;
1324
Willy Tarreaudacfde42021-01-21 09:07:29 +01001325 if (!fdt.thread_mask)
1326 suspicious = 1;
1327
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001328 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001329 " %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 +02001330 fd,
1331 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001332 (fdt.state & FD_CLONED) ? 'C' : 'c',
1333 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001334 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1335 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1336 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1337 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1338 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001339 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1340 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1341 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1342 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1343 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1344 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001345 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001346 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001347 fdt.iocb);
1348 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001349
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001350 if (!fdt.owner) {
1351 chunk_appendf(&trash, ")");
1352 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001353 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001354 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001355
1356 if (conn->handle.fd != fd) {
1357 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1358 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001359 } else {
1360 struct sockaddr_storage sa;
1361 socklen_t salen;
1362
1363 salen = sizeof(sa);
1364 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1365 if (sa.ss_family == AF_INET)
1366 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1367 else if (sa.ss_family == AF_INET6)
1368 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1369 else if (sa.ss_family == AF_UNIX)
1370 chunk_appendf(&trash, " fam=unix");
1371 }
1372
1373 salen = sizeof(sa);
1374 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1375 if (sa.ss_family == AF_INET)
1376 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1377 else if (sa.ss_family == AF_INET6)
1378 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1379 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001380 }
1381
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001382 if (px)
1383 chunk_appendf(&trash, " px=%s", px->id);
1384 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001385 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001386 else if (li)
1387 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001388
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001389 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001390 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001391 if (!ctx)
1392 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001393 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001394 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001395 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001396 else
1397 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001398
1399 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001400 if (xprt) {
1401 if (xprt_ctx || xprt->show_fd)
1402 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1403 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001404 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001405 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001406 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001407 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001408 struct sockaddr_storage sa;
1409 socklen_t salen;
1410
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001411 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001412 listener_state_str(li),
1413 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001414
1415 salen = sizeof(sa);
1416 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1417 if (sa.ss_family == AF_INET)
1418 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1419 else if (sa.ss_family == AF_INET6)
1420 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1421 else if (sa.ss_family == AF_UNIX)
1422 chunk_appendf(&trash, " fam=unix");
1423 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001424 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001425 else
1426 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001427
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001428#ifdef DEBUG_FD
1429 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001430 if (fdtab[fd].event_count >= 1000000)
1431 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001432#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001433 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001434
Christopher Faulet908628c2022-03-25 16:43:49 +01001435 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001436 cs_rx_room_blk(cs);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001437 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001438 ret = 0;
1439 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001440 }
1441 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001442 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001443 break;
1444
1445 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001446 }
1447
Willy Tarreauca1b1572018-12-18 15:45:11 +01001448 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001449 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001450
1451 thread_release();
1452 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001453}
1454
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001455/* This function dumps some activity counters used by developers and support to
1456 * rule out some hypothesis during bug reports. It returns 0 if the output
1457 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1458 * everything at once in the buffer and is not designed to do it in multiple
1459 * passes.
1460 */
1461static int cli_io_handler_show_activity(struct appctx *appctx)
1462{
Christopher Faulet908628c2022-03-25 16:43:49 +01001463 struct conn_stream *cs = appctx->owner;
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001464 int thr;
1465
Christopher Faulet908628c2022-03-25 16:43:49 +01001466 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001467 return 1;
1468
1469 chunk_reset(&trash);
1470
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001471#undef SHOW_TOT
1472#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001473 do { \
1474 unsigned int _v[MAX_THREADS]; \
1475 unsigned int _tot; \
1476 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001477 _tot = t = 0; \
1478 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001479 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001480 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001481 if (_nbt == 1) { \
1482 chunk_appendf(&trash, " %u\n", _tot); \
1483 break; \
1484 } \
1485 chunk_appendf(&trash, " %u [", _tot); \
1486 for (t = 0; t < _nbt; t++) \
1487 chunk_appendf(&trash, " %u", _v[t]); \
1488 chunk_appendf(&trash, " ]\n"); \
1489 } while (0)
1490
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001491#undef SHOW_AVG
1492#define SHOW_AVG(t, x) \
1493 do { \
1494 unsigned int _v[MAX_THREADS]; \
1495 unsigned int _tot; \
1496 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001497 _tot = t = 0; \
1498 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001499 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001500 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001501 if (_nbt == 1) { \
1502 chunk_appendf(&trash, " %u\n", _tot); \
1503 break; \
1504 } \
1505 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1506 for (t = 0; t < _nbt; t++) \
1507 chunk_appendf(&trash, " %u", _v[t]); \
1508 chunk_appendf(&trash, " ]\n"); \
1509 } while (0)
1510
Willy Tarreaua0211b82019-05-28 15:09:08 +02001511 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1512 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001513 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1514 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1515 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1516 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001517 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001518 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1519 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001520 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001521 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001522 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001523 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001524 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001525 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001526 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1527 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001528 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1529 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1530 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1531 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1532 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1533 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1534 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001535#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001536 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 +02001537 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001538#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001539
Willy Tarreaud6a78502019-05-27 07:03:38 +02001540#if defined(DEBUG_DEV)
1541 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001542 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1543 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1544 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001545#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001546
Christopher Faulet908628c2022-03-25 16:43:49 +01001547 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001548 chunk_reset(&trash);
1549 chunk_printf(&trash, "[output too large, cannot dump]\n");
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001550 cs_rx_room_blk(cs);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001551 }
1552
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001553#undef SHOW_AVG
1554#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001555 /* dump complete */
1556 return 1;
1557}
1558
William Lallemandeceddf72016-12-15 18:06:44 +01001559/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001560 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001561 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1562 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001563 */
1564static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1565{
Willy Tarreaub128f492022-05-05 19:11:05 +02001566 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1567 struct bind_conf *bind_conf = ctx->bind_conf;
Christopher Faulet908628c2022-03-25 16:43:49 +01001568 struct conn_stream *cs = appctx->owner;
William Lallemandeceddf72016-12-15 18:06:44 +01001569
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001570 if (!global.cli_fe)
1571 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001572
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001573 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001574
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001575 if (!bind_conf) {
1576 /* first call */
1577 if (ci_putstr(cs_ic(cs), "# socket lvl processes\n") == -1)
1578 goto full;
1579 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1580 }
William Lallemandeceddf72016-12-15 18:06:44 +01001581
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001582 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001583 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001584
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001585 if (!l)
1586 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001587
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001588 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1589 char addr[46];
1590 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001591
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001592 if (l->rx.addr.ss_family == AF_UNIX) {
1593 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001594
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001595 un = (struct sockaddr_un *)&l->rx.addr;
1596 if (un->sun_path[0] == '\0') {
1597 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1598 } else {
1599 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1600 }
1601 } else if (l->rx.addr.ss_family == AF_INET) {
1602 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1603 port_to_str(&l->rx.addr, port, sizeof(port));
1604 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1605 } else if (l->rx.addr.ss_family == AF_INET6) {
1606 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1607 port_to_str(&l->rx.addr, port, sizeof(port));
1608 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1609 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1610 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1611 } else
1612 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001613
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001614 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1615 chunk_appendf(&trash, "admin ");
1616 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1617 chunk_appendf(&trash, "operator ");
1618 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1619 chunk_appendf(&trash, "user ");
1620 else
1621 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001622
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001623 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001624
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001625 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001626 ctx->bind_conf = bind_conf;
1627 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001628 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001629 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001630 }
William Lallemandeceddf72016-12-15 18:06:44 +01001631 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001632 done:
1633 return 1;
1634 full:
1635 cs_rx_room_blk(cs);
1636 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001637}
1638
1639
Willy Tarreau0a739292016-11-22 20:21:23 +01001640/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001641 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1642 * be dumped as well as a flag if a single variable is requested, otherwise puts
1643 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001644 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001645static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001646{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001647 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001648 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001649 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001650
1651 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1652 return 1;
1653
Willy Tarreauf6710f82016-12-16 17:45:44 +01001654 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001655
1656 if (*args[2]) {
1657 int len = strlen(args[2]);
1658
Willy Tarreauf6710f82016-12-16 17:45:44 +01001659 for (; *var; var++) {
1660 if (strncmp(*var, args[2], len) == 0 &&
1661 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001662 break;
1663 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001664 if (!*var)
1665 return cli_err(appctx, "Variable not found\n");
1666
Willy Tarreau307dbb32022-05-05 17:45:52 +02001667 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001668 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001669 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001670 return 0;
1671}
1672
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001673/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001674 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1675 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001676 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001677static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001678{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001679 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1680
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001681 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1682 return 1;
1683
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001684 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001685 ctx->fd = atoi(args[2]);
1686 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001687 }
1688 return 0;
1689}
1690
Willy Tarreau599852e2016-11-22 20:33:32 +01001691/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001692static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001693{
Christopher Faulet908628c2022-03-25 16:43:49 +01001694 struct stream *s = __cs_strm(appctx->owner);
Willy Tarreau599852e2016-11-22 20:33:32 +01001695
1696 if (strcmp(args[2], "cli") == 0) {
1697 unsigned timeout;
1698 const char *res;
1699
Willy Tarreau9d008692019-08-09 11:21:01 +02001700 if (!*args[3])
1701 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001702
1703 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001704 if (res || timeout < 1)
1705 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001706
1707 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1708 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1709 return 1;
1710 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001711
1712 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001713}
1714
Willy Tarreau2af99412016-11-23 11:10:59 +01001715/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001716static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001717{
1718 int v;
1719
1720 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1721 return 1;
1722
Willy Tarreau9d008692019-08-09 11:21:01 +02001723 if (!*args[3])
1724 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001725
1726 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001727 if (v > global.hardmaxconn)
1728 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001729
1730 /* check for unlimited values */
1731 if (v <= 0)
1732 v = global.hardmaxconn;
1733
1734 global.maxconn = v;
1735
1736 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001737 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001738
1739 return 1;
1740}
1741
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001742static int set_severity_output(int *target, char *argument)
1743{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001744 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001745 *target = CLI_SEVERITY_NONE;
1746 return 1;
1747 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001748 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001749 *target = CLI_SEVERITY_NUMBER;
1750 return 1;
1751 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001752 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001753 *target = CLI_SEVERITY_STRING;
1754 return 1;
1755 }
1756 return 0;
1757}
1758
1759/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001760static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001761{
1762 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1763 return 0;
1764
Willy Tarreau9d008692019-08-09 11:21:01 +02001765 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001766}
William Lallemandeceddf72016-12-15 18:06:44 +01001767
William Lallemand67a234f2018-12-13 09:05:45 +01001768
1769/* show the level of the current CLI session */
1770static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1771{
William Lallemand67a234f2018-12-13 09:05:45 +01001772 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001773 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001774 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001775 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001776 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001777 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001778 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001779 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001780}
1781
1782/* parse and set the CLI level dynamically */
1783static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1784{
William Lallemandad032882019-07-01 10:56:15 +02001785 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001786 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001787 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1788
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001789 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001790 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1791 return 1;
1792 }
1793 appctx->cli_level &= ~ACCESS_LVL_MASK;
1794 appctx->cli_level |= ACCESS_LVL_OPER;
1795
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001796 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001797 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1798 return 1;
1799 }
1800 appctx->cli_level &= ~ACCESS_LVL_MASK;
1801 appctx->cli_level |= ACCESS_LVL_USER;
1802 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001803 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001804 return 1;
1805}
1806
1807
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001808/* parse and set the CLI expert/experimental-mode dynamically */
1809static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001810{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001811 int level;
1812 char *level_str;
1813 char *output = NULL;
1814
William Lallemand7267f782022-02-01 16:08:50 +01001815 /* this will ask the applet to not output a \n after the command */
1816 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1817 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1818
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001819 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1820 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001821
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001822 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001823 level = ACCESS_EXPERT;
1824 level_str = "expert-mode";
1825 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001826 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001827 level = ACCESS_EXPERIMENTAL;
1828 level_str = "experimental-mode";
1829 }
William Lallemand2a171912022-02-02 11:43:20 +01001830 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1831 level = ACCESS_MCLI_DEBUG;
1832 level_str = "mcli-debug-mode";
1833 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001834 else {
1835 return 1;
1836 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001837
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001838 if (!*args[1]) {
1839 memprintf(&output, "%s is %s\n", level_str,
1840 (appctx->cli_level & level) ? "ON" : "OFF");
1841 return cli_dynmsg(appctx, LOG_INFO, output);
1842 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001843
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001844 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001845 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001846 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001847 return 1;
1848}
1849
William Lallemand740629e2021-12-14 15:22:29 +01001850/* shows HAProxy version */
1851static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1852{
1853 char *msg = NULL;
1854
1855 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1856}
1857
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001858int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001859{
1860 return 0;
1861}
1862
Willy Tarreau45c742b2016-11-24 14:51:17 +01001863/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001864static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001865{
1866 int v;
1867 int *res;
1868 int mul = 1;
1869
1870 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1871 return 1;
1872
1873 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1874 res = &global.cps_lim;
1875 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1876 res = &global.sps_lim;
1877#ifdef USE_OPENSSL
1878 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1879 res = &global.ssl_lim;
1880#endif
1881 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1882 res = &global.comp_rate_lim;
1883 mul = 1024;
1884 }
1885 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001886 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001887 "'set rate-limit' only supports :\n"
1888 " - 'connections global' to set the per-process maximum connection rate\n"
1889 " - 'sessions global' to set the per-process maximum session rate\n"
1890#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001891 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001892#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001893 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001894 }
1895
Willy Tarreau9d008692019-08-09 11:21:01 +02001896 if (!*args[4])
1897 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001898
1899 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001900 if (v < 0)
1901 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001902
1903 *res = v * mul;
1904
1905 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001906 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001907
1908 return 1;
1909}
1910
William Lallemandf6975e92017-05-26 17:42:10 +02001911/* parse the "expose-fd" argument on the bind lines */
1912static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1913{
1914 if (!*args[cur_arg + 1]) {
1915 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1916 return ERR_ALERT | ERR_FATAL;
1917 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001918 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001919 conf->level |= ACCESS_FD_LISTENERS;
1920 } else {
1921 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1922 args[cur_arg], args[cur_arg+1]);
1923 return ERR_ALERT | ERR_FATAL;
1924 }
1925
1926 return 0;
1927}
1928
William Lallemand74c24fb2016-11-21 17:18:36 +01001929/* parse the "level" argument on the bind lines */
1930static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1931{
1932 if (!*args[cur_arg + 1]) {
1933 memprintf(err, "'%s' : missing level", args[cur_arg]);
1934 return ERR_ALERT | ERR_FATAL;
1935 }
1936
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001937 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001938 conf->level &= ~ACCESS_LVL_MASK;
1939 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001940 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001941 conf->level &= ~ACCESS_LVL_MASK;
1942 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001943 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001944 conf->level &= ~ACCESS_LVL_MASK;
1945 conf->level |= ACCESS_LVL_ADMIN;
1946 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001947 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1948 args[cur_arg], args[cur_arg+1]);
1949 return ERR_ALERT | ERR_FATAL;
1950 }
1951
1952 return 0;
1953}
1954
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001955static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1956{
1957 if (!*args[cur_arg + 1]) {
1958 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1959 return ERR_ALERT | ERR_FATAL;
1960 }
1961
1962 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1963 return 0;
1964 else {
1965 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1966 args[cur_arg], args[cur_arg+1]);
1967 return ERR_ALERT | ERR_FATAL;
1968 }
1969}
1970
Olivier Houchardf886e342017-04-05 22:24:59 +02001971/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001972static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001973{
1974 char *cmsgbuf = NULL;
1975 unsigned char *tmpbuf = NULL;
1976 struct cmsghdr *cmsg;
Christopher Faulet908628c2022-03-25 16:43:49 +01001977 struct conn_stream *cs = appctx->owner;
1978 struct stream *s = __cs_strm(cs);
1979 struct connection *remote = cs_conn(cs_opposite(cs));
Olivier Houchardf886e342017-04-05 22:24:59 +02001980 struct msghdr msghdr;
1981 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001982 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001983 const char *ns_name, *if_name;
1984 unsigned char ns_nlen, if_nlen;
1985 int nb_queued;
1986 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001987 int *tmpfd;
1988 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001989 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001990 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001991 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001992 int ret;
1993
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001994 if (!remote) {
1995 ha_warning("Only works on real connections\n");
1996 goto out;
1997 }
1998
1999 fd = remote->handle.fd;
2000
Olivier Houchardf886e342017-04-05 22:24:59 +02002001 /* Temporary set the FD in blocking mode, that will make our life easier */
2002 old_fcntl = fcntl(fd, F_GETFL);
2003 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002004 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002005 goto out;
2006 }
2007 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2008 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002009 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002010 goto out;
2011 }
2012 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002013 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002014 goto out;
2015 }
Olivier Houchard54740872017-04-06 14:45:14 +02002016 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002017 iov.iov_base = &tot_fd_nb;
2018 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002019 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002020 goto out;
2021 memset(&msghdr, 0, sizeof(msghdr));
2022 /*
2023 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002024 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002025 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002026 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002027 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002028
Olivier Houchardf886e342017-04-05 22:24:59 +02002029 if (tot_fd_nb == 0)
2030 goto out;
2031
2032 /* First send the total number of file descriptors, so that the
2033 * receiving end knows what to expect.
2034 */
2035 msghdr.msg_iov = &iov;
2036 msghdr.msg_iovlen = 1;
2037 ret = sendmsg(fd, &msghdr, 0);
2038 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002039 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002040 goto out;
2041 }
2042
2043 /* Now send the fds */
2044 msghdr.msg_control = cmsgbuf;
2045 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2046 cmsg = CMSG_FIRSTHDR(&msghdr);
2047 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2048 cmsg->cmsg_level = SOL_SOCKET;
2049 cmsg->cmsg_type = SCM_RIGHTS;
2050 tmpfd = (int *)CMSG_DATA(cmsg);
2051
Olivier Houchardf886e342017-04-05 22:24:59 +02002052 /* For each socket, e message is sent, containing the following :
2053 * Size of the namespace name (or 0 if none), as an unsigned char.
2054 * The namespace name, if any
2055 * Size of the interface name (or 0 if none), as an unsigned char
2056 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002057 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002058 */
2059 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002060 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002061 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002062 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002063 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002064 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002065 goto out;
2066 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002067
2068 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002069 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002070 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002071 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002072 continue;
2073
2074 ns_name = if_name = "";
2075 ns_nlen = if_nlen = 0;
2076
2077 /* for now we can only retrieve namespaces and interfaces from
2078 * pure listeners.
2079 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002080 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002081 const struct listener *l = fdtab[cur_fd].owner;
2082
Willy Tarreau818a92e2020-09-03 07:50:19 +02002083 if (l->rx.settings->interface) {
2084 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002085 if_nlen = strlen(if_name);
2086 }
2087
2088#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002089 if (l->rx.settings->netns) {
2090 ns_name = l->rx.settings->netns->node.key;
2091 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002092 }
2093#endif
2094 }
2095
2096 /* put the FD into the CMSG_DATA */
2097 tmpfd[nb_queued++] = cur_fd;
2098
2099 /* first block is <ns_name_len> <ns_name> */
2100 tmpbuf[curoff++] = ns_nlen;
2101 if (ns_nlen)
2102 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2103 curoff += ns_nlen;
2104
2105 /* second block is <if_name_len> <if_name> */
2106 tmpbuf[curoff++] = if_nlen;
2107 if (if_nlen)
2108 memcpy(tmpbuf + curoff, if_name, if_nlen);
2109 curoff += if_nlen;
2110
2111 /* we used to send the listener options here before 2.3 */
2112 memset(tmpbuf + curoff, 0, sizeof(int));
2113 curoff += sizeof(int);
2114
2115 /* there's a limit to how many FDs may be sent at once */
2116 if (nb_queued == MAX_SEND_FD) {
2117 iov.iov_len = curoff;
2118 if (sendmsg(fd, &msghdr, 0) != curoff) {
2119 ha_warning("Failed to transfer sockets\n");
2120 return -1;
2121 }
2122
2123 /* Wait for an ack */
2124 do {
2125 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2126 } while (ret == -1 && errno == EINTR);
2127
2128 if (ret <= 0) {
2129 ha_warning("Unexpected error while transferring sockets\n");
2130 return -1;
2131 }
2132 curoff = 0;
2133 nb_queued = 0;
2134 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002135 }
2136
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002137 /* flush pending stuff */
2138 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002139 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002140 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2141 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002142 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002143 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002144 goto out;
2145 }
2146 }
2147
2148out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002149 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002150 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002151 goto out;
2152 }
2153 appctx->st0 = CLI_ST_END;
2154 free(cmsgbuf);
2155 free(tmpbuf);
2156 return 1;
2157}
2158
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002159static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2160{
2161 if (*args[0] == 'h')
2162 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002163 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002164 else if (*args[0] == 'p')
2165 /* prompt */
2166 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2167 else if (*args[0] == 'q')
2168 /* quit */
2169 appctx->st0 = CLI_ST_END;
2170
2171 return 1;
2172}
Olivier Houchardf886e342017-04-05 22:24:59 +02002173
William Lallemand2f4ce202018-10-26 14:47:47 +02002174void pcli_write_prompt(struct stream *s)
2175{
2176 struct buffer *msg = get_trash_chunk();
Christopher Faulet908628c2022-03-25 16:43:49 +01002177 struct channel *oc = cs_oc(s->csf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002178
William Lallemanddc12c2e2018-12-13 09:05:46 +01002179 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002180 return;
2181
William Lallemanddc12c2e2018-12-13 09:05:46 +01002182 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002183 chunk_appendf(msg, "+ ");
2184 } else {
2185 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002186 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002187 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002188 else
William Lallemanddae12c72022-02-02 14:13:54 +01002189 chunk_appendf(msg, "%d", s->pcli_next_pid);
2190
2191 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2192 chunk_appendf(msg, "(");
2193
2194 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2195 chunk_appendf(msg, "x");
2196
2197 if (s->pcli_flags & ACCESS_EXPERT)
2198 chunk_appendf(msg, "e");
2199
2200 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2201 chunk_appendf(msg, "d");
2202
2203 chunk_appendf(msg, ")");
2204 }
2205
2206 chunk_appendf(msg, "> ");
2207
2208
William Lallemandebf61802018-12-11 16:10:57 +01002209 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002210 co_inject(oc, msg->area, msg->data);
2211}
2212
William Lallemand291810d2018-10-26 14:47:38 +02002213
William Lallemandcf62f7e2018-10-26 14:47:40 +02002214/* The pcli_* functions are used for the CLI proxy in the master */
2215
William Lallemanddeeaa592018-10-26 14:47:48 +02002216void pcli_reply_and_close(struct stream *s, const char *msg)
2217{
2218 struct buffer *buf = get_trash_chunk();
2219
2220 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002221 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002222}
2223
William Lallemand291810d2018-10-26 14:47:38 +02002224static enum obj_type *pcli_pid_to_server(int proc_pid)
2225{
2226 struct mworker_proc *child;
2227
William Lallemand99e0bb92020-11-05 10:28:53 +01002228 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002229 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002230 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002231
William Lallemand291810d2018-10-26 14:47:38 +02002232 list_for_each_entry(child, &proc_list, list) {
2233 if (child->pid == proc_pid){
2234 return &child->srv->obj_type;
2235 }
2236 }
2237 return NULL;
2238}
2239
2240/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2241 * Return:
2242 * 0: master
2243 * > 0: pid of a worker
2244 * < 0: didn't find a worker
2245 */
2246static int pcli_prefix_to_pid(const char *prefix)
2247{
2248 int proc_pid;
2249 struct mworker_proc *child;
2250 char *errtol = NULL;
2251
2252 if (*prefix != '@') /* not a prefix, should not happen */
2253 return -1;
2254
2255 prefix++;
2256 if (!*prefix) /* sent @ alone, return the master */
2257 return 0;
2258
2259 if (strcmp("master", prefix) == 0) {
2260 return 0;
2261 } else if (*prefix == '!') {
2262 prefix++;
2263 if (!*prefix)
2264 return -1;
2265
2266 proc_pid = strtol(prefix, &errtol, 10);
2267 if (*errtol != '\0')
2268 return -1;
2269 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002270 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002271 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002272 if (child->pid == proc_pid){
2273 return child->pid;
2274 }
2275 }
2276 } else {
2277 struct mworker_proc *chosen = NULL;
2278 /* this is a relative pid */
2279
2280 proc_pid = strtol(prefix, &errtol, 10);
2281 if (*errtol != '\0')
2282 return -1;
2283
2284 if (proc_pid == 0) /* return the master */
2285 return 0;
2286
2287 /* chose the right process, the current one is the one with the
2288 least number of reloads */
2289 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002290 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002291 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002292 if (child->reloads == 0)
2293 return child->pid;
2294 else if (chosen == NULL || child->reloads < chosen->reloads)
2295 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002296 }
2297 if (chosen)
2298 return chosen->pid;
2299 }
2300 return -1;
2301}
2302
William Lallemandbddd33a2018-12-11 16:10:53 +01002303/* Return::
2304 * >= 0 : number of words to escape
2305 * = -1 : error
2306 */
2307
2308int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2309{
2310 if (argl < 1)
2311 return 0;
2312
2313 /* there is a prefix */
2314 if (args[0][0] == '@') {
2315 int target_pid = pcli_prefix_to_pid(args[0]);
2316
2317 if (target_pid == -1) {
2318 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2319 return -1;
2320 }
2321
2322 /* if the prefix is alone, define a default target */
2323 if (argl == 1)
2324 s->pcli_next_pid = target_pid;
2325 else
2326 *next_pid = target_pid;
2327 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002328 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002329 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002330 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002331
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002332 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002333 channel_shutr_now(&s->req);
2334 channel_shutw_now(&s->res);
2335 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002336 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002337 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2338 memprintf(errmsg, "Permission denied!\n");
2339 return -1;
2340 }
2341 s->pcli_flags &= ~ACCESS_LVL_MASK;
2342 s->pcli_flags |= ACCESS_LVL_OPER;
2343 return argl;
2344
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002345 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002346 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2347 memprintf(errmsg, "Permission denied!\n");
2348 return -1;
2349 }
2350 s->pcli_flags &= ~ACCESS_LVL_MASK;
2351 s->pcli_flags |= ACCESS_LVL_USER;
2352 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002353
2354 } else if (strcmp(args[0], "expert-mode") == 0) {
2355 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2356 memprintf(errmsg, "Permission denied!\n");
2357 return -1;
2358 }
2359
2360 s->pcli_flags &= ~ACCESS_EXPERT;
2361 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2362 s->pcli_flags |= ACCESS_EXPERT;
2363 return argl;
2364
2365 } else if (strcmp(args[0], "experimental-mode") == 0) {
2366 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2367 memprintf(errmsg, "Permission denied!\n");
2368 return -1;
2369 }
2370 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2371 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2372 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2373 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002374 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2375 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2376 memprintf(errmsg, "Permission denied!\n");
2377 return -1;
2378 }
2379 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2380 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2381 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2382 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002383 }
2384
2385 return 0;
2386}
2387
2388/*
2389 * Parse the CLI request:
2390 * - It does basically the same as the cli_io_handler, but as a proxy
2391 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002392 *
2393 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002394 * - the number of characters to forward or
2395 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002396 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002397int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002398{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002399 char *str;
2400 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002401 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002402 int argl; /* number of args */
2403 char *p;
2404 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002405 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002406 int wtrim = 0; /* number of words to trim */
2407 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002408 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002409 int i = 0;
2410
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002411 /* we cannot deal with a wrapping buffer, so let's take care of this
2412 * first.
2413 */
2414 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2415 b_slow_realign(&req->buf, trash.area, co_data(req));
2416
2417 str = (char *)ci_head(req);
2418 end = (char *)ci_stop(req);
2419
William Lallemandbddd33a2018-12-11 16:10:53 +01002420 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002421
William Lallemanddc12c2e2018-12-13 09:05:46 +01002422 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002423
2424 /* Looks for the end of one command */
2425 while (p+reql < end) {
2426 /* handle escaping */
2427 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002428 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002429 continue;
2430 }
2431 if (p[reql] == ';' || p[reql] == '\n') {
2432 /* found the end of the command */
2433 p[reql] = '\n';
2434 reql++;
2435 break;
2436 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002437 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002438 }
William Lallemandebf61802018-12-11 16:10:57 +01002439 } else {
2440 while (p+reql < end) {
2441 if (p[reql] == '\n') {
2442 /* found the end of the line */
2443 reql++;
2444 break;
2445 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002446 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002447 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002449
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 /* set end to first byte after the end of the command */
2451 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002452
William Lallemandbddd33a2018-12-11 16:10:53 +01002453 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002454 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002455 return -1;
2456 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002457
William Lallemand3301f3e2018-12-13 09:05:48 +01002458 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2459 if (reql == 1) /* last line of the payload */
2460 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002461 return reql;
2462 }
2463
William Lallemandbddd33a2018-12-11 16:10:53 +01002464 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002465
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002467 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002468 /* skip leading spaces/tabs */
2469 p += strspn(p, " \t");
2470 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002471 break;
2472
William Lallemandbddd33a2018-12-11 16:10:53 +01002473 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002474 while (1) {
2475 p += strcspn(p, " \t\\");
2476 /* escaped chars using backlashes (\) */
2477 if (*p == '\\') {
2478 if (!*++p)
2479 break;
2480 if (!*++p)
2481 break;
2482 } else {
2483 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002484 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002485 }
William Lallemandfe249c32020-06-18 18:03:57 +02002486 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002487 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002488 }
2489
William Lallemandbddd33a2018-12-11 16:10:53 +01002490 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002491
Willy Tarreauf14c7572021-03-13 10:59:23 +01002492 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002493 args[i] = NULL;
2494
2495 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2496
2497 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002498 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002499 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002500 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002501 if (*p == '\0')
2502 *p = ' ';
2503 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002504 }
2505
William Lallemand3301f3e2018-12-13 09:05:48 +01002506 payload = strstr(str, PAYLOAD_PATTERN);
2507 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2508 /* if the payload pattern is at the end */
2509 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002510 }
2511
William Lallemandbddd33a2018-12-11 16:10:53 +01002512 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002513
William Lallemandbddd33a2018-12-11 16:10:53 +01002514 if (wtrim > 0) {
2515 trim = &args[wtrim][0];
2516 if (trim == NULL) /* if this was the last word in the table */
2517 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002518
William Lallemandbddd33a2018-12-11 16:10:53 +01002519 b_del(&req->buf, trim - str);
2520
William Lallemandb7ea1412018-12-13 09:05:47 +01002521 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002522 } else if (wtrim < 0) {
2523 /* parsing error */
2524 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002525 } else {
2526 /* the whole string */
2527 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002528 }
2529
William Lallemandb7ea1412018-12-13 09:05:47 +01002530 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002531
2532 /* the mcli-debug-mode is only sent to the applet of the master */
2533 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2534 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2535 ret += strlen("mcli-debug-mode on -") + 2;
2536 }
William Lallemand7267f782022-02-01 16:08:50 +01002537 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2538 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2539 ret += strlen("experimental-mode on -") + 2;
2540 }
2541 if (s->pcli_flags & ACCESS_EXPERT) {
2542 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2543 ret += strlen("expert-mode on -") + 2;
2544 }
2545
William Lallemandb7ea1412018-12-13 09:05:47 +01002546 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2547 goto end;
2548 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002549 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2550 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002551 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002552 ci_insert_line2(req, 0, "user -", strlen("user -"));
2553 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002554 }
2555 }
2556end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002557
William Lallemandb7ea1412018-12-13 09:05:47 +01002558 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002559}
2560
2561int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2562{
William Lallemandbddd33a2018-12-11 16:10:53 +01002563 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002564 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002565 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002566
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002567 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002568 * current one. Just wait. At this stage, errors should be handled by
2569 * the response analyzer.
2570 */
2571 if (s->res.analysers & AN_RES_WAIT_CLI)
2572 return 0;
2573
William Lallemandb7ea1412018-12-13 09:05:47 +01002574 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2575 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2576
William Lallemandcf62f7e2018-10-26 14:47:40 +02002577read_again:
2578 /* if the channel is closed for read, we won't receive any more data
2579 from the client, but we don't want to forward this close to the
2580 server */
2581 channel_dont_close(req);
2582
2583 /* We don't know yet to which server we will connect */
2584 channel_dont_connect(req);
2585
William Lallemandcf62f7e2018-10-26 14:47:40 +02002586 req->flags |= CF_READ_DONTWAIT;
2587
2588 /* need more data */
2589 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002590 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002591
2592 /* If there is data available for analysis, log the end of the idle time. */
2593 if (c_data(req) && s->logs.t_idle == -1)
2594 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2595
William Lallemandbddd33a2018-12-11 16:10:53 +01002596 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002597 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002598 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002599 /* enough data */
2600
William Lallemandcf62f7e2018-10-26 14:47:40 +02002601 /* forward only 1 command */
2602 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002603
William Lallemanddc12c2e2018-12-13 09:05:46 +01002604 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002605 /* we send only 1 command per request, and we write close after it */
2606 channel_shutw_now(req);
2607 } else {
2608 pcli_write_prompt(s);
2609 }
2610
2611 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002612 s->res.analysers |= AN_RES_WAIT_CLI;
2613
William Lallemandebf61802018-12-11 16:10:57 +01002614 if (!(s->flags & SF_ASSIGNED)) {
2615 if (next_pid > -1)
2616 target_pid = next_pid;
2617 else
2618 target_pid = s->pcli_next_pid;
2619 /* we can connect now */
2620 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002621
William Lallemanddcbe7b92021-12-10 14:14:53 +01002622 if (!s->target)
2623 goto server_disconnect;
2624
William Lallemandebf61802018-12-11 16:10:57 +01002625 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2626 channel_auto_connect(req);
2627 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002628
2629 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002630 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002631 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002632 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002633 } else if (to_forward == -1) {
2634 if (errmsg) {
2635 /* there was an error during the parsing */
2636 pcli_reply_and_close(s, errmsg);
2637 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2638 return 0;
2639 }
2640 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002641 }
2642
2643 return 0;
2644
2645send_help:
2646 b_reset(&req->buf);
2647 b_putblk(&req->buf, "help\n", 5);
2648 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002649
Christopher Faulet0f727da2022-01-18 08:44:23 +01002650missing_data:
2651 if (req->flags & CF_SHUTR) {
2652 /* There is no more request or a only a partial one and we
2653 * receive a close from the client, we can leave */
2654 channel_shutw_now(&s->res);
2655 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2656 return 1;
2657 }
2658 else if (channel_full(req, global.tune.maxrewrite)) {
2659 /* buffer is full and we didn't catch the end of a command */
2660 goto send_help;
2661 }
2662 return 0;
2663
William Lallemanddcbe7b92021-12-10 14:14:53 +01002664server_disconnect:
2665 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2666 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002667}
2668
2669int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2670{
2671 struct proxy *fe = strm_fe(s);
2672 struct proxy *be = s->be;
2673
Christopher Faulete8cefac2022-03-07 18:20:21 +01002674 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2675 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002676 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002677 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002678 s->res.analysers &= ~AN_RES_WAIT_CLI;
2679 return 0;
2680 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002681 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2682 rep->flags |= CF_NEVER_WAIT;
2683
2684 /* don't forward the close */
2685 channel_dont_close(&s->res);
2686 channel_dont_close(&s->req);
2687
William Lallemanddc12c2e2018-12-13 09:05:46 +01002688 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002689 s->res.analysers &= ~AN_RES_WAIT_CLI;
2690 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2691 return 0;
2692 }
2693
William Lallemandcf62f7e2018-10-26 14:47:40 +02002694 /* forward the data */
2695 if (ci_data(rep)) {
2696 c_adv(rep, ci_data(rep));
2697 return 0;
2698 }
2699
2700 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2701 /* stream cleanup */
2702
William Lallemand2f4ce202018-10-26 14:47:47 +02002703 pcli_write_prompt(s);
2704
Christopher Faulet8abe7122022-03-30 15:10:18 +02002705 s->csb->flags |= CS_FL_NOLINGER | CS_FL_NOHALF;
Christopher Fauletda098e62022-03-31 17:44:45 +02002706 cs_shutr(s->csb);
2707 cs_shutw(s->csb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002708
2709 /*
2710 * starting from there this the same code as
2711 * http_end_txn_clean_session().
2712 *
2713 * It allows to do frontend keepalive while reconnecting to a
2714 * new server for each request.
2715 */
2716
2717 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002718 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002719 if (unlikely(s->srv_conn))
2720 sess_change_server(s, NULL);
2721 }
2722
2723 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2724 stream_process_counters(s);
2725
2726 /* don't count other requests' data */
2727 s->logs.bytes_in -= ci_data(&s->req);
2728 s->logs.bytes_out -= ci_data(&s->res);
2729
2730 /* we may need to know the position in the queue */
2731 pendconn_free(s);
2732
2733 /* let's do a final log if we need it */
2734 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2735 !(s->flags & SF_MONITOR) &&
2736 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2737 s->do_log(s);
2738 }
2739
2740 /* stop tracking content-based counters */
2741 stream_stop_content_counters(s);
2742 stream_update_time_stats(s);
2743
2744 s->logs.accept_date = date; /* user-visible date for logging */
2745 s->logs.tv_accept = now; /* corrected date for internal use */
2746 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2747 s->logs.t_idle = -1;
2748 tv_zero(&s->logs.tv_request);
2749 s->logs.t_queue = -1;
2750 s->logs.t_connect = -1;
2751 s->logs.t_data = -1;
2752 s->logs.t_close = 0;
2753 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2754 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2755
2756 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2757 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2758
2759 stream_del_srv_conn(s);
2760 if (objt_server(s->target)) {
2761 if (s->flags & SF_CURR_SESS) {
2762 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002763 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002764 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002765 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002766 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002767 }
2768
2769 s->target = NULL;
2770
2771 /* only release our endpoint if we don't intend to reuse the
2772 * connection.
2773 */
Christopher Faulete39a4df2022-03-31 09:58:41 +02002774 if (!cs_conn_ready(s->csb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002775 s->srv_conn = NULL;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002776 if (cs_reset_endp(s->csb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002777 if (!s->conn_err_type)
2778 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002779 if (s->srv_error)
Christopher Faulet0eb32c02022-04-04 11:06:31 +02002780 s->srv_error(s, s->csb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002781 return 1;
2782 }
Christopher Fauleta6c4a482022-04-28 18:25:24 +02002783 s->csb->endp->flags &= CS_EP_DETACHED;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002784 }
2785
Christopher Faulet8da67aa2022-03-29 17:53:09 +02002786 sockaddr_free(&s->csb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002787
Christopher Faulet62e75742022-03-31 09:16:34 +02002788 cs_set_state(s->csb, CS_ST_INI);
Christopher Faulet974da9f2022-03-30 15:30:03 +02002789 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 +02002790 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 +02002791 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 +02002792 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002793 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2794 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002795 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002796 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002797 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002798 /* reinitialise the current rule list pointer to NULL. We are sure that
2799 * any rulelist match the NULL pointer.
2800 */
2801 s->current_rule_list = NULL;
2802
2803 s->be = strm_fe(s);
2804 s->logs.logwait = strm_fe(s)->to_log;
2805 s->logs.level = 0;
2806 stream_del_srv_conn(s);
2807 s->target = NULL;
2808 /* re-init store persistence */
2809 s->store_count = 0;
2810 s->uniq_id = global.req_count++;
2811
2812 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2813
2814 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2815
William Lallemandcf62f7e2018-10-26 14:47:40 +02002816 s->res.analysers &= ~AN_RES_WAIT_CLI;
2817
2818 /* We must trim any excess data from the response buffer, because we
2819 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002820 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002821 * we want those data to come along with next response. A typical
2822 * example of such data would be from a buggy server responding to
2823 * a HEAD with some data, or sending more than the advertised
2824 * content-length.
2825 */
2826 if (unlikely(ci_data(&s->res)))
2827 b_set_data(&s->res.buf, co_data(&s->res));
2828
2829 /* Now we can realign the response buffer */
2830 c_realign_if_empty(&s->res);
2831
2832 s->req.rto = strm_fe(s)->timeout.client;
2833 s->req.wto = TICK_ETERNITY;
2834
2835 s->res.rto = TICK_ETERNITY;
2836 s->res.wto = strm_fe(s)->timeout.client;
2837
2838 s->req.rex = TICK_ETERNITY;
2839 s->req.wex = TICK_ETERNITY;
2840 s->req.analyse_exp = TICK_ETERNITY;
2841 s->res.rex = TICK_ETERNITY;
2842 s->res.wex = TICK_ETERNITY;
2843 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet1d987772022-03-29 18:03:35 +02002844 s->csb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002845
2846 /* we're removing the analysers, we MUST re-enable events detection.
2847 * We don't enable close on the response channel since it's either
2848 * already closed, or in keep-alive with an idle connection handler.
2849 */
2850 channel_auto_read(&s->req);
2851 channel_auto_close(&s->req);
2852 channel_auto_read(&s->res);
2853
2854
2855 return 1;
2856 }
2857 return 0;
2858}
2859
William Lallemand8a022572018-10-26 14:47:35 +02002860/*
2861 * The mworker functions are used to initialize the CLI in the master process
2862 */
2863
William Lallemand309dc9a2018-10-26 14:47:45 +02002864 /*
2865 * Stop the mworker proxy
2866 */
2867void mworker_cli_proxy_stop()
2868{
William Lallemand550db6d2018-11-06 17:37:12 +01002869 if (mworker_proxy)
2870 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002871}
2872
William Lallemand8a022572018-10-26 14:47:35 +02002873/*
2874 * Create the mworker CLI proxy
2875 */
2876int mworker_cli_proxy_create()
2877{
2878 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002879 char *msg = NULL;
2880 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002881
William Lallemandae787ba2021-07-29 15:13:22 +02002882 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002883 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002884 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002885
William Lallemandcf62f7e2018-10-26 14:47:40 +02002886 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002887 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2888 mworker_proxy->timeout.client = 0; /* no timeout */
2889 mworker_proxy->conf.file = strdup("MASTER");
2890 mworker_proxy->conf.line = 0;
2891 mworker_proxy->accept = frontend_accept;
2892 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2893
2894 /* Does not init the default target the CLI applet, but must be done in
2895 * the request parsing code */
2896 mworker_proxy->default_target = NULL;
2897
William Lallemand8a022572018-10-26 14:47:35 +02002898 /* create all servers using the mworker_proc list */
2899 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002900 struct server *newsrv = NULL;
2901 struct sockaddr_storage *sk;
2902 int port1, port2, port;
2903 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002904
William Lallemanda31b09e2020-01-14 15:25:02 +01002905 /* only the workers support the master CLI */
2906 if (!(child->options & PROC_O_TYPE_WORKER))
2907 continue;
2908
William Lallemand8a022572018-10-26 14:47:35 +02002909 newsrv = new_server(mworker_proxy);
2910 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002911 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002912
2913 /* we don't know the new pid yet */
2914 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002915 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002916 else
2917 memprintf(&msg, "old-%d", child->pid);
2918
2919 newsrv->next = mworker_proxy->srv;
2920 mworker_proxy->srv = newsrv;
2921 newsrv->conf.file = strdup(msg);
2922 newsrv->id = strdup(msg);
2923 newsrv->conf.line = 0;
2924
2925 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002926 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002927 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002928 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002929 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002930 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002931
Willy Tarreau5fc93282020-09-16 18:25:03 +02002932 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002933 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002934 }
2935
2936 /* no port specified */
2937 newsrv->flags |= SRV_F_MAPPORTS;
2938 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002939 /* don't let the server participate to load balancing */
2940 newsrv->iweight = 0;
2941 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002942 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002943
2944 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002945 }
William Lallemandae787ba2021-07-29 15:13:22 +02002946
2947 mworker_proxy->next = proxies_list;
2948 proxies_list = mworker_proxy;
2949
William Lallemand8a022572018-10-26 14:47:35 +02002950 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002951
2952error:
William Lallemand744a0892018-11-22 16:46:51 +01002953
2954 list_for_each_entry(child, &proc_list, list) {
2955 free((char *)child->srv->conf.file); /* cast because of const char * */
2956 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002957 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002958 }
William Lallemandae787ba2021-07-29 15:13:22 +02002959 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002960 free(msg);
2961
William Lallemandae787ba2021-07-29 15:13:22 +02002962error_proxy:
2963 ha_alert("%s\n", errmsg);
2964 free(errmsg);
2965
William Lallemand744a0892018-11-22 16:46:51 +01002966 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002967}
Olivier Houchardf886e342017-04-05 22:24:59 +02002968
William Lallemandce83b4a2018-10-26 14:47:30 +02002969/*
William Lallemande7361152018-10-26 14:47:36 +02002970 * Create a new listener for the master CLI proxy
2971 */
2972int mworker_cli_proxy_new_listener(char *line)
2973{
2974 struct bind_conf *bind_conf;
2975 struct listener *l;
2976 char *err = NULL;
2977 char *args[MAX_LINE_ARGS + 1];
2978 int arg;
2979 int cur_arg;
2980
William Lallemand2e945c82019-11-25 09:58:37 +01002981 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002982 args[0] = line;
2983
2984 /* args is a bind configuration with spaces replaced by commas */
2985 while (*line && arg < MAX_LINE_ARGS) {
2986
2987 if (*line == ',') {
2988 *line++ = '\0';
2989 while (*line == ',')
2990 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002991 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002992 }
2993 line++;
2994 }
2995
William Lallemand2e945c82019-11-25 09:58:37 +01002996 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002997
2998 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002999 if (!bind_conf)
3000 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003001
3002 bind_conf->level &= ~ACCESS_LVL_MASK;
3003 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003004 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003005
3006 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3007 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003008 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003009 }
3010
3011 cur_arg = 1;
3012
3013 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003014 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003015 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003016
3017 kw = bind_find_kw(args[cur_arg]);
3018 if (kw) {
3019 if (!kw->parse) {
3020 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3021 args[0], args[1], args[cur_arg]);
3022 goto err;
3023 }
3024
Willy Tarreau4975d142021-03-13 11:00:33 +01003025 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003026 if (err)
3027 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3028 else
3029 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3030 args[0], args[1], args[cur_arg]);
3031 goto err;
3032 }
3033
3034 cur_arg += 1 + kw->skip;
3035 continue;
3036 }
3037
Willy Tarreau433b05f2021-03-12 10:14:07 +01003038 best = bind_find_best_kw(args[cur_arg]);
3039 if (best)
3040 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3041 args[0], args[1], args[cur_arg], best);
3042 else
3043 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3044 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003045 goto err;
3046 }
3047
3048
3049 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003050 l->accept = session_accept_fd;
3051 l->default_target = mworker_proxy->default_target;
3052 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003053 l->options |= LI_O_UNLIMITED;
3054 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003055 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003056 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003057 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003058 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003059
3060 return 0;
3061
3062err:
3063 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003064 free(err);
3065 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003066 return -1;
3067
3068}
3069
3070/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003071 * Create a new CLI socket using a socketpair for a worker process
3072 * <mworker_proc> is the process structure, and <proc> is the process number
3073 */
3074int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3075{
3076 struct bind_conf *bind_conf;
3077 struct listener *l;
3078 char *path = NULL;
3079 char *err = NULL;
3080
3081 /* master pipe to ensure the master is still alive */
3082 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3083 ha_alert("Cannot create worker socketpair.\n");
3084 return -1;
3085 }
3086
3087 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003088 if (!global.cli_fe) {
3089 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003090 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003091 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003092 }
3093 }
3094
Willy Tarreau4975d142021-03-13 11:00:33 +01003095 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003096 if (!bind_conf)
3097 goto error;
3098
William Lallemandce83b4a2018-10-26 14:47:30 +02003099 bind_conf->level &= ~ACCESS_LVL_MASK;
3100 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003101 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003102
William Lallemandce83b4a2018-10-26 14:47:30 +02003103 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3104 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003105 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003106 }
3107
Willy Tarreau4975d142021-03-13 11:00:33 +01003108 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003109 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003110 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003111 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003112 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003113 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003114
3115 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003116 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003117 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003118 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003119 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003120 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003121 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003122 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003123 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003124 }
3125
3126 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003127
3128error:
3129 close(mworker_proc->ipc_fd[0]);
3130 close(mworker_proc->ipc_fd[1]);
3131 free(err);
3132
3133 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003134}
3135
William Lallemand74c24fb2016-11-21 17:18:36 +01003136static struct applet cli_applet = {
3137 .obj_type = OBJ_TYPE_APPLET,
3138 .name = "<CLI>", /* used for logging */
3139 .fct = cli_io_handler,
3140 .release = cli_release_handler,
3141};
3142
William Lallemand99e0bb92020-11-05 10:28:53 +01003143/* master CLI */
3144static struct applet mcli_applet = {
3145 .obj_type = OBJ_TYPE_APPLET,
3146 .name = "<MCLI>", /* used for logging */
3147 .fct = cli_io_handler,
3148 .release = cli_release_handler,
3149};
3150
Willy Tarreau0a739292016-11-22 20:21:23 +01003151/* register cli keywords */
3152static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003153 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3154 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3155 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3156 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003157 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3158 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003159 { { "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 +02003160 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3161 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3162 { { "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 },
3163 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3164 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3165 { { "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 },
3166 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3167 { { "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 },
3168 { { "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 +01003169 { { "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 +02003170 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3171 { { "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 +01003172 {{},}
3173}};
3174
Willy Tarreau0108d902018-11-25 19:14:37 +01003175INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3176
William Lallemand74c24fb2016-11-21 17:18:36 +01003177static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003178 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003179 { 0, NULL, NULL },
3180}};
3181
Willy Tarreau0108d902018-11-25 19:14:37 +01003182INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3183
William Lallemand74c24fb2016-11-21 17:18:36 +01003184static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003185 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3186 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003187 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003188 { NULL, NULL, 0 },
3189}};
3190
Willy Tarreau0108d902018-11-25 19:14:37 +01003191INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003192
3193/*
3194 * Local variables:
3195 * c-indent-level: 8
3196 * c-basic-offset: 8
3197 * End:
3198 */