blob: f81cfa65299838904352e2e0dba1f805151ddda0 [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 Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020030#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020032#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020033#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020034#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020035#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020036#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020037#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020038#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020039#include <haproxy/fd.h>
40#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020041#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020043#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020044#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020045#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010046#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020054#include <haproxy/sc_strm.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020055#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020056#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020057#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020058#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020059#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020060#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020061#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020062#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020063#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020064#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020065#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010066
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020067#define PAYLOAD_PATTERN "<<"
68
William Lallemand74c24fb2016-11-21 17:18:36 +010069static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010070static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010071
Willy Tarreau4975d142021-03-13 11:00:33 +010072static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010073 "Permission denied\n"
74 "";
75
76
Christopher Faulet1bc04c72017-10-29 20:14:08 +010077static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010078
79/* List head of cli keywords */
80static struct cli_kw_list cli_keywords = {
81 .list = LIST_HEAD_INIT(cli_keywords.list)
82};
83
84extern const char *stat_status_codes[];
85
Eric Salama1b8dacc2021-03-16 15:12:17 +010086struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand56f73b22022-09-24 15:56:25 +020087struct bind_conf *mcli_reload_bind_conf;
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 */
Willy Tarreau1cb041a2023-03-31 16:33:53 +020096/* flags for show_fd_ctx->show_mask */
97#define CLI_SHOWFD_F_PI 0x00000001 /* pipes */
98#define CLI_SHOWFD_F_LI 0x00000002 /* listeners */
99#define CLI_SHOWFD_F_FE 0x00000004 /* frontend conns */
100#define CLI_SHOWFD_F_SV 0x00000010 /* server-only conns */
101#define CLI_SHOWFD_F_PX 0x00000020 /* proxy-only conns */
102#define CLI_SHOWFD_F_BE 0x00000030 /* backend: srv+px */
103#define CLI_SHOWFD_F_CO 0x00000034 /* conn: be+fe */
104#define CLI_SHOWFD_F_ANY 0x0000003f /* any type */
105
Willy Tarreau741a5a92022-05-05 17:56:58 +0200106struct show_fd_ctx {
107 int fd; /* first FD to show */
108 int show_one; /* stop after showing one FD */
Willy Tarreau1cb041a2023-03-31 16:33:53 +0200109 uint show_mask; /* CLI_SHOWFD_F_xxx */
Willy Tarreau741a5a92022-05-05 17:56:58 +0200110};
111
Willy Tarreaub128f492022-05-05 19:11:05 +0200112/* CLI context for the "show cli sockets" command */
113struct show_sock_ctx {
114 struct bind_conf *bind_conf;
115 struct listener *listener;
116};
117
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200118static int cmp_kw_entries(const void *a, const void *b)
119{
120 const struct cli_kw *l = *(const struct cli_kw **)a;
121 const struct cli_kw *r = *(const struct cli_kw **)b;
122
123 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
124}
125
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100126/* This will show the help message and list the commands supported at the
127 * current level that match all of the first words of <args> if args is not
128 * NULL, or all args if none matches or if args is null.
129 */
130static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100131{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200132 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100133 struct cli_kw_list *kw_list;
134 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200135 struct buffer *tmp = get_trash_chunk();
136 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100137 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100138 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200139 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100140 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200141 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100142
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100143 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100144
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200145 if (args && *args && strcmp(*args, "help") == 0) {
146 args++;
147 ishelp = 1;
148 }
149
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100150 /* first, let's measure the longest match */
151 list_for_each_entry(kw_list, &cli_keywords.list, list) {
152 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100153 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100154 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100155 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
156 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100157 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
158 continue;
159
160 /* OK this command is visible */
161 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
162 if (!kw->str_kw[idx])
163 break; // end of keyword
164 if (!args || !args[idx] || !*args[idx])
165 break; // end of command line
166 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
167 break;
168 if (idx + 1 > length)
169 length = idx + 1;
170 }
171 }
172 }
173
Willy Tarreaub7364582021-03-12 18:24:46 +0100174 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100175 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200176 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100177 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Abhijeet Rastogic8601502022-11-17 04:42:38 -0800178 else {
179 chunk_strcat(tmp, "Unknown command: '");
180 if (args && *args)
181 chunk_strcat(tmp, *args);
182 chunk_strcat(tmp, "'");
183
184 if (!length && (!args || !*args || !**args)) // no match
185 chunk_strcat(tmp, ". Please enter one of the following commands only:\n");
186 else // partial match
187 chunk_strcat(tmp, ", but maybe one of the following ones is a better match:\n");
188 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100189
Willy Tarreaub7364582021-03-12 18:24:46 +0100190 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
191 matches[idx].kw = NULL;
192 matches[idx].dist = INT_MAX;
193 }
194
195 /* In case of partial match we'll look for the best matching entries
196 * starting from position <length>
197 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100198 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100199 list_for_each_entry(kw_list, &cli_keywords.list, list) {
200 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100201 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100202 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100203 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
204 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
205 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100206 continue;
207
208 for (idx = 0; idx < length; idx++) {
209 if (!kw->str_kw[idx])
210 break; // end of keyword
211 if (!args || !args[idx] || !*args[idx])
212 break; // end of command line
213 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
214 break;
215 }
216
217 /* extra non-matching words are fuzzy-matched */
218 if (kw->usage && idx == length && args[idx] && *args[idx]) {
219 uint8_t word_sig[1024];
220 uint8_t list_sig[1024];
221 int dist = 0;
222 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100223 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100224
225 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100226 * on the remaining words. For this we're computing the signature
227 * of everything that remains and the cumulated length of the
228 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100229 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100230 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100231 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
232 update_word_fingerprint(word_sig, args[i]);
233 totlen += strlen(args[i]);
234 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100235
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100236 memset(list_sig, 0, sizeof(list_sig));
237 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
238 update_word_fingerprint(list_sig, kw->str_kw[i]);
239 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100240 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100241
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100242 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100243
244 /* insert this one at its place if relevant, in order to keep only
245 * the best matches.
246 */
247 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100248 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100249 matches[CLI_MAX_MATCHES-1] = swp;
250 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
251 if (matches[idx+1].dist >= matches[idx].dist)
252 break;
253 matches[idx+1] = matches[idx];
254 matches[idx] = swp;
255 }
256 }
257 }
258 }
259 }
260 }
261
Willy Tarreauec197e82021-03-15 10:35:04 +0100262 if (matches[0].kw) {
263 /* we have fuzzy matches, let's propose them */
264 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
265 kw = matches[idx].kw;
266 if (!kw)
267 break;
268
269 /* stop the dump if some words look very unlikely candidates */
270 if (matches[idx].dist > 5*matches[0].dist/2)
271 break;
272
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200273 if (help_entries < CLI_MAX_HELP_ENTRIES)
274 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100275 }
276 }
277
William Lallemand74c24fb2016-11-21 17:18:36 +0100278 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100279 /* no full dump if we've already found nice candidates */
280 if (matches[0].kw)
281 break;
282
Willy Tarreau91bc3592021-03-12 15:20:39 +0100283 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200284
Willy Tarreau91bc3592021-03-12 15:20:39 +0100285 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100286 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100287 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100288 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100289 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200290
William Lallemand2a171912022-02-02 11:43:20 +0100291 /* in master, if the CLI don't have the
292 * ACCESS_MCLI_DEBUG don't display commands that have
293 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100294 */
William Lallemand2a171912022-02-02 11:43:20 +0100295 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
296 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
297 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100298 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200299
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100300 for (idx = 0; idx < length; idx++) {
301 if (!kw->str_kw[idx])
302 break; // end of keyword
303 if (!args || !args[idx] || !*args[idx])
304 break; // end of command line
305 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
306 break;
307 }
308
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200309 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
310 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100311 }
312 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100313
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200314 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
315
316 for (idx = 0; idx < help_entries; idx++)
317 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
318
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100319 /* always show the prompt/help/quit commands */
320 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200321 " help [<command>] : list matching or all commands\n"
Willy Tarreau22555572023-05-04 14:22:36 +0200322 " prompt [timed] : toggle interactive mode with prompt\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200323 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100324
William Lallemand74c24fb2016-11-21 17:18:36 +0100325 chunk_init(&out, NULL, 0);
326 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200327 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200328
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200329 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100330 return dynamic_usage_msg;
331}
332
333struct cli_kw* cli_find_kw(char **args)
334{
335 struct cli_kw_list *kw_list;
336 struct cli_kw *kw;/* current cli_kw */
337 char **tmp_args;
338 const char **tmp_str_kw;
339 int found = 0;
340
341 if (LIST_ISEMPTY(&cli_keywords.list))
342 return NULL;
343
344 list_for_each_entry(kw_list, &cli_keywords.list, list) {
345 kw = &kw_list->kw[0];
346 while (*kw->str_kw) {
347 tmp_args = args;
348 tmp_str_kw = kw->str_kw;
349 while (*tmp_str_kw) {
350 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
351 found = 1;
352 } else {
353 found = 0;
354 break;
355 }
356 tmp_args++;
357 tmp_str_kw++;
358 }
359 if (found)
360 return (kw);
361 kw++;
362 }
363 }
364 return NULL;
365}
366
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100367struct cli_kw* cli_find_kw_exact(char **args)
368{
369 struct cli_kw_list *kw_list;
370 int found = 0;
371 int i;
372 int j;
373
374 if (LIST_ISEMPTY(&cli_keywords.list))
375 return NULL;
376
377 list_for_each_entry(kw_list, &cli_keywords.list, list) {
378 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
379 found = 1;
380 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
381 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
382 break;
383 }
384 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
385 found = 0;
386 break;
387 }
388 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
389 found = 0;
390 break;
391 }
392 }
393 if (found)
394 return &kw_list->kw[i];
395 }
396 }
397 return NULL;
398}
399
William Lallemand74c24fb2016-11-21 17:18:36 +0100400void cli_register_kw(struct cli_kw_list *kw_list)
401{
Willy Tarreau2b718102021-04-21 07:32:39 +0200402 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100403}
404
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200405/* list all known keywords on stdout, one per line */
406void cli_list_keywords(void)
407{
408 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200409 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200410 int idx;
411
Willy Tarreau44651712022-03-30 12:02:35 +0200412 for (kwn = kwp = NULL;; kwp = kwn) {
413 list_for_each_entry(kw_list, &cli_keywords.list, list) {
414 /* note: we sort based on the usage message when available,
415 * otherwise we fall back to the first keyword.
416 */
417 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
418 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
419 kw->usage ? kw->usage : kw->str_kw[0],
420 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
421 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200422 }
Willy Tarreau44651712022-03-30 12:02:35 +0200423 }
424
425 if (kwn == kwp)
426 break;
427
428 for (idx = 0; kwn->str_kw[idx]; idx++) {
429 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200430 }
Willy Tarreau44651712022-03-30 12:02:35 +0200431 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
432 printf("[MASTER] ");
433 if (!(kwn->level & ACCESS_MASTER_ONLY))
434 printf("[WORKER] ");
435 if (kwn->level & ACCESS_EXPERT)
436 printf("[EXPERT] ");
437 if (kwn->level & ACCESS_EXPERIMENTAL)
438 printf("[EXPERIM] ");
439 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200440 }
441}
William Lallemand74c24fb2016-11-21 17:18:36 +0100442
443/* allocate a new stats frontend named <name>, and return it
444 * (or NULL in case of lack of memory).
445 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100446static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100447{
448 struct proxy *fe;
449
450 fe = calloc(1, sizeof(*fe));
451 if (!fe)
452 return NULL;
453
454 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100455 fe->next = proxies_list;
456 proxies_list = fe;
Willy Tarreau69530f52023-04-28 09:16:15 +0200457 fe->last_change = ns_to_sec(now_ns);
William Lallemand74c24fb2016-11-21 17:18:36 +0100458 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200459 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100460 fe->maxconn = 10; /* default to 10 concurrent connections */
461 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
462 fe->conf.file = strdup(file);
463 fe->conf.line = line;
464 fe->accept = frontend_accept;
465 fe->default_target = &cli_applet.obj_type;
466
467 /* the stats frontend is the only one able to assign ID #0 */
468 fe->conf.id.key = fe->uuid = 0;
469 eb32_insert(&used_proxy_id, &fe->conf.id);
470 return fe;
471}
472
473/* This function parses a "stats" statement in the "global" section. It returns
474 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
475 * error message into the <err> buffer which will be preallocated. The trailing
476 * '\n' must not be written. The function must be called with <args> pointing to
477 * the first word after "stats".
478 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100479static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
480 const struct proxy *defpx, const char *file, int line,
481 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100482{
483 struct bind_conf *bind_conf;
484 struct listener *l;
485
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100486 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100487 int cur_arg;
488
489 if (*args[2] == 0) {
490 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
491 return -1;
492 }
493
Willy Tarreau4975d142021-03-13 11:00:33 +0100494 if (!global.cli_fe) {
495 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100496 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
497 return -1;
498 }
499 }
500
Willy Tarreau4975d142021-03-13 11:00:33 +0100501 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200502 if (!bind_conf) {
503 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
504 return -1;
505 }
William Lallemand07a62f72017-05-24 00:57:40 +0200506 bind_conf->level &= ~ACCESS_LVL_MASK;
507 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100508
Willy Tarreau4975d142021-03-13 11:00:33 +0100509 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100510 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
511 file, line, args[0], args[1], err && *err ? *err : "error");
512 return -1;
513 }
514
515 cur_arg = 3;
516 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100517 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100518 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100519 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100520
521 kw = bind_find_kw(args[cur_arg]);
522 if (kw) {
523 if (!kw->parse) {
524 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
525 args[0], args[1], args[cur_arg]);
526 return -1;
527 }
528
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100529 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
530
531 /* FIXME: this is ugly, we don't have a way to collect warnings,
532 * yet some important bind keywords may report warnings that we
533 * must display.
534 */
535 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
536 indent_msg(err, 2);
537 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
538 ha_free(err);
539 }
540
541 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 if (err && *err)
543 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
544 else
545 memprintf(err, "'%s %s' : error encountered while processing '%s'",
546 args[0], args[1], args[cur_arg]);
547 return -1;
548 }
549
550 cur_arg += 1 + kw->skip;
551 continue;
552 }
553
Willy Tarreau433b05f2021-03-12 10:14:07 +0100554 best = bind_find_best_kw(args[cur_arg]);
555 if (best)
556 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
557 args[0], args[1], args[cur_arg], best);
558 else
559 memprintf(err, "'%s %s' : unknown keyword '%s'.",
560 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100561 return -1;
562 }
563
Willy Tarreau30836152023-01-12 19:10:17 +0100564 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +0100565 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +0100566 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +0100567
William Lallemand74c24fb2016-11-21 17:18:36 +0100568 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18215cb2019-02-27 16:25:28 +0100569 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100570 }
571 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100572 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100573 unsigned timeout;
574 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
575
Willy Tarreau9faebe32019-06-07 19:00:37 +0200576 if (res == PARSE_TIME_OVER) {
577 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
578 args[2], args[0], args[1]);
579 return -1;
580 }
581 else if (res == PARSE_TIME_UNDER) {
582 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
583 args[2], args[0], args[1]);
584 return -1;
585 }
586 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
588 return -1;
589 }
590
591 if (!timeout) {
592 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
593 return -1;
594 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100595 if (!global.cli_fe) {
596 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100597 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
598 return -1;
599 }
600 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100601 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100603 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100604 int maxconn = atol(args[2]);
605
606 if (maxconn <= 0) {
607 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
608 return -1;
609 }
610
Willy Tarreau4975d142021-03-13 11:00:33 +0100611 if (!global.cli_fe) {
612 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100613 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
614 return -1;
615 }
616 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100617 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100618 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200619 else if (strcmp(args[1], "bind-process") == 0) {
Willy Tarreau023c3112023-04-23 09:40:56 +0200620 memprintf(err, "'%s %s' is not supported anymore.", args[0], args[1]);
Willy Tarreau94f763b2022-07-15 17:14:40 +0200621 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100622 }
623 else {
624 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
625 return -1;
626 }
627 return 0;
628}
629
William Lallemand33d29e22019-04-01 11:30:06 +0200630/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200631 * This function exports the bound addresses of a <frontend> in the environment
632 * variable <varname>. Those addresses are separated by semicolons and prefixed
633 * with their type (abns@, unix@, sockpair@ etc)
634 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200635 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200636int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200637{
638 struct buffer *trash = get_trash_chunk();
639 struct bind_conf *bind_conf;
640
William Lallemand9a37fd02019-04-12 16:09:24 +0200641 if (frontend) {
642 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200643 struct listener *l;
644
645 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
646 char addr[46];
647 char port[6];
648
William Lallemand620072b2019-04-12 16:09:25 +0200649 /* separate listener by semicolons */
650 if (trash->data)
651 chunk_appendf(trash, ";");
652
Willy Tarreau37159062020-08-27 07:48:42 +0200653 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200654 const struct sockaddr_un *un;
655
Willy Tarreau37159062020-08-27 07:48:42 +0200656 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200657 if (un->sun_path[0] == '\0') {
658 chunk_appendf(trash, "abns@%s", un->sun_path+1);
659 } else {
660 chunk_appendf(trash, "unix@%s", un->sun_path);
661 }
Willy Tarreau37159062020-08-27 07:48:42 +0200662 } else if (l->rx.addr.ss_family == AF_INET) {
663 addr_to_str(&l->rx.addr, addr, sizeof(addr));
664 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200665 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200666 } else if (l->rx.addr.ss_family == AF_INET6) {
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, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200670 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
671 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200672 }
William Lallemand33d29e22019-04-01 11:30:06 +0200673 }
674 }
675 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200676 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200677 return -1;
678 }
679
680 return 0;
681}
682
William Lallemand9a37fd02019-04-12 16:09:24 +0200683int cli_socket_setenv()
684{
Willy Tarreau4975d142021-03-13 11:00:33 +0100685 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200686 return -1;
687 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
688 return -1;
689
690 return 0;
691}
692
William Lallemand33d29e22019-04-01 11:30:06 +0200693REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
694
Willy Tarreaude57a572016-11-23 17:01:39 +0100695/* Verifies that the CLI at least has a level at least as high as <level>
696 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
697 * failure, an error message is prepared and the appctx's state is adjusted
698 * to print it so that a return 1 is enough to abort any processing.
699 */
700int cli_has_level(struct appctx *appctx, int level)
701{
Willy Tarreaude57a572016-11-23 17:01:39 +0100702
William Lallemandf630d012018-12-13 09:05:44 +0100703 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100704 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100705 return 0;
706 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100707 return 1;
708}
709
William Lallemandb7ea1412018-12-13 09:05:47 +0100710/* same as cli_has_level but for the CLI proxy and without error message */
711int pcli_has_level(struct stream *s, int level)
712{
713 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
714 return 0;
715 }
716 return 1;
717}
718
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200719/* Returns severity_output for the current session if set, or default for the socket */
720static int cli_get_severity_output(struct appctx *appctx)
721{
722 if (appctx->cli_severity_output)
723 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200724 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200725}
William Lallemand74c24fb2016-11-21 17:18:36 +0100726
Willy Tarreau41908562016-11-24 16:23:38 +0100727/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100728 * from the CLI's IO handler running in an appctx context. The function returns
729 * 1 if the request was understood, otherwise zero (in which case an error
730 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100731 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
732 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
733 * have its own I/O handler called again. Most of the time, parsers will only
734 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100735 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
736 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100737 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100739{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100740 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200744 p = appctx->chunk->area;
745 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100746
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200747 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 * Get pointers on words.
749 * One extra slot is reserved to store a pointer on a null byte.
750 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100751 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200752 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100753
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200754 /* skip leading spaces/tabs */
755 p += strspn(p, " \t");
756 if (!*p)
757 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200758
759 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
760 /* payload pattern recognized here, this is not an arg anymore,
761 * the payload starts at the first byte that follows the zero
762 * after the pattern.
763 */
764 payload = p + strlen(PAYLOAD_PATTERN) + 1;
765 break;
766 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100767
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200768 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200769 while (1) {
770 p += strcspn(p, " \t\\");
771 /* escaped chars using backlashes (\) */
772 if (*p == '\\') {
773 if (!*++p)
774 break;
775 if (!*++p)
776 break;
777 } else {
778 break;
779 }
780 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200781 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100782
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200783 /* unescape backslashes (\) */
784 for (j = 0, k = 0; args[i][k]; k++) {
785 if (args[i][k] == '\\') {
786 if (args[i][k + 1] == '\\')
787 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100788 else
789 continue;
790 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200791 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100792 j++;
793 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200794 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100795
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200796 i++;
797 }
798 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200799 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100800 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200801 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100802
Willy Tarreau21d71252023-05-11 16:32:56 +0200803 if (!**args)
804 return 0;
805
Willy Tarreau41908562016-11-24 16:23:38 +0100806 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100807 if (!kw ||
808 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100809 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
810 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100811 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100812 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100813 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100814 }
William Lallemand14721be2018-10-26 14:47:37 +0200815
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100816 /* don't handle expert mode commands if not in this mode. */
817 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
818 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200819 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100820 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200821
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100822 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
823 cli_err(appctx, "This command is restricted to experimental mode only.\n");
824 return 0;
825 }
826
Amaury Denoyellef4929922021-05-05 16:29:23 +0200827 if (kw->level == ACCESS_EXPERT)
828 mark_tainted(TAINTED_CLI_EXPERT_MODE);
829 else if (kw->level == ACCESS_EXPERIMENTAL)
830 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
831
Willy Tarreau41908562016-11-24 16:23:38 +0100832 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200833 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200834
835 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
836 goto fail;
837
838 /* kw->parse could set its own io_handler or io_release handler */
839 if (!appctx->io_handler)
840 goto fail;
841
842 appctx->st0 = CLI_ST_CALLBACK;
843 return 1;
844fail:
845 appctx->io_handler = NULL;
846 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100847 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100848}
849
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200850/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200851static int cli_output_msg(struct appctx *appctx, const char *msg, int severity, int severity_output)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200852{
Willy Tarreau83061a82018-07-13 11:56:34 +0200853 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200854
855 if (likely(severity_output == CLI_SEVERITY_NONE))
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200856 return applet_putstr(appctx, msg);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200857
858 tmp = get_trash_chunk();
859 chunk_reset(tmp);
860
861 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100862 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200863 chunk_printf(tmp, "[%d]: ", severity);
864 }
865 else {
866 switch (severity_output) {
867 case CLI_SEVERITY_NUMBER:
868 chunk_printf(tmp, "[%d]: ", severity);
869 break;
870 case CLI_SEVERITY_STRING:
871 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
872 break;
873 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100874 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200875 }
876 }
877 chunk_appendf(tmp, "%s", msg);
878
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200879 return applet_putchk(appctx, tmp);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200880}
881
Willy Tarreau4596fe22022-05-17 19:07:51 +0200882/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100883 * used to processes I/O from/to the stats unix socket. The system relies on a
884 * state machine handling requests and various responses. We read a request,
885 * then we process it and send the response, and we possibly display a prompt.
886 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100887 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100888 * or not.
889 */
890static void cli_io_handler(struct appctx *appctx)
891{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200892 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200893 struct channel *req = sc_oc(sc);
894 struct channel *res = sc_ic(sc);
895 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100896 int reql;
897 int len;
898
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200899 if (unlikely(se_fl_test(appctx->sedesc, (SE_FL_EOS|SE_FL_ERROR|SE_FL_SHR|SE_FL_SHW)))) {
900 co_skip(sc_oc(sc), co_data(sc_oc(sc)));
William Lallemand74c24fb2016-11-21 17:18:36 +0100901 goto out;
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200902 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100903
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800904 /* Check if the input buffer is available. */
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200905 if (!b_size(&res->buf)) {
Christopher Faulet7b3d38a2023-05-05 11:28:45 +0200906 sc_need_room(sc, 0);
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100907 goto out;
908 }
909
William Lallemand74c24fb2016-11-21 17:18:36 +0100910 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100911 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200912 /* reset severity to default at init */
913 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200914 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100915 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100916 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100917 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100918 else if (appctx->st0 == CLI_ST_END) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200919 se_fl_set(appctx->sedesc, SE_FL_EOS);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200920 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200921 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100922 break;
923 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100924 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200925 char *str;
926
927 /* use a trash chunk to store received data */
928 if (!appctx->chunk) {
929 appctx->chunk = alloc_trash_chunk();
930 if (!appctx->chunk) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200931 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200932 appctx->st0 = CLI_ST_END;
933 continue;
934 }
935 }
936
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200937 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200938
William Lallemand74c24fb2016-11-21 17:18:36 +0100939 /* ensure we have some output room left in the event we
940 * would want to return some info right after parsing.
941 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200942 if (buffer_almost_full(sc_ib(sc))) {
Christopher Faulet7b3d38a2023-05-05 11:28:45 +0200943 sc_need_room(sc, b_size(&res->buf) / 2);
William Lallemand74c24fb2016-11-21 17:18:36 +0100944 break;
945 }
946
Willy Tarreau0011c252022-01-19 17:23:52 +0100947 /* payload doesn't take escapes nor does it end on semi-colons, so
948 * we use the regular getline. Normal mode however must stop on
949 * LFs and semi-colons that are not prefixed by a backslash. Note
950 * that we reserve one byte at the end to insert a trailing nul byte.
951 */
952
953 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200954 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100955 appctx->chunk->size - appctx->chunk->data - 1);
956 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200957 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100958 appctx->chunk->size - appctx->chunk->data - 1,
959 "\n;", '\\');
960
William Lallemand74c24fb2016-11-21 17:18:36 +0100961 if (reql <= 0) { /* closed or EOL not found */
962 if (reql == 0)
963 break;
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200964 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100965 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100966 continue;
967 }
968
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200969 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
970 /* seek for a possible unescaped semi-colon. If we find
971 * one, we replace it with an LF and skip only this part.
972 */
973 for (len = 0; len < reql; len++) {
974 if (str[len] == '\\') {
975 len++;
976 continue;
977 }
978 if (str[len] == ';') {
979 str[len] = '\n';
980 reql = len + 1;
981 break;
982 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100983 }
984 }
985
986 /* now it is time to check that we have a full line,
987 * remove the trailing \n and possibly \r, then cut the
988 * line.
989 */
990 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200991 if (str[len] != '\n') {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200992 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100993 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100994 continue;
995 }
996
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200997 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100998 len--;
999
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001000 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001001 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001002
1003 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001004 appctx->chunk->area[appctx->chunk->data] = '\n';
1005 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1006 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001007 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001008
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001009 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001010
1011 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1012 /* empty line */
1013 if (!len) {
1014 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001015 appctx->chunk->data -= 2;
1016 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001017 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001018 chunk_reset(appctx->chunk);
1019 /* NB: cli_sock_parse_request() may have put
1020 * another CLI_ST_O_* into appctx->st0.
1021 */
1022
1023 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001024 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001025 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001026 else {
1027 /*
1028 * Look for the "payload start" pattern at the end of a line
1029 * Its location is not remembered here, this is just to switch
1030 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001031 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001032 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001033 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001034 appctx->chunk->data++; // keep the trailing \0 after '<<'
1035 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001036 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001037 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001038 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001039 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001040 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001041 }
1042
1043 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001044 co_skip(sc_oc(sc), reql);
Christopher Faulet9a790f62023-03-16 14:40:03 +01001045 sc_opposite(sc)->flags |= SC_FL_RCV_ONCE; /* we plan to read small requests */
William Lallemand74c24fb2016-11-21 17:18:36 +01001046 }
1047 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001048 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001049 const char *msg;
1050 int sev;
1051
William Lallemand74c24fb2016-11-21 17:18:36 +01001052 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001053 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001054 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001055 case CLI_ST_PRINT: /* print const message in msg */
1056 case CLI_ST_PRINT_ERR: /* print const error in msg */
1057 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001058 case CLI_ST_PRINT_DYNERR: /* print dyn error in err, free */
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001059 case CLI_ST_PRINT_UMSG: /* print usermsgs_ctx and reset it */
1060 case CLI_ST_PRINT_UMSGERR: /* print usermsgs_ctx as error and reset it */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001061 /* the message is in the svcctx */
1062 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001063 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1064 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001065 LOG_ERR : ctx->severity;
1066 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001067 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001068 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
1069 sev = appctx->st0 == CLI_ST_PRINT_DYNERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001070 LOG_ERR : ctx->severity;
1071 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001072 if (!msg) {
1073 sev = LOG_ERR;
1074 msg = "Out of memory.\n";
1075 }
1076 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001077 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1078 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1079 sev = appctx->st0 == CLI_ST_PRINT_UMSGERR ?
1080 LOG_ERR : ctx->severity;
1081 msg = usermsgs_str();
1082 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001083 else {
1084 sev = LOG_ERR;
1085 msg = "Internal error.\n";
1086 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001087
Christopher Faulete8ee27b2023-05-05 10:56:00 +02001088 if (cli_output_msg(appctx, msg, sev, cli_get_severity_output(appctx)) != -1) {
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001089 if (appctx->st0 == CLI_ST_PRINT_DYN ||
1090 appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001091 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001092 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001093 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1094 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1095 usermsgs_clr(NULL);
1096 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001097 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001099 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001100
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001101 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001102 if (appctx->io_handler)
1103 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001104 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001105 if (appctx->io_release) {
1106 appctx->io_release(appctx);
1107 appctx->io_release = NULL;
1108 }
1109 }
1110 break;
1111 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001112 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001113 break;
1114 }
1115
1116 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001117 if (appctx->st0 == CLI_ST_PROMPT) {
Willy Tarreau22555572023-05-04 14:22:36 +02001118 char prompt_buf[20];
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001119 const char *prompt = "";
1120
1121 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1122 /*
1123 * when entering a payload with interactive mode, change the prompt
1124 * to emphasize that more data can still be sent
1125 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001126 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001127 prompt = "+ ";
Willy Tarreau22555572023-05-04 14:22:36 +02001128 else if (appctx->st1 & APPCTX_CLI_ST1_TIMED) {
1129 uint up = ns_to_sec(now_ns - start_time_ns);
1130 snprintf(prompt_buf, sizeof(prompt_buf),
1131 "\n[%u:%02u:%02u:%02u]> ",
1132 (up / 86400), (up / 3600) % 24, (up / 60) % 60, up % 60);
1133 prompt = prompt_buf;
1134 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001135 else
1136 prompt = "\n> ";
1137 }
1138 else {
William Lallemandad032882019-07-01 10:56:15 +02001139 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001140 prompt = "\n";
1141 }
1142
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001143 if (applet_putstr(appctx, prompt) != -1) {
1144 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001145 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001146 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001147 }
1148
1149 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001150 if (appctx->st0 >= CLI_ST_OUTPUT) {
1151 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001153 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001154
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001155 /* Now we close the output if we're not in interactive
1156 * mode and the request buffer is empty. This still
1157 * allows pipelined requests to be sent in
1158 * non-interactive mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001159 */
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001160 if (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))) {
1161 se_fl_set(appctx->sedesc, SE_FL_EOI);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001162 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001163 continue;
1164 }
1165
1166 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001167 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001168 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001169 applet_will_consume(appctx);
1170
William Lallemandad032882019-07-01 10:56:15 +02001171 /* reactivate the \n at the end of the response for the next command */
1172 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001173
1174 /* this forces us to yield between pipelined commands and
1175 * avoid extremely long latencies (e.g. "del map" etc). In
1176 * addition this increases the likelihood that the stream
1177 * refills the buffer with new bytes in non-interactive
1178 * mode, avoiding to close on apparently empty commands.
1179 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001180 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001181 appctx_wakeup(appctx);
1182 goto out;
1183 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001184 }
1185 }
1186
William Lallemand74c24fb2016-11-21 17:18:36 +01001187 out:
Christopher Faulet845f7c42023-04-18 18:36:43 +02001188 return;
William Lallemand74c24fb2016-11-21 17:18:36 +01001189}
1190
Willy Tarreau4596fe22022-05-17 19:07:51 +02001191/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 * external abort, we won't call the i/o handler anymore so we may need to
1193 * remove back references to the stream currently being dumped.
1194 */
1195static void cli_release_handler(struct appctx *appctx)
1196{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001197 free_trash_chunk(appctx->chunk);
1198 appctx->chunk = NULL;
1199
William Lallemand74c24fb2016-11-21 17:18:36 +01001200 if (appctx->io_release) {
1201 appctx->io_release(appctx);
1202 appctx->io_release = NULL;
1203 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001204 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001205 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1206
1207 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001208 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001209 else if (appctx->st0 == CLI_ST_PRINT_UMSG || appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1210 usermsgs_clr(NULL);
1211 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001212}
1213
1214/* This function dumps all environmnent variables to the buffer. It returns 0
1215 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001216 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1217 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001218 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001219static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001220{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001221 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001222 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001223 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001224
Christopher Faulet87633c32023-04-03 18:32:50 +02001225 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001226 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
William Lallemand74c24fb2016-11-21 17:18:36 +01001227 return 1;
1228
1229 chunk_reset(&trash);
1230
1231 /* we have two inner loops here, one for the proxy, the other one for
1232 * the buffer.
1233 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001234 while (*var) {
1235 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001236
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001237 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001238 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001239
Willy Tarreau307dbb32022-05-05 17:45:52 +02001240 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001241 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001242 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001243 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001244 }
1245
1246 /* dump complete */
1247 return 1;
1248}
1249
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001250/* This function dumps all file descriptors states (or the requested one) to
1251 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001252 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1253 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1254 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001255 */
1256static int cli_io_handler_show_fd(struct appctx *appctx)
1257{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001258 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001259 struct show_fd_ctx *fdctx = appctx->svcctx;
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001260 uint match = fdctx->show_mask;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001261 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001262 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001263
Christopher Faulet87633c32023-04-03 18:32:50 +02001264 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001265 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001266 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001267
1268 chunk_reset(&trash);
1269
Willy Tarreauca1b1572018-12-18 15:45:11 +01001270 /* isolate the threads once per round. We're limited to a buffer worth
1271 * of output anyway, it cannot last very long.
1272 */
1273 thread_isolate();
1274
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001275 /* we have two inner loops here, one for the proxy, the other one for
1276 * the buffer.
1277 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001278 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001279 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001280 const struct listener *li = NULL;
1281 const struct server *sv = NULL;
1282 const struct proxy *px = NULL;
1283 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001284 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001285 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001286 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001287 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001288 uint32_t conn_flags = 0;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001289 uint8_t conn_err = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001290 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001291 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001292
1293 fdt = fdtab[fd];
1294
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001295 /* When DEBUG_FD is set, we also report closed FDs that have a
1296 * non-null event count to detect stuck ones.
1297 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001298 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001299#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001300 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001301#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001302 goto skip; // closed
1303 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001304 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001305 conn = (const struct connection *)fdt.owner;
1306 conn_flags = conn->flags;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001307 conn_err = conn->err_code;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001308 mux = conn->mux;
1309 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001310 xprt = conn->xprt;
1311 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001312 li = objt_listener(conn->target);
1313 sv = objt_server(conn->target);
1314 px = objt_proxy(conn->target);
1315 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001316 if (atleast2(fdt.thread_mask))
1317 suspicious = 1;
1318 if (conn->handle.fd != fd)
1319 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001320 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001321 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001322 li = fdt.owner;
1323
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001324 if (!((conn &&
1325 ((match & CLI_SHOWFD_F_SV && sv) ||
1326 (match & CLI_SHOWFD_F_PX && px) ||
1327 (match & CLI_SHOWFD_F_FE && li))) ||
1328 (!conn &&
1329 ((match & CLI_SHOWFD_F_LI && li) ||
1330 (match & CLI_SHOWFD_F_PI && !li /* only pipes match this */))))) {
1331 /* not a desired type */
1332 goto skip;
1333 }
1334
Willy Tarreaudacfde42021-01-21 09:07:29 +01001335 if (!fdt.thread_mask)
1336 suspicious = 1;
1337
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001338 chunk_printf(&trash,
Willy Tarreau677c0062023-03-02 15:05:31 +01001339 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) ref=%#x gid=%d tmask=0x%lx umask=0x%lx prmsk=0x%lx pwmsk=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001340 fd,
1341 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001342 (fdt.state & FD_CLONED) ? 'C' : 'c',
1343 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001344 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1345 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1346 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1347 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1348 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001349 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1350 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1351 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1352 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1353 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1354 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001355 (fdt.refc_tgid >> 4) & 0xffff,
1356 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001357 fdt.thread_mask, fdt.update_mask,
Willy Tarreau677c0062023-03-02 15:05:31 +01001358 polled_mask[fd].poll_recv,
1359 polled_mask[fd].poll_send,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001360 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001361 fdt.iocb);
1362 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001363
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001364 if (!fdt.owner) {
1365 chunk_appendf(&trash, ")");
1366 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001367 else if (fdt.iocb == sock_conn_iocb) {
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001368 chunk_appendf(&trash, ") back=%d cflg=0x%08x cerr=%d", is_back, conn_flags, conn_err);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001369
1370 if (conn->handle.fd != fd) {
1371 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1372 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001373 } else {
1374 struct sockaddr_storage sa;
1375 socklen_t salen;
1376
1377 salen = sizeof(sa);
1378 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1379 if (sa.ss_family == AF_INET)
1380 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1381 else if (sa.ss_family == AF_INET6)
1382 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1383 else if (sa.ss_family == AF_UNIX)
1384 chunk_appendf(&trash, " fam=unix");
1385 }
1386
1387 salen = sizeof(sa);
1388 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1389 if (sa.ss_family == AF_INET)
1390 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1391 else if (sa.ss_family == AF_INET6)
1392 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1393 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001394 }
1395
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001396 if (px)
1397 chunk_appendf(&trash, " px=%s", px->id);
1398 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001399 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001400 else if (li)
1401 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001402
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001403 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001404 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001405 if (!ctx)
1406 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001407 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001408 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001409 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001410 else
1411 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001412
1413 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001414 if (xprt) {
1415 if (xprt_ctx || xprt->show_fd)
1416 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1417 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001418 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001419 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001420 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001421 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001422 struct sockaddr_storage sa;
1423 socklen_t salen;
1424
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001425 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001426 listener_state_str(li),
1427 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001428
1429 salen = sizeof(sa);
1430 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1431 if (sa.ss_family == AF_INET)
1432 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1433 else if (sa.ss_family == AF_INET6)
1434 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1435 else if (sa.ss_family == AF_UNIX)
1436 chunk_appendf(&trash, " fam=unix");
1437 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001438 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001439 else
1440 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001441
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001442#ifdef DEBUG_FD
1443 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001444 if (fdtab[fd].event_count >= 1000000)
1445 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001446#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001447 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001448
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001449 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001450 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001451 ret = 0;
1452 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001453 }
1454 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001455 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001456 break;
1457
1458 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001459 }
1460
Willy Tarreauca1b1572018-12-18 15:45:11 +01001461 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001462 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001463
1464 thread_release();
1465 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001466}
1467
William Lallemandeceddf72016-12-15 18:06:44 +01001468/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001469 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001470 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1471 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001472 */
1473static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1474{
Willy Tarreaub128f492022-05-05 19:11:05 +02001475 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1476 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001477
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001478 if (!global.cli_fe)
1479 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001480
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001481 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001482
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001483 if (!bind_conf) {
1484 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001485 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001486 goto full;
1487 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1488 }
William Lallemandeceddf72016-12-15 18:06:44 +01001489
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001490 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001491 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001492
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001493 if (!l)
1494 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001495
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001496 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1497 char addr[46];
1498 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001499
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001500 if (l->rx.addr.ss_family == AF_UNIX) {
1501 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001502
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001503 un = (struct sockaddr_un *)&l->rx.addr;
1504 if (un->sun_path[0] == '\0') {
1505 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1506 } else {
1507 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1508 }
1509 } else if (l->rx.addr.ss_family == AF_INET) {
1510 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1511 port_to_str(&l->rx.addr, port, sizeof(port));
1512 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1513 } else if (l->rx.addr.ss_family == AF_INET6) {
1514 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1515 port_to_str(&l->rx.addr, port, sizeof(port));
1516 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1517 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1518 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1519 } else
1520 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001521
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001522 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1523 chunk_appendf(&trash, "admin ");
1524 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1525 chunk_appendf(&trash, "operator ");
1526 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1527 chunk_appendf(&trash, "user ");
1528 else
1529 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001530
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001531 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001532
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001533 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001534 ctx->bind_conf = bind_conf;
1535 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001536 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001537 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001538 }
William Lallemandeceddf72016-12-15 18:06:44 +01001539 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001540 done:
1541 return 1;
1542 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001543 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001544}
1545
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001546
Willy Tarreau0a739292016-11-22 20:21:23 +01001547/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001548 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1549 * be dumped as well as a flag if a single variable is requested, otherwise puts
1550 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001551 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001552static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001553{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001554 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001555 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001556 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001557
1558 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1559 return 1;
1560
Willy Tarreauf6710f82016-12-16 17:45:44 +01001561 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001562
1563 if (*args[2]) {
1564 int len = strlen(args[2]);
1565
Willy Tarreauf6710f82016-12-16 17:45:44 +01001566 for (; *var; var++) {
1567 if (strncmp(*var, args[2], len) == 0 &&
1568 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001569 break;
1570 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001571 if (!*var)
1572 return cli_err(appctx, "Variable not found\n");
1573
Willy Tarreau307dbb32022-05-05 17:45:52 +02001574 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001575 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001576 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001577 return 0;
1578}
1579
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001580/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001581 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1582 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001583 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001584static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001585{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001586 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001587 const char *c;
1588 int arg;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001589
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001590 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1591 return 1;
1592
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001593 arg = 2;
1594
1595 /* when starting with an inversion we preset every flag */
1596 if (*args[arg] == '!' || *args[arg] == '-')
1597 ctx->show_mask = CLI_SHOWFD_F_ANY;
1598
1599 while (*args[arg] && !isdigit((uchar)*args[arg])) {
1600 uint flag = 0, inv = 0;
1601 c = args[arg];
1602 while (*c) {
1603 switch (*c) {
1604 case '!': inv = !inv; break;
1605 case '-': inv = !inv; break;
1606 case 'p': flag = CLI_SHOWFD_F_PI; break;
1607 case 'l': flag = CLI_SHOWFD_F_LI; break;
1608 case 'c': flag = CLI_SHOWFD_F_CO; break;
1609 case 'f': flag = CLI_SHOWFD_F_FE; break;
1610 case 'b': flag = CLI_SHOWFD_F_BE; break;
1611 case 's': flag = CLI_SHOWFD_F_SV; break;
1612 case 'd': flag = CLI_SHOWFD_F_PX; break;
1613 default: return cli_err(appctx, "Invalid FD type\n");
1614 }
1615 c++;
1616 if (!inv)
1617 ctx->show_mask |= flag;
1618 else
1619 ctx->show_mask &= ~flag;
1620 }
1621 arg++;
1622 }
1623
1624 /* default mask is to show everything */
1625 if (!ctx->show_mask)
1626 ctx->show_mask = CLI_SHOWFD_F_ANY;
1627
1628 if (*args[arg]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001629 ctx->fd = atoi(args[2]);
1630 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001631 }
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001632
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001633 return 0;
1634}
1635
Willy Tarreau599852e2016-11-22 20:33:32 +01001636/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001637static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001638{
Willy Tarreau0698c802022-05-11 14:09:57 +02001639 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001640
1641 if (strcmp(args[2], "cli") == 0) {
1642 unsigned timeout;
1643 const char *res;
1644
Willy Tarreau9d008692019-08-09 11:21:01 +02001645 if (!*args[3])
1646 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001647
1648 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001649 if (res || timeout < 1)
1650 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001651
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01001652 s->scf->ioto = 1 + MS_TO_TICKS(timeout*1000);
Willy Tarreau599852e2016-11-22 20:33:32 +01001653 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1654 return 1;
1655 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001656
1657 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001658}
1659
Willy Tarreau2af99412016-11-23 11:10:59 +01001660/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001661static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001662{
1663 int v;
1664
1665 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1666 return 1;
1667
Willy Tarreau9d008692019-08-09 11:21:01 +02001668 if (!*args[3])
1669 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001670
1671 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001672 if (v > global.hardmaxconn)
1673 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001674
1675 /* check for unlimited values */
1676 if (v <= 0)
1677 v = global.hardmaxconn;
1678
1679 global.maxconn = v;
1680
1681 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001682 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001683
1684 return 1;
1685}
1686
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001687static int set_severity_output(int *target, char *argument)
1688{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001689 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001690 *target = CLI_SEVERITY_NONE;
1691 return 1;
1692 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001693 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001694 *target = CLI_SEVERITY_NUMBER;
1695 return 1;
1696 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001697 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001698 *target = CLI_SEVERITY_STRING;
1699 return 1;
1700 }
1701 return 0;
1702}
1703
1704/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001705static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001706{
1707 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1708 return 0;
1709
Willy Tarreau9d008692019-08-09 11:21:01 +02001710 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001711}
William Lallemandeceddf72016-12-15 18:06:44 +01001712
William Lallemand67a234f2018-12-13 09:05:45 +01001713
1714/* show the level of the current CLI session */
1715static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1716{
William Lallemand67a234f2018-12-13 09:05:45 +01001717 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001718 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001719 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001720 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001721 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001722 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001723 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001724 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001725}
1726
1727/* parse and set the CLI level dynamically */
1728static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1729{
William Lallemandad032882019-07-01 10:56:15 +02001730 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001731 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001732 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1733
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001734 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001735 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1736 return 1;
1737 }
1738 appctx->cli_level &= ~ACCESS_LVL_MASK;
1739 appctx->cli_level |= ACCESS_LVL_OPER;
1740
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001741 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001742 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1743 return 1;
1744 }
1745 appctx->cli_level &= ~ACCESS_LVL_MASK;
1746 appctx->cli_level |= ACCESS_LVL_USER;
1747 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001748 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001749 return 1;
1750}
1751
1752
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001753/* parse and set the CLI expert/experimental-mode dynamically */
1754static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001755{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001756 int level;
1757 char *level_str;
1758 char *output = NULL;
1759
William Lallemand7267f782022-02-01 16:08:50 +01001760 /* this will ask the applet to not output a \n after the command */
1761 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1762 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1763
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001764 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1765 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001766
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001767 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001768 level = ACCESS_EXPERT;
1769 level_str = "expert-mode";
1770 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001771 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001772 level = ACCESS_EXPERIMENTAL;
1773 level_str = "experimental-mode";
1774 }
William Lallemand2a171912022-02-02 11:43:20 +01001775 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1776 level = ACCESS_MCLI_DEBUG;
1777 level_str = "mcli-debug-mode";
1778 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001779 else {
1780 return 1;
1781 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001782
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001783 if (!*args[1]) {
1784 memprintf(&output, "%s is %s\n", level_str,
1785 (appctx->cli_level & level) ? "ON" : "OFF");
1786 return cli_dynmsg(appctx, LOG_INFO, output);
1787 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001788
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001789 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001790 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001791 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001792 return 1;
1793}
1794
William Lallemand740629e2021-12-14 15:22:29 +01001795/* shows HAProxy version */
1796static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1797{
1798 char *msg = NULL;
1799
1800 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1801}
1802
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001803int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001804{
1805 return 0;
1806}
1807
Erwan Le Goas54966df2022-09-14 17:24:22 +02001808/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1809static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1810{
1811 uint32_t tmp;
1812 long long key;
1813
1814 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001815
1816 if (*args[3]) {
1817 key = atoll(args[3]);
1818 if (key < 1 || key > UINT_MAX)
1819 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1820 appctx->cli_anon_key = key;
1821 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001822 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001823 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1824 if (tmp != 0)
1825 appctx->cli_anon_key = tmp;
1826 else
1827 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001828 }
1829 }
1830 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001831
1832 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001833 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1834 }
1835 else {
1836 appctx->cli_anon_key = 0;
1837 }
1838 }
1839 else {
1840 return cli_err(appctx,
1841 "'set anon' only supports :\n"
1842 " - 'on' [key] to enable the anonymized mode\n"
1843 " - 'off' to disable the anonymized mode");
1844 }
1845 return 1;
1846}
1847
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001848/* This function set the global anonyzing key, restricted to level 'admin' */
1849static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1850{
1851 long long key;
1852
1853 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1854 return cli_err(appctx, "Permission denied\n");
1855 if (!*args[2])
1856 return cli_err(appctx, "Expects an integer value.\n");
1857
1858 key = atoll(args[2]);
1859 if (key < 0 || key > UINT_MAX)
1860 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1861
1862 HA_ATOMIC_STORE(&global.anon_key, key);
1863 return 1;
1864}
1865
Erwan Le Goas54966df2022-09-14 17:24:22 +02001866/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1867static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1868{
1869 char *msg = NULL;
1870 char *anon_mode = NULL;
1871 uint32_t c_key = appctx->cli_anon_key;
1872
1873 if (!c_key)
1874 anon_mode = "Anonymized mode disabled";
1875 else
1876 anon_mode = "Anonymized mode enabled";
1877
1878 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1879 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1880 }
1881 else {
1882 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1883 }
1884
1885 return 1;
1886}
1887
Willy Tarreau45c742b2016-11-24 14:51:17 +01001888/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001889static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001890{
1891 int v;
1892 int *res;
1893 int mul = 1;
1894
1895 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1896 return 1;
1897
1898 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1899 res = &global.cps_lim;
1900 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1901 res = &global.sps_lim;
1902#ifdef USE_OPENSSL
1903 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1904 res = &global.ssl_lim;
1905#endif
1906 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1907 res = &global.comp_rate_lim;
1908 mul = 1024;
1909 }
1910 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001911 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001912 "'set rate-limit' only supports :\n"
1913 " - 'connections global' to set the per-process maximum connection rate\n"
1914 " - 'sessions global' to set the per-process maximum session rate\n"
1915#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001916 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001917#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001918 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001919 }
1920
Willy Tarreau9d008692019-08-09 11:21:01 +02001921 if (!*args[4])
1922 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001923
1924 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001925 if (v < 0)
1926 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001927
1928 *res = v * mul;
1929
1930 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001931 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001932
1933 return 1;
1934}
1935
William Lallemandf6975e92017-05-26 17:42:10 +02001936/* parse the "expose-fd" argument on the bind lines */
1937static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1938{
1939 if (!*args[cur_arg + 1]) {
1940 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1941 return ERR_ALERT | ERR_FATAL;
1942 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001943 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001944 conf->level |= ACCESS_FD_LISTENERS;
1945 } else {
1946 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1947 args[cur_arg], args[cur_arg+1]);
1948 return ERR_ALERT | ERR_FATAL;
1949 }
1950
1951 return 0;
1952}
1953
William Lallemand74c24fb2016-11-21 17:18:36 +01001954/* parse the "level" argument on the bind lines */
1955static int bind_parse_level(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 level", args[cur_arg]);
1959 return ERR_ALERT | ERR_FATAL;
1960 }
1961
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001962 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001963 conf->level &= ~ACCESS_LVL_MASK;
1964 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001965 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001966 conf->level &= ~ACCESS_LVL_MASK;
1967 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001968 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001969 conf->level &= ~ACCESS_LVL_MASK;
1970 conf->level |= ACCESS_LVL_ADMIN;
1971 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001972 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1973 args[cur_arg], args[cur_arg+1]);
1974 return ERR_ALERT | ERR_FATAL;
1975 }
1976
1977 return 0;
1978}
1979
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001980static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1981{
1982 if (!*args[cur_arg + 1]) {
1983 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1984 return ERR_ALERT | ERR_FATAL;
1985 }
1986
1987 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1988 return 0;
1989 else {
1990 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1991 args[cur_arg], args[cur_arg+1]);
1992 return ERR_ALERT | ERR_FATAL;
1993 }
1994}
1995
Olivier Houchardf886e342017-04-05 22:24:59 +02001996/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001997static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001998{
William Lallemandb5d062d2022-07-28 15:33:41 +02001999 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 char *cmsgbuf = NULL;
2001 unsigned char *tmpbuf = NULL;
2002 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02002003 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02002004 struct stream *s = __sc_strm(sc);
2005 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02002006 struct msghdr msghdr;
2007 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02002008 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002009 const char *ns_name, *if_name;
2010 unsigned char ns_nlen, if_nlen;
2011 int nb_queued;
2012 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002013 int *tmpfd;
2014 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002015 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002016 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002017 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002018 int ret;
2019
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002020 if (!remote) {
2021 ha_warning("Only works on real connections\n");
2022 goto out;
2023 }
2024
2025 fd = remote->handle.fd;
2026
Olivier Houchardf886e342017-04-05 22:24:59 +02002027 /* Temporary set the FD in blocking mode, that will make our life easier */
2028 old_fcntl = fcntl(fd, F_GETFL);
2029 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002030 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002031 goto out;
2032 }
2033 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2034 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002035 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002036 goto out;
2037 }
2038 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002039 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002040 goto out;
2041 }
Olivier Houchard54740872017-04-06 14:45:14 +02002042 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002043 iov.iov_base = &tot_fd_nb;
2044 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002045 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002046 goto out;
2047 memset(&msghdr, 0, sizeof(msghdr));
2048 /*
2049 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002050 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002051 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002052 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002053 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002054
William Lallemandb5d062d2022-07-28 15:33:41 +02002055 if (tot_fd_nb == 0) {
2056 if (already_sent)
2057 ha_warning("_getsocks: attempt to get sockets but they were already sent and closed in this process!\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002058 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002059 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002060
2061 /* First send the total number of file descriptors, so that the
2062 * receiving end knows what to expect.
2063 */
2064 msghdr.msg_iov = &iov;
2065 msghdr.msg_iovlen = 1;
2066 ret = sendmsg(fd, &msghdr, 0);
2067 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002068 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002069 goto out;
2070 }
2071
2072 /* Now send the fds */
2073 msghdr.msg_control = cmsgbuf;
2074 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2075 cmsg = CMSG_FIRSTHDR(&msghdr);
2076 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2077 cmsg->cmsg_level = SOL_SOCKET;
2078 cmsg->cmsg_type = SCM_RIGHTS;
2079 tmpfd = (int *)CMSG_DATA(cmsg);
2080
Olivier Houchardf886e342017-04-05 22:24:59 +02002081 /* For each socket, e message is sent, containing the following :
2082 * Size of the namespace name (or 0 if none), as an unsigned char.
2083 * The namespace name, if any
2084 * Size of the interface name (or 0 if none), as an unsigned char
2085 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002086 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002087 */
2088 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002089 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002090 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002091 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002092 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002093 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002094 goto out;
2095 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002096
2097 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002098 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002099 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002100 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002101 continue;
2102
2103 ns_name = if_name = "";
2104 ns_nlen = if_nlen = 0;
2105
2106 /* for now we can only retrieve namespaces and interfaces from
2107 * pure listeners.
2108 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002109 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002110 const struct listener *l = fdtab[cur_fd].owner;
2111
Willy Tarreau818a92e2020-09-03 07:50:19 +02002112 if (l->rx.settings->interface) {
2113 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002114 if_nlen = strlen(if_name);
2115 }
2116
2117#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002118 if (l->rx.settings->netns) {
2119 ns_name = l->rx.settings->netns->node.key;
2120 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002121 }
2122#endif
2123 }
2124
2125 /* put the FD into the CMSG_DATA */
2126 tmpfd[nb_queued++] = cur_fd;
2127
2128 /* first block is <ns_name_len> <ns_name> */
2129 tmpbuf[curoff++] = ns_nlen;
2130 if (ns_nlen)
2131 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2132 curoff += ns_nlen;
2133
2134 /* second block is <if_name_len> <if_name> */
2135 tmpbuf[curoff++] = if_nlen;
2136 if (if_nlen)
2137 memcpy(tmpbuf + curoff, if_name, if_nlen);
2138 curoff += if_nlen;
2139
2140 /* we used to send the listener options here before 2.3 */
2141 memset(tmpbuf + curoff, 0, sizeof(int));
2142 curoff += sizeof(int);
2143
2144 /* there's a limit to how many FDs may be sent at once */
2145 if (nb_queued == MAX_SEND_FD) {
2146 iov.iov_len = curoff;
2147 if (sendmsg(fd, &msghdr, 0) != curoff) {
2148 ha_warning("Failed to transfer sockets\n");
2149 return -1;
2150 }
2151
2152 /* Wait for an ack */
2153 do {
2154 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2155 } while (ret == -1 && errno == EINTR);
2156
2157 if (ret <= 0) {
2158 ha_warning("Unexpected error while transferring sockets\n");
2159 return -1;
2160 }
2161 curoff = 0;
2162 nb_queued = 0;
2163 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002164 }
2165
William Lallemandb5d062d2022-07-28 15:33:41 +02002166 already_sent = 1;
2167
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002168 /* flush pending stuff */
2169 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002170 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002171 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2172 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002173 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002174 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002175 goto out;
2176 }
2177 }
2178
2179out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002180 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002181 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002182 goto out;
2183 }
Christopher Faulet33af9962023-04-07 17:58:21 +02002184 se_fl_set(appctx->sedesc, SE_FL_EOI);
Olivier Houchardf886e342017-04-05 22:24:59 +02002185 appctx->st0 = CLI_ST_END;
2186 free(cmsgbuf);
2187 free(tmpbuf);
2188 return 1;
2189}
2190
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002191static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2192{
2193 if (*args[0] == 'h')
2194 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002195 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002196 else if (*args[0] == 'p')
2197 /* prompt */
Willy Tarreau22555572023-05-04 14:22:36 +02002198 if (strcmp(args[1], "timed") == 0) {
2199 appctx->st1 |= APPCTX_CLI_ST1_PROMPT;
2200 appctx->st1 ^= APPCTX_CLI_ST1_TIMED;
2201 }
2202 else
2203 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
Christopher Faulet33af9962023-04-07 17:58:21 +02002204 else if (*args[0] == 'q') {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002205 /* quit */
Christopher Faulet33af9962023-04-07 17:58:21 +02002206 se_fl_set(appctx->sedesc, SE_FL_EOI);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002207 appctx->st0 = CLI_ST_END;
Christopher Faulet33af9962023-04-07 17:58:21 +02002208 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002209
2210 return 1;
2211}
Olivier Houchardf886e342017-04-05 22:24:59 +02002212
William Lallemand2f4ce202018-10-26 14:47:47 +02002213void pcli_write_prompt(struct stream *s)
2214{
2215 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002216 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002217
William Lallemanddc12c2e2018-12-13 09:05:46 +01002218 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002219 return;
2220
William Lallemanddc12c2e2018-12-13 09:05:46 +01002221 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002222 chunk_appendf(msg, "+ ");
2223 } else {
2224 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002225 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002226 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002227 else
William Lallemanddae12c72022-02-02 14:13:54 +01002228 chunk_appendf(msg, "%d", s->pcli_next_pid);
2229
2230 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2231 chunk_appendf(msg, "(");
2232
2233 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2234 chunk_appendf(msg, "x");
2235
2236 if (s->pcli_flags & ACCESS_EXPERT)
2237 chunk_appendf(msg, "e");
2238
2239 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2240 chunk_appendf(msg, "d");
2241
2242 chunk_appendf(msg, ")");
2243 }
2244
2245 chunk_appendf(msg, "> ");
2246
2247
William Lallemandebf61802018-12-11 16:10:57 +01002248 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002249 co_inject(oc, msg->area, msg->data);
2250}
2251
William Lallemand291810d2018-10-26 14:47:38 +02002252
William Lallemandcf62f7e2018-10-26 14:47:40 +02002253/* The pcli_* functions are used for the CLI proxy in the master */
2254
William Lallemanddeeaa592018-10-26 14:47:48 +02002255void pcli_reply_and_close(struct stream *s, const char *msg)
2256{
2257 struct buffer *buf = get_trash_chunk();
2258
2259 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002260 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002261}
2262
William Lallemand291810d2018-10-26 14:47:38 +02002263static enum obj_type *pcli_pid_to_server(int proc_pid)
2264{
2265 struct mworker_proc *child;
2266
William Lallemand99e0bb92020-11-05 10:28:53 +01002267 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002268 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002269 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002270
William Lallemand291810d2018-10-26 14:47:38 +02002271 list_for_each_entry(child, &proc_list, list) {
2272 if (child->pid == proc_pid){
2273 return &child->srv->obj_type;
2274 }
2275 }
2276 return NULL;
2277}
2278
2279/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2280 * Return:
2281 * 0: master
2282 * > 0: pid of a worker
2283 * < 0: didn't find a worker
2284 */
2285static int pcli_prefix_to_pid(const char *prefix)
2286{
2287 int proc_pid;
2288 struct mworker_proc *child;
2289 char *errtol = NULL;
2290
2291 if (*prefix != '@') /* not a prefix, should not happen */
2292 return -1;
2293
2294 prefix++;
2295 if (!*prefix) /* sent @ alone, return the master */
2296 return 0;
2297
2298 if (strcmp("master", prefix) == 0) {
2299 return 0;
2300 } else if (*prefix == '!') {
2301 prefix++;
2302 if (!*prefix)
2303 return -1;
2304
2305 proc_pid = strtol(prefix, &errtol, 10);
2306 if (*errtol != '\0')
2307 return -1;
2308 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002309 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002310 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002311 if (child->pid == proc_pid){
2312 return child->pid;
2313 }
2314 }
2315 } else {
2316 struct mworker_proc *chosen = NULL;
2317 /* this is a relative pid */
2318
2319 proc_pid = strtol(prefix, &errtol, 10);
2320 if (*errtol != '\0')
2321 return -1;
2322
2323 if (proc_pid == 0) /* return the master */
2324 return 0;
2325
William Lallemandbac3a822022-07-20 14:30:56 +02002326 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2327 return -1;
2328
William Lallemand291810d2018-10-26 14:47:38 +02002329 /* chose the right process, the current one is the one with the
2330 least number of reloads */
2331 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002332 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002333 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002334 if (child->reloads == 0)
2335 return child->pid;
2336 else if (chosen == NULL || child->reloads < chosen->reloads)
2337 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002338 }
2339 if (chosen)
2340 return chosen->pid;
2341 }
2342 return -1;
2343}
2344
William Lallemandbddd33a2018-12-11 16:10:53 +01002345/* Return::
2346 * >= 0 : number of words to escape
2347 * = -1 : error
2348 */
2349
2350int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2351{
2352 if (argl < 1)
2353 return 0;
2354
2355 /* there is a prefix */
2356 if (args[0][0] == '@') {
2357 int target_pid = pcli_prefix_to_pid(args[0]);
2358
2359 if (target_pid == -1) {
2360 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2361 return -1;
2362 }
2363
2364 /* if the prefix is alone, define a default target */
2365 if (argl == 1)
2366 s->pcli_next_pid = target_pid;
2367 else
2368 *next_pid = target_pid;
2369 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002370 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002371 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002372 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002373
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002374 } else if (strcmp("quit", args[0]) == 0) {
Christopher Faulet12762f02023-04-13 15:40:10 +02002375 sc_schedule_abort(s->scf);
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002376 sc_schedule_shutdown(s->scf);
William Lallemand5f610682018-12-11 16:10:55 +01002377 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002378 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002379 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2380 memprintf(errmsg, "Permission denied!\n");
2381 return -1;
2382 }
2383 s->pcli_flags &= ~ACCESS_LVL_MASK;
2384 s->pcli_flags |= ACCESS_LVL_OPER;
2385 return argl;
2386
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002387 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002388 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2389 memprintf(errmsg, "Permission denied!\n");
2390 return -1;
2391 }
2392 s->pcli_flags &= ~ACCESS_LVL_MASK;
2393 s->pcli_flags |= ACCESS_LVL_USER;
2394 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002395
2396 } else if (strcmp(args[0], "expert-mode") == 0) {
2397 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2398 memprintf(errmsg, "Permission denied!\n");
2399 return -1;
2400 }
2401
2402 s->pcli_flags &= ~ACCESS_EXPERT;
2403 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2404 s->pcli_flags |= ACCESS_EXPERT;
2405 return argl;
2406
2407 } else if (strcmp(args[0], "experimental-mode") == 0) {
2408 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2409 memprintf(errmsg, "Permission denied!\n");
2410 return -1;
2411 }
2412 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2413 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2414 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2415 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002416 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2417 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2418 memprintf(errmsg, "Permission denied!\n");
2419 return -1;
2420 }
2421 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2422 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2423 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2424 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002425 }
2426
2427 return 0;
2428}
2429
2430/*
2431 * Parse the CLI request:
2432 * - It does basically the same as the cli_io_handler, but as a proxy
2433 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434 *
2435 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002436 * - the number of characters to forward or
2437 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002438 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002439int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002440{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002441 char *str;
2442 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002443 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002444 int argl; /* number of args */
2445 char *p;
2446 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002447 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 int wtrim = 0; /* number of words to trim */
2449 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002450 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002451 int i = 0;
2452
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002453 /* we cannot deal with a wrapping buffer, so let's take care of this
2454 * first.
2455 */
2456 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2457 b_slow_realign(&req->buf, trash.area, co_data(req));
2458
2459 str = (char *)ci_head(req);
2460 end = (char *)ci_stop(req);
2461
William Lallemandbddd33a2018-12-11 16:10:53 +01002462 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002463
William Lallemanddc12c2e2018-12-13 09:05:46 +01002464 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002465
2466 /* Looks for the end of one command */
2467 while (p+reql < end) {
2468 /* handle escaping */
2469 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002470 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002471 continue;
2472 }
2473 if (p[reql] == ';' || p[reql] == '\n') {
2474 /* found the end of the command */
2475 p[reql] = '\n';
2476 reql++;
2477 break;
2478 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002479 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002480 }
William Lallemandebf61802018-12-11 16:10:57 +01002481 } else {
2482 while (p+reql < end) {
2483 if (p[reql] == '\n') {
2484 /* found the end of the line */
2485 reql++;
2486 break;
2487 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002488 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002489 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002490 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002491
William Lallemandbddd33a2018-12-11 16:10:53 +01002492 /* set end to first byte after the end of the command */
2493 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002494
William Lallemandbddd33a2018-12-11 16:10:53 +01002495 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002496 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002497 return -1;
2498 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002499
William Lallemand3301f3e2018-12-13 09:05:48 +01002500 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2501 if (reql == 1) /* last line of the payload */
2502 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002503 return reql;
2504 }
2505
William Lallemandbddd33a2018-12-11 16:10:53 +01002506 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002507
William Lallemandbddd33a2018-12-11 16:10:53 +01002508 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002509 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002510 /* skip leading spaces/tabs */
2511 p += strspn(p, " \t");
2512 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002513 break;
2514
William Lallemandbddd33a2018-12-11 16:10:53 +01002515 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002516 while (1) {
2517 p += strcspn(p, " \t\\");
2518 /* escaped chars using backlashes (\) */
2519 if (*p == '\\') {
2520 if (!*++p)
2521 break;
2522 if (!*++p)
2523 break;
2524 } else {
2525 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002526 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002527 }
William Lallemandfe249c32020-06-18 18:03:57 +02002528 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002529 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002530 }
2531
William Lallemandbddd33a2018-12-11 16:10:53 +01002532 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002533
Willy Tarreauf14c7572021-03-13 10:59:23 +01002534 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002535 args[i] = NULL;
2536
2537 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2538
2539 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002540 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002541 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002542 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002543 if (*p == '\0')
2544 *p = ' ';
2545 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002546 }
2547
William Lallemand3301f3e2018-12-13 09:05:48 +01002548 payload = strstr(str, PAYLOAD_PATTERN);
2549 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2550 /* if the payload pattern is at the end */
2551 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002552 }
2553
William Lallemandbddd33a2018-12-11 16:10:53 +01002554 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002555
William Lallemandbddd33a2018-12-11 16:10:53 +01002556 if (wtrim > 0) {
2557 trim = &args[wtrim][0];
2558 if (trim == NULL) /* if this was the last word in the table */
2559 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002560
William Lallemandbddd33a2018-12-11 16:10:53 +01002561 b_del(&req->buf, trim - str);
2562
William Lallemandb7ea1412018-12-13 09:05:47 +01002563 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002564 } else if (wtrim < 0) {
2565 /* parsing error */
2566 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002567 } else {
2568 /* the whole string */
2569 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002570 }
2571
William Lallemandb7ea1412018-12-13 09:05:47 +01002572 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002573
2574 /* the mcli-debug-mode is only sent to the applet of the master */
2575 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2576 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2577 ret += strlen("mcli-debug-mode on -") + 2;
2578 }
William Lallemand7267f782022-02-01 16:08:50 +01002579 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2580 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2581 ret += strlen("experimental-mode on -") + 2;
2582 }
2583 if (s->pcli_flags & ACCESS_EXPERT) {
2584 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2585 ret += strlen("expert-mode on -") + 2;
2586 }
2587
William Lallemandb7ea1412018-12-13 09:05:47 +01002588 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2589 goto end;
2590 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002591 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2592 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002593 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002594 ci_insert_line2(req, 0, "user -", strlen("user -"));
2595 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002596 }
2597 }
2598end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002599
William Lallemandb7ea1412018-12-13 09:05:47 +01002600 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002601}
2602
2603int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2604{
William Lallemandbddd33a2018-12-11 16:10:53 +01002605 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002606 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002607 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002608
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002609 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002610 * current one. Just wait. At this stage, errors should be handled by
2611 * the response analyzer.
2612 */
2613 if (s->res.analysers & AN_RES_WAIT_CLI)
2614 return 0;
2615
William Lallemandb7ea1412018-12-13 09:05:47 +01002616 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2617 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2618
William Lallemand0a0512f2022-09-24 16:14:50 +02002619 /* stream that comes from the reload listener only responses the reload
2620 * status and quits */
2621 if (!(s->pcli_flags & PCLI_F_RELOAD)
2622 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2623 goto send_status;
2624
2625
William Lallemandcf62f7e2018-10-26 14:47:40 +02002626read_again:
2627 /* if the channel is closed for read, we won't receive any more data
2628 from the client, but we don't want to forward this close to the
2629 server */
2630 channel_dont_close(req);
2631
2632 /* We don't know yet to which server we will connect */
2633 channel_dont_connect(req);
2634
Christopher Faulet9a790f62023-03-16 14:40:03 +01002635 s->scf->flags |= SC_FL_RCV_ONCE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002636
2637 /* need more data */
2638 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002639 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002640
2641 /* If there is data available for analysis, log the end of the idle time. */
2642 if (c_data(req) && s->logs.t_idle == -1)
Willy Tarreau69530f52023-04-28 09:16:15 +02002643 s->logs.t_idle = ns_to_ms(now_ns - s->logs.accept_ts) - s->logs.t_handshake;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002644
William Lallemandbddd33a2018-12-11 16:10:53 +01002645 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002646 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002647 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002648 /* enough data */
2649
William Lallemandcf62f7e2018-10-26 14:47:40 +02002650 /* forward only 1 command */
2651 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002652
William Lallemanddc12c2e2018-12-13 09:05:46 +01002653 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002654 /* we send only 1 command per request, and we write close after it */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002655 sc_schedule_shutdown(s->scb);
William Lallemandebf61802018-12-11 16:10:57 +01002656 } else {
2657 pcli_write_prompt(s);
2658 }
2659
2660 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002661 s->res.analysers |= AN_RES_WAIT_CLI;
2662
William Lallemandebf61802018-12-11 16:10:57 +01002663 if (!(s->flags & SF_ASSIGNED)) {
2664 if (next_pid > -1)
2665 target_pid = next_pid;
2666 else
2667 target_pid = s->pcli_next_pid;
2668 /* we can connect now */
2669 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002670
William Lallemanddcbe7b92021-12-10 14:14:53 +01002671 if (!s->target)
2672 goto server_disconnect;
2673
William Lallemandebf61802018-12-11 16:10:57 +01002674 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2675 channel_auto_connect(req);
2676 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002677
2678 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002679 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002680 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002681 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002682 } else if (to_forward == -1) {
2683 if (errmsg) {
2684 /* there was an error during the parsing */
2685 pcli_reply_and_close(s, errmsg);
2686 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2687 return 0;
2688 }
2689 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002690 }
2691
2692 return 0;
2693
2694send_help:
2695 b_reset(&req->buf);
2696 b_putblk(&req->buf, "help\n", 5);
2697 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002698
William Lallemand0a0512f2022-09-24 16:14:50 +02002699send_status:
2700 s->pcli_flags |= PCLI_F_RELOAD;
Willy Tarreaudd9f9212023-05-07 07:07:44 +02002701 /* don't use ci_putblk here because SHUT_DONE could have been sent */
William Lallemand0a0512f2022-09-24 16:14:50 +02002702 b_reset(&req->buf);
2703 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2704 goto read_again;
2705
Christopher Faulet0f727da2022-01-18 08:44:23 +01002706missing_data:
Christopher Fauletca5309a2023-04-17 16:17:32 +02002707 if (s->scf->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
Christopher Faulet0f727da2022-01-18 08:44:23 +01002708 /* There is no more request or a only a partial one and we
2709 * receive a close from the client, we can leave */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002710 sc_schedule_shutdown(s->scf);
Christopher Faulet0f727da2022-01-18 08:44:23 +01002711 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2712 return 1;
2713 }
2714 else if (channel_full(req, global.tune.maxrewrite)) {
2715 /* buffer is full and we didn't catch the end of a command */
2716 goto send_help;
2717 }
2718 return 0;
2719
William Lallemanddcbe7b92021-12-10 14:14:53 +01002720server_disconnect:
2721 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2722 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002723}
2724
2725int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2726{
2727 struct proxy *fe = strm_fe(s);
2728 struct proxy *be = s->be;
2729
Christopher Fauletd7bac882023-04-14 12:05:55 +02002730 if ((s->scb->flags & SC_FL_ERROR) || (rep->flags & (CF_READ_TIMEOUT|CF_WRITE_TIMEOUT)) ||
Christopher Faulet64350bb2023-04-13 16:37:37 +02002731 ((s->scf->flags & SC_FL_SHUT_DONE) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002732 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002733 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002734 s->res.analysers &= ~AN_RES_WAIT_CLI;
2735 return 0;
2736 }
Christopher Faulet9a790f62023-03-16 14:40:03 +01002737 s->scb->flags |= SC_FL_RCV_ONCE; /* try to get back here ASAP */
Christopher Faulet68ef2182023-03-17 15:38:18 +01002738 s->scf->flags |= SC_FL_SND_NEVERWAIT;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002739
2740 /* don't forward the close */
2741 channel_dont_close(&s->res);
2742 channel_dont_close(&s->req);
2743
William Lallemanddc12c2e2018-12-13 09:05:46 +01002744 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002745 s->res.analysers &= ~AN_RES_WAIT_CLI;
2746 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2747 return 0;
2748 }
2749
William Lallemandcf62f7e2018-10-26 14:47:40 +02002750 /* forward the data */
2751 if (ci_data(rep)) {
2752 c_adv(rep, ci_data(rep));
2753 return 0;
2754 }
2755
Christopher Fauletca5309a2023-04-17 16:17:32 +02002756 if (s->scb->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002757 /* stream cleanup */
2758
William Lallemand2f4ce202018-10-26 14:47:47 +02002759 pcli_write_prompt(s);
2760
Willy Tarreaucb041662022-05-17 19:44:42 +02002761 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Christopher Fauletcfc11c02023-04-13 16:10:23 +02002762 sc_abort(s->scb);
Christopher Fauletb2b1c3a2023-04-13 16:23:48 +02002763 sc_shutdown(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002764
2765 /*
2766 * starting from there this the same code as
2767 * http_end_txn_clean_session().
2768 *
2769 * It allows to do frontend keepalive while reconnecting to a
2770 * new server for each request.
2771 */
2772
2773 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002774 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002775 if (unlikely(s->srv_conn))
2776 sess_change_server(s, NULL);
2777 }
2778
Willy Tarreau69530f52023-04-28 09:16:15 +02002779 s->logs.t_close = ns_to_ms(now_ns - s->logs.accept_ts);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002780 stream_process_counters(s);
2781
2782 /* don't count other requests' data */
2783 s->logs.bytes_in -= ci_data(&s->req);
2784 s->logs.bytes_out -= ci_data(&s->res);
2785
2786 /* we may need to know the position in the queue */
2787 pendconn_free(s);
2788
2789 /* let's do a final log if we need it */
2790 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2791 !(s->flags & SF_MONITOR) &&
2792 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2793 s->do_log(s);
2794 }
2795
2796 /* stop tracking content-based counters */
2797 stream_stop_content_counters(s);
2798 stream_update_time_stats(s);
2799
2800 s->logs.accept_date = date; /* user-visible date for logging */
Willy Tarreau69530f52023-04-28 09:16:15 +02002801 s->logs.accept_ts = now_ns; /* corrected date for internal use */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002802 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2803 s->logs.t_idle = -1;
Willy Tarreauad5a5f62023-04-27 09:46:02 +02002804 s->logs.request_ts = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002805 s->logs.t_queue = -1;
2806 s->logs.t_connect = -1;
2807 s->logs.t_data = -1;
2808 s->logs.t_close = 0;
2809 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2810 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2811
2812 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2813 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2814
2815 stream_del_srv_conn(s);
2816 if (objt_server(s->target)) {
2817 if (s->flags & SF_CURR_SESS) {
2818 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002819 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002820 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002821 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002822 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002823 }
2824
2825 s->target = NULL;
2826
2827 /* only release our endpoint if we don't intend to reuse the
2828 * connection.
2829 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002830 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002831 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002832 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002833 if (!s->conn_err_type)
2834 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002835 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002836 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002837 return 1;
2838 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002839 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002840 }
2841
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002842 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002843
Willy Tarreau74568cf2022-05-27 09:03:30 +02002844 sc_set_state(s->scb, SC_ST_INI);
Christopher Fauleta1d14a72023-04-14 10:42:08 +02002845 s->scb->flags &= ~(SC_FL_ERROR|SC_FL_SHUT_DONE|SC_FL_SHUT_WANTED);
Willy Tarreaucb041662022-05-17 19:44:42 +02002846 s->scb->flags &= SC_FL_ISBACK | SC_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet87633c32023-04-03 18:32:50 +02002847
2848 s->req.flags &= ~(CF_AUTO_CONNECT|CF_STREAMER|CF_STREAMER_FAST|CF_WROTE_DATA);
2849 s->res.flags &= ~(CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_EVENT|CF_WROTE_DATA|CF_READ_EVENT);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002850 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002851 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2852 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002853 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002854 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002855 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002856 /* reinitialise the current rule list pointer to NULL. We are sure that
2857 * any rulelist match the NULL pointer.
2858 */
2859 s->current_rule_list = NULL;
2860
2861 s->be = strm_fe(s);
2862 s->logs.logwait = strm_fe(s)->to_log;
2863 s->logs.level = 0;
2864 stream_del_srv_conn(s);
2865 s->target = NULL;
2866 /* re-init store persistence */
2867 s->store_count = 0;
2868 s->uniq_id = global.req_count++;
2869
Christopher Fauletca5309a2023-04-17 16:17:32 +02002870 s->scf->flags &= ~(SC_FL_EOS|SC_FL_ERROR|SC_FL_ABRT_DONE|SC_FL_ABRT_WANTED);
Christopher Faulet68ef2182023-03-17 15:38:18 +01002871 s->scf->flags &= ~SC_FL_SND_NEVERWAIT;
Christopher Faulet9a790f62023-03-16 14:40:03 +01002872 s->scf->flags |= SC_FL_RCV_ONCE; /* one read is usually enough */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002873
2874 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2875
William Lallemandcf62f7e2018-10-26 14:47:40 +02002876 s->res.analysers &= ~AN_RES_WAIT_CLI;
2877
2878 /* We must trim any excess data from the response buffer, because we
2879 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002880 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002881 * we want those data to come along with next response. A typical
2882 * example of such data would be from a buggy server responding to
2883 * a HEAD with some data, or sending more than the advertised
2884 * content-length.
2885 */
2886 if (unlikely(ci_data(&s->res)))
2887 b_set_data(&s->res.buf, co_data(&s->res));
2888
2889 /* Now we can realign the response buffer */
2890 c_realign_if_empty(&s->res);
2891
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01002892 s->scf->ioto = strm_fe(s)->timeout.client;
2893 s->scb->ioto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002894
William Lallemandcf62f7e2018-10-26 14:47:40 +02002895 s->req.analyse_exp = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002896 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet15315d62023-02-20 08:23:51 +01002897
William Lallemandcf62f7e2018-10-26 14:47:40 +02002898 /* we're removing the analysers, we MUST re-enable events detection.
2899 * We don't enable close on the response channel since it's either
2900 * already closed, or in keep-alive with an idle connection handler.
2901 */
2902 channel_auto_read(&s->req);
2903 channel_auto_close(&s->req);
2904 channel_auto_read(&s->res);
2905
2906
2907 return 1;
2908 }
2909 return 0;
2910}
2911
William Lallemand8a022572018-10-26 14:47:35 +02002912/*
2913 * The mworker functions are used to initialize the CLI in the master process
2914 */
2915
William Lallemand309dc9a2018-10-26 14:47:45 +02002916 /*
2917 * Stop the mworker proxy
2918 */
2919void mworker_cli_proxy_stop()
2920{
William Lallemand550db6d2018-11-06 17:37:12 +01002921 if (mworker_proxy)
2922 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002923}
2924
William Lallemand8a022572018-10-26 14:47:35 +02002925/*
2926 * Create the mworker CLI proxy
2927 */
2928int mworker_cli_proxy_create()
2929{
2930 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002931 char *msg = NULL;
2932 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002933
William Lallemandae787ba2021-07-29 15:13:22 +02002934 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002935 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002936 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002937
William Lallemandcf62f7e2018-10-26 14:47:40 +02002938 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002939 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2940 mworker_proxy->timeout.client = 0; /* no timeout */
2941 mworker_proxy->conf.file = strdup("MASTER");
2942 mworker_proxy->conf.line = 0;
2943 mworker_proxy->accept = frontend_accept;
2944 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2945
2946 /* Does not init the default target the CLI applet, but must be done in
2947 * the request parsing code */
2948 mworker_proxy->default_target = NULL;
2949
William Lallemand8a022572018-10-26 14:47:35 +02002950 /* create all servers using the mworker_proc list */
2951 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002952 struct server *newsrv = NULL;
2953 struct sockaddr_storage *sk;
2954 int port1, port2, port;
2955 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002956
William Lallemanda31b09e2020-01-14 15:25:02 +01002957 /* only the workers support the master CLI */
2958 if (!(child->options & PROC_O_TYPE_WORKER))
2959 continue;
2960
William Lallemand8a022572018-10-26 14:47:35 +02002961 newsrv = new_server(mworker_proxy);
2962 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002963 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002964
2965 /* we don't know the new pid yet */
2966 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002967 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002968 else
2969 memprintf(&msg, "old-%d", child->pid);
2970
2971 newsrv->next = mworker_proxy->srv;
2972 mworker_proxy->srv = newsrv;
2973 newsrv->conf.file = strdup(msg);
2974 newsrv->id = strdup(msg);
2975 newsrv->conf.line = 0;
2976
2977 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002978 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002979 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002980 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002981 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002982 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002983
Willy Tarreau5fc93282020-09-16 18:25:03 +02002984 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002985 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002986 }
2987
2988 /* no port specified */
2989 newsrv->flags |= SRV_F_MAPPORTS;
2990 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002991 /* don't let the server participate to load balancing */
2992 newsrv->iweight = 0;
2993 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002994 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002995
2996 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002997 }
William Lallemandae787ba2021-07-29 15:13:22 +02002998
2999 mworker_proxy->next = proxies_list;
3000 proxies_list = mworker_proxy;
3001
William Lallemand8a022572018-10-26 14:47:35 +02003002 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003003
3004error:
William Lallemand744a0892018-11-22 16:46:51 +01003005
3006 list_for_each_entry(child, &proc_list, list) {
3007 free((char *)child->srv->conf.file); /* cast because of const char * */
3008 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003009 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01003010 }
William Lallemandae787ba2021-07-29 15:13:22 +02003011 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01003012 free(msg);
3013
William Lallemandae787ba2021-07-29 15:13:22 +02003014error_proxy:
3015 ha_alert("%s\n", errmsg);
3016 free(errmsg);
3017
William Lallemand744a0892018-11-22 16:46:51 +01003018 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02003019}
Olivier Houchardf886e342017-04-05 22:24:59 +02003020
William Lallemandce83b4a2018-10-26 14:47:30 +02003021/*
William Lallemande7361152018-10-26 14:47:36 +02003022 * Create a new listener for the master CLI proxy
3023 */
William Lallemand21623b52022-09-24 15:51:27 +02003024struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02003025{
3026 struct bind_conf *bind_conf;
3027 struct listener *l;
3028 char *err = NULL;
3029 char *args[MAX_LINE_ARGS + 1];
3030 int arg;
3031 int cur_arg;
3032
William Lallemand2e945c82019-11-25 09:58:37 +01003033 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02003034 args[0] = line;
3035
3036 /* args is a bind configuration with spaces replaced by commas */
3037 while (*line && arg < MAX_LINE_ARGS) {
3038
3039 if (*line == ',') {
3040 *line++ = '\0';
3041 while (*line == ',')
3042 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01003043 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02003044 }
3045 line++;
3046 }
3047
William Lallemand2e945c82019-11-25 09:58:37 +01003048 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02003049
3050 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003051 if (!bind_conf)
3052 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003053
3054 bind_conf->level &= ~ACCESS_LVL_MASK;
3055 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003056 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003057
3058 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3059 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003060 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003061 }
3062
3063 cur_arg = 1;
3064
3065 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003066 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003067 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003068
3069 kw = bind_find_kw(args[cur_arg]);
3070 if (kw) {
3071 if (!kw->parse) {
3072 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3073 args[0], args[1], args[cur_arg]);
3074 goto err;
3075 }
3076
Willy Tarreau4975d142021-03-13 11:00:33 +01003077 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003078 if (err)
3079 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3080 else
3081 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3082 args[0], args[1], args[cur_arg]);
3083 goto err;
3084 }
3085
3086 cur_arg += 1 + kw->skip;
3087 continue;
3088 }
3089
Willy Tarreau433b05f2021-03-12 10:14:07 +01003090 best = bind_find_best_kw(args[cur_arg]);
3091 if (best)
3092 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3093 args[0], args[1], args[cur_arg], best);
3094 else
3095 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3096 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003097 goto err;
3098 }
3099
3100
Willy Tarreau30836152023-01-12 19:10:17 +01003101 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003102 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003103 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003104
William Lallemande7361152018-10-26 14:47:36 +02003105 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18c20d22020-10-09 16:11:46 +02003106 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003107 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003108 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003109 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003110
William Lallemand21623b52022-09-24 15:51:27 +02003111 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003112
3113err:
3114 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003115 free(err);
3116 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003117 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003118
3119}
3120
3121/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003122 * Create a new CLI socket using a socketpair for a worker process
3123 * <mworker_proc> is the process structure, and <proc> is the process number
3124 */
3125int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3126{
3127 struct bind_conf *bind_conf;
3128 struct listener *l;
3129 char *path = NULL;
3130 char *err = NULL;
3131
3132 /* master pipe to ensure the master is still alive */
3133 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3134 ha_alert("Cannot create worker socketpair.\n");
3135 return -1;
3136 }
3137
3138 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003139 if (!global.cli_fe) {
3140 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003141 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003142 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003143 }
3144 }
3145
Willy Tarreau4975d142021-03-13 11:00:33 +01003146 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003147 if (!bind_conf)
3148 goto error;
3149
William Lallemandce83b4a2018-10-26 14:47:30 +02003150 bind_conf->level &= ~ACCESS_LVL_MASK;
3151 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003152 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003153
William Lallemandce83b4a2018-10-26 14:47:30 +02003154 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3155 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003156 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003157 }
3158
Willy Tarreau4975d142021-03-13 11:00:33 +01003159 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003160 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003161 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003162 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003163 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003164 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003165
Willy Tarreau30836152023-01-12 19:10:17 +01003166 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003167 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003168 bind_conf->options |= BC_O_UNLIMITED | BC_O_NOSTOP;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003169
William Lallemandce83b4a2018-10-26 14:47:30 +02003170 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003171 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003172 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003173 l->rx.flags &= ~RX_F_INHERITED;
Willy Tarreau18215cb2019-02-27 16:25:28 +01003174 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003175 }
3176
3177 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003178
3179error:
3180 close(mworker_proc->ipc_fd[0]);
3181 close(mworker_proc->ipc_fd[1]);
3182 free(err);
3183
3184 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003185}
3186
William Lallemand74c24fb2016-11-21 17:18:36 +01003187static struct applet cli_applet = {
3188 .obj_type = OBJ_TYPE_APPLET,
3189 .name = "<CLI>", /* used for logging */
3190 .fct = cli_io_handler,
3191 .release = cli_release_handler,
3192};
3193
William Lallemand99e0bb92020-11-05 10:28:53 +01003194/* master CLI */
3195static struct applet mcli_applet = {
3196 .obj_type = OBJ_TYPE_APPLET,
3197 .name = "<MCLI>", /* used for logging */
3198 .fct = cli_io_handler,
3199 .release = cli_release_handler,
3200};
3201
Willy Tarreau0a739292016-11-22 20:21:23 +01003202/* register cli keywords */
3203static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003204 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3205 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3206 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3207 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003208 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3209 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003210 { { "mcli-debug-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER_ONLY }, // not listed
Amaury Denoyelledd3a33f2023-03-03 17:11:10 +01003211 { { "set", "anon", "on" }, "set anon on [value] : activate the anonymized mode", cli_parse_set_anon, NULL, NULL },
3212 { { "set", "anon", "off" }, "set anon off : deactivate the anonymized mode", cli_parse_set_anon, NULL, NULL },
Erwan Le Goasd7869312022-09-29 10:36:11 +02003213 { { "set", "anon", "global-key", NULL }, "set anon global-key <value> : change the global anonymizing key", cli_parse_set_global_key, NULL, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003214 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3215 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3216 { { "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 },
3217 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Erwan Le Goas54966df2022-09-14 17:24:22 +02003218 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003219 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3220 { { "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 },
3221 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau1cb041a2023-03-31 16:33:53 +02003222 { { "show", "fd", NULL }, "show fd [-!plcfbsd]* [num] : dump list of file descriptors in use or a specific one", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003223 { { "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 +02003224 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3225 { { "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 +01003226 {{},}
3227}};
3228
Willy Tarreau0108d902018-11-25 19:14:37 +01003229INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3230
William Lallemand74c24fb2016-11-21 17:18:36 +01003231static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003232 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003233 { 0, NULL, NULL },
3234}};
3235
Willy Tarreau0108d902018-11-25 19:14:37 +01003236INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3237
William Lallemand74c24fb2016-11-21 17:18:36 +01003238static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003239 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3240 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003241 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003242 { NULL, NULL, 0 },
3243}};
3244
Willy Tarreau0108d902018-11-25 19:14:37 +01003245INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003246
3247/*
3248 * Local variables:
3249 * c-indent-level: 8
3250 * c-basic-offset: 8
3251 * End:
3252 */