blob: 5635ea8263dfe74da7ee5b3ea89916789b829398 [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020031#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020032#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020038#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020039#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020042#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020043#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020044#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020045#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020046#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010047#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020048#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020049#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020050#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020051#include <haproxy/pipe.h>
52#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020053#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020054#include <haproxy/sample-t.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020055#include <haproxy/sc_strm.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020056#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020057#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020058#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020059#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020060#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020061#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020062#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020063#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020064#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020065#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020066#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010067
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020068#define PAYLOAD_PATTERN "<<"
69
William Lallemand74c24fb2016-11-21 17:18:36 +010070static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010071static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010072
Willy Tarreau4975d142021-03-13 11:00:33 +010073static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010074 "Permission denied\n"
75 "";
76
77
Christopher Faulet1bc04c72017-10-29 20:14:08 +010078static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010079
80/* List head of cli keywords */
81static struct cli_kw_list cli_keywords = {
82 .list = LIST_HEAD_INIT(cli_keywords.list)
83};
84
85extern const char *stat_status_codes[];
86
Eric Salama1b8dacc2021-03-16 15:12:17 +010087struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand56f73b22022-09-24 15:56:25 +020088struct bind_conf *mcli_reload_bind_conf;
William Lallemand8a022572018-10-26 14:47:35 +020089
Willy Tarreau9a7fa902022-07-15 16:51:16 +020090/* CLI context for the "show activity" command */
91struct show_activity_ctx {
92 int thr; /* thread ID to show or -1 for all */
93};
94
Willy Tarreau307dbb32022-05-05 17:45:52 +020095/* CLI context for the "show env" command */
96struct show_env_ctx {
97 char **var; /* first variable to show */
98 int show_one; /* stop after showing the first one */
99};
100
Willy Tarreau741a5a92022-05-05 17:56:58 +0200101/* CLI context for the "show fd" command */
102struct show_fd_ctx {
103 int fd; /* first FD to show */
104 int show_one; /* stop after showing one FD */
105};
106
Willy Tarreaub128f492022-05-05 19:11:05 +0200107/* CLI context for the "show cli sockets" command */
108struct show_sock_ctx {
109 struct bind_conf *bind_conf;
110 struct listener *listener;
111};
112
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200113static int cmp_kw_entries(const void *a, const void *b)
114{
115 const struct cli_kw *l = *(const struct cli_kw **)a;
116 const struct cli_kw *r = *(const struct cli_kw **)b;
117
118 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
119}
120
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100121/* This will show the help message and list the commands supported at the
122 * current level that match all of the first words of <args> if args is not
123 * NULL, or all args if none matches or if args is null.
124 */
125static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100126{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200127 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100128 struct cli_kw_list *kw_list;
129 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200130 struct buffer *tmp = get_trash_chunk();
131 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100132 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100133 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200134 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100135 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200136 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100137
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100138 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100139
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200140 if (args && *args && strcmp(*args, "help") == 0) {
141 args++;
142 ishelp = 1;
143 }
144
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100145 /* first, let's measure the longest match */
146 list_for_each_entry(kw_list, &cli_keywords.list, list) {
147 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100148 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100149 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100150 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
151 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100152 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
153 continue;
154
155 /* OK this command is visible */
156 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
157 if (!kw->str_kw[idx])
158 break; // end of keyword
159 if (!args || !args[idx] || !*args[idx])
160 break; // end of command line
161 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
162 break;
163 if (idx + 1 > length)
164 length = idx + 1;
165 }
166 }
167 }
168
Willy Tarreaub7364582021-03-12 18:24:46 +0100169 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100170 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200171 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100172 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200173 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100174 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
175 else // partial match
176 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
177
Willy Tarreaub7364582021-03-12 18:24:46 +0100178 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
179 matches[idx].kw = NULL;
180 matches[idx].dist = INT_MAX;
181 }
182
183 /* In case of partial match we'll look for the best matching entries
184 * starting from position <length>
185 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100186 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100187 list_for_each_entry(kw_list, &cli_keywords.list, list) {
188 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100189 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100190 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100191 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
192 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
193 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100194 continue;
195
196 for (idx = 0; idx < length; idx++) {
197 if (!kw->str_kw[idx])
198 break; // end of keyword
199 if (!args || !args[idx] || !*args[idx])
200 break; // end of command line
201 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
202 break;
203 }
204
205 /* extra non-matching words are fuzzy-matched */
206 if (kw->usage && idx == length && args[idx] && *args[idx]) {
207 uint8_t word_sig[1024];
208 uint8_t list_sig[1024];
209 int dist = 0;
210 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100211 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100212
213 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100214 * on the remaining words. For this we're computing the signature
215 * of everything that remains and the cumulated length of the
216 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100217 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100218 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100219 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
220 update_word_fingerprint(word_sig, args[i]);
221 totlen += strlen(args[i]);
222 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100223
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100224 memset(list_sig, 0, sizeof(list_sig));
225 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
226 update_word_fingerprint(list_sig, kw->str_kw[i]);
227 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100228 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100229
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100230 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100231
232 /* insert this one at its place if relevant, in order to keep only
233 * the best matches.
234 */
235 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100236 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100237 matches[CLI_MAX_MATCHES-1] = swp;
238 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
239 if (matches[idx+1].dist >= matches[idx].dist)
240 break;
241 matches[idx+1] = matches[idx];
242 matches[idx] = swp;
243 }
244 }
245 }
246 }
247 }
248 }
249
Willy Tarreauec197e82021-03-15 10:35:04 +0100250 if (matches[0].kw) {
251 /* we have fuzzy matches, let's propose them */
252 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
253 kw = matches[idx].kw;
254 if (!kw)
255 break;
256
257 /* stop the dump if some words look very unlikely candidates */
258 if (matches[idx].dist > 5*matches[0].dist/2)
259 break;
260
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200261 if (help_entries < CLI_MAX_HELP_ENTRIES)
262 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100263 }
264 }
265
William Lallemand74c24fb2016-11-21 17:18:36 +0100266 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100267 /* no full dump if we've already found nice candidates */
268 if (matches[0].kw)
269 break;
270
Willy Tarreau91bc3592021-03-12 15:20:39 +0100271 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200272
Willy Tarreau91bc3592021-03-12 15:20:39 +0100273 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100274 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100275 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100276 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100277 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200278
William Lallemand2a171912022-02-02 11:43:20 +0100279 /* in master, if the CLI don't have the
280 * ACCESS_MCLI_DEBUG don't display commands that have
281 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100282 */
William Lallemand2a171912022-02-02 11:43:20 +0100283 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
284 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
285 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100286 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200287
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100288 for (idx = 0; idx < length; idx++) {
289 if (!kw->str_kw[idx])
290 break; // end of keyword
291 if (!args || !args[idx] || !*args[idx])
292 break; // end of command line
293 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
294 break;
295 }
296
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200297 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
298 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100299 }
300 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100301
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200302 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
303
304 for (idx = 0; idx < help_entries; idx++)
305 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
306
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100307 /* always show the prompt/help/quit commands */
308 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200309 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200310 " prompt : toggle interactive mode with prompt\n"
311 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100312
William Lallemand74c24fb2016-11-21 17:18:36 +0100313 chunk_init(&out, NULL, 0);
314 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200315 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200316
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200317 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100318 return dynamic_usage_msg;
319}
320
321struct cli_kw* cli_find_kw(char **args)
322{
323 struct cli_kw_list *kw_list;
324 struct cli_kw *kw;/* current cli_kw */
325 char **tmp_args;
326 const char **tmp_str_kw;
327 int found = 0;
328
329 if (LIST_ISEMPTY(&cli_keywords.list))
330 return NULL;
331
332 list_for_each_entry(kw_list, &cli_keywords.list, list) {
333 kw = &kw_list->kw[0];
334 while (*kw->str_kw) {
335 tmp_args = args;
336 tmp_str_kw = kw->str_kw;
337 while (*tmp_str_kw) {
338 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
339 found = 1;
340 } else {
341 found = 0;
342 break;
343 }
344 tmp_args++;
345 tmp_str_kw++;
346 }
347 if (found)
348 return (kw);
349 kw++;
350 }
351 }
352 return NULL;
353}
354
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100355struct cli_kw* cli_find_kw_exact(char **args)
356{
357 struct cli_kw_list *kw_list;
358 int found = 0;
359 int i;
360 int j;
361
362 if (LIST_ISEMPTY(&cli_keywords.list))
363 return NULL;
364
365 list_for_each_entry(kw_list, &cli_keywords.list, list) {
366 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
367 found = 1;
368 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
369 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
370 break;
371 }
372 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
373 found = 0;
374 break;
375 }
376 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
377 found = 0;
378 break;
379 }
380 }
381 if (found)
382 return &kw_list->kw[i];
383 }
384 }
385 return NULL;
386}
387
William Lallemand74c24fb2016-11-21 17:18:36 +0100388void cli_register_kw(struct cli_kw_list *kw_list)
389{
Willy Tarreau2b718102021-04-21 07:32:39 +0200390 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100391}
392
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200393/* list all known keywords on stdout, one per line */
394void cli_list_keywords(void)
395{
396 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200397 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200398 int idx;
399
Willy Tarreau44651712022-03-30 12:02:35 +0200400 for (kwn = kwp = NULL;; kwp = kwn) {
401 list_for_each_entry(kw_list, &cli_keywords.list, list) {
402 /* note: we sort based on the usage message when available,
403 * otherwise we fall back to the first keyword.
404 */
405 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
406 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
407 kw->usage ? kw->usage : kw->str_kw[0],
408 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
409 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200410 }
Willy Tarreau44651712022-03-30 12:02:35 +0200411 }
412
413 if (kwn == kwp)
414 break;
415
416 for (idx = 0; kwn->str_kw[idx]; idx++) {
417 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200418 }
Willy Tarreau44651712022-03-30 12:02:35 +0200419 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
420 printf("[MASTER] ");
421 if (!(kwn->level & ACCESS_MASTER_ONLY))
422 printf("[WORKER] ");
423 if (kwn->level & ACCESS_EXPERT)
424 printf("[EXPERT] ");
425 if (kwn->level & ACCESS_EXPERIMENTAL)
426 printf("[EXPERIM] ");
427 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200428 }
429}
William Lallemand74c24fb2016-11-21 17:18:36 +0100430
431/* allocate a new stats frontend named <name>, and return it
432 * (or NULL in case of lack of memory).
433 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100434static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100435{
436 struct proxy *fe;
437
438 fe = calloc(1, sizeof(*fe));
439 if (!fe)
440 return NULL;
441
442 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100443 fe->next = proxies_list;
444 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100445 fe->last_change = now.tv_sec;
446 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200447 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100448 fe->maxconn = 10; /* default to 10 concurrent connections */
449 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
450 fe->conf.file = strdup(file);
451 fe->conf.line = line;
452 fe->accept = frontend_accept;
453 fe->default_target = &cli_applet.obj_type;
454
455 /* the stats frontend is the only one able to assign ID #0 */
456 fe->conf.id.key = fe->uuid = 0;
457 eb32_insert(&used_proxy_id, &fe->conf.id);
458 return fe;
459}
460
461/* This function parses a "stats" statement in the "global" section. It returns
462 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
463 * error message into the <err> buffer which will be preallocated. The trailing
464 * '\n' must not be written. The function must be called with <args> pointing to
465 * the first word after "stats".
466 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100467static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
468 const struct proxy *defpx, const char *file, int line,
469 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100470{
471 struct bind_conf *bind_conf;
472 struct listener *l;
473
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100474 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100475 int cur_arg;
476
477 if (*args[2] == 0) {
478 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
479 return -1;
480 }
481
Willy Tarreau4975d142021-03-13 11:00:33 +0100482 if (!global.cli_fe) {
483 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100484 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
485 return -1;
486 }
487 }
488
Willy Tarreau4975d142021-03-13 11:00:33 +0100489 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200490 if (!bind_conf) {
491 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
492 return -1;
493 }
William Lallemand07a62f72017-05-24 00:57:40 +0200494 bind_conf->level &= ~ACCESS_LVL_MASK;
495 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
Willy Tarreau6bdf9452022-07-06 11:52:24 +0200496 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemand74c24fb2016-11-21 17:18:36 +0100497
Willy Tarreau4975d142021-03-13 11:00:33 +0100498 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100499 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
500 file, line, args[0], args[1], err && *err ? *err : "error");
501 return -1;
502 }
503
504 cur_arg = 3;
505 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100506 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100507 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100508 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100509
510 kw = bind_find_kw(args[cur_arg]);
511 if (kw) {
512 if (!kw->parse) {
513 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
514 args[0], args[1], args[cur_arg]);
515 return -1;
516 }
517
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100518 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
519
520 /* FIXME: this is ugly, we don't have a way to collect warnings,
521 * yet some important bind keywords may report warnings that we
522 * must display.
523 */
524 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
525 indent_msg(err, 2);
526 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
527 ha_free(err);
528 }
529
530 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100531 if (err && *err)
532 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
533 else
534 memprintf(err, "'%s %s' : error encountered while processing '%s'",
535 args[0], args[1], args[cur_arg]);
536 return -1;
537 }
538
539 cur_arg += 1 + kw->skip;
540 continue;
541 }
542
Willy Tarreau433b05f2021-03-12 10:14:07 +0100543 best = bind_find_best_kw(args[cur_arg]);
544 if (best)
545 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
546 args[0], args[1], args[cur_arg], best);
547 else
548 memprintf(err, "'%s %s' : unknown keyword '%s'.",
549 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100550 return -1;
551 }
552
553 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100554 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100555 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100556 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
557 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100558 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100559 }
560 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100561 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100562 unsigned timeout;
563 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
564
Willy Tarreau9faebe32019-06-07 19:00:37 +0200565 if (res == PARSE_TIME_OVER) {
566 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
567 args[2], args[0], args[1]);
568 return -1;
569 }
570 else if (res == PARSE_TIME_UNDER) {
571 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
572 args[2], args[0], args[1]);
573 return -1;
574 }
575 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100576 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
577 return -1;
578 }
579
580 if (!timeout) {
581 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
582 return -1;
583 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100584 if (!global.cli_fe) {
585 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100586 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
587 return -1;
588 }
589 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100590 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100591 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100592 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100593 int maxconn = atol(args[2]);
594
595 if (maxconn <= 0) {
596 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
597 return -1;
598 }
599
Willy Tarreau4975d142021-03-13 11:00:33 +0100600 if (!global.cli_fe) {
601 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
603 return -1;
604 }
605 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100606 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100607 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200608 else if (strcmp(args[1], "bind-process") == 0) {
609 memprintf(err, "'%s' is not supported anymore.", args[0]);
610 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100611 }
612 else {
613 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
614 return -1;
615 }
616 return 0;
617}
618
William Lallemand33d29e22019-04-01 11:30:06 +0200619/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200620 * This function exports the bound addresses of a <frontend> in the environment
621 * variable <varname>. Those addresses are separated by semicolons and prefixed
622 * with their type (abns@, unix@, sockpair@ etc)
623 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200624 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200625int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200626{
627 struct buffer *trash = get_trash_chunk();
628 struct bind_conf *bind_conf;
629
William Lallemand9a37fd02019-04-12 16:09:24 +0200630 if (frontend) {
631 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200632 struct listener *l;
633
634 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
635 char addr[46];
636 char port[6];
637
William Lallemand620072b2019-04-12 16:09:25 +0200638 /* separate listener by semicolons */
639 if (trash->data)
640 chunk_appendf(trash, ";");
641
Willy Tarreau37159062020-08-27 07:48:42 +0200642 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200643 const struct sockaddr_un *un;
644
Willy Tarreau37159062020-08-27 07:48:42 +0200645 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200646 if (un->sun_path[0] == '\0') {
647 chunk_appendf(trash, "abns@%s", un->sun_path+1);
648 } else {
649 chunk_appendf(trash, "unix@%s", un->sun_path);
650 }
Willy Tarreau37159062020-08-27 07:48:42 +0200651 } else if (l->rx.addr.ss_family == AF_INET) {
652 addr_to_str(&l->rx.addr, addr, sizeof(addr));
653 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200654 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200655 } else if (l->rx.addr.ss_family == AF_INET6) {
656 addr_to_str(&l->rx.addr, addr, sizeof(addr));
657 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200658 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200659 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
660 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200661 }
William Lallemand33d29e22019-04-01 11:30:06 +0200662 }
663 }
664 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200665 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200666 return -1;
667 }
668
669 return 0;
670}
671
William Lallemand9a37fd02019-04-12 16:09:24 +0200672int cli_socket_setenv()
673{
Willy Tarreau4975d142021-03-13 11:00:33 +0100674 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200675 return -1;
676 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
677 return -1;
678
679 return 0;
680}
681
William Lallemand33d29e22019-04-01 11:30:06 +0200682REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
683
Willy Tarreaude57a572016-11-23 17:01:39 +0100684/* Verifies that the CLI at least has a level at least as high as <level>
685 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
686 * failure, an error message is prepared and the appctx's state is adjusted
687 * to print it so that a return 1 is enough to abort any processing.
688 */
689int cli_has_level(struct appctx *appctx, int level)
690{
Willy Tarreaude57a572016-11-23 17:01:39 +0100691
William Lallemandf630d012018-12-13 09:05:44 +0100692 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100693 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100694 return 0;
695 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100696 return 1;
697}
698
William Lallemandb7ea1412018-12-13 09:05:47 +0100699/* same as cli_has_level but for the CLI proxy and without error message */
700int pcli_has_level(struct stream *s, int level)
701{
702 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
703 return 0;
704 }
705 return 1;
706}
707
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200708/* Returns severity_output for the current session if set, or default for the socket */
709static int cli_get_severity_output(struct appctx *appctx)
710{
711 if (appctx->cli_severity_output)
712 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200713 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200714}
William Lallemand74c24fb2016-11-21 17:18:36 +0100715
Willy Tarreau41908562016-11-24 16:23:38 +0100716/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100717 * from the CLI's IO handler running in an appctx context. The function returns
718 * 1 if the request was understood, otherwise zero (in which case an error
719 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100720 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
721 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
722 * have its own I/O handler called again. Most of the time, parsers will only
723 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100724 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
725 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100726 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200727static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100728{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100729 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100731 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100732
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200733 p = appctx->chunk->area;
734 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100735
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 * Get pointers on words.
738 * One extra slot is reserved to store a pointer on a null byte.
739 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100740 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 /* skip leading spaces/tabs */
744 p += strspn(p, " \t");
745 if (!*p)
746 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200747
748 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
749 /* payload pattern recognized here, this is not an arg anymore,
750 * the payload starts at the first byte that follows the zero
751 * after the pattern.
752 */
753 payload = p + strlen(PAYLOAD_PATTERN) + 1;
754 break;
755 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100756
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200757 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200758 while (1) {
759 p += strcspn(p, " \t\\");
760 /* escaped chars using backlashes (\) */
761 if (*p == '\\') {
762 if (!*++p)
763 break;
764 if (!*++p)
765 break;
766 } else {
767 break;
768 }
769 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200770 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100771
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200772 /* unescape backslashes (\) */
773 for (j = 0, k = 0; args[i][k]; k++) {
774 if (args[i][k] == '\\') {
775 if (args[i][k + 1] == '\\')
776 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100777 else
778 continue;
779 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200780 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100781 j++;
782 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200783 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100784
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200785 i++;
786 }
787 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200788 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100789 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200790 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100791
792 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100793 if (!kw ||
794 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100795 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
796 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100797 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100798 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100799 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100800 }
William Lallemand14721be2018-10-26 14:47:37 +0200801
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100802 /* don't handle expert mode commands if not in this mode. */
803 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
804 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200805 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100806 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200807
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100808 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
809 cli_err(appctx, "This command is restricted to experimental mode only.\n");
810 return 0;
811 }
812
Amaury Denoyellef4929922021-05-05 16:29:23 +0200813 if (kw->level == ACCESS_EXPERT)
814 mark_tainted(TAINTED_CLI_EXPERT_MODE);
815 else if (kw->level == ACCESS_EXPERIMENTAL)
816 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
817
Willy Tarreau41908562016-11-24 16:23:38 +0100818 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200819 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200820
821 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
822 goto fail;
823
824 /* kw->parse could set its own io_handler or io_release handler */
825 if (!appctx->io_handler)
826 goto fail;
827
828 appctx->st0 = CLI_ST_CALLBACK;
829 return 1;
830fail:
831 appctx->io_handler = NULL;
832 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100833 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100834}
835
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200836/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
837static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
838{
Willy Tarreau83061a82018-07-13 11:56:34 +0200839 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200840
841 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200842 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200843
844 tmp = get_trash_chunk();
845 chunk_reset(tmp);
846
847 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100848 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200849 chunk_printf(tmp, "[%d]: ", severity);
850 }
851 else {
852 switch (severity_output) {
853 case CLI_SEVERITY_NUMBER:
854 chunk_printf(tmp, "[%d]: ", severity);
855 break;
856 case CLI_SEVERITY_STRING:
857 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
858 break;
859 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100860 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200861 }
862 }
863 chunk_appendf(tmp, "%s", msg);
864
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200865 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200866}
867
Willy Tarreau4596fe22022-05-17 19:07:51 +0200868/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100869 * used to processes I/O from/to the stats unix socket. The system relies on a
870 * state machine handling requests and various responses. We read a request,
871 * then we process it and send the response, and we possibly display a prompt.
872 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100873 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100874 * or not.
875 */
876static void cli_io_handler(struct appctx *appctx)
877{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200878 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200879 struct channel *req = sc_oc(sc);
880 struct channel *res = sc_ic(sc);
881 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100882 int reql;
883 int len;
884
Willy Tarreau475e4632022-05-27 10:26:46 +0200885 if (unlikely(sc->state == SC_ST_DIS || sc->state == SC_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100886 goto out;
887
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800888 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200889 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100890 /* buf.size==0 means we failed to get a buffer and were
891 * already subscribed to a wait list to get a buffer.
892 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100893 goto out;
894 }
895
William Lallemand74c24fb2016-11-21 17:18:36 +0100896 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100897 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200898 /* reset severity to default at init */
899 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200900 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100901 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100902 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100904 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100905 /* Let's close for real now. We just close the request
906 * side, the conditions below will complete if needed.
907 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200908 sc_shutw(sc);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200909 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200910 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100911 break;
912 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100913 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200914 char *str;
915
916 /* use a trash chunk to store received data */
917 if (!appctx->chunk) {
918 appctx->chunk = alloc_trash_chunk();
919 if (!appctx->chunk) {
920 appctx->st0 = CLI_ST_END;
921 continue;
922 }
923 }
924
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200925 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200926
William Lallemand74c24fb2016-11-21 17:18:36 +0100927 /* ensure we have some output room left in the event we
928 * would want to return some info right after parsing.
929 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200930 if (buffer_almost_full(sc_ib(sc))) {
931 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +0100932 break;
933 }
934
Willy Tarreau0011c252022-01-19 17:23:52 +0100935 /* payload doesn't take escapes nor does it end on semi-colons, so
936 * we use the regular getline. Normal mode however must stop on
937 * LFs and semi-colons that are not prefixed by a backslash. Note
938 * that we reserve one byte at the end to insert a trailing nul byte.
939 */
940
941 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200942 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100943 appctx->chunk->size - appctx->chunk->data - 1);
944 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200945 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100946 appctx->chunk->size - appctx->chunk->data - 1,
947 "\n;", '\\');
948
William Lallemand74c24fb2016-11-21 17:18:36 +0100949 if (reql <= 0) { /* closed or EOL not found */
950 if (reql == 0)
951 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100952 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100953 continue;
954 }
955
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200956 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
957 /* seek for a possible unescaped semi-colon. If we find
958 * one, we replace it with an LF and skip only this part.
959 */
960 for (len = 0; len < reql; len++) {
961 if (str[len] == '\\') {
962 len++;
963 continue;
964 }
965 if (str[len] == ';') {
966 str[len] = '\n';
967 reql = len + 1;
968 break;
969 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100970 }
971 }
972
973 /* now it is time to check that we have a full line,
974 * remove the trailing \n and possibly \r, then cut the
975 * line.
976 */
977 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200978 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100979 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100980 continue;
981 }
982
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200983 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100984 len--;
985
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200986 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200987 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200988
989 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200990 appctx->chunk->area[appctx->chunk->data] = '\n';
991 appctx->chunk->area[appctx->chunk->data + 1] = 0;
992 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200993 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100994
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100995 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200996
997 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
998 /* empty line */
999 if (!len) {
1000 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001001 appctx->chunk->data -= 2;
1002 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001003 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001004 chunk_reset(appctx->chunk);
1005 /* NB: cli_sock_parse_request() may have put
1006 * another CLI_ST_O_* into appctx->st0.
1007 */
1008
1009 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001010 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001011 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001012 else {
1013 /*
1014 * Look for the "payload start" pattern at the end of a line
1015 * Its location is not remembered here, this is just to switch
1016 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001017 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001018 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001019 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001020 appctx->chunk->data++; // keep the trailing \0 after '<<'
1021 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001022 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001023 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001024 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001025 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001026 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001027 }
1028
1029 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001030 co_skip(sc_oc(sc), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001031 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1032 }
1033 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001034 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001035 const char *msg;
1036 int sev;
1037
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001039 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001040 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001041 case CLI_ST_PRINT: /* print const message in msg */
1042 case CLI_ST_PRINT_ERR: /* print const error in msg */
1043 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1044 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001045 /* the message is in the svcctx */
1046 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001047 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1048 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001049 LOG_ERR : ctx->severity;
1050 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001051 }
1052 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1053 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001054 LOG_ERR : ctx->severity;
1055 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001056 if (!msg) {
1057 sev = LOG_ERR;
1058 msg = "Out of memory.\n";
1059 }
1060 }
1061 else {
1062 sev = LOG_ERR;
1063 msg = "Internal error.\n";
1064 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001065
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001066 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1067 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1068 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001069 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001070 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001071 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001072 }
1073 else
Willy Tarreau475e4632022-05-27 10:26:46 +02001074 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001075 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001076
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001077 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001078 if (appctx->io_handler)
1079 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001080 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001081 if (appctx->io_release) {
1082 appctx->io_release(appctx);
1083 appctx->io_release = NULL;
1084 }
1085 }
1086 break;
1087 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001088 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001089 break;
1090 }
1091
1092 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001093 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001094 const char *prompt = "";
1095
1096 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1097 /*
1098 * when entering a payload with interactive mode, change the prompt
1099 * to emphasize that more data can still be sent
1100 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001101 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001102 prompt = "+ ";
1103 else
1104 prompt = "\n> ";
1105 }
1106 else {
William Lallemandad032882019-07-01 10:56:15 +02001107 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001108 prompt = "\n";
1109 }
1110
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001111 if (applet_putstr(appctx, prompt) != -1) {
1112 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001113 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001114 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001115 }
1116
1117 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001118 if (appctx->st0 >= CLI_ST_OUTPUT) {
1119 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001120 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001121 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001122
1123 /* Now we close the output if one of the writers did so,
1124 * or if we're not in interactive mode and the request
1125 * buffer is empty. This still allows pipelined requests
1126 * to be sent in non-interactive mode.
1127 */
William Lallemand3de09d52018-12-11 16:10:56 +01001128 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1129 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001130 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001131 continue;
1132 }
1133
1134 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001135 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001136 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001137 applet_will_consume(appctx);
1138
William Lallemandad032882019-07-01 10:56:15 +02001139 /* reactivate the \n at the end of the response for the next command */
1140 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001141
1142 /* this forces us to yield between pipelined commands and
1143 * avoid extremely long latencies (e.g. "del map" etc). In
1144 * addition this increases the likelihood that the stream
1145 * refills the buffer with new bytes in non-interactive
1146 * mode, avoiding to close on apparently empty commands.
1147 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001148 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001149 appctx_wakeup(appctx);
1150 goto out;
1151 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 }
1153 }
1154
Willy Tarreau475e4632022-05-27 10:26:46 +02001155 if ((res->flags & CF_SHUTR) && (sc->state == SC_ST_EST)) {
1156 DPRINTF(stderr, "%s@%d: sc to buf closed. req=%08x, res=%08x, st=%d\n",
1157 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001158 /* Other side has closed, let's abort if we have no more processing to do
1159 * and nothing more to consume. This is comparable to a broken pipe, so
1160 * we forward the close to the request side so that it flows upstream to
1161 * the client.
1162 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001163 sc_shutw(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001164 }
1165
Willy Tarreau475e4632022-05-27 10:26:46 +02001166 if ((req->flags & CF_SHUTW) && (sc->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
1167 DPRINTF(stderr, "%s@%d: buf to sc closed. req=%08x, res=%08x, st=%d\n",
1168 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001169 /* We have no more processing to do, and nothing more to send, and
1170 * the client side has closed. So we'll forward this state downstream
1171 * on the response buffer.
1172 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001173 sc_shutr(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001174 res->flags |= CF_READ_NULL;
1175 }
1176
1177 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001178 DPRINTF(stderr, "%s@%d: st=%d, rqf=%x, rpf=%x, rqh=%lu, rqs=%lu, rh=%lu, rs=%lu\n",
William Lallemand74c24fb2016-11-21 17:18:36 +01001179 __FUNCTION__, __LINE__,
Willy Tarreau475e4632022-05-27 10:26:46 +02001180 sc->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001181}
1182
Willy Tarreau4596fe22022-05-17 19:07:51 +02001183/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001184 * external abort, we won't call the i/o handler anymore so we may need to
1185 * remove back references to the stream currently being dumped.
1186 */
1187static void cli_release_handler(struct appctx *appctx)
1188{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001189 free_trash_chunk(appctx->chunk);
1190 appctx->chunk = NULL;
1191
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 if (appctx->io_release) {
1193 appctx->io_release(appctx);
1194 appctx->io_release = NULL;
1195 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001196 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001197 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1198
1199 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001200 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001201}
1202
1203/* This function dumps all environmnent variables to the buffer. It returns 0
1204 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001205 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1206 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001207 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001208static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001209{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001210 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001211 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001212 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001213
Willy Tarreau475e4632022-05-27 10:26:46 +02001214 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001215 return 1;
1216
1217 chunk_reset(&trash);
1218
1219 /* we have two inner loops here, one for the proxy, the other one for
1220 * the buffer.
1221 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001222 while (*var) {
1223 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001224
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001225 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001226 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001227
Willy Tarreau307dbb32022-05-05 17:45:52 +02001228 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001229 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001230 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001231 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001232 }
1233
1234 /* dump complete */
1235 return 1;
1236}
1237
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001238/* This function dumps all file descriptors states (or the requested one) to
1239 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001240 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1241 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1242 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001243 */
1244static int cli_io_handler_show_fd(struct appctx *appctx)
1245{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001246 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001247 struct show_fd_ctx *fdctx = appctx->svcctx;
1248 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001249 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001250
Willy Tarreau475e4632022-05-27 10:26:46 +02001251 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001252 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001253
1254 chunk_reset(&trash);
1255
Willy Tarreauca1b1572018-12-18 15:45:11 +01001256 /* isolate the threads once per round. We're limited to a buffer worth
1257 * of output anyway, it cannot last very long.
1258 */
1259 thread_isolate();
1260
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001261 /* we have two inner loops here, one for the proxy, the other one for
1262 * the buffer.
1263 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001264 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001265 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001266 const struct listener *li = NULL;
1267 const struct server *sv = NULL;
1268 const struct proxy *px = NULL;
1269 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001270 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001271 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001272 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001273 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001274 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001275 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001276 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001277
1278 fdt = fdtab[fd];
1279
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001280 /* When DEBUG_FD is set, we also report closed FDs that have a
1281 * non-null event count to detect stuck ones.
1282 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001283 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001284#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001285 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001286#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001287 goto skip; // closed
1288 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001289 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001290 conn = (const struct connection *)fdt.owner;
1291 conn_flags = conn->flags;
1292 mux = conn->mux;
1293 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001294 xprt = conn->xprt;
1295 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001296 li = objt_listener(conn->target);
1297 sv = objt_server(conn->target);
1298 px = objt_proxy(conn->target);
1299 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001300 if (atleast2(fdt.thread_mask))
1301 suspicious = 1;
1302 if (conn->handle.fd != fd)
1303 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001304 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001305 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001306 li = fdt.owner;
1307
Willy Tarreaudacfde42021-01-21 09:07:29 +01001308 if (!fdt.thread_mask)
1309 suspicious = 1;
1310
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001311 chunk_printf(&trash,
Willy Tarreauc2431822022-07-08 10:23:01 +02001312 " %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 owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001313 fd,
1314 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001315 (fdt.state & FD_CLONED) ? 'C' : 'c',
1316 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001317 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1318 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1319 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1320 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1321 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001322 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1323 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1324 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1325 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1326 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1327 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001328 (fdt.refc_tgid >> 4) & 0xffff,
1329 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001330 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001331 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001332 fdt.iocb);
1333 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001334
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001335 if (!fdt.owner) {
1336 chunk_appendf(&trash, ")");
1337 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001338 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001339 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001340
1341 if (conn->handle.fd != fd) {
1342 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1343 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001344 } else {
1345 struct sockaddr_storage sa;
1346 socklen_t salen;
1347
1348 salen = sizeof(sa);
1349 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1350 if (sa.ss_family == AF_INET)
1351 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1352 else if (sa.ss_family == AF_INET6)
1353 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1354 else if (sa.ss_family == AF_UNIX)
1355 chunk_appendf(&trash, " fam=unix");
1356 }
1357
1358 salen = sizeof(sa);
1359 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1360 if (sa.ss_family == AF_INET)
1361 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1362 else if (sa.ss_family == AF_INET6)
1363 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1364 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001365 }
1366
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001367 if (px)
1368 chunk_appendf(&trash, " px=%s", px->id);
1369 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001370 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001371 else if (li)
1372 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001373
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001374 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001375 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001376 if (!ctx)
1377 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001378 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001379 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001380 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001381 else
1382 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001383
1384 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001385 if (xprt) {
1386 if (xprt_ctx || xprt->show_fd)
1387 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1388 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001389 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001390 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001391 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001392 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001393 struct sockaddr_storage sa;
1394 socklen_t salen;
1395
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001396 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001397 listener_state_str(li),
1398 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001399
1400 salen = sizeof(sa);
1401 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1402 if (sa.ss_family == AF_INET)
1403 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1404 else if (sa.ss_family == AF_INET6)
1405 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1406 else if (sa.ss_family == AF_UNIX)
1407 chunk_appendf(&trash, " fam=unix");
1408 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001409 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001410 else
1411 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001412
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001413#ifdef DEBUG_FD
1414 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001415 if (fdtab[fd].event_count >= 1000000)
1416 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001417#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001418 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001419
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001420 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001421 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001422 ret = 0;
1423 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001424 }
1425 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001426 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001427 break;
1428
1429 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001430 }
1431
Willy Tarreauca1b1572018-12-18 15:45:11 +01001432 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001433 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001434
1435 thread_release();
1436 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001437}
1438
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001439/* This function dumps some activity counters used by developers and support to
1440 * rule out some hypothesis during bug reports. It returns 0 if the output
1441 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1442 * everything at once in the buffer and is not designed to do it in multiple
1443 * passes.
1444 */
1445static int cli_io_handler_show_activity(struct appctx *appctx)
1446{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001447 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001448 struct show_activity_ctx *actctx = appctx->svcctx;
1449 int tgt = actctx->thr; // target thread, -1 for all, 0 for total only
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001450 int thr;
1451
Willy Tarreau475e4632022-05-27 10:26:46 +02001452 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001453 return 1;
1454
1455 chunk_reset(&trash);
1456
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001457#undef SHOW_TOT
1458#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001459 do { \
1460 unsigned int _v[MAX_THREADS]; \
1461 unsigned int _tot; \
1462 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001463 _tot = t = 0; \
1464 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001465 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001466 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001467 if (_nbt == 1) { \
1468 chunk_appendf(&trash, " %u\n", _tot); \
1469 break; \
1470 } \
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001471 if (tgt == -1) { \
1472 chunk_appendf(&trash, " %u [", _tot); \
1473 for (t = 0; t < _nbt; t++) \
1474 chunk_appendf(&trash, " %u", _v[t]); \
1475 chunk_appendf(&trash, " ]\n"); \
1476 } else if (tgt == 0) \
1477 chunk_appendf(&trash, " %u\n", _tot); \
1478 else \
1479 chunk_appendf(&trash, " %u\n", _v[tgt-1]);\
Willy Tarreaua0211b82019-05-28 15:09:08 +02001480 } while (0)
1481
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001482#undef SHOW_AVG
1483#define SHOW_AVG(t, x) \
1484 do { \
1485 unsigned int _v[MAX_THREADS]; \
1486 unsigned int _tot; \
1487 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001488 _tot = t = 0; \
1489 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001490 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001491 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001492 if (_nbt == 1) { \
1493 chunk_appendf(&trash, " %u\n", _tot); \
1494 break; \
1495 } \
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001496 if (tgt == -1) { \
1497 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1498 for (t = 0; t < _nbt; t++) \
1499 chunk_appendf(&trash, " %u", _v[t]); \
1500 chunk_appendf(&trash, " ]\n"); \
1501 } else if (tgt == 0) \
1502 chunk_appendf(&trash, " %u\n", (_tot + _nbt/2) / _nbt); \
1503 else \
1504 chunk_appendf(&trash, " %u\n", _v[tgt-1]);\
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001505 } while (0)
1506
Willy Tarreaua0211b82019-05-28 15:09:08 +02001507 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1508 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001509 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1510 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1511 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1512 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001513 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001514 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1515 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001516 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001517 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001518 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001519 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001520 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001521 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001522 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1523 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001524 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1525 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1526 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1527 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1528 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1529 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1530 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001531#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001532 chunk_appendf(&trash, "accq_ring:"); SHOW_TOT(thr, (accept_queue_rings[thr].tail - accept_queue_rings[thr].head + ACCEPT_QUEUE_SIZE) % ACCEPT_QUEUE_SIZE);
Willy Tarreaub1591322020-06-29 14:17:59 +02001533 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001534#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001535
Willy Tarreaud6a78502019-05-27 07:03:38 +02001536#if defined(DEBUG_DEV)
1537 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001538 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1539 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1540 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001541#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001542
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001543 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001544 chunk_reset(&trash);
1545 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001546 }
1547
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001548#undef SHOW_AVG
1549#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001550 /* dump complete */
1551 return 1;
1552}
1553
William Lallemandeceddf72016-12-15 18:06:44 +01001554/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001555 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001556 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1557 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001558 */
1559static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1560{
Willy Tarreaub128f492022-05-05 19:11:05 +02001561 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1562 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001563
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001564 if (!global.cli_fe)
1565 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001566
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001567 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001568
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001569 if (!bind_conf) {
1570 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001571 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001572 goto full;
1573 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1574 }
William Lallemandeceddf72016-12-15 18:06:44 +01001575
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001576 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001577 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001578
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001579 if (!l)
1580 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001581
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001582 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1583 char addr[46];
1584 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001585
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001586 if (l->rx.addr.ss_family == AF_UNIX) {
1587 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001588
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001589 un = (struct sockaddr_un *)&l->rx.addr;
1590 if (un->sun_path[0] == '\0') {
1591 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1592 } else {
1593 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1594 }
1595 } else if (l->rx.addr.ss_family == AF_INET) {
1596 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1597 port_to_str(&l->rx.addr, port, sizeof(port));
1598 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1599 } else if (l->rx.addr.ss_family == AF_INET6) {
1600 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1601 port_to_str(&l->rx.addr, port, sizeof(port));
1602 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1603 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1604 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1605 } else
1606 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001607
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001608 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1609 chunk_appendf(&trash, "admin ");
1610 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1611 chunk_appendf(&trash, "operator ");
1612 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1613 chunk_appendf(&trash, "user ");
1614 else
1615 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001616
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001617 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001618
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001619 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001620 ctx->bind_conf = bind_conf;
1621 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001622 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001623 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001624 }
William Lallemandeceddf72016-12-15 18:06:44 +01001625 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001626 done:
1627 return 1;
1628 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001629 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001630}
1631
1632
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001633/* parse a "show activity" CLI request. Returns 0 if it needs to continue, 1 if it
1634 * wants to stop here. It sets a show_activity_ctx context where, if a specific
1635 * thread is requested, it puts the thread number into ->thr otherwise sets it to
1636 * -1.
1637 */
1638static int cli_parse_show_activity(char **args, char *payload, struct appctx *appctx, void *private)
1639{
1640 struct show_activity_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1641
1642 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1643 return 1;
1644
1645 ctx->thr = -1; // show all by default
1646 if (*args[2])
1647 ctx->thr = atoi(args[2]);
1648
1649 if (ctx->thr < -1 || ctx->thr > global.nbthread)
1650 return cli_err(appctx, "Thread ID number must be between -1 and nbthread\n");
1651
1652 return 0;
1653}
1654
Willy Tarreau0a739292016-11-22 20:21:23 +01001655/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001656 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1657 * be dumped as well as a flag if a single variable is requested, otherwise puts
1658 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001659 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001660static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001661{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001662 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001663 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001664 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001665
1666 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1667 return 1;
1668
Willy Tarreauf6710f82016-12-16 17:45:44 +01001669 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001670
1671 if (*args[2]) {
1672 int len = strlen(args[2]);
1673
Willy Tarreauf6710f82016-12-16 17:45:44 +01001674 for (; *var; var++) {
1675 if (strncmp(*var, args[2], len) == 0 &&
1676 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001677 break;
1678 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001679 if (!*var)
1680 return cli_err(appctx, "Variable not found\n");
1681
Willy Tarreau307dbb32022-05-05 17:45:52 +02001682 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001683 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001684 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001685 return 0;
1686}
1687
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001688/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001689 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1690 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001691 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001692static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001693{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001694 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1695
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001696 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1697 return 1;
1698
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001699 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001700 ctx->fd = atoi(args[2]);
1701 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001702 }
1703 return 0;
1704}
1705
Willy Tarreau599852e2016-11-22 20:33:32 +01001706/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001707static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001708{
Willy Tarreau0698c802022-05-11 14:09:57 +02001709 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001710
1711 if (strcmp(args[2], "cli") == 0) {
1712 unsigned timeout;
1713 const char *res;
1714
Willy Tarreau9d008692019-08-09 11:21:01 +02001715 if (!*args[3])
1716 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001717
1718 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001719 if (res || timeout < 1)
1720 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001721
1722 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1723 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1724 return 1;
1725 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001726
1727 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001728}
1729
Willy Tarreau2af99412016-11-23 11:10:59 +01001730/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001731static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001732{
1733 int v;
1734
1735 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1736 return 1;
1737
Willy Tarreau9d008692019-08-09 11:21:01 +02001738 if (!*args[3])
1739 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001740
1741 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001742 if (v > global.hardmaxconn)
1743 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001744
1745 /* check for unlimited values */
1746 if (v <= 0)
1747 v = global.hardmaxconn;
1748
1749 global.maxconn = v;
1750
1751 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001752 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001753
1754 return 1;
1755}
1756
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001757static int set_severity_output(int *target, char *argument)
1758{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001759 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001760 *target = CLI_SEVERITY_NONE;
1761 return 1;
1762 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001763 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001764 *target = CLI_SEVERITY_NUMBER;
1765 return 1;
1766 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001767 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001768 *target = CLI_SEVERITY_STRING;
1769 return 1;
1770 }
1771 return 0;
1772}
1773
1774/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001775static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001776{
1777 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1778 return 0;
1779
Willy Tarreau9d008692019-08-09 11:21:01 +02001780 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001781}
William Lallemandeceddf72016-12-15 18:06:44 +01001782
William Lallemand67a234f2018-12-13 09:05:45 +01001783
1784/* show the level of the current CLI session */
1785static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1786{
William Lallemand67a234f2018-12-13 09:05:45 +01001787 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001788 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001789 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001790 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001791 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001792 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001793 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001794 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001795}
1796
1797/* parse and set the CLI level dynamically */
1798static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1799{
William Lallemandad032882019-07-01 10:56:15 +02001800 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001801 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001802 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1803
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001804 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001805 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1806 return 1;
1807 }
1808 appctx->cli_level &= ~ACCESS_LVL_MASK;
1809 appctx->cli_level |= ACCESS_LVL_OPER;
1810
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001811 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001812 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1813 return 1;
1814 }
1815 appctx->cli_level &= ~ACCESS_LVL_MASK;
1816 appctx->cli_level |= ACCESS_LVL_USER;
1817 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001818 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001819 return 1;
1820}
1821
1822
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001823/* parse and set the CLI expert/experimental-mode dynamically */
1824static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001825{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001826 int level;
1827 char *level_str;
1828 char *output = NULL;
1829
William Lallemand7267f782022-02-01 16:08:50 +01001830 /* this will ask the applet to not output a \n after the command */
1831 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1832 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1833
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001834 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1835 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001836
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001837 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001838 level = ACCESS_EXPERT;
1839 level_str = "expert-mode";
1840 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001841 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001842 level = ACCESS_EXPERIMENTAL;
1843 level_str = "experimental-mode";
1844 }
William Lallemand2a171912022-02-02 11:43:20 +01001845 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1846 level = ACCESS_MCLI_DEBUG;
1847 level_str = "mcli-debug-mode";
1848 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001849 else {
1850 return 1;
1851 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001852
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001853 if (!*args[1]) {
1854 memprintf(&output, "%s is %s\n", level_str,
1855 (appctx->cli_level & level) ? "ON" : "OFF");
1856 return cli_dynmsg(appctx, LOG_INFO, output);
1857 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001858
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001859 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001860 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001861 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001862 return 1;
1863}
1864
William Lallemand740629e2021-12-14 15:22:29 +01001865/* shows HAProxy version */
1866static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1867{
1868 char *msg = NULL;
1869
1870 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1871}
1872
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001873int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001874{
1875 return 0;
1876}
1877
Erwan Le Goas54966df2022-09-14 17:24:22 +02001878/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1879static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1880{
1881 uint32_t tmp;
1882 long long key;
1883
1884 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001885
1886 if (*args[3]) {
1887 key = atoll(args[3]);
1888 if (key < 1 || key > UINT_MAX)
1889 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1890 appctx->cli_anon_key = key;
1891 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001892 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001893 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1894 if (tmp != 0)
1895 appctx->cli_anon_key = tmp;
1896 else
1897 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001898 }
1899 }
1900 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001901
1902 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001903 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1904 }
1905 else {
1906 appctx->cli_anon_key = 0;
1907 }
1908 }
1909 else {
1910 return cli_err(appctx,
1911 "'set anon' only supports :\n"
1912 " - 'on' [key] to enable the anonymized mode\n"
1913 " - 'off' to disable the anonymized mode");
1914 }
1915 return 1;
1916}
1917
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001918/* This function set the global anonyzing key, restricted to level 'admin' */
1919static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1920{
1921 long long key;
1922
1923 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1924 return cli_err(appctx, "Permission denied\n");
1925 if (!*args[2])
1926 return cli_err(appctx, "Expects an integer value.\n");
1927
1928 key = atoll(args[2]);
1929 if (key < 0 || key > UINT_MAX)
1930 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1931
1932 HA_ATOMIC_STORE(&global.anon_key, key);
1933 return 1;
1934}
1935
Erwan Le Goas54966df2022-09-14 17:24:22 +02001936/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1937static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1938{
1939 char *msg = NULL;
1940 char *anon_mode = NULL;
1941 uint32_t c_key = appctx->cli_anon_key;
1942
1943 if (!c_key)
1944 anon_mode = "Anonymized mode disabled";
1945 else
1946 anon_mode = "Anonymized mode enabled";
1947
1948 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1949 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1950 }
1951 else {
1952 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1953 }
1954
1955 return 1;
1956}
1957
Willy Tarreau45c742b2016-11-24 14:51:17 +01001958/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001959static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001960{
1961 int v;
1962 int *res;
1963 int mul = 1;
1964
1965 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1966 return 1;
1967
1968 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1969 res = &global.cps_lim;
1970 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1971 res = &global.sps_lim;
1972#ifdef USE_OPENSSL
1973 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1974 res = &global.ssl_lim;
1975#endif
1976 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1977 res = &global.comp_rate_lim;
1978 mul = 1024;
1979 }
1980 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001981 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001982 "'set rate-limit' only supports :\n"
1983 " - 'connections global' to set the per-process maximum connection rate\n"
1984 " - 'sessions global' to set the per-process maximum session rate\n"
1985#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001986 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001987#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001988 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001989 }
1990
Willy Tarreau9d008692019-08-09 11:21:01 +02001991 if (!*args[4])
1992 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001993
1994 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001995 if (v < 0)
1996 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001997
1998 *res = v * mul;
1999
2000 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01002001 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01002002
2003 return 1;
2004}
2005
William Lallemandf6975e92017-05-26 17:42:10 +02002006/* parse the "expose-fd" argument on the bind lines */
2007static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2008{
2009 if (!*args[cur_arg + 1]) {
2010 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
2011 return ERR_ALERT | ERR_FATAL;
2012 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002013 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02002014 conf->level |= ACCESS_FD_LISTENERS;
2015 } else {
2016 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
2017 args[cur_arg], args[cur_arg+1]);
2018 return ERR_ALERT | ERR_FATAL;
2019 }
2020
2021 return 0;
2022}
2023
William Lallemand74c24fb2016-11-21 17:18:36 +01002024/* parse the "level" argument on the bind lines */
2025static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2026{
2027 if (!*args[cur_arg + 1]) {
2028 memprintf(err, "'%s' : missing level", args[cur_arg]);
2029 return ERR_ALERT | ERR_FATAL;
2030 }
2031
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002032 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02002033 conf->level &= ~ACCESS_LVL_MASK;
2034 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002035 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02002036 conf->level &= ~ACCESS_LVL_MASK;
2037 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002038 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02002039 conf->level &= ~ACCESS_LVL_MASK;
2040 conf->level |= ACCESS_LVL_ADMIN;
2041 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01002042 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
2043 args[cur_arg], args[cur_arg+1]);
2044 return ERR_ALERT | ERR_FATAL;
2045 }
2046
2047 return 0;
2048}
2049
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002050static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2051{
2052 if (!*args[cur_arg + 1]) {
2053 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
2054 return ERR_ALERT | ERR_FATAL;
2055 }
2056
2057 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
2058 return 0;
2059 else {
2060 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
2061 args[cur_arg], args[cur_arg+1]);
2062 return ERR_ALERT | ERR_FATAL;
2063 }
2064}
2065
Olivier Houchardf886e342017-04-05 22:24:59 +02002066/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002067static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02002068{
William Lallemandb5d062d2022-07-28 15:33:41 +02002069 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002070 char *cmsgbuf = NULL;
2071 unsigned char *tmpbuf = NULL;
2072 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02002073 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02002074 struct stream *s = __sc_strm(sc);
2075 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02002076 struct msghdr msghdr;
2077 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02002078 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002079 const char *ns_name, *if_name;
2080 unsigned char ns_nlen, if_nlen;
2081 int nb_queued;
2082 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002083 int *tmpfd;
2084 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002085 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002086 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002087 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002088 int ret;
2089
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002090 if (!remote) {
2091 ha_warning("Only works on real connections\n");
2092 goto out;
2093 }
2094
2095 fd = remote->handle.fd;
2096
Olivier Houchardf886e342017-04-05 22:24:59 +02002097 /* Temporary set the FD in blocking mode, that will make our life easier */
2098 old_fcntl = fcntl(fd, F_GETFL);
2099 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002100 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002101 goto out;
2102 }
2103 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2104 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002105 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002106 goto out;
2107 }
2108 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002109 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002110 goto out;
2111 }
Olivier Houchard54740872017-04-06 14:45:14 +02002112 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002113 iov.iov_base = &tot_fd_nb;
2114 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002115 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002116 goto out;
2117 memset(&msghdr, 0, sizeof(msghdr));
2118 /*
2119 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002120 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002121 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002122 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002123 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002124
William Lallemandb5d062d2022-07-28 15:33:41 +02002125 if (tot_fd_nb == 0) {
2126 if (already_sent)
2127 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 +02002128 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002129 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002130
2131 /* First send the total number of file descriptors, so that the
2132 * receiving end knows what to expect.
2133 */
2134 msghdr.msg_iov = &iov;
2135 msghdr.msg_iovlen = 1;
2136 ret = sendmsg(fd, &msghdr, 0);
2137 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002138 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002139 goto out;
2140 }
2141
2142 /* Now send the fds */
2143 msghdr.msg_control = cmsgbuf;
2144 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2145 cmsg = CMSG_FIRSTHDR(&msghdr);
2146 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2147 cmsg->cmsg_level = SOL_SOCKET;
2148 cmsg->cmsg_type = SCM_RIGHTS;
2149 tmpfd = (int *)CMSG_DATA(cmsg);
2150
Olivier Houchardf886e342017-04-05 22:24:59 +02002151 /* For each socket, e message is sent, containing the following :
2152 * Size of the namespace name (or 0 if none), as an unsigned char.
2153 * The namespace name, if any
2154 * Size of the interface name (or 0 if none), as an unsigned char
2155 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002156 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002157 */
2158 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002159 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002160 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002161 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002162 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002163 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002164 goto out;
2165 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002166
2167 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002168 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002169 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002170 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002171 continue;
2172
2173 ns_name = if_name = "";
2174 ns_nlen = if_nlen = 0;
2175
2176 /* for now we can only retrieve namespaces and interfaces from
2177 * pure listeners.
2178 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002179 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002180 const struct listener *l = fdtab[cur_fd].owner;
2181
Willy Tarreau818a92e2020-09-03 07:50:19 +02002182 if (l->rx.settings->interface) {
2183 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002184 if_nlen = strlen(if_name);
2185 }
2186
2187#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002188 if (l->rx.settings->netns) {
2189 ns_name = l->rx.settings->netns->node.key;
2190 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002191 }
2192#endif
2193 }
2194
2195 /* put the FD into the CMSG_DATA */
2196 tmpfd[nb_queued++] = cur_fd;
2197
2198 /* first block is <ns_name_len> <ns_name> */
2199 tmpbuf[curoff++] = ns_nlen;
2200 if (ns_nlen)
2201 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2202 curoff += ns_nlen;
2203
2204 /* second block is <if_name_len> <if_name> */
2205 tmpbuf[curoff++] = if_nlen;
2206 if (if_nlen)
2207 memcpy(tmpbuf + curoff, if_name, if_nlen);
2208 curoff += if_nlen;
2209
2210 /* we used to send the listener options here before 2.3 */
2211 memset(tmpbuf + curoff, 0, sizeof(int));
2212 curoff += sizeof(int);
2213
2214 /* there's a limit to how many FDs may be sent at once */
2215 if (nb_queued == MAX_SEND_FD) {
2216 iov.iov_len = curoff;
2217 if (sendmsg(fd, &msghdr, 0) != curoff) {
2218 ha_warning("Failed to transfer sockets\n");
2219 return -1;
2220 }
2221
2222 /* Wait for an ack */
2223 do {
2224 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2225 } while (ret == -1 && errno == EINTR);
2226
2227 if (ret <= 0) {
2228 ha_warning("Unexpected error while transferring sockets\n");
2229 return -1;
2230 }
2231 curoff = 0;
2232 nb_queued = 0;
2233 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002234 }
2235
William Lallemandb5d062d2022-07-28 15:33:41 +02002236 already_sent = 1;
2237
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002238 /* flush pending stuff */
2239 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002240 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002241 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2242 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002243 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002244 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002245 goto out;
2246 }
2247 }
2248
2249out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002250 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002251 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002252 goto out;
2253 }
2254 appctx->st0 = CLI_ST_END;
2255 free(cmsgbuf);
2256 free(tmpbuf);
2257 return 1;
2258}
2259
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002260static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2261{
2262 if (*args[0] == 'h')
2263 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002264 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002265 else if (*args[0] == 'p')
2266 /* prompt */
2267 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2268 else if (*args[0] == 'q')
2269 /* quit */
2270 appctx->st0 = CLI_ST_END;
2271
2272 return 1;
2273}
Olivier Houchardf886e342017-04-05 22:24:59 +02002274
William Lallemand2f4ce202018-10-26 14:47:47 +02002275void pcli_write_prompt(struct stream *s)
2276{
2277 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002278 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002279
William Lallemanddc12c2e2018-12-13 09:05:46 +01002280 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002281 return;
2282
William Lallemanddc12c2e2018-12-13 09:05:46 +01002283 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002284 chunk_appendf(msg, "+ ");
2285 } else {
2286 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002287 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002288 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002289 else
William Lallemanddae12c72022-02-02 14:13:54 +01002290 chunk_appendf(msg, "%d", s->pcli_next_pid);
2291
2292 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2293 chunk_appendf(msg, "(");
2294
2295 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2296 chunk_appendf(msg, "x");
2297
2298 if (s->pcli_flags & ACCESS_EXPERT)
2299 chunk_appendf(msg, "e");
2300
2301 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2302 chunk_appendf(msg, "d");
2303
2304 chunk_appendf(msg, ")");
2305 }
2306
2307 chunk_appendf(msg, "> ");
2308
2309
William Lallemandebf61802018-12-11 16:10:57 +01002310 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002311 co_inject(oc, msg->area, msg->data);
2312}
2313
William Lallemand291810d2018-10-26 14:47:38 +02002314
William Lallemandcf62f7e2018-10-26 14:47:40 +02002315/* The pcli_* functions are used for the CLI proxy in the master */
2316
William Lallemanddeeaa592018-10-26 14:47:48 +02002317void pcli_reply_and_close(struct stream *s, const char *msg)
2318{
2319 struct buffer *buf = get_trash_chunk();
2320
2321 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002322 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002323}
2324
William Lallemand291810d2018-10-26 14:47:38 +02002325static enum obj_type *pcli_pid_to_server(int proc_pid)
2326{
2327 struct mworker_proc *child;
2328
William Lallemand99e0bb92020-11-05 10:28:53 +01002329 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002330 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002331 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002332
William Lallemand291810d2018-10-26 14:47:38 +02002333 list_for_each_entry(child, &proc_list, list) {
2334 if (child->pid == proc_pid){
2335 return &child->srv->obj_type;
2336 }
2337 }
2338 return NULL;
2339}
2340
2341/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2342 * Return:
2343 * 0: master
2344 * > 0: pid of a worker
2345 * < 0: didn't find a worker
2346 */
2347static int pcli_prefix_to_pid(const char *prefix)
2348{
2349 int proc_pid;
2350 struct mworker_proc *child;
2351 char *errtol = NULL;
2352
2353 if (*prefix != '@') /* not a prefix, should not happen */
2354 return -1;
2355
2356 prefix++;
2357 if (!*prefix) /* sent @ alone, return the master */
2358 return 0;
2359
2360 if (strcmp("master", prefix) == 0) {
2361 return 0;
2362 } else if (*prefix == '!') {
2363 prefix++;
2364 if (!*prefix)
2365 return -1;
2366
2367 proc_pid = strtol(prefix, &errtol, 10);
2368 if (*errtol != '\0')
2369 return -1;
2370 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002371 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002372 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002373 if (child->pid == proc_pid){
2374 return child->pid;
2375 }
2376 }
2377 } else {
2378 struct mworker_proc *chosen = NULL;
2379 /* this is a relative pid */
2380
2381 proc_pid = strtol(prefix, &errtol, 10);
2382 if (*errtol != '\0')
2383 return -1;
2384
2385 if (proc_pid == 0) /* return the master */
2386 return 0;
2387
William Lallemandbac3a822022-07-20 14:30:56 +02002388 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2389 return -1;
2390
William Lallemand291810d2018-10-26 14:47:38 +02002391 /* chose the right process, the current one is the one with the
2392 least number of reloads */
2393 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002394 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002395 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002396 if (child->reloads == 0)
2397 return child->pid;
2398 else if (chosen == NULL || child->reloads < chosen->reloads)
2399 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002400 }
2401 if (chosen)
2402 return chosen->pid;
2403 }
2404 return -1;
2405}
2406
William Lallemandbddd33a2018-12-11 16:10:53 +01002407/* Return::
2408 * >= 0 : number of words to escape
2409 * = -1 : error
2410 */
2411
2412int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2413{
2414 if (argl < 1)
2415 return 0;
2416
2417 /* there is a prefix */
2418 if (args[0][0] == '@') {
2419 int target_pid = pcli_prefix_to_pid(args[0]);
2420
2421 if (target_pid == -1) {
2422 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2423 return -1;
2424 }
2425
2426 /* if the prefix is alone, define a default target */
2427 if (argl == 1)
2428 s->pcli_next_pid = target_pid;
2429 else
2430 *next_pid = target_pid;
2431 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002432 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002433 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002434 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002435
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002436 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002437 channel_shutr_now(&s->req);
2438 channel_shutw_now(&s->res);
2439 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002440 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002441 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2442 memprintf(errmsg, "Permission denied!\n");
2443 return -1;
2444 }
2445 s->pcli_flags &= ~ACCESS_LVL_MASK;
2446 s->pcli_flags |= ACCESS_LVL_OPER;
2447 return argl;
2448
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002449 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002450 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2451 memprintf(errmsg, "Permission denied!\n");
2452 return -1;
2453 }
2454 s->pcli_flags &= ~ACCESS_LVL_MASK;
2455 s->pcli_flags |= ACCESS_LVL_USER;
2456 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002457
2458 } else if (strcmp(args[0], "expert-mode") == 0) {
2459 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2460 memprintf(errmsg, "Permission denied!\n");
2461 return -1;
2462 }
2463
2464 s->pcli_flags &= ~ACCESS_EXPERT;
2465 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2466 s->pcli_flags |= ACCESS_EXPERT;
2467 return argl;
2468
2469 } else if (strcmp(args[0], "experimental-mode") == 0) {
2470 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2471 memprintf(errmsg, "Permission denied!\n");
2472 return -1;
2473 }
2474 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2475 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2476 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2477 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002478 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2479 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2480 memprintf(errmsg, "Permission denied!\n");
2481 return -1;
2482 }
2483 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2484 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2485 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2486 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002487 }
2488
2489 return 0;
2490}
2491
2492/*
2493 * Parse the CLI request:
2494 * - It does basically the same as the cli_io_handler, but as a proxy
2495 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002496 *
2497 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002498 * - the number of characters to forward or
2499 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002500 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002501int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002502{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002503 char *str;
2504 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002505 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002506 int argl; /* number of args */
2507 char *p;
2508 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002509 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002510 int wtrim = 0; /* number of words to trim */
2511 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002512 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002513 int i = 0;
2514
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002515 /* we cannot deal with a wrapping buffer, so let's take care of this
2516 * first.
2517 */
2518 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2519 b_slow_realign(&req->buf, trash.area, co_data(req));
2520
2521 str = (char *)ci_head(req);
2522 end = (char *)ci_stop(req);
2523
William Lallemandbddd33a2018-12-11 16:10:53 +01002524 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002525
William Lallemanddc12c2e2018-12-13 09:05:46 +01002526 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002527
2528 /* Looks for the end of one command */
2529 while (p+reql < end) {
2530 /* handle escaping */
2531 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002532 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002533 continue;
2534 }
2535 if (p[reql] == ';' || p[reql] == '\n') {
2536 /* found the end of the command */
2537 p[reql] = '\n';
2538 reql++;
2539 break;
2540 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002541 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002542 }
William Lallemandebf61802018-12-11 16:10:57 +01002543 } else {
2544 while (p+reql < end) {
2545 if (p[reql] == '\n') {
2546 /* found the end of the line */
2547 reql++;
2548 break;
2549 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002550 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002551 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002552 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002553
William Lallemandbddd33a2018-12-11 16:10:53 +01002554 /* set end to first byte after the end of the command */
2555 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002556
William Lallemandbddd33a2018-12-11 16:10:53 +01002557 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002558 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002559 return -1;
2560 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002561
William Lallemand3301f3e2018-12-13 09:05:48 +01002562 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2563 if (reql == 1) /* last line of the payload */
2564 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002565 return reql;
2566 }
2567
William Lallemandbddd33a2018-12-11 16:10:53 +01002568 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002569
William Lallemandbddd33a2018-12-11 16:10:53 +01002570 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002571 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002572 /* skip leading spaces/tabs */
2573 p += strspn(p, " \t");
2574 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002575 break;
2576
William Lallemandbddd33a2018-12-11 16:10:53 +01002577 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002578 while (1) {
2579 p += strcspn(p, " \t\\");
2580 /* escaped chars using backlashes (\) */
2581 if (*p == '\\') {
2582 if (!*++p)
2583 break;
2584 if (!*++p)
2585 break;
2586 } else {
2587 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002588 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002589 }
William Lallemandfe249c32020-06-18 18:03:57 +02002590 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002591 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002592 }
2593
William Lallemandbddd33a2018-12-11 16:10:53 +01002594 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002595
Willy Tarreauf14c7572021-03-13 10:59:23 +01002596 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002597 args[i] = NULL;
2598
2599 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2600
2601 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002602 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002603 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002604 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002605 if (*p == '\0')
2606 *p = ' ';
2607 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002608 }
2609
William Lallemand3301f3e2018-12-13 09:05:48 +01002610 payload = strstr(str, PAYLOAD_PATTERN);
2611 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2612 /* if the payload pattern is at the end */
2613 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002614 }
2615
William Lallemandbddd33a2018-12-11 16:10:53 +01002616 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002617
William Lallemandbddd33a2018-12-11 16:10:53 +01002618 if (wtrim > 0) {
2619 trim = &args[wtrim][0];
2620 if (trim == NULL) /* if this was the last word in the table */
2621 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002622
William Lallemandbddd33a2018-12-11 16:10:53 +01002623 b_del(&req->buf, trim - str);
2624
William Lallemandb7ea1412018-12-13 09:05:47 +01002625 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002626 } else if (wtrim < 0) {
2627 /* parsing error */
2628 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002629 } else {
2630 /* the whole string */
2631 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002632 }
2633
William Lallemandb7ea1412018-12-13 09:05:47 +01002634 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002635
2636 /* the mcli-debug-mode is only sent to the applet of the master */
2637 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2638 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2639 ret += strlen("mcli-debug-mode on -") + 2;
2640 }
William Lallemand7267f782022-02-01 16:08:50 +01002641 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2642 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2643 ret += strlen("experimental-mode on -") + 2;
2644 }
2645 if (s->pcli_flags & ACCESS_EXPERT) {
2646 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2647 ret += strlen("expert-mode on -") + 2;
2648 }
2649
William Lallemandb7ea1412018-12-13 09:05:47 +01002650 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2651 goto end;
2652 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002653 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2654 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002655 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002656 ci_insert_line2(req, 0, "user -", strlen("user -"));
2657 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002658 }
2659 }
2660end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002661
William Lallemandb7ea1412018-12-13 09:05:47 +01002662 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002663}
2664
2665int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2666{
William Lallemandbddd33a2018-12-11 16:10:53 +01002667 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002668 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002669 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002670
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002671 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002672 * current one. Just wait. At this stage, errors should be handled by
2673 * the response analyzer.
2674 */
2675 if (s->res.analysers & AN_RES_WAIT_CLI)
2676 return 0;
2677
William Lallemandb7ea1412018-12-13 09:05:47 +01002678 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2679 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2680
William Lallemand0a0512f2022-09-24 16:14:50 +02002681 /* stream that comes from the reload listener only responses the reload
2682 * status and quits */
2683 if (!(s->pcli_flags & PCLI_F_RELOAD)
2684 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2685 goto send_status;
2686
2687
William Lallemandcf62f7e2018-10-26 14:47:40 +02002688read_again:
2689 /* if the channel is closed for read, we won't receive any more data
2690 from the client, but we don't want to forward this close to the
2691 server */
2692 channel_dont_close(req);
2693
2694 /* We don't know yet to which server we will connect */
2695 channel_dont_connect(req);
2696
William Lallemandcf62f7e2018-10-26 14:47:40 +02002697 req->flags |= CF_READ_DONTWAIT;
2698
2699 /* need more data */
2700 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002701 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002702
2703 /* If there is data available for analysis, log the end of the idle time. */
2704 if (c_data(req) && s->logs.t_idle == -1)
2705 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2706
William Lallemandbddd33a2018-12-11 16:10:53 +01002707 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002708 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002709 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002710 /* enough data */
2711
William Lallemandcf62f7e2018-10-26 14:47:40 +02002712 /* forward only 1 command */
2713 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002714
William Lallemanddc12c2e2018-12-13 09:05:46 +01002715 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002716 /* we send only 1 command per request, and we write close after it */
2717 channel_shutw_now(req);
2718 } else {
2719 pcli_write_prompt(s);
2720 }
2721
2722 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002723 s->res.analysers |= AN_RES_WAIT_CLI;
2724
William Lallemandebf61802018-12-11 16:10:57 +01002725 if (!(s->flags & SF_ASSIGNED)) {
2726 if (next_pid > -1)
2727 target_pid = next_pid;
2728 else
2729 target_pid = s->pcli_next_pid;
2730 /* we can connect now */
2731 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002732
William Lallemanddcbe7b92021-12-10 14:14:53 +01002733 if (!s->target)
2734 goto server_disconnect;
2735
William Lallemandebf61802018-12-11 16:10:57 +01002736 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2737 channel_auto_connect(req);
2738 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002739
2740 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002741 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002742 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002743 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002744 } else if (to_forward == -1) {
2745 if (errmsg) {
2746 /* there was an error during the parsing */
2747 pcli_reply_and_close(s, errmsg);
2748 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2749 return 0;
2750 }
2751 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002752 }
2753
2754 return 0;
2755
2756send_help:
2757 b_reset(&req->buf);
2758 b_putblk(&req->buf, "help\n", 5);
2759 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002760
William Lallemand0a0512f2022-09-24 16:14:50 +02002761send_status:
2762 s->pcli_flags |= PCLI_F_RELOAD;
2763 /* dont' use ci_putblk here because SHUTW could have been sent */
2764 b_reset(&req->buf);
2765 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2766 goto read_again;
2767
Christopher Faulet0f727da2022-01-18 08:44:23 +01002768missing_data:
2769 if (req->flags & CF_SHUTR) {
2770 /* There is no more request or a only a partial one and we
2771 * receive a close from the client, we can leave */
2772 channel_shutw_now(&s->res);
2773 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2774 return 1;
2775 }
2776 else if (channel_full(req, global.tune.maxrewrite)) {
2777 /* buffer is full and we didn't catch the end of a command */
2778 goto send_help;
2779 }
2780 return 0;
2781
William Lallemanddcbe7b92021-12-10 14:14:53 +01002782server_disconnect:
2783 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2784 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002785}
2786
2787int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2788{
2789 struct proxy *fe = strm_fe(s);
2790 struct proxy *be = s->be;
2791
Christopher Faulete8cefac2022-03-07 18:20:21 +01002792 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2793 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002794 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002795 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002796 s->res.analysers &= ~AN_RES_WAIT_CLI;
2797 return 0;
2798 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002799 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2800 rep->flags |= CF_NEVER_WAIT;
2801
2802 /* don't forward the close */
2803 channel_dont_close(&s->res);
2804 channel_dont_close(&s->req);
2805
William Lallemanddc12c2e2018-12-13 09:05:46 +01002806 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002807 s->res.analysers &= ~AN_RES_WAIT_CLI;
2808 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2809 return 0;
2810 }
2811
William Lallemandcf62f7e2018-10-26 14:47:40 +02002812 /* forward the data */
2813 if (ci_data(rep)) {
2814 c_adv(rep, ci_data(rep));
2815 return 0;
2816 }
2817
2818 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2819 /* stream cleanup */
2820
William Lallemand2f4ce202018-10-26 14:47:47 +02002821 pcli_write_prompt(s);
2822
Willy Tarreaucb041662022-05-17 19:44:42 +02002823 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreauf61dd192022-05-27 09:00:19 +02002824 sc_shutr(s->scb);
2825 sc_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002826
2827 /*
2828 * starting from there this the same code as
2829 * http_end_txn_clean_session().
2830 *
2831 * It allows to do frontend keepalive while reconnecting to a
2832 * new server for each request.
2833 */
2834
2835 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002836 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002837 if (unlikely(s->srv_conn))
2838 sess_change_server(s, NULL);
2839 }
2840
2841 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2842 stream_process_counters(s);
2843
2844 /* don't count other requests' data */
2845 s->logs.bytes_in -= ci_data(&s->req);
2846 s->logs.bytes_out -= ci_data(&s->res);
2847
2848 /* we may need to know the position in the queue */
2849 pendconn_free(s);
2850
2851 /* let's do a final log if we need it */
2852 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2853 !(s->flags & SF_MONITOR) &&
2854 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2855 s->do_log(s);
2856 }
2857
2858 /* stop tracking content-based counters */
2859 stream_stop_content_counters(s);
2860 stream_update_time_stats(s);
2861
2862 s->logs.accept_date = date; /* user-visible date for logging */
2863 s->logs.tv_accept = now; /* corrected date for internal use */
2864 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2865 s->logs.t_idle = -1;
2866 tv_zero(&s->logs.tv_request);
2867 s->logs.t_queue = -1;
2868 s->logs.t_connect = -1;
2869 s->logs.t_data = -1;
2870 s->logs.t_close = 0;
2871 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2872 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2873
2874 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2875 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2876
2877 stream_del_srv_conn(s);
2878 if (objt_server(s->target)) {
2879 if (s->flags & SF_CURR_SESS) {
2880 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002881 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002882 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002883 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002884 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002885 }
2886
2887 s->target = NULL;
2888
2889 /* only release our endpoint if we don't intend to reuse the
2890 * connection.
2891 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002892 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002893 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002894 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002895 if (!s->conn_err_type)
2896 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002897 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002898 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002899 return 1;
2900 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002901 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002902 }
2903
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002904 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002905
Willy Tarreau74568cf2022-05-27 09:03:30 +02002906 sc_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002907 s->scb->flags &= SC_FL_ISBACK | SC_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet22dc2482019-07-16 14:43:08 +02002908 s->req.flags &= ~(CF_SHUTW|CF_SHUTW_NOW|CF_AUTO_CONNECT|CF_WRITE_ERROR|CF_STREAMER|CF_STREAMER_FAST|CF_NEVER_WAIT|CF_WROTE_DATA);
William Lallemand19338012019-06-25 18:00:19 +02002909 s->res.flags &= ~(CF_SHUTR|CF_SHUTR_NOW|CF_READ_ATTACHED|CF_READ_ERROR|CF_READ_NOEXP|CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_PARTIAL|CF_NEVER_WAIT|CF_WROTE_DATA|CF_READ_NULL);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002910 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002911 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2912 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002913 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002914 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002915 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002916 /* reinitialise the current rule list pointer to NULL. We are sure that
2917 * any rulelist match the NULL pointer.
2918 */
2919 s->current_rule_list = NULL;
2920
2921 s->be = strm_fe(s);
2922 s->logs.logwait = strm_fe(s)->to_log;
2923 s->logs.level = 0;
2924 stream_del_srv_conn(s);
2925 s->target = NULL;
2926 /* re-init store persistence */
2927 s->store_count = 0;
2928 s->uniq_id = global.req_count++;
2929
2930 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2931
2932 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2933
William Lallemandcf62f7e2018-10-26 14:47:40 +02002934 s->res.analysers &= ~AN_RES_WAIT_CLI;
2935
2936 /* We must trim any excess data from the response buffer, because we
2937 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002938 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002939 * we want those data to come along with next response. A typical
2940 * example of such data would be from a buggy server responding to
2941 * a HEAD with some data, or sending more than the advertised
2942 * content-length.
2943 */
2944 if (unlikely(ci_data(&s->res)))
2945 b_set_data(&s->res.buf, co_data(&s->res));
2946
2947 /* Now we can realign the response buffer */
2948 c_realign_if_empty(&s->res);
2949
2950 s->req.rto = strm_fe(s)->timeout.client;
2951 s->req.wto = TICK_ETERNITY;
2952
2953 s->res.rto = TICK_ETERNITY;
2954 s->res.wto = strm_fe(s)->timeout.client;
2955
2956 s->req.rex = TICK_ETERNITY;
2957 s->req.wex = TICK_ETERNITY;
2958 s->req.analyse_exp = TICK_ETERNITY;
2959 s->res.rex = TICK_ETERNITY;
2960 s->res.wex = TICK_ETERNITY;
2961 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002962 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002963
2964 /* we're removing the analysers, we MUST re-enable events detection.
2965 * We don't enable close on the response channel since it's either
2966 * already closed, or in keep-alive with an idle connection handler.
2967 */
2968 channel_auto_read(&s->req);
2969 channel_auto_close(&s->req);
2970 channel_auto_read(&s->res);
2971
2972
2973 return 1;
2974 }
2975 return 0;
2976}
2977
William Lallemand8a022572018-10-26 14:47:35 +02002978/*
2979 * The mworker functions are used to initialize the CLI in the master process
2980 */
2981
William Lallemand309dc9a2018-10-26 14:47:45 +02002982 /*
2983 * Stop the mworker proxy
2984 */
2985void mworker_cli_proxy_stop()
2986{
William Lallemand550db6d2018-11-06 17:37:12 +01002987 if (mworker_proxy)
2988 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002989}
2990
William Lallemand8a022572018-10-26 14:47:35 +02002991/*
2992 * Create the mworker CLI proxy
2993 */
2994int mworker_cli_proxy_create()
2995{
2996 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002997 char *msg = NULL;
2998 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002999
William Lallemandae787ba2021-07-29 15:13:22 +02003000 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02003001 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02003002 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02003003
William Lallemandcf62f7e2018-10-26 14:47:40 +02003004 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02003005 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
3006 mworker_proxy->timeout.client = 0; /* no timeout */
3007 mworker_proxy->conf.file = strdup("MASTER");
3008 mworker_proxy->conf.line = 0;
3009 mworker_proxy->accept = frontend_accept;
3010 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
3011
3012 /* Does not init the default target the CLI applet, but must be done in
3013 * the request parsing code */
3014 mworker_proxy->default_target = NULL;
3015
William Lallemand8a022572018-10-26 14:47:35 +02003016 /* create all servers using the mworker_proc list */
3017 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02003018 struct server *newsrv = NULL;
3019 struct sockaddr_storage *sk;
3020 int port1, port2, port;
3021 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02003022
William Lallemanda31b09e2020-01-14 15:25:02 +01003023 /* only the workers support the master CLI */
3024 if (!(child->options & PROC_O_TYPE_WORKER))
3025 continue;
3026
William Lallemand8a022572018-10-26 14:47:35 +02003027 newsrv = new_server(mworker_proxy);
3028 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01003029 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02003030
3031 /* we don't know the new pid yet */
3032 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02003033 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02003034 else
3035 memprintf(&msg, "old-%d", child->pid);
3036
3037 newsrv->next = mworker_proxy->srv;
3038 mworker_proxy->srv = newsrv;
3039 newsrv->conf.file = strdup(msg);
3040 newsrv->id = strdup(msg);
3041 newsrv->conf.line = 0;
3042
3043 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02003044 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02003045 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01003046 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003047 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003048 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02003049
Willy Tarreau5fc93282020-09-16 18:25:03 +02003050 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01003051 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02003052 }
3053
3054 /* no port specified */
3055 newsrv->flags |= SRV_F_MAPPORTS;
3056 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02003057 /* don't let the server participate to load balancing */
3058 newsrv->iweight = 0;
3059 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02003060 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02003061
3062 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02003063 }
William Lallemandae787ba2021-07-29 15:13:22 +02003064
3065 mworker_proxy->next = proxies_list;
3066 proxies_list = mworker_proxy;
3067
William Lallemand8a022572018-10-26 14:47:35 +02003068 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003069
3070error:
William Lallemand744a0892018-11-22 16:46:51 +01003071
3072 list_for_each_entry(child, &proc_list, list) {
3073 free((char *)child->srv->conf.file); /* cast because of const char * */
3074 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003075 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01003076 }
William Lallemandae787ba2021-07-29 15:13:22 +02003077 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01003078 free(msg);
3079
William Lallemandae787ba2021-07-29 15:13:22 +02003080error_proxy:
3081 ha_alert("%s\n", errmsg);
3082 free(errmsg);
3083
William Lallemand744a0892018-11-22 16:46:51 +01003084 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02003085}
Olivier Houchardf886e342017-04-05 22:24:59 +02003086
William Lallemandce83b4a2018-10-26 14:47:30 +02003087/*
William Lallemande7361152018-10-26 14:47:36 +02003088 * Create a new listener for the master CLI proxy
3089 */
William Lallemand21623b52022-09-24 15:51:27 +02003090struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02003091{
3092 struct bind_conf *bind_conf;
3093 struct listener *l;
3094 char *err = NULL;
3095 char *args[MAX_LINE_ARGS + 1];
3096 int arg;
3097 int cur_arg;
3098
William Lallemand2e945c82019-11-25 09:58:37 +01003099 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02003100 args[0] = line;
3101
3102 /* args is a bind configuration with spaces replaced by commas */
3103 while (*line && arg < MAX_LINE_ARGS) {
3104
3105 if (*line == ',') {
3106 *line++ = '\0';
3107 while (*line == ',')
3108 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01003109 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02003110 }
3111 line++;
3112 }
3113
William Lallemand2e945c82019-11-25 09:58:37 +01003114 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02003115
3116 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003117 if (!bind_conf)
3118 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003119
3120 bind_conf->level &= ~ACCESS_LVL_MASK;
3121 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003122 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
Willy Tarreaudcbd7632022-07-06 11:46:34 +02003123 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemande7361152018-10-26 14:47:36 +02003124
3125 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3126 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003127 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003128 }
3129
3130 cur_arg = 1;
3131
3132 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003133 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003134 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003135
3136 kw = bind_find_kw(args[cur_arg]);
3137 if (kw) {
3138 if (!kw->parse) {
3139 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3140 args[0], args[1], args[cur_arg]);
3141 goto err;
3142 }
3143
Willy Tarreau4975d142021-03-13 11:00:33 +01003144 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003145 if (err)
3146 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3147 else
3148 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3149 args[0], args[1], args[cur_arg]);
3150 goto err;
3151 }
3152
3153 cur_arg += 1 + kw->skip;
3154 continue;
3155 }
3156
Willy Tarreau433b05f2021-03-12 10:14:07 +01003157 best = bind_find_best_kw(args[cur_arg]);
3158 if (best)
3159 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3160 args[0], args[1], args[cur_arg], best);
3161 else
3162 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3163 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003164 goto err;
3165 }
3166
3167
3168 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003169 l->accept = session_accept_fd;
3170 l->default_target = mworker_proxy->default_target;
3171 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003172 l->options |= LI_O_UNLIMITED;
3173 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003174 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003175 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003176 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003177 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003178
William Lallemand21623b52022-09-24 15:51:27 +02003179 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003180
3181err:
3182 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003183 free(err);
3184 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003185 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003186
3187}
3188
3189/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003190 * Create a new CLI socket using a socketpair for a worker process
3191 * <mworker_proc> is the process structure, and <proc> is the process number
3192 */
3193int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3194{
3195 struct bind_conf *bind_conf;
3196 struct listener *l;
3197 char *path = NULL;
3198 char *err = NULL;
3199
3200 /* master pipe to ensure the master is still alive */
3201 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3202 ha_alert("Cannot create worker socketpair.\n");
3203 return -1;
3204 }
3205
3206 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003207 if (!global.cli_fe) {
3208 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003209 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003210 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003211 }
3212 }
3213
Willy Tarreau4975d142021-03-13 11:00:33 +01003214 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003215 if (!bind_conf)
3216 goto error;
3217
William Lallemandce83b4a2018-10-26 14:47:30 +02003218 bind_conf->level &= ~ACCESS_LVL_MASK;
3219 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003220 bind_conf->level |= ACCESS_FD_LISTENERS;
Willy Tarreaudcbd7632022-07-06 11:46:34 +02003221 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemandce83b4a2018-10-26 14:47:30 +02003222
William Lallemandce83b4a2018-10-26 14:47:30 +02003223 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3224 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003225 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003226 }
3227
Willy Tarreau4975d142021-03-13 11:00:33 +01003228 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003229 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003230 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003231 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003232 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003233 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003234
3235 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003236 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003237 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003238 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003239 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003240 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003241 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003242 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003243 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003244 }
3245
3246 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003247
3248error:
3249 close(mworker_proc->ipc_fd[0]);
3250 close(mworker_proc->ipc_fd[1]);
3251 free(err);
3252
3253 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003254}
3255
William Lallemand74c24fb2016-11-21 17:18:36 +01003256static struct applet cli_applet = {
3257 .obj_type = OBJ_TYPE_APPLET,
3258 .name = "<CLI>", /* used for logging */
3259 .fct = cli_io_handler,
3260 .release = cli_release_handler,
3261};
3262
William Lallemand99e0bb92020-11-05 10:28:53 +01003263/* master CLI */
3264static struct applet mcli_applet = {
3265 .obj_type = OBJ_TYPE_APPLET,
3266 .name = "<MCLI>", /* used for logging */
3267 .fct = cli_io_handler,
3268 .release = cli_release_handler,
3269};
3270
Willy Tarreau0a739292016-11-22 20:21:23 +01003271/* register cli keywords */
3272static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003273 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3274 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3275 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3276 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003277 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3278 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003279 { { "mcli-debug-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER_ONLY }, // not listed
Erwan Le Goas54966df2022-09-14 17:24:22 +02003280 { { "set", "anon", NULL }, "set anon <setting> [value] : change the anonymized mode setting", cli_parse_set_anon, NULL, NULL },
Erwan Le Goasd7869312022-09-29 10:36:11 +02003281 { { "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 +02003282 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3283 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3284 { { "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 },
3285 { { "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 +02003286 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003287 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3288 { { "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 },
3289 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3290 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use or a specific one", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
Willy Tarreau9a7fa902022-07-15 16:51:16 +02003291 { { "show", "activity", NULL }, "show activity [-1|0|thread_num] : show per-thread activity stats (for support/developers)", cli_parse_show_activity, cli_io_handler_show_activity, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003292 { { "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 +02003293 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3294 { { "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 +01003295 {{},}
3296}};
3297
Willy Tarreau0108d902018-11-25 19:14:37 +01003298INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3299
William Lallemand74c24fb2016-11-21 17:18:36 +01003300static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003301 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003302 { 0, NULL, NULL },
3303}};
3304
Willy Tarreau0108d902018-11-25 19:14:37 +01003305INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3306
William Lallemand74c24fb2016-11-21 17:18:36 +01003307static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003308 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3309 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003310 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003311 { NULL, NULL, 0 },
3312}};
3313
Willy Tarreau0108d902018-11-25 19:14:37 +01003314INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003315
3316/*
3317 * Local variables:
3318 * c-indent-level: 8
3319 * c-basic-offset: 8
3320 * End:
3321 */