blob: aeba3f3165e65e8d06235b4cff3203739211903b [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020031#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020032#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Christopher Faulet908628c2022-03-25 16:43:49 +010037#include <haproxy/conn_stream.h>
38#include <haproxy/cs_utils.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020039#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020040#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020041#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/fd.h>
43#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020044#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020045#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020046#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020047#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020048#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010049#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020050#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020051#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020052#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020053#include <haproxy/pipe.h>
54#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020055#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020056#include <haproxy/sample-t.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020057#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020058#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020059#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020060#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020061#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020062#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020063#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020064#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020065#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020066#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010067
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020068#define PAYLOAD_PATTERN "<<"
69
William Lallemand74c24fb2016-11-21 17:18:36 +010070static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010071static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010072
Willy Tarreau4975d142021-03-13 11:00:33 +010073static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010074 "Permission denied\n"
75 "";
76
77
Christopher Faulet1bc04c72017-10-29 20:14:08 +010078static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010079
80/* List head of cli keywords */
81static struct cli_kw_list cli_keywords = {
82 .list = LIST_HEAD_INIT(cli_keywords.list)
83};
84
85extern const char *stat_status_codes[];
86
Eric Salama1b8dacc2021-03-16 15:12:17 +010087struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +020088
Willy Tarreau307dbb32022-05-05 17:45:52 +020089/* CLI context for the "show env" command */
90struct show_env_ctx {
91 char **var; /* first variable to show */
92 int show_one; /* stop after showing the first one */
93};
94
Willy Tarreau741a5a92022-05-05 17:56:58 +020095/* CLI context for the "show fd" command */
96struct show_fd_ctx {
97 int fd; /* first FD to show */
98 int show_one; /* stop after showing one FD */
99};
100
Willy Tarreaub128f492022-05-05 19:11:05 +0200101/* CLI context for the "show cli sockets" command */
102struct show_sock_ctx {
103 struct bind_conf *bind_conf;
104 struct listener *listener;
105};
106
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200107static int cmp_kw_entries(const void *a, const void *b)
108{
109 const struct cli_kw *l = *(const struct cli_kw **)a;
110 const struct cli_kw *r = *(const struct cli_kw **)b;
111
112 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
113}
114
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100115/* This will show the help message and list the commands supported at the
116 * current level that match all of the first words of <args> if args is not
117 * NULL, or all args if none matches or if args is null.
118 */
119static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100120{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200121 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100122 struct cli_kw_list *kw_list;
123 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200124 struct buffer *tmp = get_trash_chunk();
125 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100126 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100127 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200128 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100129 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200130 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100131
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100132 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100133
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200134 if (args && *args && strcmp(*args, "help") == 0) {
135 args++;
136 ishelp = 1;
137 }
138
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100139 /* first, let's measure the longest match */
140 list_for_each_entry(kw_list, &cli_keywords.list, list) {
141 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100142 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100143 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100144 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
145 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100146 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
147 continue;
148
149 /* OK this command is visible */
150 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
151 if (!kw->str_kw[idx])
152 break; // end of keyword
153 if (!args || !args[idx] || !*args[idx])
154 break; // end of command line
155 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
156 break;
157 if (idx + 1 > length)
158 length = idx + 1;
159 }
160 }
161 }
162
Willy Tarreaub7364582021-03-12 18:24:46 +0100163 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100164 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200165 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100166 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200167 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100168 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
169 else // partial match
170 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
171
Willy Tarreaub7364582021-03-12 18:24:46 +0100172 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
173 matches[idx].kw = NULL;
174 matches[idx].dist = INT_MAX;
175 }
176
177 /* In case of partial match we'll look for the best matching entries
178 * starting from position <length>
179 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100180 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100181 list_for_each_entry(kw_list, &cli_keywords.list, list) {
182 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100183 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100184 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100185 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
186 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
187 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100188 continue;
189
190 for (idx = 0; idx < length; idx++) {
191 if (!kw->str_kw[idx])
192 break; // end of keyword
193 if (!args || !args[idx] || !*args[idx])
194 break; // end of command line
195 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
196 break;
197 }
198
199 /* extra non-matching words are fuzzy-matched */
200 if (kw->usage && idx == length && args[idx] && *args[idx]) {
201 uint8_t word_sig[1024];
202 uint8_t list_sig[1024];
203 int dist = 0;
204 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100205 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100206
207 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100208 * on the remaining words. For this we're computing the signature
209 * of everything that remains and the cumulated length of the
210 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100211 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100212 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100213 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
214 update_word_fingerprint(word_sig, args[i]);
215 totlen += strlen(args[i]);
216 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100217
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100218 memset(list_sig, 0, sizeof(list_sig));
219 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
220 update_word_fingerprint(list_sig, kw->str_kw[i]);
221 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100222 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100223
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100224 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100225
226 /* insert this one at its place if relevant, in order to keep only
227 * the best matches.
228 */
229 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100230 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100231 matches[CLI_MAX_MATCHES-1] = swp;
232 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
233 if (matches[idx+1].dist >= matches[idx].dist)
234 break;
235 matches[idx+1] = matches[idx];
236 matches[idx] = swp;
237 }
238 }
239 }
240 }
241 }
242 }
243
Willy Tarreauec197e82021-03-15 10:35:04 +0100244 if (matches[0].kw) {
245 /* we have fuzzy matches, let's propose them */
246 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
247 kw = matches[idx].kw;
248 if (!kw)
249 break;
250
251 /* stop the dump if some words look very unlikely candidates */
252 if (matches[idx].dist > 5*matches[0].dist/2)
253 break;
254
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200255 if (help_entries < CLI_MAX_HELP_ENTRIES)
256 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100257 }
258 }
259
William Lallemand74c24fb2016-11-21 17:18:36 +0100260 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100261 /* no full dump if we've already found nice candidates */
262 if (matches[0].kw)
263 break;
264
Willy Tarreau91bc3592021-03-12 15:20:39 +0100265 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200266
Willy Tarreau91bc3592021-03-12 15:20:39 +0100267 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100268 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100269 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100270 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100271 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200272
William Lallemand2a171912022-02-02 11:43:20 +0100273 /* in master, if the CLI don't have the
274 * ACCESS_MCLI_DEBUG don't display commands that have
275 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100276 */
William Lallemand2a171912022-02-02 11:43:20 +0100277 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
278 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
279 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100280 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200281
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100282 for (idx = 0; idx < length; idx++) {
283 if (!kw->str_kw[idx])
284 break; // end of keyword
285 if (!args || !args[idx] || !*args[idx])
286 break; // end of command line
287 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
288 break;
289 }
290
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200291 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
292 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100293 }
294 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100295
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200296 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
297
298 for (idx = 0; idx < help_entries; idx++)
299 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
300
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100301 /* always show the prompt/help/quit commands */
302 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200303 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200304 " prompt : toggle interactive mode with prompt\n"
305 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100306
William Lallemand74c24fb2016-11-21 17:18:36 +0100307 chunk_init(&out, NULL, 0);
308 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200309 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200310
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200311 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100312 return dynamic_usage_msg;
313}
314
315struct cli_kw* cli_find_kw(char **args)
316{
317 struct cli_kw_list *kw_list;
318 struct cli_kw *kw;/* current cli_kw */
319 char **tmp_args;
320 const char **tmp_str_kw;
321 int found = 0;
322
323 if (LIST_ISEMPTY(&cli_keywords.list))
324 return NULL;
325
326 list_for_each_entry(kw_list, &cli_keywords.list, list) {
327 kw = &kw_list->kw[0];
328 while (*kw->str_kw) {
329 tmp_args = args;
330 tmp_str_kw = kw->str_kw;
331 while (*tmp_str_kw) {
332 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
333 found = 1;
334 } else {
335 found = 0;
336 break;
337 }
338 tmp_args++;
339 tmp_str_kw++;
340 }
341 if (found)
342 return (kw);
343 kw++;
344 }
345 }
346 return NULL;
347}
348
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100349struct cli_kw* cli_find_kw_exact(char **args)
350{
351 struct cli_kw_list *kw_list;
352 int found = 0;
353 int i;
354 int j;
355
356 if (LIST_ISEMPTY(&cli_keywords.list))
357 return NULL;
358
359 list_for_each_entry(kw_list, &cli_keywords.list, list) {
360 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
361 found = 1;
362 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
363 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
364 break;
365 }
366 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
367 found = 0;
368 break;
369 }
370 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
371 found = 0;
372 break;
373 }
374 }
375 if (found)
376 return &kw_list->kw[i];
377 }
378 }
379 return NULL;
380}
381
William Lallemand74c24fb2016-11-21 17:18:36 +0100382void cli_register_kw(struct cli_kw_list *kw_list)
383{
Willy Tarreau2b718102021-04-21 07:32:39 +0200384 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100385}
386
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200387/* list all known keywords on stdout, one per line */
388void cli_list_keywords(void)
389{
390 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200391 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200392 int idx;
393
Willy Tarreau44651712022-03-30 12:02:35 +0200394 for (kwn = kwp = NULL;; kwp = kwn) {
395 list_for_each_entry(kw_list, &cli_keywords.list, list) {
396 /* note: we sort based on the usage message when available,
397 * otherwise we fall back to the first keyword.
398 */
399 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
400 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
401 kw->usage ? kw->usage : kw->str_kw[0],
402 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
403 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200404 }
Willy Tarreau44651712022-03-30 12:02:35 +0200405 }
406
407 if (kwn == kwp)
408 break;
409
410 for (idx = 0; kwn->str_kw[idx]; idx++) {
411 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200412 }
Willy Tarreau44651712022-03-30 12:02:35 +0200413 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
414 printf("[MASTER] ");
415 if (!(kwn->level & ACCESS_MASTER_ONLY))
416 printf("[WORKER] ");
417 if (kwn->level & ACCESS_EXPERT)
418 printf("[EXPERT] ");
419 if (kwn->level & ACCESS_EXPERIMENTAL)
420 printf("[EXPERIM] ");
421 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200422 }
423}
William Lallemand74c24fb2016-11-21 17:18:36 +0100424
425/* allocate a new stats frontend named <name>, and return it
426 * (or NULL in case of lack of memory).
427 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100428static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100429{
430 struct proxy *fe;
431
432 fe = calloc(1, sizeof(*fe));
433 if (!fe)
434 return NULL;
435
436 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100437 fe->next = proxies_list;
438 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100439 fe->last_change = now.tv_sec;
440 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200441 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100442 fe->maxconn = 10; /* default to 10 concurrent connections */
443 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
444 fe->conf.file = strdup(file);
445 fe->conf.line = line;
446 fe->accept = frontend_accept;
447 fe->default_target = &cli_applet.obj_type;
448
449 /* the stats frontend is the only one able to assign ID #0 */
450 fe->conf.id.key = fe->uuid = 0;
451 eb32_insert(&used_proxy_id, &fe->conf.id);
452 return fe;
453}
454
455/* This function parses a "stats" statement in the "global" section. It returns
456 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
457 * error message into the <err> buffer which will be preallocated. The trailing
458 * '\n' must not be written. The function must be called with <args> pointing to
459 * the first word after "stats".
460 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100461static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
462 const struct proxy *defpx, const char *file, int line,
463 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100464{
465 struct bind_conf *bind_conf;
466 struct listener *l;
467
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100468 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100469 int cur_arg;
470
471 if (*args[2] == 0) {
472 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
473 return -1;
474 }
475
Willy Tarreau4975d142021-03-13 11:00:33 +0100476 if (!global.cli_fe) {
477 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100478 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
479 return -1;
480 }
481 }
482
Willy Tarreau4975d142021-03-13 11:00:33 +0100483 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200484 if (!bind_conf) {
485 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
486 return -1;
487 }
William Lallemand07a62f72017-05-24 00:57:40 +0200488 bind_conf->level &= ~ACCESS_LVL_MASK;
489 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100490
Willy Tarreau4975d142021-03-13 11:00:33 +0100491 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100492 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
493 file, line, args[0], args[1], err && *err ? *err : "error");
494 return -1;
495 }
496
497 cur_arg = 3;
498 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100499 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100500 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100501 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100502
503 kw = bind_find_kw(args[cur_arg]);
504 if (kw) {
505 if (!kw->parse) {
506 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
507 args[0], args[1], args[cur_arg]);
508 return -1;
509 }
510
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100511 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
512
513 /* FIXME: this is ugly, we don't have a way to collect warnings,
514 * yet some important bind keywords may report warnings that we
515 * must display.
516 */
517 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
518 indent_msg(err, 2);
519 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
520 ha_free(err);
521 }
522
523 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100524 if (err && *err)
525 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
526 else
527 memprintf(err, "'%s %s' : error encountered while processing '%s'",
528 args[0], args[1], args[cur_arg]);
529 return -1;
530 }
531
532 cur_arg += 1 + kw->skip;
533 continue;
534 }
535
Willy Tarreau433b05f2021-03-12 10:14:07 +0100536 best = bind_find_best_kw(args[cur_arg]);
537 if (best)
538 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
539 args[0], args[1], args[cur_arg], best);
540 else
541 memprintf(err, "'%s %s' : unknown keyword '%s'.",
542 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100543 return -1;
544 }
545
546 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100547 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100548 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100549 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
550 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100551 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100552 }
553 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100554 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100555 unsigned timeout;
556 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
557
Willy Tarreau9faebe32019-06-07 19:00:37 +0200558 if (res == PARSE_TIME_OVER) {
559 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
560 args[2], args[0], args[1]);
561 return -1;
562 }
563 else if (res == PARSE_TIME_UNDER) {
564 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
565 args[2], args[0], args[1]);
566 return -1;
567 }
568 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100569 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
570 return -1;
571 }
572
573 if (!timeout) {
574 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
575 return -1;
576 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100577 if (!global.cli_fe) {
578 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100579 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
580 return -1;
581 }
582 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100583 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100584 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100585 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100586 int maxconn = atol(args[2]);
587
588 if (maxconn <= 0) {
589 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
590 return -1;
591 }
592
Willy Tarreau4975d142021-03-13 11:00:33 +0100593 if (!global.cli_fe) {
594 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100595 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
596 return -1;
597 }
598 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100599 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100600 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100601 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 int cur_arg = 2;
603 unsigned long set = 0;
604
Willy Tarreau4975d142021-03-13 11:00:33 +0100605 if (!global.cli_fe) {
606 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100607 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
608 return -1;
609 }
610 }
611
612 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100613 if (strcmp(args[cur_arg], "all") == 0) {
614 set = 0;
615 break;
616 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200617 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100618 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100619 return -1;
620 }
621 cur_arg++;
622 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100623 }
624 else {
625 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
626 return -1;
627 }
628 return 0;
629}
630
William Lallemand33d29e22019-04-01 11:30:06 +0200631/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200632 * This function exports the bound addresses of a <frontend> in the environment
633 * variable <varname>. Those addresses are separated by semicolons and prefixed
634 * with their type (abns@, unix@, sockpair@ etc)
635 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200636 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200637int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200638{
639 struct buffer *trash = get_trash_chunk();
640 struct bind_conf *bind_conf;
641
William Lallemand9a37fd02019-04-12 16:09:24 +0200642 if (frontend) {
643 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200644 struct listener *l;
645
646 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
647 char addr[46];
648 char port[6];
649
William Lallemand620072b2019-04-12 16:09:25 +0200650 /* separate listener by semicolons */
651 if (trash->data)
652 chunk_appendf(trash, ";");
653
Willy Tarreau37159062020-08-27 07:48:42 +0200654 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200655 const struct sockaddr_un *un;
656
Willy Tarreau37159062020-08-27 07:48:42 +0200657 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200658 if (un->sun_path[0] == '\0') {
659 chunk_appendf(trash, "abns@%s", un->sun_path+1);
660 } else {
661 chunk_appendf(trash, "unix@%s", un->sun_path);
662 }
Willy Tarreau37159062020-08-27 07:48:42 +0200663 } else if (l->rx.addr.ss_family == AF_INET) {
664 addr_to_str(&l->rx.addr, addr, sizeof(addr));
665 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200666 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200667 } else if (l->rx.addr.ss_family == AF_INET6) {
668 addr_to_str(&l->rx.addr, addr, sizeof(addr));
669 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200670 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200671 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
672 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200673 }
William Lallemand33d29e22019-04-01 11:30:06 +0200674 }
675 }
676 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200677 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200678 return -1;
679 }
680
681 return 0;
682}
683
William Lallemand9a37fd02019-04-12 16:09:24 +0200684int cli_socket_setenv()
685{
Willy Tarreau4975d142021-03-13 11:00:33 +0100686 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200687 return -1;
688 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
689 return -1;
690
691 return 0;
692}
693
William Lallemand33d29e22019-04-01 11:30:06 +0200694REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
695
Willy Tarreaude57a572016-11-23 17:01:39 +0100696/* Verifies that the CLI at least has a level at least as high as <level>
697 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
698 * failure, an error message is prepared and the appctx's state is adjusted
699 * to print it so that a return 1 is enough to abort any processing.
700 */
701int cli_has_level(struct appctx *appctx, int level)
702{
Willy Tarreaude57a572016-11-23 17:01:39 +0100703
William Lallemandf630d012018-12-13 09:05:44 +0100704 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100705 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100706 return 0;
707 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100708 return 1;
709}
710
William Lallemandb7ea1412018-12-13 09:05:47 +0100711/* same as cli_has_level but for the CLI proxy and without error message */
712int pcli_has_level(struct stream *s, int level)
713{
714 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
715 return 0;
716 }
717 return 1;
718}
719
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200720/* Returns severity_output for the current session if set, or default for the socket */
721static int cli_get_severity_output(struct appctx *appctx)
722{
723 if (appctx->cli_severity_output)
724 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200725 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200726}
William Lallemand74c24fb2016-11-21 17:18:36 +0100727
Willy Tarreau41908562016-11-24 16:23:38 +0100728/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100729 * from the CLI's IO handler running in an appctx context. The function returns
730 * 1 if the request was understood, otherwise zero (in which case an error
731 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100732 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
733 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
734 * have its own I/O handler called again. Most of the time, parsers will only
735 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100736 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
737 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100738 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200739static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100740{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100741 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100744
Willy Tarreauc7afedc2022-05-05 20:01:54 +0200745 appctx->_st2 = 0;
Willy Tarreauf12f32a2022-05-02 14:57:03 +0200746
747 /* temporary for 2.6: let's make sure we clean the whole shared
748 * context.
749 */
750 if (sizeof(appctx->ctx) > sizeof(appctx->svc))
751 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
752 else
753 memset(&appctx->svc, 0, sizeof(appctx->svc));
William Lallemand74c24fb2016-11-21 17:18:36 +0100754
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200755 p = appctx->chunk->area;
756 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100757
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200758 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200759 * Get pointers on words.
760 * One extra slot is reserved to store a pointer on a null byte.
761 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100762 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200763 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100764
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200765 /* skip leading spaces/tabs */
766 p += strspn(p, " \t");
767 if (!*p)
768 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200769
770 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
771 /* payload pattern recognized here, this is not an arg anymore,
772 * the payload starts at the first byte that follows the zero
773 * after the pattern.
774 */
775 payload = p + strlen(PAYLOAD_PATTERN) + 1;
776 break;
777 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100778
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200779 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200780 while (1) {
781 p += strcspn(p, " \t\\");
782 /* escaped chars using backlashes (\) */
783 if (*p == '\\') {
784 if (!*++p)
785 break;
786 if (!*++p)
787 break;
788 } else {
789 break;
790 }
791 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200792 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100793
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200794 /* unescape backslashes (\) */
795 for (j = 0, k = 0; args[i][k]; k++) {
796 if (args[i][k] == '\\') {
797 if (args[i][k + 1] == '\\')
798 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100799 else
800 continue;
801 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200802 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100803 j++;
804 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200805 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100806
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200807 i++;
808 }
809 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200810 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100811 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200812 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100813
814 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100815 if (!kw ||
816 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100817 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
818 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100819 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100820 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100821 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100822 }
William Lallemand14721be2018-10-26 14:47:37 +0200823
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100824 /* don't handle expert mode commands if not in this mode. */
825 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
826 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200827 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100828 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200829
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100830 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
831 cli_err(appctx, "This command is restricted to experimental mode only.\n");
832 return 0;
833 }
834
Amaury Denoyellef4929922021-05-05 16:29:23 +0200835 if (kw->level == ACCESS_EXPERT)
836 mark_tainted(TAINTED_CLI_EXPERT_MODE);
837 else if (kw->level == ACCESS_EXPERIMENTAL)
838 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
839
Willy Tarreau41908562016-11-24 16:23:38 +0100840 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200841 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200842
843 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
844 goto fail;
845
846 /* kw->parse could set its own io_handler or io_release handler */
847 if (!appctx->io_handler)
848 goto fail;
849
850 appctx->st0 = CLI_ST_CALLBACK;
851 return 1;
852fail:
853 appctx->io_handler = NULL;
854 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100855 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100856}
857
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200858/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
859static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
860{
Willy Tarreau83061a82018-07-13 11:56:34 +0200861 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200862
863 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200864 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200865
866 tmp = get_trash_chunk();
867 chunk_reset(tmp);
868
869 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100870 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200871 chunk_printf(tmp, "[%d]: ", severity);
872 }
873 else {
874 switch (severity_output) {
875 case CLI_SEVERITY_NUMBER:
876 chunk_printf(tmp, "[%d]: ", severity);
877 break;
878 case CLI_SEVERITY_STRING:
879 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
880 break;
881 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100882 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200883 }
884 }
885 chunk_appendf(tmp, "%s", msg);
886
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200887 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200888}
889
Willy Tarreau4596fe22022-05-17 19:07:51 +0200890/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100891 * used to processes I/O from/to the stats unix socket. The system relies on a
892 * state machine handling requests and various responses. We read a request,
893 * then we process it and send the response, and we possibly display a prompt.
894 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100895 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100896 * or not.
897 */
898static void cli_io_handler(struct appctx *appctx)
899{
Willy Tarreau4596fe22022-05-17 19:07:51 +0200900 struct stconn *cs = appctx_cs(appctx);
Willy Tarreau40a9c322022-05-18 15:55:18 +0200901 struct channel *req = sc_oc(cs);
902 struct channel *res = sc_ic(cs);
Willy Tarreauea27f482022-05-18 16:10:52 +0200903 struct bind_conf *bind_conf = strm_li(__sc_strm(cs))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100904 int reql;
905 int len;
906
Willy Tarreau026e8fb2022-05-17 19:47:17 +0200907 if (unlikely(cs->state == SC_ST_DIS || cs->state == SC_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100908 goto out;
909
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800910 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200911 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100912 /* buf.size==0 means we failed to get a buffer and were
913 * already subscribed to a wait list to get a buffer.
914 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100915 goto out;
916 }
917
William Lallemand74c24fb2016-11-21 17:18:36 +0100918 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100919 if (appctx->st0 == CLI_ST_INIT) {
Willy Tarreau7bf20ca2022-05-03 17:02:03 +0200920 /* CLI/stats not initialized yet */
921 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200922 /* reset severity to default at init */
923 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100924 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100925 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100926 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100927 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100928 /* Let's close for real now. We just close the request
929 * side, the conditions below will complete if needed.
930 */
Willy Tarreauf61dd192022-05-27 09:00:19 +0200931 sc_shutw(cs);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200932 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200933 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100934 break;
935 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100936 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200937 char *str;
938
939 /* use a trash chunk to store received data */
940 if (!appctx->chunk) {
941 appctx->chunk = alloc_trash_chunk();
942 if (!appctx->chunk) {
943 appctx->st0 = CLI_ST_END;
944 continue;
945 }
946 }
947
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200948 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200949
William Lallemand74c24fb2016-11-21 17:18:36 +0100950 /* ensure we have some output room left in the event we
951 * would want to return some info right after parsing.
952 */
Willy Tarreau40a9c322022-05-18 15:55:18 +0200953 if (buffer_almost_full(sc_ib(cs))) {
Willy Tarreau99615ed2022-05-25 07:29:36 +0200954 sc_need_room(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +0100955 break;
956 }
957
Willy Tarreau0011c252022-01-19 17:23:52 +0100958 /* payload doesn't take escapes nor does it end on semi-colons, so
959 * we use the regular getline. Normal mode however must stop on
960 * LFs and semi-colons that are not prefixed by a backslash. Note
961 * that we reserve one byte at the end to insert a trailing nul byte.
962 */
963
964 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau40a9c322022-05-18 15:55:18 +0200965 reql = co_getline(sc_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100966 appctx->chunk->size - appctx->chunk->data - 1);
967 else
Willy Tarreau40a9c322022-05-18 15:55:18 +0200968 reql = co_getdelim(sc_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100969 appctx->chunk->size - appctx->chunk->data - 1,
970 "\n;", '\\');
971
William Lallemand74c24fb2016-11-21 17:18:36 +0100972 if (reql <= 0) { /* closed or EOL not found */
973 if (reql == 0)
974 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100975 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100976 continue;
977 }
978
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200979 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
980 /* seek for a possible unescaped semi-colon. If we find
981 * one, we replace it with an LF and skip only this part.
982 */
983 for (len = 0; len < reql; len++) {
984 if (str[len] == '\\') {
985 len++;
986 continue;
987 }
988 if (str[len] == ';') {
989 str[len] = '\n';
990 reql = len + 1;
991 break;
992 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100993 }
994 }
995
996 /* now it is time to check that we have a full line,
997 * remove the trailing \n and possibly \r, then cut the
998 * line.
999 */
1000 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001001 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001002 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001003 continue;
1004 }
1005
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001006 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +01001007 len--;
1008
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001009 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001010 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001011
1012 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001013 appctx->chunk->area[appctx->chunk->data] = '\n';
1014 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1015 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001016 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001017
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001018 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001019
1020 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1021 /* empty line */
1022 if (!len) {
1023 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001024 appctx->chunk->data -= 2;
1025 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001026 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001027 chunk_reset(appctx->chunk);
1028 /* NB: cli_sock_parse_request() may have put
1029 * another CLI_ST_O_* into appctx->st0.
1030 */
1031
1032 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001033 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001034 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001035 else {
1036 /*
1037 * Look for the "payload start" pattern at the end of a line
1038 * Its location is not remembered here, this is just to switch
1039 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001040 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001041 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001042 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001043 appctx->chunk->data++; // keep the trailing \0 after '<<'
1044 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001045 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001046 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001047 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001048 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001049 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001050 }
1051
1052 /* re-adjust req buffer */
Willy Tarreau40a9c322022-05-18 15:55:18 +02001053 co_skip(sc_oc(cs), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001054 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1055 }
1056 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001057 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001058 const char *msg;
1059 int sev;
1060
William Lallemand74c24fb2016-11-21 17:18:36 +01001061 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001062 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001063 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001064 case CLI_ST_PRINT: /* print const message in msg */
1065 case CLI_ST_PRINT_ERR: /* print const error in msg */
1066 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1067 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001068 /* the message is in the svcctx */
1069 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001070 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1071 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001072 LOG_ERR : ctx->severity;
1073 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001074 }
1075 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1076 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001077 LOG_ERR : ctx->severity;
1078 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001079 if (!msg) {
1080 sev = LOG_ERR;
1081 msg = "Out of memory.\n";
1082 }
1083 }
1084 else {
1085 sev = LOG_ERR;
1086 msg = "Internal error.\n";
1087 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001088
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1090 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1091 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001092 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001093 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001094 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001095 }
1096 else
Willy Tarreau99615ed2022-05-25 07:29:36 +02001097 sc_need_room(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001099
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001100 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001101 if (appctx->io_handler)
1102 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001103 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001104 if (appctx->io_release) {
1105 appctx->io_release(appctx);
1106 appctx->io_release = NULL;
1107 }
1108 }
1109 break;
1110 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001111 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 break;
1113 }
1114
1115 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001116 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001117 const char *prompt = "";
1118
1119 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1120 /*
1121 * when entering a payload with interactive mode, change the prompt
1122 * to emphasize that more data can still be sent
1123 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001124 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001125 prompt = "+ ";
1126 else
1127 prompt = "\n> ";
1128 }
1129 else {
William Lallemandad032882019-07-01 10:56:15 +02001130 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001131 prompt = "\n";
1132 }
1133
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001134 if (applet_putstr(appctx, prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001135 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001136 }
1137
1138 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001139 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001140 break;
1141
1142 /* Now we close the output if one of the writers did so,
1143 * or if we're not in interactive mode and the request
1144 * buffer is empty. This still allows pipelined requests
1145 * to be sent in non-interactive mode.
1146 */
William Lallemand3de09d52018-12-11 16:10:56 +01001147 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1148 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001149 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001150 continue;
1151 }
1152
1153 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001154 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001155 /* reactivate the \n at the end of the response for the next command */
1156 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001157
1158 /* this forces us to yield between pipelined commands and
1159 * avoid extremely long latencies (e.g. "del map" etc). In
1160 * addition this increases the likelihood that the stream
1161 * refills the buffer with new bytes in non-interactive
1162 * mode, avoiding to close on apparently empty commands.
1163 */
Willy Tarreau40a9c322022-05-18 15:55:18 +02001164 if (co_data(sc_oc(cs))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001165 appctx_wakeup(appctx);
1166 goto out;
1167 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001168 }
1169 }
1170
Willy Tarreau026e8fb2022-05-17 19:47:17 +02001171 if ((res->flags & CF_SHUTR) && (cs->state == SC_ST_EST)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001172 DPRINTF(stderr, "%s@%d: cs to buf closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001173 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001174 /* Other side has closed, let's abort if we have no more processing to do
1175 * and nothing more to consume. This is comparable to a broken pipe, so
1176 * we forward the close to the request side so that it flows upstream to
1177 * the client.
1178 */
Willy Tarreauf61dd192022-05-27 09:00:19 +02001179 sc_shutw(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001180 }
1181
Willy Tarreau026e8fb2022-05-17 19:47:17 +02001182 if ((req->flags & CF_SHUTW) && (cs->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001183 DPRINTF(stderr, "%s@%d: buf to cs closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001184 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001185 /* We have no more processing to do, and nothing more to send, and
1186 * the client side has closed. So we'll forward this state downstream
1187 * on the response buffer.
1188 */
Willy Tarreauf61dd192022-05-27 09:00:19 +02001189 sc_shutr(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001190 res->flags |= CF_READ_NULL;
1191 }
1192
1193 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001194 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 +01001195 __FUNCTION__, __LINE__,
Christopher Faulet62e75742022-03-31 09:16:34 +02001196 cs->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001197}
1198
Willy Tarreau4596fe22022-05-17 19:07:51 +02001199/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001200 * external abort, we won't call the i/o handler anymore so we may need to
1201 * remove back references to the stream currently being dumped.
1202 */
1203static void cli_release_handler(struct appctx *appctx)
1204{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001205 free_trash_chunk(appctx->chunk);
1206 appctx->chunk = NULL;
1207
William Lallemand74c24fb2016-11-21 17:18:36 +01001208 if (appctx->io_release) {
1209 appctx->io_release(appctx);
1210 appctx->io_release = NULL;
1211 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001212 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001213 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1214
1215 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001216 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001217}
1218
1219/* This function dumps all environmnent variables to the buffer. It returns 0
1220 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001221 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1222 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001223 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001224static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001225{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001226 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreau4596fe22022-05-17 19:07:51 +02001227 struct stconn *cs = appctx_cs(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001228 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001229
Willy Tarreau40a9c322022-05-18 15:55:18 +02001230 if (unlikely(sc_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001231 return 1;
1232
1233 chunk_reset(&trash);
1234
1235 /* we have two inner loops here, one for the proxy, the other one for
1236 * the buffer.
1237 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001238 while (*var) {
1239 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001240
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001241 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001242 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001243
Willy Tarreau307dbb32022-05-05 17:45:52 +02001244 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001245 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001246 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001247 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001248 }
1249
1250 /* dump complete */
1251 return 1;
1252}
1253
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001254/* This function dumps all file descriptors states (or the requested one) to
1255 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001256 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1257 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1258 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001259 */
1260static int cli_io_handler_show_fd(struct appctx *appctx)
1261{
Willy Tarreau4596fe22022-05-17 19:07:51 +02001262 struct stconn *cs = appctx_cs(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001263 struct show_fd_ctx *fdctx = appctx->svcctx;
1264 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001265 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001266
Willy Tarreau40a9c322022-05-18 15:55:18 +02001267 if (unlikely(sc_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001268 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001269
1270 chunk_reset(&trash);
1271
Willy Tarreauca1b1572018-12-18 15:45:11 +01001272 /* isolate the threads once per round. We're limited to a buffer worth
1273 * of output anyway, it cannot last very long.
1274 */
1275 thread_isolate();
1276
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001277 /* we have two inner loops here, one for the proxy, the other one for
1278 * the buffer.
1279 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001280 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001281 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001282 const struct listener *li = NULL;
1283 const struct server *sv = NULL;
1284 const struct proxy *px = NULL;
1285 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001286 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001287 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001288 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001289 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001290 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001291 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001292 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001293
1294 fdt = fdtab[fd];
1295
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001296 /* When DEBUG_FD is set, we also report closed FDs that have a
1297 * non-null event count to detect stuck ones.
1298 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001299 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001300#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001301 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001302#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001303 goto skip; // closed
1304 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001305 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001306 conn = (const struct connection *)fdt.owner;
1307 conn_flags = conn->flags;
1308 mux = conn->mux;
1309 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001310 xprt = conn->xprt;
1311 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001312 li = objt_listener(conn->target);
1313 sv = objt_server(conn->target);
1314 px = objt_proxy(conn->target);
1315 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001316 if (atleast2(fdt.thread_mask))
1317 suspicious = 1;
1318 if (conn->handle.fd != fd)
1319 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001320 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001321 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001322 li = fdt.owner;
1323
Willy Tarreaudacfde42021-01-21 09:07:29 +01001324 if (!fdt.thread_mask)
1325 suspicious = 1;
1326
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001327 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001328 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001329 fd,
1330 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001331 (fdt.state & FD_CLONED) ? 'C' : 'c',
1332 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001333 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1334 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1335 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1336 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1337 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001338 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1339 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1340 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1341 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1342 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1343 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001344 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001345 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001346 fdt.iocb);
1347 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001348
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001349 if (!fdt.owner) {
1350 chunk_appendf(&trash, ")");
1351 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001352 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001353 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001354
1355 if (conn->handle.fd != fd) {
1356 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1357 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001358 } else {
1359 struct sockaddr_storage sa;
1360 socklen_t salen;
1361
1362 salen = sizeof(sa);
1363 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1364 if (sa.ss_family == AF_INET)
1365 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1366 else if (sa.ss_family == AF_INET6)
1367 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1368 else if (sa.ss_family == AF_UNIX)
1369 chunk_appendf(&trash, " fam=unix");
1370 }
1371
1372 salen = sizeof(sa);
1373 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1374 if (sa.ss_family == AF_INET)
1375 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1376 else if (sa.ss_family == AF_INET6)
1377 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1378 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001379 }
1380
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001381 if (px)
1382 chunk_appendf(&trash, " px=%s", px->id);
1383 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001384 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001385 else if (li)
1386 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001387
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001388 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001389 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001390 if (!ctx)
1391 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001392 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001393 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001394 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001395 else
1396 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001397
1398 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001399 if (xprt) {
1400 if (xprt_ctx || xprt->show_fd)
1401 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1402 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001403 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001404 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001405 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001406 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001407 struct sockaddr_storage sa;
1408 socklen_t salen;
1409
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001410 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001411 listener_state_str(li),
1412 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001413
1414 salen = sizeof(sa);
1415 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1416 if (sa.ss_family == AF_INET)
1417 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1418 else if (sa.ss_family == AF_INET6)
1419 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1420 else if (sa.ss_family == AF_UNIX)
1421 chunk_appendf(&trash, " fam=unix");
1422 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001423 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001424 else
1425 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001426
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001427#ifdef DEBUG_FD
1428 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001429 if (fdtab[fd].event_count >= 1000000)
1430 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001431#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001432 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001433
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001434 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001435 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001436 ret = 0;
1437 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001438 }
1439 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001440 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001441 break;
1442
1443 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001444 }
1445
Willy Tarreauca1b1572018-12-18 15:45:11 +01001446 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001447 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001448
1449 thread_release();
1450 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001451}
1452
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001453/* This function dumps some activity counters used by developers and support to
1454 * rule out some hypothesis during bug reports. It returns 0 if the output
1455 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1456 * everything at once in the buffer and is not designed to do it in multiple
1457 * passes.
1458 */
1459static int cli_io_handler_show_activity(struct appctx *appctx)
1460{
Willy Tarreau4596fe22022-05-17 19:07:51 +02001461 struct stconn *cs = appctx_cs(appctx);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001462 int thr;
1463
Willy Tarreau40a9c322022-05-18 15:55:18 +02001464 if (unlikely(sc_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001465 return 1;
1466
1467 chunk_reset(&trash);
1468
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001469#undef SHOW_TOT
1470#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001471 do { \
1472 unsigned int _v[MAX_THREADS]; \
1473 unsigned int _tot; \
1474 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001475 _tot = t = 0; \
1476 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001477 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001478 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001479 if (_nbt == 1) { \
1480 chunk_appendf(&trash, " %u\n", _tot); \
1481 break; \
1482 } \
1483 chunk_appendf(&trash, " %u [", _tot); \
1484 for (t = 0; t < _nbt; t++) \
1485 chunk_appendf(&trash, " %u", _v[t]); \
1486 chunk_appendf(&trash, " ]\n"); \
1487 } while (0)
1488
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001489#undef SHOW_AVG
1490#define SHOW_AVG(t, x) \
1491 do { \
1492 unsigned int _v[MAX_THREADS]; \
1493 unsigned int _tot; \
1494 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001495 _tot = t = 0; \
1496 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001497 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001498 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001499 if (_nbt == 1) { \
1500 chunk_appendf(&trash, " %u\n", _tot); \
1501 break; \
1502 } \
1503 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1504 for (t = 0; t < _nbt; t++) \
1505 chunk_appendf(&trash, " %u", _v[t]); \
1506 chunk_appendf(&trash, " ]\n"); \
1507 } while (0)
1508
Willy Tarreaua0211b82019-05-28 15:09:08 +02001509 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1510 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001511 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1512 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1513 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1514 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001515 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001516 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1517 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001518 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001519 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001520 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001521 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001522 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001523 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001524 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1525 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001526 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1527 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1528 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1529 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1530 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1531 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1532 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001533#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001534 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 +02001535 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001536#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001537
Willy Tarreaud6a78502019-05-27 07:03:38 +02001538#if defined(DEBUG_DEV)
1539 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001540 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1541 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1542 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001543#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001544
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001545 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001546 chunk_reset(&trash);
1547 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001548 }
1549
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001550#undef SHOW_AVG
1551#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001552 /* dump complete */
1553 return 1;
1554}
1555
William Lallemandeceddf72016-12-15 18:06:44 +01001556/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001557 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001558 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1559 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001560 */
1561static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1562{
Willy Tarreaub128f492022-05-05 19:11:05 +02001563 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1564 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001565
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001566 if (!global.cli_fe)
1567 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001568
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001569 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001570
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001571 if (!bind_conf) {
1572 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001573 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001574 goto full;
1575 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1576 }
William Lallemandeceddf72016-12-15 18:06:44 +01001577
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001578 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001579 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001580
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001581 if (!l)
1582 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001583
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001584 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1585 char addr[46];
1586 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001587
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001588 if (l->rx.addr.ss_family == AF_UNIX) {
1589 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001590
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001591 un = (struct sockaddr_un *)&l->rx.addr;
1592 if (un->sun_path[0] == '\0') {
1593 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1594 } else {
1595 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1596 }
1597 } else if (l->rx.addr.ss_family == AF_INET) {
1598 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1599 port_to_str(&l->rx.addr, port, sizeof(port));
1600 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1601 } else if (l->rx.addr.ss_family == AF_INET6) {
1602 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1603 port_to_str(&l->rx.addr, port, sizeof(port));
1604 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1605 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1606 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1607 } else
1608 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001609
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001610 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1611 chunk_appendf(&trash, "admin ");
1612 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1613 chunk_appendf(&trash, "operator ");
1614 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1615 chunk_appendf(&trash, "user ");
1616 else
1617 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001618
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001619 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001620
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001621 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001622 ctx->bind_conf = bind_conf;
1623 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001624 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001625 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001626 }
William Lallemandeceddf72016-12-15 18:06:44 +01001627 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001628 done:
1629 return 1;
1630 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001631 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001632}
1633
1634
Willy Tarreau0a739292016-11-22 20:21:23 +01001635/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001636 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1637 * be dumped as well as a flag if a single variable is requested, otherwise puts
1638 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001639 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001640static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001641{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001642 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001643 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001644 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001645
1646 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1647 return 1;
1648
Willy Tarreauf6710f82016-12-16 17:45:44 +01001649 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001650
1651 if (*args[2]) {
1652 int len = strlen(args[2]);
1653
Willy Tarreauf6710f82016-12-16 17:45:44 +01001654 for (; *var; var++) {
1655 if (strncmp(*var, args[2], len) == 0 &&
1656 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001657 break;
1658 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001659 if (!*var)
1660 return cli_err(appctx, "Variable not found\n");
1661
Willy Tarreau307dbb32022-05-05 17:45:52 +02001662 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001663 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001664 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001665 return 0;
1666}
1667
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001668/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001669 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1670 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001671 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001672static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001673{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001674 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1675
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001676 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1677 return 1;
1678
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001679 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001680 ctx->fd = atoi(args[2]);
1681 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001682 }
1683 return 0;
1684}
1685
Willy Tarreau599852e2016-11-22 20:33:32 +01001686/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001687static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001688{
Willy Tarreau0698c802022-05-11 14:09:57 +02001689 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001690
1691 if (strcmp(args[2], "cli") == 0) {
1692 unsigned timeout;
1693 const char *res;
1694
Willy Tarreau9d008692019-08-09 11:21:01 +02001695 if (!*args[3])
1696 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001697
1698 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001699 if (res || timeout < 1)
1700 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001701
1702 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1703 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1704 return 1;
1705 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001706
1707 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001708}
1709
Willy Tarreau2af99412016-11-23 11:10:59 +01001710/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001711static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001712{
1713 int v;
1714
1715 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1716 return 1;
1717
Willy Tarreau9d008692019-08-09 11:21:01 +02001718 if (!*args[3])
1719 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001720
1721 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001722 if (v > global.hardmaxconn)
1723 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001724
1725 /* check for unlimited values */
1726 if (v <= 0)
1727 v = global.hardmaxconn;
1728
1729 global.maxconn = v;
1730
1731 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001732 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001733
1734 return 1;
1735}
1736
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001737static int set_severity_output(int *target, char *argument)
1738{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001739 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001740 *target = CLI_SEVERITY_NONE;
1741 return 1;
1742 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001743 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001744 *target = CLI_SEVERITY_NUMBER;
1745 return 1;
1746 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001747 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001748 *target = CLI_SEVERITY_STRING;
1749 return 1;
1750 }
1751 return 0;
1752}
1753
1754/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001755static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001756{
1757 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1758 return 0;
1759
Willy Tarreau9d008692019-08-09 11:21:01 +02001760 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001761}
William Lallemandeceddf72016-12-15 18:06:44 +01001762
William Lallemand67a234f2018-12-13 09:05:45 +01001763
1764/* show the level of the current CLI session */
1765static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1766{
William Lallemand67a234f2018-12-13 09:05:45 +01001767 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001768 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001769 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001770 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001771 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001772 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001773 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001774 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001775}
1776
1777/* parse and set the CLI level dynamically */
1778static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1779{
William Lallemandad032882019-07-01 10:56:15 +02001780 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001781 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001782 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1783
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001784 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001785 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1786 return 1;
1787 }
1788 appctx->cli_level &= ~ACCESS_LVL_MASK;
1789 appctx->cli_level |= ACCESS_LVL_OPER;
1790
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001791 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001792 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1793 return 1;
1794 }
1795 appctx->cli_level &= ~ACCESS_LVL_MASK;
1796 appctx->cli_level |= ACCESS_LVL_USER;
1797 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001798 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001799 return 1;
1800}
1801
1802
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001803/* parse and set the CLI expert/experimental-mode dynamically */
1804static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001805{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001806 int level;
1807 char *level_str;
1808 char *output = NULL;
1809
William Lallemand7267f782022-02-01 16:08:50 +01001810 /* this will ask the applet to not output a \n after the command */
1811 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1812 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1813
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001814 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1815 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001816
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001817 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001818 level = ACCESS_EXPERT;
1819 level_str = "expert-mode";
1820 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001821 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001822 level = ACCESS_EXPERIMENTAL;
1823 level_str = "experimental-mode";
1824 }
William Lallemand2a171912022-02-02 11:43:20 +01001825 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1826 level = ACCESS_MCLI_DEBUG;
1827 level_str = "mcli-debug-mode";
1828 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001829 else {
1830 return 1;
1831 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001832
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001833 if (!*args[1]) {
1834 memprintf(&output, "%s is %s\n", level_str,
1835 (appctx->cli_level & level) ? "ON" : "OFF");
1836 return cli_dynmsg(appctx, LOG_INFO, output);
1837 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001838
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001839 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001840 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001841 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001842 return 1;
1843}
1844
William Lallemand740629e2021-12-14 15:22:29 +01001845/* shows HAProxy version */
1846static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1847{
1848 char *msg = NULL;
1849
1850 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1851}
1852
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001853int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001854{
1855 return 0;
1856}
1857
Willy Tarreau45c742b2016-11-24 14:51:17 +01001858/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001859static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001860{
1861 int v;
1862 int *res;
1863 int mul = 1;
1864
1865 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1866 return 1;
1867
1868 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1869 res = &global.cps_lim;
1870 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1871 res = &global.sps_lim;
1872#ifdef USE_OPENSSL
1873 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1874 res = &global.ssl_lim;
1875#endif
1876 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1877 res = &global.comp_rate_lim;
1878 mul = 1024;
1879 }
1880 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001881 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001882 "'set rate-limit' only supports :\n"
1883 " - 'connections global' to set the per-process maximum connection rate\n"
1884 " - 'sessions global' to set the per-process maximum session rate\n"
1885#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001886 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001887#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001888 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001889 }
1890
Willy Tarreau9d008692019-08-09 11:21:01 +02001891 if (!*args[4])
1892 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001893
1894 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001895 if (v < 0)
1896 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001897
1898 *res = v * mul;
1899
1900 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001901 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001902
1903 return 1;
1904}
1905
William Lallemandf6975e92017-05-26 17:42:10 +02001906/* parse the "expose-fd" argument on the bind lines */
1907static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1908{
1909 if (!*args[cur_arg + 1]) {
1910 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1911 return ERR_ALERT | ERR_FATAL;
1912 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001913 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001914 conf->level |= ACCESS_FD_LISTENERS;
1915 } else {
1916 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1917 args[cur_arg], args[cur_arg+1]);
1918 return ERR_ALERT | ERR_FATAL;
1919 }
1920
1921 return 0;
1922}
1923
William Lallemand74c24fb2016-11-21 17:18:36 +01001924/* parse the "level" argument on the bind lines */
1925static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1926{
1927 if (!*args[cur_arg + 1]) {
1928 memprintf(err, "'%s' : missing level", args[cur_arg]);
1929 return ERR_ALERT | ERR_FATAL;
1930 }
1931
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001932 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001933 conf->level &= ~ACCESS_LVL_MASK;
1934 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001935 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001936 conf->level &= ~ACCESS_LVL_MASK;
1937 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001938 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001939 conf->level &= ~ACCESS_LVL_MASK;
1940 conf->level |= ACCESS_LVL_ADMIN;
1941 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001942 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1943 args[cur_arg], args[cur_arg+1]);
1944 return ERR_ALERT | ERR_FATAL;
1945 }
1946
1947 return 0;
1948}
1949
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001950static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1951{
1952 if (!*args[cur_arg + 1]) {
1953 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1954 return ERR_ALERT | ERR_FATAL;
1955 }
1956
1957 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1958 return 0;
1959 else {
1960 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1961 args[cur_arg], args[cur_arg+1]);
1962 return ERR_ALERT | ERR_FATAL;
1963 }
1964}
1965
Olivier Houchardf886e342017-04-05 22:24:59 +02001966/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001967static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001968{
1969 char *cmsgbuf = NULL;
1970 unsigned char *tmpbuf = NULL;
1971 struct cmsghdr *cmsg;
Willy Tarreau4596fe22022-05-17 19:07:51 +02001972 struct stconn *cs = appctx_cs(appctx);
Willy Tarreauea27f482022-05-18 16:10:52 +02001973 struct stream *s = __sc_strm(cs);
Willy Tarreau74568cf2022-05-27 09:03:30 +02001974 struct connection *remote = sc_conn(sc_opposite(cs));
Olivier Houchardf886e342017-04-05 22:24:59 +02001975 struct msghdr msghdr;
1976 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001977 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001978 const char *ns_name, *if_name;
1979 unsigned char ns_nlen, if_nlen;
1980 int nb_queued;
1981 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001982 int *tmpfd;
1983 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001984 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001985 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001986 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001987 int ret;
1988
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001989 if (!remote) {
1990 ha_warning("Only works on real connections\n");
1991 goto out;
1992 }
1993
1994 fd = remote->handle.fd;
1995
Olivier Houchardf886e342017-04-05 22:24:59 +02001996 /* Temporary set the FD in blocking mode, that will make our life easier */
1997 old_fcntl = fcntl(fd, F_GETFL);
1998 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001999 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 goto out;
2001 }
2002 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2003 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002004 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002005 goto out;
2006 }
2007 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002008 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002009 goto out;
2010 }
Olivier Houchard54740872017-04-06 14:45:14 +02002011 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002012 iov.iov_base = &tot_fd_nb;
2013 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002014 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002015 goto out;
2016 memset(&msghdr, 0, sizeof(msghdr));
2017 /*
2018 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002019 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002020 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002021 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002022 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002023
Olivier Houchardf886e342017-04-05 22:24:59 +02002024 if (tot_fd_nb == 0)
2025 goto out;
2026
2027 /* First send the total number of file descriptors, so that the
2028 * receiving end knows what to expect.
2029 */
2030 msghdr.msg_iov = &iov;
2031 msghdr.msg_iovlen = 1;
2032 ret = sendmsg(fd, &msghdr, 0);
2033 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002034 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002035 goto out;
2036 }
2037
2038 /* Now send the fds */
2039 msghdr.msg_control = cmsgbuf;
2040 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2041 cmsg = CMSG_FIRSTHDR(&msghdr);
2042 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2043 cmsg->cmsg_level = SOL_SOCKET;
2044 cmsg->cmsg_type = SCM_RIGHTS;
2045 tmpfd = (int *)CMSG_DATA(cmsg);
2046
Olivier Houchardf886e342017-04-05 22:24:59 +02002047 /* For each socket, e message is sent, containing the following :
2048 * Size of the namespace name (or 0 if none), as an unsigned char.
2049 * The namespace name, if any
2050 * Size of the interface name (or 0 if none), as an unsigned char
2051 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002052 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002053 */
2054 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002055 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002056 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002057 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002058 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002059 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002060 goto out;
2061 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002062
2063 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002064 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002065 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002066 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002067 continue;
2068
2069 ns_name = if_name = "";
2070 ns_nlen = if_nlen = 0;
2071
2072 /* for now we can only retrieve namespaces and interfaces from
2073 * pure listeners.
2074 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002075 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002076 const struct listener *l = fdtab[cur_fd].owner;
2077
Willy Tarreau818a92e2020-09-03 07:50:19 +02002078 if (l->rx.settings->interface) {
2079 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002080 if_nlen = strlen(if_name);
2081 }
2082
2083#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002084 if (l->rx.settings->netns) {
2085 ns_name = l->rx.settings->netns->node.key;
2086 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002087 }
2088#endif
2089 }
2090
2091 /* put the FD into the CMSG_DATA */
2092 tmpfd[nb_queued++] = cur_fd;
2093
2094 /* first block is <ns_name_len> <ns_name> */
2095 tmpbuf[curoff++] = ns_nlen;
2096 if (ns_nlen)
2097 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2098 curoff += ns_nlen;
2099
2100 /* second block is <if_name_len> <if_name> */
2101 tmpbuf[curoff++] = if_nlen;
2102 if (if_nlen)
2103 memcpy(tmpbuf + curoff, if_name, if_nlen);
2104 curoff += if_nlen;
2105
2106 /* we used to send the listener options here before 2.3 */
2107 memset(tmpbuf + curoff, 0, sizeof(int));
2108 curoff += sizeof(int);
2109
2110 /* there's a limit to how many FDs may be sent at once */
2111 if (nb_queued == MAX_SEND_FD) {
2112 iov.iov_len = curoff;
2113 if (sendmsg(fd, &msghdr, 0) != curoff) {
2114 ha_warning("Failed to transfer sockets\n");
2115 return -1;
2116 }
2117
2118 /* Wait for an ack */
2119 do {
2120 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2121 } while (ret == -1 && errno == EINTR);
2122
2123 if (ret <= 0) {
2124 ha_warning("Unexpected error while transferring sockets\n");
2125 return -1;
2126 }
2127 curoff = 0;
2128 nb_queued = 0;
2129 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002130 }
2131
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002132 /* flush pending stuff */
2133 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002134 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002135 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2136 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002137 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002138 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002139 goto out;
2140 }
2141 }
2142
2143out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002144 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002145 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002146 goto out;
2147 }
2148 appctx->st0 = CLI_ST_END;
2149 free(cmsgbuf);
2150 free(tmpbuf);
2151 return 1;
2152}
2153
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002154static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2155{
2156 if (*args[0] == 'h')
2157 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002158 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002159 else if (*args[0] == 'p')
2160 /* prompt */
2161 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2162 else if (*args[0] == 'q')
2163 /* quit */
2164 appctx->st0 = CLI_ST_END;
2165
2166 return 1;
2167}
Olivier Houchardf886e342017-04-05 22:24:59 +02002168
William Lallemand2f4ce202018-10-26 14:47:47 +02002169void pcli_write_prompt(struct stream *s)
2170{
2171 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002172 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002173
William Lallemanddc12c2e2018-12-13 09:05:46 +01002174 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002175 return;
2176
William Lallemanddc12c2e2018-12-13 09:05:46 +01002177 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002178 chunk_appendf(msg, "+ ");
2179 } else {
2180 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002181 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002182 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002183 else
William Lallemanddae12c72022-02-02 14:13:54 +01002184 chunk_appendf(msg, "%d", s->pcli_next_pid);
2185
2186 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2187 chunk_appendf(msg, "(");
2188
2189 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2190 chunk_appendf(msg, "x");
2191
2192 if (s->pcli_flags & ACCESS_EXPERT)
2193 chunk_appendf(msg, "e");
2194
2195 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2196 chunk_appendf(msg, "d");
2197
2198 chunk_appendf(msg, ")");
2199 }
2200
2201 chunk_appendf(msg, "> ");
2202
2203
William Lallemandebf61802018-12-11 16:10:57 +01002204 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002205 co_inject(oc, msg->area, msg->data);
2206}
2207
William Lallemand291810d2018-10-26 14:47:38 +02002208
William Lallemandcf62f7e2018-10-26 14:47:40 +02002209/* The pcli_* functions are used for the CLI proxy in the master */
2210
William Lallemanddeeaa592018-10-26 14:47:48 +02002211void pcli_reply_and_close(struct stream *s, const char *msg)
2212{
2213 struct buffer *buf = get_trash_chunk();
2214
2215 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002216 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002217}
2218
William Lallemand291810d2018-10-26 14:47:38 +02002219static enum obj_type *pcli_pid_to_server(int proc_pid)
2220{
2221 struct mworker_proc *child;
2222
William Lallemand99e0bb92020-11-05 10:28:53 +01002223 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002224 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002225 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002226
William Lallemand291810d2018-10-26 14:47:38 +02002227 list_for_each_entry(child, &proc_list, list) {
2228 if (child->pid == proc_pid){
2229 return &child->srv->obj_type;
2230 }
2231 }
2232 return NULL;
2233}
2234
2235/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2236 * Return:
2237 * 0: master
2238 * > 0: pid of a worker
2239 * < 0: didn't find a worker
2240 */
2241static int pcli_prefix_to_pid(const char *prefix)
2242{
2243 int proc_pid;
2244 struct mworker_proc *child;
2245 char *errtol = NULL;
2246
2247 if (*prefix != '@') /* not a prefix, should not happen */
2248 return -1;
2249
2250 prefix++;
2251 if (!*prefix) /* sent @ alone, return the master */
2252 return 0;
2253
2254 if (strcmp("master", prefix) == 0) {
2255 return 0;
2256 } else if (*prefix == '!') {
2257 prefix++;
2258 if (!*prefix)
2259 return -1;
2260
2261 proc_pid = strtol(prefix, &errtol, 10);
2262 if (*errtol != '\0')
2263 return -1;
2264 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002265 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002266 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002267 if (child->pid == proc_pid){
2268 return child->pid;
2269 }
2270 }
2271 } else {
2272 struct mworker_proc *chosen = NULL;
2273 /* this is a relative pid */
2274
2275 proc_pid = strtol(prefix, &errtol, 10);
2276 if (*errtol != '\0')
2277 return -1;
2278
2279 if (proc_pid == 0) /* return the master */
2280 return 0;
2281
2282 /* chose the right process, the current one is the one with the
2283 least number of reloads */
2284 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002285 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002286 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002287 if (child->reloads == 0)
2288 return child->pid;
2289 else if (chosen == NULL || child->reloads < chosen->reloads)
2290 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002291 }
2292 if (chosen)
2293 return chosen->pid;
2294 }
2295 return -1;
2296}
2297
William Lallemandbddd33a2018-12-11 16:10:53 +01002298/* Return::
2299 * >= 0 : number of words to escape
2300 * = -1 : error
2301 */
2302
2303int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2304{
2305 if (argl < 1)
2306 return 0;
2307
2308 /* there is a prefix */
2309 if (args[0][0] == '@') {
2310 int target_pid = pcli_prefix_to_pid(args[0]);
2311
2312 if (target_pid == -1) {
2313 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2314 return -1;
2315 }
2316
2317 /* if the prefix is alone, define a default target */
2318 if (argl == 1)
2319 s->pcli_next_pid = target_pid;
2320 else
2321 *next_pid = target_pid;
2322 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002323 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002324 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002325 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002326
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002327 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002328 channel_shutr_now(&s->req);
2329 channel_shutw_now(&s->res);
2330 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002331 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002332 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2333 memprintf(errmsg, "Permission denied!\n");
2334 return -1;
2335 }
2336 s->pcli_flags &= ~ACCESS_LVL_MASK;
2337 s->pcli_flags |= ACCESS_LVL_OPER;
2338 return argl;
2339
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002340 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002341 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2342 memprintf(errmsg, "Permission denied!\n");
2343 return -1;
2344 }
2345 s->pcli_flags &= ~ACCESS_LVL_MASK;
2346 s->pcli_flags |= ACCESS_LVL_USER;
2347 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002348
2349 } else if (strcmp(args[0], "expert-mode") == 0) {
2350 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2351 memprintf(errmsg, "Permission denied!\n");
2352 return -1;
2353 }
2354
2355 s->pcli_flags &= ~ACCESS_EXPERT;
2356 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2357 s->pcli_flags |= ACCESS_EXPERT;
2358 return argl;
2359
2360 } else if (strcmp(args[0], "experimental-mode") == 0) {
2361 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2362 memprintf(errmsg, "Permission denied!\n");
2363 return -1;
2364 }
2365 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2366 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2367 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2368 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002369 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2370 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2371 memprintf(errmsg, "Permission denied!\n");
2372 return -1;
2373 }
2374 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2375 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2376 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2377 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002378 }
2379
2380 return 0;
2381}
2382
2383/*
2384 * Parse the CLI request:
2385 * - It does basically the same as the cli_io_handler, but as a proxy
2386 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002387 *
2388 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002389 * - the number of characters to forward or
2390 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002391 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002392int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002393{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002394 char *str;
2395 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002396 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002397 int argl; /* number of args */
2398 char *p;
2399 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002400 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002401 int wtrim = 0; /* number of words to trim */
2402 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002403 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002404 int i = 0;
2405
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002406 /* we cannot deal with a wrapping buffer, so let's take care of this
2407 * first.
2408 */
2409 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2410 b_slow_realign(&req->buf, trash.area, co_data(req));
2411
2412 str = (char *)ci_head(req);
2413 end = (char *)ci_stop(req);
2414
William Lallemandbddd33a2018-12-11 16:10:53 +01002415 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002416
William Lallemanddc12c2e2018-12-13 09:05:46 +01002417 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002418
2419 /* Looks for the end of one command */
2420 while (p+reql < end) {
2421 /* handle escaping */
2422 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002423 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002424 continue;
2425 }
2426 if (p[reql] == ';' || p[reql] == '\n') {
2427 /* found the end of the command */
2428 p[reql] = '\n';
2429 reql++;
2430 break;
2431 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002432 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002433 }
William Lallemandebf61802018-12-11 16:10:57 +01002434 } else {
2435 while (p+reql < end) {
2436 if (p[reql] == '\n') {
2437 /* found the end of the line */
2438 reql++;
2439 break;
2440 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002441 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002442 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002443 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002444
William Lallemandbddd33a2018-12-11 16:10:53 +01002445 /* set end to first byte after the end of the command */
2446 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002449 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 return -1;
2451 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002452
William Lallemand3301f3e2018-12-13 09:05:48 +01002453 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2454 if (reql == 1) /* last line of the payload */
2455 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002456 return reql;
2457 }
2458
William Lallemandbddd33a2018-12-11 16:10:53 +01002459 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002460
William Lallemandbddd33a2018-12-11 16:10:53 +01002461 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002462 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002463 /* skip leading spaces/tabs */
2464 p += strspn(p, " \t");
2465 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002466 break;
2467
William Lallemandbddd33a2018-12-11 16:10:53 +01002468 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002469 while (1) {
2470 p += strcspn(p, " \t\\");
2471 /* escaped chars using backlashes (\) */
2472 if (*p == '\\') {
2473 if (!*++p)
2474 break;
2475 if (!*++p)
2476 break;
2477 } else {
2478 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002479 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002480 }
William Lallemandfe249c32020-06-18 18:03:57 +02002481 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002482 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002483 }
2484
William Lallemandbddd33a2018-12-11 16:10:53 +01002485 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002486
Willy Tarreauf14c7572021-03-13 10:59:23 +01002487 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002488 args[i] = NULL;
2489
2490 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2491
2492 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002493 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002494 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002495 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002496 if (*p == '\0')
2497 *p = ' ';
2498 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002499 }
2500
William Lallemand3301f3e2018-12-13 09:05:48 +01002501 payload = strstr(str, PAYLOAD_PATTERN);
2502 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2503 /* if the payload pattern is at the end */
2504 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002505 }
2506
William Lallemandbddd33a2018-12-11 16:10:53 +01002507 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002508
William Lallemandbddd33a2018-12-11 16:10:53 +01002509 if (wtrim > 0) {
2510 trim = &args[wtrim][0];
2511 if (trim == NULL) /* if this was the last word in the table */
2512 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002513
William Lallemandbddd33a2018-12-11 16:10:53 +01002514 b_del(&req->buf, trim - str);
2515
William Lallemandb7ea1412018-12-13 09:05:47 +01002516 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002517 } else if (wtrim < 0) {
2518 /* parsing error */
2519 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002520 } else {
2521 /* the whole string */
2522 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002523 }
2524
William Lallemandb7ea1412018-12-13 09:05:47 +01002525 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002526
2527 /* the mcli-debug-mode is only sent to the applet of the master */
2528 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2529 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2530 ret += strlen("mcli-debug-mode on -") + 2;
2531 }
William Lallemand7267f782022-02-01 16:08:50 +01002532 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2533 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2534 ret += strlen("experimental-mode on -") + 2;
2535 }
2536 if (s->pcli_flags & ACCESS_EXPERT) {
2537 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2538 ret += strlen("expert-mode on -") + 2;
2539 }
2540
William Lallemandb7ea1412018-12-13 09:05:47 +01002541 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2542 goto end;
2543 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002544 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2545 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002546 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002547 ci_insert_line2(req, 0, "user -", strlen("user -"));
2548 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002549 }
2550 }
2551end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002552
William Lallemandb7ea1412018-12-13 09:05:47 +01002553 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002554}
2555
2556int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2557{
William Lallemandbddd33a2018-12-11 16:10:53 +01002558 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002559 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002560 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002561
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002562 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002563 * current one. Just wait. At this stage, errors should be handled by
2564 * the response analyzer.
2565 */
2566 if (s->res.analysers & AN_RES_WAIT_CLI)
2567 return 0;
2568
William Lallemandb7ea1412018-12-13 09:05:47 +01002569 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2570 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2571
William Lallemandcf62f7e2018-10-26 14:47:40 +02002572read_again:
2573 /* if the channel is closed for read, we won't receive any more data
2574 from the client, but we don't want to forward this close to the
2575 server */
2576 channel_dont_close(req);
2577
2578 /* We don't know yet to which server we will connect */
2579 channel_dont_connect(req);
2580
William Lallemandcf62f7e2018-10-26 14:47:40 +02002581 req->flags |= CF_READ_DONTWAIT;
2582
2583 /* need more data */
2584 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002585 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002586
2587 /* If there is data available for analysis, log the end of the idle time. */
2588 if (c_data(req) && s->logs.t_idle == -1)
2589 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2590
William Lallemandbddd33a2018-12-11 16:10:53 +01002591 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002592 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002593 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002594 /* enough data */
2595
William Lallemandcf62f7e2018-10-26 14:47:40 +02002596 /* forward only 1 command */
2597 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002598
William Lallemanddc12c2e2018-12-13 09:05:46 +01002599 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002600 /* we send only 1 command per request, and we write close after it */
2601 channel_shutw_now(req);
2602 } else {
2603 pcli_write_prompt(s);
2604 }
2605
2606 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002607 s->res.analysers |= AN_RES_WAIT_CLI;
2608
William Lallemandebf61802018-12-11 16:10:57 +01002609 if (!(s->flags & SF_ASSIGNED)) {
2610 if (next_pid > -1)
2611 target_pid = next_pid;
2612 else
2613 target_pid = s->pcli_next_pid;
2614 /* we can connect now */
2615 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002616
William Lallemanddcbe7b92021-12-10 14:14:53 +01002617 if (!s->target)
2618 goto server_disconnect;
2619
William Lallemandebf61802018-12-11 16:10:57 +01002620 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2621 channel_auto_connect(req);
2622 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002623
2624 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002625 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002626 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002627 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002628 } else if (to_forward == -1) {
2629 if (errmsg) {
2630 /* there was an error during the parsing */
2631 pcli_reply_and_close(s, errmsg);
2632 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2633 return 0;
2634 }
2635 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002636 }
2637
2638 return 0;
2639
2640send_help:
2641 b_reset(&req->buf);
2642 b_putblk(&req->buf, "help\n", 5);
2643 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002644
Christopher Faulet0f727da2022-01-18 08:44:23 +01002645missing_data:
2646 if (req->flags & CF_SHUTR) {
2647 /* There is no more request or a only a partial one and we
2648 * receive a close from the client, we can leave */
2649 channel_shutw_now(&s->res);
2650 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2651 return 1;
2652 }
2653 else if (channel_full(req, global.tune.maxrewrite)) {
2654 /* buffer is full and we didn't catch the end of a command */
2655 goto send_help;
2656 }
2657 return 0;
2658
William Lallemanddcbe7b92021-12-10 14:14:53 +01002659server_disconnect:
2660 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2661 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002662}
2663
2664int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2665{
2666 struct proxy *fe = strm_fe(s);
2667 struct proxy *be = s->be;
2668
Christopher Faulete8cefac2022-03-07 18:20:21 +01002669 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2670 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002671 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002672 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002673 s->res.analysers &= ~AN_RES_WAIT_CLI;
2674 return 0;
2675 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002676 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2677 rep->flags |= CF_NEVER_WAIT;
2678
2679 /* don't forward the close */
2680 channel_dont_close(&s->res);
2681 channel_dont_close(&s->req);
2682
William Lallemanddc12c2e2018-12-13 09:05:46 +01002683 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002684 s->res.analysers &= ~AN_RES_WAIT_CLI;
2685 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2686 return 0;
2687 }
2688
William Lallemandcf62f7e2018-10-26 14:47:40 +02002689 /* forward the data */
2690 if (ci_data(rep)) {
2691 c_adv(rep, ci_data(rep));
2692 return 0;
2693 }
2694
2695 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2696 /* stream cleanup */
2697
William Lallemand2f4ce202018-10-26 14:47:47 +02002698 pcli_write_prompt(s);
2699
Willy Tarreaucb041662022-05-17 19:44:42 +02002700 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreauf61dd192022-05-27 09:00:19 +02002701 sc_shutr(s->scb);
2702 sc_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002703
2704 /*
2705 * starting from there this the same code as
2706 * http_end_txn_clean_session().
2707 *
2708 * It allows to do frontend keepalive while reconnecting to a
2709 * new server for each request.
2710 */
2711
2712 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002713 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002714 if (unlikely(s->srv_conn))
2715 sess_change_server(s, NULL);
2716 }
2717
2718 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2719 stream_process_counters(s);
2720
2721 /* don't count other requests' data */
2722 s->logs.bytes_in -= ci_data(&s->req);
2723 s->logs.bytes_out -= ci_data(&s->res);
2724
2725 /* we may need to know the position in the queue */
2726 pendconn_free(s);
2727
2728 /* let's do a final log if we need it */
2729 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2730 !(s->flags & SF_MONITOR) &&
2731 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2732 s->do_log(s);
2733 }
2734
2735 /* stop tracking content-based counters */
2736 stream_stop_content_counters(s);
2737 stream_update_time_stats(s);
2738
2739 s->logs.accept_date = date; /* user-visible date for logging */
2740 s->logs.tv_accept = now; /* corrected date for internal use */
2741 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2742 s->logs.t_idle = -1;
2743 tv_zero(&s->logs.tv_request);
2744 s->logs.t_queue = -1;
2745 s->logs.t_connect = -1;
2746 s->logs.t_data = -1;
2747 s->logs.t_close = 0;
2748 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2749 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2750
2751 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2752 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2753
2754 stream_del_srv_conn(s);
2755 if (objt_server(s->target)) {
2756 if (s->flags & SF_CURR_SESS) {
2757 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002758 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002759 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002760 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002761 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002762 }
2763
2764 s->target = NULL;
2765
2766 /* only release our endpoint if we don't intend to reuse the
2767 * connection.
2768 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002769 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002770 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002771 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002772 if (!s->conn_err_type)
2773 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002774 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002775 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002776 return 1;
2777 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002778 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002779 }
2780
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002781 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002782
Willy Tarreau74568cf2022-05-27 09:03:30 +02002783 sc_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002784 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 +02002785 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 +02002786 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 +02002787 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002788 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2789 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002790 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002791 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002792 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002793 /* reinitialise the current rule list pointer to NULL. We are sure that
2794 * any rulelist match the NULL pointer.
2795 */
2796 s->current_rule_list = NULL;
2797
2798 s->be = strm_fe(s);
2799 s->logs.logwait = strm_fe(s)->to_log;
2800 s->logs.level = 0;
2801 stream_del_srv_conn(s);
2802 s->target = NULL;
2803 /* re-init store persistence */
2804 s->store_count = 0;
2805 s->uniq_id = global.req_count++;
2806
2807 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2808
2809 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2810
William Lallemandcf62f7e2018-10-26 14:47:40 +02002811 s->res.analysers &= ~AN_RES_WAIT_CLI;
2812
2813 /* We must trim any excess data from the response buffer, because we
2814 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002815 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002816 * we want those data to come along with next response. A typical
2817 * example of such data would be from a buggy server responding to
2818 * a HEAD with some data, or sending more than the advertised
2819 * content-length.
2820 */
2821 if (unlikely(ci_data(&s->res)))
2822 b_set_data(&s->res.buf, co_data(&s->res));
2823
2824 /* Now we can realign the response buffer */
2825 c_realign_if_empty(&s->res);
2826
2827 s->req.rto = strm_fe(s)->timeout.client;
2828 s->req.wto = TICK_ETERNITY;
2829
2830 s->res.rto = TICK_ETERNITY;
2831 s->res.wto = strm_fe(s)->timeout.client;
2832
2833 s->req.rex = TICK_ETERNITY;
2834 s->req.wex = TICK_ETERNITY;
2835 s->req.analyse_exp = TICK_ETERNITY;
2836 s->res.rex = TICK_ETERNITY;
2837 s->res.wex = TICK_ETERNITY;
2838 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002839 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002840
2841 /* we're removing the analysers, we MUST re-enable events detection.
2842 * We don't enable close on the response channel since it's either
2843 * already closed, or in keep-alive with an idle connection handler.
2844 */
2845 channel_auto_read(&s->req);
2846 channel_auto_close(&s->req);
2847 channel_auto_read(&s->res);
2848
2849
2850 return 1;
2851 }
2852 return 0;
2853}
2854
William Lallemand8a022572018-10-26 14:47:35 +02002855/*
2856 * The mworker functions are used to initialize the CLI in the master process
2857 */
2858
William Lallemand309dc9a2018-10-26 14:47:45 +02002859 /*
2860 * Stop the mworker proxy
2861 */
2862void mworker_cli_proxy_stop()
2863{
William Lallemand550db6d2018-11-06 17:37:12 +01002864 if (mworker_proxy)
2865 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002866}
2867
William Lallemand8a022572018-10-26 14:47:35 +02002868/*
2869 * Create the mworker CLI proxy
2870 */
2871int mworker_cli_proxy_create()
2872{
2873 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002874 char *msg = NULL;
2875 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002876
William Lallemandae787ba2021-07-29 15:13:22 +02002877 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002878 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002879 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002880
William Lallemandcf62f7e2018-10-26 14:47:40 +02002881 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002882 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2883 mworker_proxy->timeout.client = 0; /* no timeout */
2884 mworker_proxy->conf.file = strdup("MASTER");
2885 mworker_proxy->conf.line = 0;
2886 mworker_proxy->accept = frontend_accept;
2887 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2888
2889 /* Does not init the default target the CLI applet, but must be done in
2890 * the request parsing code */
2891 mworker_proxy->default_target = NULL;
2892
William Lallemand8a022572018-10-26 14:47:35 +02002893 /* create all servers using the mworker_proc list */
2894 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002895 struct server *newsrv = NULL;
2896 struct sockaddr_storage *sk;
2897 int port1, port2, port;
2898 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002899
William Lallemanda31b09e2020-01-14 15:25:02 +01002900 /* only the workers support the master CLI */
2901 if (!(child->options & PROC_O_TYPE_WORKER))
2902 continue;
2903
William Lallemand8a022572018-10-26 14:47:35 +02002904 newsrv = new_server(mworker_proxy);
2905 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002906 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002907
2908 /* we don't know the new pid yet */
2909 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002910 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002911 else
2912 memprintf(&msg, "old-%d", child->pid);
2913
2914 newsrv->next = mworker_proxy->srv;
2915 mworker_proxy->srv = newsrv;
2916 newsrv->conf.file = strdup(msg);
2917 newsrv->id = strdup(msg);
2918 newsrv->conf.line = 0;
2919
2920 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002921 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002922 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002923 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002924 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002925 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002926
Willy Tarreau5fc93282020-09-16 18:25:03 +02002927 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002928 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002929 }
2930
2931 /* no port specified */
2932 newsrv->flags |= SRV_F_MAPPORTS;
2933 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002934 /* don't let the server participate to load balancing */
2935 newsrv->iweight = 0;
2936 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002937 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002938
2939 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002940 }
William Lallemandae787ba2021-07-29 15:13:22 +02002941
2942 mworker_proxy->next = proxies_list;
2943 proxies_list = mworker_proxy;
2944
William Lallemand8a022572018-10-26 14:47:35 +02002945 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002946
2947error:
William Lallemand744a0892018-11-22 16:46:51 +01002948
2949 list_for_each_entry(child, &proc_list, list) {
2950 free((char *)child->srv->conf.file); /* cast because of const char * */
2951 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002952 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002953 }
William Lallemandae787ba2021-07-29 15:13:22 +02002954 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002955 free(msg);
2956
William Lallemandae787ba2021-07-29 15:13:22 +02002957error_proxy:
2958 ha_alert("%s\n", errmsg);
2959 free(errmsg);
2960
William Lallemand744a0892018-11-22 16:46:51 +01002961 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002962}
Olivier Houchardf886e342017-04-05 22:24:59 +02002963
William Lallemandce83b4a2018-10-26 14:47:30 +02002964/*
William Lallemande7361152018-10-26 14:47:36 +02002965 * Create a new listener for the master CLI proxy
2966 */
2967int mworker_cli_proxy_new_listener(char *line)
2968{
2969 struct bind_conf *bind_conf;
2970 struct listener *l;
2971 char *err = NULL;
2972 char *args[MAX_LINE_ARGS + 1];
2973 int arg;
2974 int cur_arg;
2975
William Lallemand2e945c82019-11-25 09:58:37 +01002976 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002977 args[0] = line;
2978
2979 /* args is a bind configuration with spaces replaced by commas */
2980 while (*line && arg < MAX_LINE_ARGS) {
2981
2982 if (*line == ',') {
2983 *line++ = '\0';
2984 while (*line == ',')
2985 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002986 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002987 }
2988 line++;
2989 }
2990
William Lallemand2e945c82019-11-25 09:58:37 +01002991 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002992
2993 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002994 if (!bind_conf)
2995 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002996
2997 bind_conf->level &= ~ACCESS_LVL_MASK;
2998 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002999 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003000
3001 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3002 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003003 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003004 }
3005
3006 cur_arg = 1;
3007
3008 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003009 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003010 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003011
3012 kw = bind_find_kw(args[cur_arg]);
3013 if (kw) {
3014 if (!kw->parse) {
3015 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3016 args[0], args[1], args[cur_arg]);
3017 goto err;
3018 }
3019
Willy Tarreau4975d142021-03-13 11:00:33 +01003020 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003021 if (err)
3022 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3023 else
3024 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3025 args[0], args[1], args[cur_arg]);
3026 goto err;
3027 }
3028
3029 cur_arg += 1 + kw->skip;
3030 continue;
3031 }
3032
Willy Tarreau433b05f2021-03-12 10:14:07 +01003033 best = bind_find_best_kw(args[cur_arg]);
3034 if (best)
3035 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3036 args[0], args[1], args[cur_arg], best);
3037 else
3038 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3039 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003040 goto err;
3041 }
3042
3043
3044 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003045 l->accept = session_accept_fd;
3046 l->default_target = mworker_proxy->default_target;
3047 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003048 l->options |= LI_O_UNLIMITED;
3049 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003050 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003051 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003052 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003053 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003054
3055 return 0;
3056
3057err:
3058 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003059 free(err);
3060 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003061 return -1;
3062
3063}
3064
3065/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003066 * Create a new CLI socket using a socketpair for a worker process
3067 * <mworker_proc> is the process structure, and <proc> is the process number
3068 */
3069int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3070{
3071 struct bind_conf *bind_conf;
3072 struct listener *l;
3073 char *path = NULL;
3074 char *err = NULL;
3075
3076 /* master pipe to ensure the master is still alive */
3077 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3078 ha_alert("Cannot create worker socketpair.\n");
3079 return -1;
3080 }
3081
3082 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003083 if (!global.cli_fe) {
3084 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003085 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003086 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003087 }
3088 }
3089
Willy Tarreau4975d142021-03-13 11:00:33 +01003090 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003091 if (!bind_conf)
3092 goto error;
3093
William Lallemandce83b4a2018-10-26 14:47:30 +02003094 bind_conf->level &= ~ACCESS_LVL_MASK;
3095 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003096 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003097
William Lallemandce83b4a2018-10-26 14:47:30 +02003098 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3099 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003100 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003101 }
3102
Willy Tarreau4975d142021-03-13 11:00:33 +01003103 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003104 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003106 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003107 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003108 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003109
3110 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003111 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003112 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003113 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003114 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003115 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003116 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003117 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003118 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003119 }
3120
3121 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003122
3123error:
3124 close(mworker_proc->ipc_fd[0]);
3125 close(mworker_proc->ipc_fd[1]);
3126 free(err);
3127
3128 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003129}
3130
William Lallemand74c24fb2016-11-21 17:18:36 +01003131static struct applet cli_applet = {
3132 .obj_type = OBJ_TYPE_APPLET,
3133 .name = "<CLI>", /* used for logging */
3134 .fct = cli_io_handler,
3135 .release = cli_release_handler,
3136};
3137
William Lallemand99e0bb92020-11-05 10:28:53 +01003138/* master CLI */
3139static struct applet mcli_applet = {
3140 .obj_type = OBJ_TYPE_APPLET,
3141 .name = "<MCLI>", /* used for logging */
3142 .fct = cli_io_handler,
3143 .release = cli_release_handler,
3144};
3145
Willy Tarreau0a739292016-11-22 20:21:23 +01003146/* register cli keywords */
3147static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003148 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3149 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3150 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3151 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003152 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3153 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003154 { { "mcli-debug-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER_ONLY }, // not listed
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003155 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3156 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3157 { { "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 },
3158 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3159 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3160 { { "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 },
3161 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3162 { { "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 },
3163 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003164 { { "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 +02003165 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3166 { { "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 +01003167 {{},}
3168}};
3169
Willy Tarreau0108d902018-11-25 19:14:37 +01003170INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3171
William Lallemand74c24fb2016-11-21 17:18:36 +01003172static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003173 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003174 { 0, NULL, NULL },
3175}};
3176
Willy Tarreau0108d902018-11-25 19:14:37 +01003177INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3178
William Lallemand74c24fb2016-11-21 17:18:36 +01003179static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003180 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3181 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003182 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003183 { NULL, NULL, 0 },
3184}};
3185
Willy Tarreau0108d902018-11-25 19:14:37 +01003186INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003187
3188/*
3189 * Local variables:
3190 * c-indent-level: 8
3191 * c-basic-offset: 8
3192 * End:
3193 */