blob: 273fe8684905895bb90b1415cab62a2d60ad0c66 [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);
Christopher Faulet908628c2022-03-25 16:43:49 +0100901 struct channel *req = cs_oc(cs);
902 struct channel *res = cs_ic(cs);
903 struct bind_conf *bind_conf = strm_li(__cs_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 */
Christopher Fauletda098e62022-03-31 17:44:45 +0200931 cs_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 */
Christopher Faulet908628c2022-03-25 16:43:49 +0100953 if (buffer_almost_full(cs_ib(cs))) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +0200954 cs_rx_room_blk(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)
Christopher Faulet908628c2022-03-25 16:43:49 +0100965 reql = co_getline(cs_oc(cs), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100966 appctx->chunk->size - appctx->chunk->data - 1);
967 else
Christopher Faulet908628c2022-03-25 16:43:49 +0100968 reql = co_getdelim(cs_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 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001053 co_skip(cs_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
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001097 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001099
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001100 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001101 if (appctx->io_handler)
1102 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001103 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001104 if (appctx->io_release) {
1105 appctx->io_release(appctx);
1106 appctx->io_release = NULL;
1107 }
1108 }
1109 break;
1110 default: /* abnormal state */
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
Christopher Faulet908628c2022-03-25 16:43:49 +01001134 if (ci_putstr(cs_ic(cs), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001135 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001136 else
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001137 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001138 }
1139
1140 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001141 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001142 break;
1143
1144 /* Now we close the output if one of the writers did so,
1145 * or if we're not in interactive mode and the request
1146 * buffer is empty. This still allows pipelined requests
1147 * to be sent in non-interactive mode.
1148 */
William Lallemand3de09d52018-12-11 16:10:56 +01001149 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1150 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001151 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 continue;
1153 }
1154
1155 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001156 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001157 /* reactivate the \n at the end of the response for the next command */
1158 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001159
1160 /* this forces us to yield between pipelined commands and
1161 * avoid extremely long latencies (e.g. "del map" etc). In
1162 * addition this increases the likelihood that the stream
1163 * refills the buffer with new bytes in non-interactive
1164 * mode, avoiding to close on apparently empty commands.
1165 */
Christopher Faulet908628c2022-03-25 16:43:49 +01001166 if (co_data(cs_oc(cs))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001167 appctx_wakeup(appctx);
1168 goto out;
1169 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001170 }
1171 }
1172
Willy Tarreau026e8fb2022-05-17 19:47:17 +02001173 if ((res->flags & CF_SHUTR) && (cs->state == SC_ST_EST)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001174 DPRINTF(stderr, "%s@%d: cs to buf closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001175 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001176 /* Other side has closed, let's abort if we have no more processing to do
1177 * and nothing more to consume. This is comparable to a broken pipe, so
1178 * we forward the close to the request side so that it flows upstream to
1179 * the client.
1180 */
Christopher Fauletda098e62022-03-31 17:44:45 +02001181 cs_shutw(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001182 }
1183
Willy Tarreau026e8fb2022-05-17 19:47:17 +02001184 if ((req->flags & CF_SHUTW) && (cs->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +02001185 DPRINTF(stderr, "%s@%d: buf to cs closed. req=%08x, res=%08x, st=%d\n",
Christopher Faulet62e75742022-03-31 09:16:34 +02001186 __FUNCTION__, __LINE__, req->flags, res->flags, cs->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001187 /* We have no more processing to do, and nothing more to send, and
1188 * the client side has closed. So we'll forward this state downstream
1189 * on the response buffer.
1190 */
Christopher Fauletda098e62022-03-31 17:44:45 +02001191 cs_shutr(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 res->flags |= CF_READ_NULL;
1193 }
1194
1195 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001196 DPRINTF(stderr, "%s@%d: st=%d, rqf=%x, rpf=%x, rqh=%lu, rqs=%lu, rh=%lu, rs=%lu\n",
William Lallemand74c24fb2016-11-21 17:18:36 +01001197 __FUNCTION__, __LINE__,
Christopher Faulet62e75742022-03-31 09:16:34 +02001198 cs->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001199}
1200
Willy Tarreau4596fe22022-05-17 19:07:51 +02001201/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001202 * external abort, we won't call the i/o handler anymore so we may need to
1203 * remove back references to the stream currently being dumped.
1204 */
1205static void cli_release_handler(struct appctx *appctx)
1206{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001207 free_trash_chunk(appctx->chunk);
1208 appctx->chunk = NULL;
1209
William Lallemand74c24fb2016-11-21 17:18:36 +01001210 if (appctx->io_release) {
1211 appctx->io_release(appctx);
1212 appctx->io_release = NULL;
1213 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001214 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001215 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1216
1217 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001218 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001219}
1220
1221/* This function dumps all environmnent variables to the buffer. It returns 0
1222 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001223 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1224 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001225 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001226static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001227{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001228 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreau4596fe22022-05-17 19:07:51 +02001229 struct stconn *cs = appctx_cs(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001230 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001231
Christopher Faulet908628c2022-03-25 16:43:49 +01001232 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001233 return 1;
1234
1235 chunk_reset(&trash);
1236
1237 /* we have two inner loops here, one for the proxy, the other one for
1238 * the buffer.
1239 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001240 while (*var) {
1241 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001242
Christopher Faulet908628c2022-03-25 16:43:49 +01001243 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001244 cs_rx_room_blk(cs);
William Lallemand74c24fb2016-11-21 17:18:36 +01001245 return 0;
1246 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001247 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001248 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001249 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001250 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001251 }
1252
1253 /* dump complete */
1254 return 1;
1255}
1256
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001257/* This function dumps all file descriptors states (or the requested one) to
1258 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001259 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1260 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1261 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001262 */
1263static int cli_io_handler_show_fd(struct appctx *appctx)
1264{
Willy Tarreau4596fe22022-05-17 19:07:51 +02001265 struct stconn *cs = appctx_cs(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001266 struct show_fd_ctx *fdctx = appctx->svcctx;
1267 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001268 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001269
Christopher Faulet908628c2022-03-25 16:43:49 +01001270 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001271 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001272
1273 chunk_reset(&trash);
1274
Willy Tarreauca1b1572018-12-18 15:45:11 +01001275 /* isolate the threads once per round. We're limited to a buffer worth
1276 * of output anyway, it cannot last very long.
1277 */
1278 thread_isolate();
1279
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001280 /* we have two inner loops here, one for the proxy, the other one for
1281 * the buffer.
1282 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001283 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001284 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001285 const struct listener *li = NULL;
1286 const struct server *sv = NULL;
1287 const struct proxy *px = NULL;
1288 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001289 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001290 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001291 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001292 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001293 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001294 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001295 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001296
1297 fdt = fdtab[fd];
1298
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001299 /* When DEBUG_FD is set, we also report closed FDs that have a
1300 * non-null event count to detect stuck ones.
1301 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001302 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001303#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001304 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001305#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001306 goto skip; // closed
1307 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001308 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001309 conn = (const struct connection *)fdt.owner;
1310 conn_flags = conn->flags;
1311 mux = conn->mux;
1312 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001313 xprt = conn->xprt;
1314 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001315 li = objt_listener(conn->target);
1316 sv = objt_server(conn->target);
1317 px = objt_proxy(conn->target);
1318 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001319 if (atleast2(fdt.thread_mask))
1320 suspicious = 1;
1321 if (conn->handle.fd != fd)
1322 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001323 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001324 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001325 li = fdt.owner;
1326
Willy Tarreaudacfde42021-01-21 09:07:29 +01001327 if (!fdt.thread_mask)
1328 suspicious = 1;
1329
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001330 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001331 " %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 +02001332 fd,
1333 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001334 (fdt.state & FD_CLONED) ? 'C' : 'c',
1335 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001336 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1337 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1338 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1339 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1340 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001341 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1342 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1343 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1344 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1345 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1346 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001347 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001348 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001349 fdt.iocb);
1350 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001351
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001352 if (!fdt.owner) {
1353 chunk_appendf(&trash, ")");
1354 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001355 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001356 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001357
1358 if (conn->handle.fd != fd) {
1359 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1360 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001361 } else {
1362 struct sockaddr_storage sa;
1363 socklen_t salen;
1364
1365 salen = sizeof(sa);
1366 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1367 if (sa.ss_family == AF_INET)
1368 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1369 else if (sa.ss_family == AF_INET6)
1370 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1371 else if (sa.ss_family == AF_UNIX)
1372 chunk_appendf(&trash, " fam=unix");
1373 }
1374
1375 salen = sizeof(sa);
1376 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1377 if (sa.ss_family == AF_INET)
1378 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1379 else if (sa.ss_family == AF_INET6)
1380 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1381 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001382 }
1383
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001384 if (px)
1385 chunk_appendf(&trash, " px=%s", px->id);
1386 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001387 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001388 else if (li)
1389 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001390
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001391 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001392 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001393 if (!ctx)
1394 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001395 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001396 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001397 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001398 else
1399 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001400
1401 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001402 if (xprt) {
1403 if (xprt_ctx || xprt->show_fd)
1404 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1405 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001406 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001407 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001408 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001409 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001410 struct sockaddr_storage sa;
1411 socklen_t salen;
1412
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001413 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001414 listener_state_str(li),
1415 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001416
1417 salen = sizeof(sa);
1418 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1419 if (sa.ss_family == AF_INET)
1420 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1421 else if (sa.ss_family == AF_INET6)
1422 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1423 else if (sa.ss_family == AF_UNIX)
1424 chunk_appendf(&trash, " fam=unix");
1425 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001426 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001427 else
1428 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001429
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001430#ifdef DEBUG_FD
1431 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001432 if (fdtab[fd].event_count >= 1000000)
1433 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001434#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001435 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001436
Christopher Faulet908628c2022-03-25 16:43:49 +01001437 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001438 cs_rx_room_blk(cs);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001439 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001440 ret = 0;
1441 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001442 }
1443 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001444 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001445 break;
1446
1447 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001448 }
1449
Willy Tarreauca1b1572018-12-18 15:45:11 +01001450 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001451 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001452
1453 thread_release();
1454 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001455}
1456
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001457/* This function dumps some activity counters used by developers and support to
1458 * rule out some hypothesis during bug reports. It returns 0 if the output
1459 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1460 * everything at once in the buffer and is not designed to do it in multiple
1461 * passes.
1462 */
1463static int cli_io_handler_show_activity(struct appctx *appctx)
1464{
Willy Tarreau4596fe22022-05-17 19:07:51 +02001465 struct stconn *cs = appctx_cs(appctx);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001466 int thr;
1467
Christopher Faulet908628c2022-03-25 16:43:49 +01001468 if (unlikely(cs_ic(cs)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001469 return 1;
1470
1471 chunk_reset(&trash);
1472
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001473#undef SHOW_TOT
1474#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001475 do { \
1476 unsigned int _v[MAX_THREADS]; \
1477 unsigned int _tot; \
1478 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001479 _tot = t = 0; \
1480 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001481 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001482 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001483 if (_nbt == 1) { \
1484 chunk_appendf(&trash, " %u\n", _tot); \
1485 break; \
1486 } \
1487 chunk_appendf(&trash, " %u [", _tot); \
1488 for (t = 0; t < _nbt; t++) \
1489 chunk_appendf(&trash, " %u", _v[t]); \
1490 chunk_appendf(&trash, " ]\n"); \
1491 } while (0)
1492
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001493#undef SHOW_AVG
1494#define SHOW_AVG(t, x) \
1495 do { \
1496 unsigned int _v[MAX_THREADS]; \
1497 unsigned int _tot; \
1498 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001499 _tot = t = 0; \
1500 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001501 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001502 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001503 if (_nbt == 1) { \
1504 chunk_appendf(&trash, " %u\n", _tot); \
1505 break; \
1506 } \
1507 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1508 for (t = 0; t < _nbt; t++) \
1509 chunk_appendf(&trash, " %u", _v[t]); \
1510 chunk_appendf(&trash, " ]\n"); \
1511 } while (0)
1512
Willy Tarreaua0211b82019-05-28 15:09:08 +02001513 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1514 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001515 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1516 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1517 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1518 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001519 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001520 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1521 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001522 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001523 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001524 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001525 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001526 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001527 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001528 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1529 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001530 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1531 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1532 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1533 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1534 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1535 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1536 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001537#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001538 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 +02001539 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001540#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001541
Willy Tarreaud6a78502019-05-27 07:03:38 +02001542#if defined(DEBUG_DEV)
1543 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001544 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1545 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1546 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001547#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001548
Christopher Faulet908628c2022-03-25 16:43:49 +01001549 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001550 chunk_reset(&trash);
1551 chunk_printf(&trash, "[output too large, cannot dump]\n");
Christopher Fauleta0bdec32022-04-04 07:51:21 +02001552 cs_rx_room_blk(cs);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001553 }
1554
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001555#undef SHOW_AVG
1556#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001557 /* dump complete */
1558 return 1;
1559}
1560
William Lallemandeceddf72016-12-15 18:06:44 +01001561/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001562 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001563 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1564 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001565 */
1566static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1567{
Willy Tarreaub128f492022-05-05 19:11:05 +02001568 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1569 struct bind_conf *bind_conf = ctx->bind_conf;
Willy Tarreau4596fe22022-05-17 19:07:51 +02001570 struct stconn *cs = appctx_cs(appctx);
William Lallemandeceddf72016-12-15 18:06:44 +01001571
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001572 if (!global.cli_fe)
1573 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001574
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001575 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001576
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001577 if (!bind_conf) {
1578 /* first call */
1579 if (ci_putstr(cs_ic(cs), "# socket lvl processes\n") == -1)
1580 goto full;
1581 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1582 }
William Lallemandeceddf72016-12-15 18:06:44 +01001583
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001584 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001585 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001586
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001587 if (!l)
1588 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001589
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001590 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1591 char addr[46];
1592 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001593
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001594 if (l->rx.addr.ss_family == AF_UNIX) {
1595 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001596
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001597 un = (struct sockaddr_un *)&l->rx.addr;
1598 if (un->sun_path[0] == '\0') {
1599 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1600 } else {
1601 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1602 }
1603 } else if (l->rx.addr.ss_family == AF_INET) {
1604 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1605 port_to_str(&l->rx.addr, port, sizeof(port));
1606 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1607 } else if (l->rx.addr.ss_family == AF_INET6) {
1608 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1609 port_to_str(&l->rx.addr, port, sizeof(port));
1610 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1611 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1612 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1613 } else
1614 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001615
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001616 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1617 chunk_appendf(&trash, "admin ");
1618 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1619 chunk_appendf(&trash, "operator ");
1620 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1621 chunk_appendf(&trash, "user ");
1622 else
1623 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001624
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001625 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001626
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001627 if (ci_putchk(cs_ic(cs), &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001628 ctx->bind_conf = bind_conf;
1629 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001630 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001631 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001632 }
William Lallemandeceddf72016-12-15 18:06:44 +01001633 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001634 done:
1635 return 1;
1636 full:
1637 cs_rx_room_blk(cs);
1638 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001639}
1640
1641
Willy Tarreau0a739292016-11-22 20:21:23 +01001642/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001643 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1644 * be dumped as well as a flag if a single variable is requested, otherwise puts
1645 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001646 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001647static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001648{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001649 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001650 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001651 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001652
1653 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1654 return 1;
1655
Willy Tarreauf6710f82016-12-16 17:45:44 +01001656 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001657
1658 if (*args[2]) {
1659 int len = strlen(args[2]);
1660
Willy Tarreauf6710f82016-12-16 17:45:44 +01001661 for (; *var; var++) {
1662 if (strncmp(*var, args[2], len) == 0 &&
1663 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001664 break;
1665 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001666 if (!*var)
1667 return cli_err(appctx, "Variable not found\n");
1668
Willy Tarreau307dbb32022-05-05 17:45:52 +02001669 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001670 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001671 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001672 return 0;
1673}
1674
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001675/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001676 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1677 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001678 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001679static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001680{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001681 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1682
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001683 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1684 return 1;
1685
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001686 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001687 ctx->fd = atoi(args[2]);
1688 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001689 }
1690 return 0;
1691}
1692
Willy Tarreau599852e2016-11-22 20:33:32 +01001693/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001694static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001695{
Willy Tarreau0698c802022-05-11 14:09:57 +02001696 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001697
1698 if (strcmp(args[2], "cli") == 0) {
1699 unsigned timeout;
1700 const char *res;
1701
Willy Tarreau9d008692019-08-09 11:21:01 +02001702 if (!*args[3])
1703 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001704
1705 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001706 if (res || timeout < 1)
1707 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001708
1709 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1710 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1711 return 1;
1712 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001713
1714 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001715}
1716
Willy Tarreau2af99412016-11-23 11:10:59 +01001717/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001718static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001719{
1720 int v;
1721
1722 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1723 return 1;
1724
Willy Tarreau9d008692019-08-09 11:21:01 +02001725 if (!*args[3])
1726 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001727
1728 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001729 if (v > global.hardmaxconn)
1730 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001731
1732 /* check for unlimited values */
1733 if (v <= 0)
1734 v = global.hardmaxconn;
1735
1736 global.maxconn = v;
1737
1738 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001739 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001740
1741 return 1;
1742}
1743
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001744static int set_severity_output(int *target, char *argument)
1745{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001746 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001747 *target = CLI_SEVERITY_NONE;
1748 return 1;
1749 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001750 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001751 *target = CLI_SEVERITY_NUMBER;
1752 return 1;
1753 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001754 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001755 *target = CLI_SEVERITY_STRING;
1756 return 1;
1757 }
1758 return 0;
1759}
1760
1761/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001762static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001763{
1764 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1765 return 0;
1766
Willy Tarreau9d008692019-08-09 11:21:01 +02001767 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001768}
William Lallemandeceddf72016-12-15 18:06:44 +01001769
William Lallemand67a234f2018-12-13 09:05:45 +01001770
1771/* show the level of the current CLI session */
1772static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1773{
William Lallemand67a234f2018-12-13 09:05:45 +01001774 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001775 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001776 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001777 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001778 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001779 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001780 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001781 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001782}
1783
1784/* parse and set the CLI level dynamically */
1785static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1786{
William Lallemandad032882019-07-01 10:56:15 +02001787 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001788 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001789 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1790
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001791 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001792 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1793 return 1;
1794 }
1795 appctx->cli_level &= ~ACCESS_LVL_MASK;
1796 appctx->cli_level |= ACCESS_LVL_OPER;
1797
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001798 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001799 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1800 return 1;
1801 }
1802 appctx->cli_level &= ~ACCESS_LVL_MASK;
1803 appctx->cli_level |= ACCESS_LVL_USER;
1804 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001805 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001806 return 1;
1807}
1808
1809
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001810/* parse and set the CLI expert/experimental-mode dynamically */
1811static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001812{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001813 int level;
1814 char *level_str;
1815 char *output = NULL;
1816
William Lallemand7267f782022-02-01 16:08:50 +01001817 /* this will ask the applet to not output a \n after the command */
1818 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1819 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1820
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001821 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1822 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001823
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001824 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001825 level = ACCESS_EXPERT;
1826 level_str = "expert-mode";
1827 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001828 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001829 level = ACCESS_EXPERIMENTAL;
1830 level_str = "experimental-mode";
1831 }
William Lallemand2a171912022-02-02 11:43:20 +01001832 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1833 level = ACCESS_MCLI_DEBUG;
1834 level_str = "mcli-debug-mode";
1835 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001836 else {
1837 return 1;
1838 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001839
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001840 if (!*args[1]) {
1841 memprintf(&output, "%s is %s\n", level_str,
1842 (appctx->cli_level & level) ? "ON" : "OFF");
1843 return cli_dynmsg(appctx, LOG_INFO, output);
1844 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001845
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001846 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001847 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001848 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001849 return 1;
1850}
1851
William Lallemand740629e2021-12-14 15:22:29 +01001852/* shows HAProxy version */
1853static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1854{
1855 char *msg = NULL;
1856
1857 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1858}
1859
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001860int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001861{
1862 return 0;
1863}
1864
Willy Tarreau45c742b2016-11-24 14:51:17 +01001865/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001866static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001867{
1868 int v;
1869 int *res;
1870 int mul = 1;
1871
1872 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1873 return 1;
1874
1875 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1876 res = &global.cps_lim;
1877 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1878 res = &global.sps_lim;
1879#ifdef USE_OPENSSL
1880 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1881 res = &global.ssl_lim;
1882#endif
1883 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1884 res = &global.comp_rate_lim;
1885 mul = 1024;
1886 }
1887 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001888 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001889 "'set rate-limit' only supports :\n"
1890 " - 'connections global' to set the per-process maximum connection rate\n"
1891 " - 'sessions global' to set the per-process maximum session rate\n"
1892#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001893 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001894#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001895 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001896 }
1897
Willy Tarreau9d008692019-08-09 11:21:01 +02001898 if (!*args[4])
1899 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001900
1901 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001902 if (v < 0)
1903 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001904
1905 *res = v * mul;
1906
1907 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001908 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001909
1910 return 1;
1911}
1912
William Lallemandf6975e92017-05-26 17:42:10 +02001913/* parse the "expose-fd" argument on the bind lines */
1914static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1915{
1916 if (!*args[cur_arg + 1]) {
1917 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1918 return ERR_ALERT | ERR_FATAL;
1919 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001920 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001921 conf->level |= ACCESS_FD_LISTENERS;
1922 } else {
1923 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1924 args[cur_arg], args[cur_arg+1]);
1925 return ERR_ALERT | ERR_FATAL;
1926 }
1927
1928 return 0;
1929}
1930
William Lallemand74c24fb2016-11-21 17:18:36 +01001931/* parse the "level" argument on the bind lines */
1932static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1933{
1934 if (!*args[cur_arg + 1]) {
1935 memprintf(err, "'%s' : missing level", args[cur_arg]);
1936 return ERR_ALERT | ERR_FATAL;
1937 }
1938
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001939 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001940 conf->level &= ~ACCESS_LVL_MASK;
1941 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001942 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001943 conf->level &= ~ACCESS_LVL_MASK;
1944 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001945 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001946 conf->level &= ~ACCESS_LVL_MASK;
1947 conf->level |= ACCESS_LVL_ADMIN;
1948 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001949 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1950 args[cur_arg], args[cur_arg+1]);
1951 return ERR_ALERT | ERR_FATAL;
1952 }
1953
1954 return 0;
1955}
1956
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001957static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1958{
1959 if (!*args[cur_arg + 1]) {
1960 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1961 return ERR_ALERT | ERR_FATAL;
1962 }
1963
1964 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1965 return 0;
1966 else {
1967 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1968 args[cur_arg], args[cur_arg+1]);
1969 return ERR_ALERT | ERR_FATAL;
1970 }
1971}
1972
Olivier Houchardf886e342017-04-05 22:24:59 +02001973/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001974static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001975{
1976 char *cmsgbuf = NULL;
1977 unsigned char *tmpbuf = NULL;
1978 struct cmsghdr *cmsg;
Willy Tarreau4596fe22022-05-17 19:07:51 +02001979 struct stconn *cs = appctx_cs(appctx);
Christopher Faulet908628c2022-03-25 16:43:49 +01001980 struct stream *s = __cs_strm(cs);
1981 struct connection *remote = cs_conn(cs_opposite(cs));
Olivier Houchardf886e342017-04-05 22:24:59 +02001982 struct msghdr msghdr;
1983 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001984 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001985 const char *ns_name, *if_name;
1986 unsigned char ns_nlen, if_nlen;
1987 int nb_queued;
1988 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001989 int *tmpfd;
1990 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001991 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001992 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001993 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001994 int ret;
1995
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001996 if (!remote) {
1997 ha_warning("Only works on real connections\n");
1998 goto out;
1999 }
2000
2001 fd = remote->handle.fd;
2002
Olivier Houchardf886e342017-04-05 22:24:59 +02002003 /* Temporary set the FD in blocking mode, that will make our life easier */
2004 old_fcntl = fcntl(fd, F_GETFL);
2005 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002006 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002007 goto out;
2008 }
2009 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2010 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002011 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002012 goto out;
2013 }
2014 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002015 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002016 goto out;
2017 }
Olivier Houchard54740872017-04-06 14:45:14 +02002018 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002019 iov.iov_base = &tot_fd_nb;
2020 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002021 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002022 goto out;
2023 memset(&msghdr, 0, sizeof(msghdr));
2024 /*
2025 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002026 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002027 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002028 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002029 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002030
Olivier Houchardf886e342017-04-05 22:24:59 +02002031 if (tot_fd_nb == 0)
2032 goto out;
2033
2034 /* First send the total number of file descriptors, so that the
2035 * receiving end knows what to expect.
2036 */
2037 msghdr.msg_iov = &iov;
2038 msghdr.msg_iovlen = 1;
2039 ret = sendmsg(fd, &msghdr, 0);
2040 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002041 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002042 goto out;
2043 }
2044
2045 /* Now send the fds */
2046 msghdr.msg_control = cmsgbuf;
2047 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2048 cmsg = CMSG_FIRSTHDR(&msghdr);
2049 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2050 cmsg->cmsg_level = SOL_SOCKET;
2051 cmsg->cmsg_type = SCM_RIGHTS;
2052 tmpfd = (int *)CMSG_DATA(cmsg);
2053
Olivier Houchardf886e342017-04-05 22:24:59 +02002054 /* For each socket, e message is sent, containing the following :
2055 * Size of the namespace name (or 0 if none), as an unsigned char.
2056 * The namespace name, if any
2057 * Size of the interface name (or 0 if none), as an unsigned char
2058 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002059 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002060 */
2061 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002062 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002063 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002064 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002065 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002066 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002067 goto out;
2068 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002069
2070 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002071 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002072 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002073 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002074 continue;
2075
2076 ns_name = if_name = "";
2077 ns_nlen = if_nlen = 0;
2078
2079 /* for now we can only retrieve namespaces and interfaces from
2080 * pure listeners.
2081 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002082 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002083 const struct listener *l = fdtab[cur_fd].owner;
2084
Willy Tarreau818a92e2020-09-03 07:50:19 +02002085 if (l->rx.settings->interface) {
2086 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002087 if_nlen = strlen(if_name);
2088 }
2089
2090#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002091 if (l->rx.settings->netns) {
2092 ns_name = l->rx.settings->netns->node.key;
2093 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002094 }
2095#endif
2096 }
2097
2098 /* put the FD into the CMSG_DATA */
2099 tmpfd[nb_queued++] = cur_fd;
2100
2101 /* first block is <ns_name_len> <ns_name> */
2102 tmpbuf[curoff++] = ns_nlen;
2103 if (ns_nlen)
2104 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2105 curoff += ns_nlen;
2106
2107 /* second block is <if_name_len> <if_name> */
2108 tmpbuf[curoff++] = if_nlen;
2109 if (if_nlen)
2110 memcpy(tmpbuf + curoff, if_name, if_nlen);
2111 curoff += if_nlen;
2112
2113 /* we used to send the listener options here before 2.3 */
2114 memset(tmpbuf + curoff, 0, sizeof(int));
2115 curoff += sizeof(int);
2116
2117 /* there's a limit to how many FDs may be sent at once */
2118 if (nb_queued == MAX_SEND_FD) {
2119 iov.iov_len = curoff;
2120 if (sendmsg(fd, &msghdr, 0) != curoff) {
2121 ha_warning("Failed to transfer sockets\n");
2122 return -1;
2123 }
2124
2125 /* Wait for an ack */
2126 do {
2127 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2128 } while (ret == -1 && errno == EINTR);
2129
2130 if (ret <= 0) {
2131 ha_warning("Unexpected error while transferring sockets\n");
2132 return -1;
2133 }
2134 curoff = 0;
2135 nb_queued = 0;
2136 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002137 }
2138
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002139 /* flush pending stuff */
2140 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002141 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002142 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2143 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002144 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002145 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002146 goto out;
2147 }
2148 }
2149
2150out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002151 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002152 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002153 goto out;
2154 }
2155 appctx->st0 = CLI_ST_END;
2156 free(cmsgbuf);
2157 free(tmpbuf);
2158 return 1;
2159}
2160
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002161static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2162{
2163 if (*args[0] == 'h')
2164 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002165 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002166 else if (*args[0] == 'p')
2167 /* prompt */
2168 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2169 else if (*args[0] == 'q')
2170 /* quit */
2171 appctx->st0 = CLI_ST_END;
2172
2173 return 1;
2174}
Olivier Houchardf886e342017-04-05 22:24:59 +02002175
William Lallemand2f4ce202018-10-26 14:47:47 +02002176void pcli_write_prompt(struct stream *s)
2177{
2178 struct buffer *msg = get_trash_chunk();
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002179 struct channel *oc = cs_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002180
William Lallemanddc12c2e2018-12-13 09:05:46 +01002181 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002182 return;
2183
William Lallemanddc12c2e2018-12-13 09:05:46 +01002184 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002185 chunk_appendf(msg, "+ ");
2186 } else {
2187 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002188 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002189 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002190 else
William Lallemanddae12c72022-02-02 14:13:54 +01002191 chunk_appendf(msg, "%d", s->pcli_next_pid);
2192
2193 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2194 chunk_appendf(msg, "(");
2195
2196 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2197 chunk_appendf(msg, "x");
2198
2199 if (s->pcli_flags & ACCESS_EXPERT)
2200 chunk_appendf(msg, "e");
2201
2202 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2203 chunk_appendf(msg, "d");
2204
2205 chunk_appendf(msg, ")");
2206 }
2207
2208 chunk_appendf(msg, "> ");
2209
2210
William Lallemandebf61802018-12-11 16:10:57 +01002211 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002212 co_inject(oc, msg->area, msg->data);
2213}
2214
William Lallemand291810d2018-10-26 14:47:38 +02002215
William Lallemandcf62f7e2018-10-26 14:47:40 +02002216/* The pcli_* functions are used for the CLI proxy in the master */
2217
William Lallemanddeeaa592018-10-26 14:47:48 +02002218void pcli_reply_and_close(struct stream *s, const char *msg)
2219{
2220 struct buffer *buf = get_trash_chunk();
2221
2222 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002223 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002224}
2225
William Lallemand291810d2018-10-26 14:47:38 +02002226static enum obj_type *pcli_pid_to_server(int proc_pid)
2227{
2228 struct mworker_proc *child;
2229
William Lallemand99e0bb92020-11-05 10:28:53 +01002230 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002231 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002232 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002233
William Lallemand291810d2018-10-26 14:47:38 +02002234 list_for_each_entry(child, &proc_list, list) {
2235 if (child->pid == proc_pid){
2236 return &child->srv->obj_type;
2237 }
2238 }
2239 return NULL;
2240}
2241
2242/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2243 * Return:
2244 * 0: master
2245 * > 0: pid of a worker
2246 * < 0: didn't find a worker
2247 */
2248static int pcli_prefix_to_pid(const char *prefix)
2249{
2250 int proc_pid;
2251 struct mworker_proc *child;
2252 char *errtol = NULL;
2253
2254 if (*prefix != '@') /* not a prefix, should not happen */
2255 return -1;
2256
2257 prefix++;
2258 if (!*prefix) /* sent @ alone, return the master */
2259 return 0;
2260
2261 if (strcmp("master", prefix) == 0) {
2262 return 0;
2263 } else if (*prefix == '!') {
2264 prefix++;
2265 if (!*prefix)
2266 return -1;
2267
2268 proc_pid = strtol(prefix, &errtol, 10);
2269 if (*errtol != '\0')
2270 return -1;
2271 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002272 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002273 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002274 if (child->pid == proc_pid){
2275 return child->pid;
2276 }
2277 }
2278 } else {
2279 struct mworker_proc *chosen = NULL;
2280 /* this is a relative pid */
2281
2282 proc_pid = strtol(prefix, &errtol, 10);
2283 if (*errtol != '\0')
2284 return -1;
2285
2286 if (proc_pid == 0) /* return the master */
2287 return 0;
2288
2289 /* chose the right process, the current one is the one with the
2290 least number of reloads */
2291 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002292 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002293 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002294 if (child->reloads == 0)
2295 return child->pid;
2296 else if (chosen == NULL || child->reloads < chosen->reloads)
2297 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002298 }
2299 if (chosen)
2300 return chosen->pid;
2301 }
2302 return -1;
2303}
2304
William Lallemandbddd33a2018-12-11 16:10:53 +01002305/* Return::
2306 * >= 0 : number of words to escape
2307 * = -1 : error
2308 */
2309
2310int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2311{
2312 if (argl < 1)
2313 return 0;
2314
2315 /* there is a prefix */
2316 if (args[0][0] == '@') {
2317 int target_pid = pcli_prefix_to_pid(args[0]);
2318
2319 if (target_pid == -1) {
2320 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2321 return -1;
2322 }
2323
2324 /* if the prefix is alone, define a default target */
2325 if (argl == 1)
2326 s->pcli_next_pid = target_pid;
2327 else
2328 *next_pid = target_pid;
2329 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002330 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002331 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002332 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002333
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002334 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002335 channel_shutr_now(&s->req);
2336 channel_shutw_now(&s->res);
2337 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002338 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002339 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2340 memprintf(errmsg, "Permission denied!\n");
2341 return -1;
2342 }
2343 s->pcli_flags &= ~ACCESS_LVL_MASK;
2344 s->pcli_flags |= ACCESS_LVL_OPER;
2345 return argl;
2346
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002347 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002348 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2349 memprintf(errmsg, "Permission denied!\n");
2350 return -1;
2351 }
2352 s->pcli_flags &= ~ACCESS_LVL_MASK;
2353 s->pcli_flags |= ACCESS_LVL_USER;
2354 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002355
2356 } else if (strcmp(args[0], "expert-mode") == 0) {
2357 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2358 memprintf(errmsg, "Permission denied!\n");
2359 return -1;
2360 }
2361
2362 s->pcli_flags &= ~ACCESS_EXPERT;
2363 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2364 s->pcli_flags |= ACCESS_EXPERT;
2365 return argl;
2366
2367 } else if (strcmp(args[0], "experimental-mode") == 0) {
2368 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2369 memprintf(errmsg, "Permission denied!\n");
2370 return -1;
2371 }
2372 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2373 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2374 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2375 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002376 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2377 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2378 memprintf(errmsg, "Permission denied!\n");
2379 return -1;
2380 }
2381 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2382 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2383 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2384 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002385 }
2386
2387 return 0;
2388}
2389
2390/*
2391 * Parse the CLI request:
2392 * - It does basically the same as the cli_io_handler, but as a proxy
2393 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002394 *
2395 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002396 * - the number of characters to forward or
2397 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002398 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002399int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002400{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002401 char *str;
2402 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002403 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002404 int argl; /* number of args */
2405 char *p;
2406 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002407 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002408 int wtrim = 0; /* number of words to trim */
2409 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002410 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002411 int i = 0;
2412
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002413 /* we cannot deal with a wrapping buffer, so let's take care of this
2414 * first.
2415 */
2416 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2417 b_slow_realign(&req->buf, trash.area, co_data(req));
2418
2419 str = (char *)ci_head(req);
2420 end = (char *)ci_stop(req);
2421
William Lallemandbddd33a2018-12-11 16:10:53 +01002422 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002423
William Lallemanddc12c2e2018-12-13 09:05:46 +01002424 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002425
2426 /* Looks for the end of one command */
2427 while (p+reql < end) {
2428 /* handle escaping */
2429 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002430 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002431 continue;
2432 }
2433 if (p[reql] == ';' || p[reql] == '\n') {
2434 /* found the end of the command */
2435 p[reql] = '\n';
2436 reql++;
2437 break;
2438 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002439 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002440 }
William Lallemandebf61802018-12-11 16:10:57 +01002441 } else {
2442 while (p+reql < end) {
2443 if (p[reql] == '\n') {
2444 /* found the end of the line */
2445 reql++;
2446 break;
2447 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002449 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002451
William Lallemandbddd33a2018-12-11 16:10:53 +01002452 /* set end to first byte after the end of the command */
2453 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002454
William Lallemandbddd33a2018-12-11 16:10:53 +01002455 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002456 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002457 return -1;
2458 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002459
William Lallemand3301f3e2018-12-13 09:05:48 +01002460 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2461 if (reql == 1) /* last line of the payload */
2462 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002463 return reql;
2464 }
2465
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002467
William Lallemandbddd33a2018-12-11 16:10:53 +01002468 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002469 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002470 /* skip leading spaces/tabs */
2471 p += strspn(p, " \t");
2472 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002473 break;
2474
William Lallemandbddd33a2018-12-11 16:10:53 +01002475 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002476 while (1) {
2477 p += strcspn(p, " \t\\");
2478 /* escaped chars using backlashes (\) */
2479 if (*p == '\\') {
2480 if (!*++p)
2481 break;
2482 if (!*++p)
2483 break;
2484 } else {
2485 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002486 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002487 }
William Lallemandfe249c32020-06-18 18:03:57 +02002488 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002489 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002490 }
2491
William Lallemandbddd33a2018-12-11 16:10:53 +01002492 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002493
Willy Tarreauf14c7572021-03-13 10:59:23 +01002494 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002495 args[i] = NULL;
2496
2497 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2498
2499 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002500 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002501 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002502 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002503 if (*p == '\0')
2504 *p = ' ';
2505 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002506 }
2507
William Lallemand3301f3e2018-12-13 09:05:48 +01002508 payload = strstr(str, PAYLOAD_PATTERN);
2509 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2510 /* if the payload pattern is at the end */
2511 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002512 }
2513
William Lallemandbddd33a2018-12-11 16:10:53 +01002514 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002515
William Lallemandbddd33a2018-12-11 16:10:53 +01002516 if (wtrim > 0) {
2517 trim = &args[wtrim][0];
2518 if (trim == NULL) /* if this was the last word in the table */
2519 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002520
William Lallemandbddd33a2018-12-11 16:10:53 +01002521 b_del(&req->buf, trim - str);
2522
William Lallemandb7ea1412018-12-13 09:05:47 +01002523 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002524 } else if (wtrim < 0) {
2525 /* parsing error */
2526 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002527 } else {
2528 /* the whole string */
2529 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002530 }
2531
William Lallemandb7ea1412018-12-13 09:05:47 +01002532 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002533
2534 /* the mcli-debug-mode is only sent to the applet of the master */
2535 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2536 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2537 ret += strlen("mcli-debug-mode on -") + 2;
2538 }
William Lallemand7267f782022-02-01 16:08:50 +01002539 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2540 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2541 ret += strlen("experimental-mode on -") + 2;
2542 }
2543 if (s->pcli_flags & ACCESS_EXPERT) {
2544 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2545 ret += strlen("expert-mode on -") + 2;
2546 }
2547
William Lallemandb7ea1412018-12-13 09:05:47 +01002548 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2549 goto end;
2550 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002551 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2552 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002553 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002554 ci_insert_line2(req, 0, "user -", strlen("user -"));
2555 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002556 }
2557 }
2558end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002559
William Lallemandb7ea1412018-12-13 09:05:47 +01002560 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002561}
2562
2563int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2564{
William Lallemandbddd33a2018-12-11 16:10:53 +01002565 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002566 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002567 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002568
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002569 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002570 * current one. Just wait. At this stage, errors should be handled by
2571 * the response analyzer.
2572 */
2573 if (s->res.analysers & AN_RES_WAIT_CLI)
2574 return 0;
2575
William Lallemandb7ea1412018-12-13 09:05:47 +01002576 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2577 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2578
William Lallemandcf62f7e2018-10-26 14:47:40 +02002579read_again:
2580 /* if the channel is closed for read, we won't receive any more data
2581 from the client, but we don't want to forward this close to the
2582 server */
2583 channel_dont_close(req);
2584
2585 /* We don't know yet to which server we will connect */
2586 channel_dont_connect(req);
2587
William Lallemandcf62f7e2018-10-26 14:47:40 +02002588 req->flags |= CF_READ_DONTWAIT;
2589
2590 /* need more data */
2591 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002592 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002593
2594 /* If there is data available for analysis, log the end of the idle time. */
2595 if (c_data(req) && s->logs.t_idle == -1)
2596 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2597
William Lallemandbddd33a2018-12-11 16:10:53 +01002598 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002599 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002600 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002601 /* enough data */
2602
William Lallemandcf62f7e2018-10-26 14:47:40 +02002603 /* forward only 1 command */
2604 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002605
William Lallemanddc12c2e2018-12-13 09:05:46 +01002606 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002607 /* we send only 1 command per request, and we write close after it */
2608 channel_shutw_now(req);
2609 } else {
2610 pcli_write_prompt(s);
2611 }
2612
2613 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002614 s->res.analysers |= AN_RES_WAIT_CLI;
2615
William Lallemandebf61802018-12-11 16:10:57 +01002616 if (!(s->flags & SF_ASSIGNED)) {
2617 if (next_pid > -1)
2618 target_pid = next_pid;
2619 else
2620 target_pid = s->pcli_next_pid;
2621 /* we can connect now */
2622 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002623
William Lallemanddcbe7b92021-12-10 14:14:53 +01002624 if (!s->target)
2625 goto server_disconnect;
2626
William Lallemandebf61802018-12-11 16:10:57 +01002627 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2628 channel_auto_connect(req);
2629 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002630
2631 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002632 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002633 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002634 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002635 } else if (to_forward == -1) {
2636 if (errmsg) {
2637 /* there was an error during the parsing */
2638 pcli_reply_and_close(s, errmsg);
2639 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2640 return 0;
2641 }
2642 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002643 }
2644
2645 return 0;
2646
2647send_help:
2648 b_reset(&req->buf);
2649 b_putblk(&req->buf, "help\n", 5);
2650 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002651
Christopher Faulet0f727da2022-01-18 08:44:23 +01002652missing_data:
2653 if (req->flags & CF_SHUTR) {
2654 /* There is no more request or a only a partial one and we
2655 * receive a close from the client, we can leave */
2656 channel_shutw_now(&s->res);
2657 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2658 return 1;
2659 }
2660 else if (channel_full(req, global.tune.maxrewrite)) {
2661 /* buffer is full and we didn't catch the end of a command */
2662 goto send_help;
2663 }
2664 return 0;
2665
William Lallemanddcbe7b92021-12-10 14:14:53 +01002666server_disconnect:
2667 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2668 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002669}
2670
2671int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2672{
2673 struct proxy *fe = strm_fe(s);
2674 struct proxy *be = s->be;
2675
Christopher Faulete8cefac2022-03-07 18:20:21 +01002676 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2677 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002678 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002679 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002680 s->res.analysers &= ~AN_RES_WAIT_CLI;
2681 return 0;
2682 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002683 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2684 rep->flags |= CF_NEVER_WAIT;
2685
2686 /* don't forward the close */
2687 channel_dont_close(&s->res);
2688 channel_dont_close(&s->req);
2689
William Lallemanddc12c2e2018-12-13 09:05:46 +01002690 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002691 s->res.analysers &= ~AN_RES_WAIT_CLI;
2692 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2693 return 0;
2694 }
2695
William Lallemandcf62f7e2018-10-26 14:47:40 +02002696 /* forward the data */
2697 if (ci_data(rep)) {
2698 c_adv(rep, ci_data(rep));
2699 return 0;
2700 }
2701
2702 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2703 /* stream cleanup */
2704
William Lallemand2f4ce202018-10-26 14:47:47 +02002705 pcli_write_prompt(s);
2706
Willy Tarreaucb041662022-05-17 19:44:42 +02002707 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002708 cs_shutr(s->scb);
2709 cs_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002710
2711 /*
2712 * starting from there this the same code as
2713 * http_end_txn_clean_session().
2714 *
2715 * It allows to do frontend keepalive while reconnecting to a
2716 * new server for each request.
2717 */
2718
2719 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002720 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002721 if (unlikely(s->srv_conn))
2722 sess_change_server(s, NULL);
2723 }
2724
2725 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2726 stream_process_counters(s);
2727
2728 /* don't count other requests' data */
2729 s->logs.bytes_in -= ci_data(&s->req);
2730 s->logs.bytes_out -= ci_data(&s->res);
2731
2732 /* we may need to know the position in the queue */
2733 pendconn_free(s);
2734
2735 /* let's do a final log if we need it */
2736 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2737 !(s->flags & SF_MONITOR) &&
2738 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2739 s->do_log(s);
2740 }
2741
2742 /* stop tracking content-based counters */
2743 stream_stop_content_counters(s);
2744 stream_update_time_stats(s);
2745
2746 s->logs.accept_date = date; /* user-visible date for logging */
2747 s->logs.tv_accept = now; /* corrected date for internal use */
2748 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2749 s->logs.t_idle = -1;
2750 tv_zero(&s->logs.tv_request);
2751 s->logs.t_queue = -1;
2752 s->logs.t_connect = -1;
2753 s->logs.t_data = -1;
2754 s->logs.t_close = 0;
2755 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2756 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2757
2758 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2759 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2760
2761 stream_del_srv_conn(s);
2762 if (objt_server(s->target)) {
2763 if (s->flags & SF_CURR_SESS) {
2764 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002765 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002766 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002767 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002768 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002769 }
2770
2771 s->target = NULL;
2772
2773 /* only release our endpoint if we don't intend to reuse the
2774 * connection.
2775 */
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002776 if (!cs_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002777 s->srv_conn = NULL;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002778 if (cs_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002779 if (!s->conn_err_type)
2780 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002781 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002782 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002783 return 1;
2784 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002785 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002786 }
2787
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002788 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002789
Willy Tarreau026e8fb2022-05-17 19:47:17 +02002790 cs_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002791 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 +02002792 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 +02002793 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 +02002794 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002795 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2796 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002797 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002798 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002799 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002800 /* reinitialise the current rule list pointer to NULL. We are sure that
2801 * any rulelist match the NULL pointer.
2802 */
2803 s->current_rule_list = NULL;
2804
2805 s->be = strm_fe(s);
2806 s->logs.logwait = strm_fe(s)->to_log;
2807 s->logs.level = 0;
2808 stream_del_srv_conn(s);
2809 s->target = NULL;
2810 /* re-init store persistence */
2811 s->store_count = 0;
2812 s->uniq_id = global.req_count++;
2813
2814 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2815
2816 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2817
William Lallemandcf62f7e2018-10-26 14:47:40 +02002818 s->res.analysers &= ~AN_RES_WAIT_CLI;
2819
2820 /* We must trim any excess data from the response buffer, because we
2821 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002822 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002823 * we want those data to come along with next response. A typical
2824 * example of such data would be from a buggy server responding to
2825 * a HEAD with some data, or sending more than the advertised
2826 * content-length.
2827 */
2828 if (unlikely(ci_data(&s->res)))
2829 b_set_data(&s->res.buf, co_data(&s->res));
2830
2831 /* Now we can realign the response buffer */
2832 c_realign_if_empty(&s->res);
2833
2834 s->req.rto = strm_fe(s)->timeout.client;
2835 s->req.wto = TICK_ETERNITY;
2836
2837 s->res.rto = TICK_ETERNITY;
2838 s->res.wto = strm_fe(s)->timeout.client;
2839
2840 s->req.rex = TICK_ETERNITY;
2841 s->req.wex = TICK_ETERNITY;
2842 s->req.analyse_exp = TICK_ETERNITY;
2843 s->res.rex = TICK_ETERNITY;
2844 s->res.wex = TICK_ETERNITY;
2845 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002846 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002847
2848 /* we're removing the analysers, we MUST re-enable events detection.
2849 * We don't enable close on the response channel since it's either
2850 * already closed, or in keep-alive with an idle connection handler.
2851 */
2852 channel_auto_read(&s->req);
2853 channel_auto_close(&s->req);
2854 channel_auto_read(&s->res);
2855
2856
2857 return 1;
2858 }
2859 return 0;
2860}
2861
William Lallemand8a022572018-10-26 14:47:35 +02002862/*
2863 * The mworker functions are used to initialize the CLI in the master process
2864 */
2865
William Lallemand309dc9a2018-10-26 14:47:45 +02002866 /*
2867 * Stop the mworker proxy
2868 */
2869void mworker_cli_proxy_stop()
2870{
William Lallemand550db6d2018-11-06 17:37:12 +01002871 if (mworker_proxy)
2872 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002873}
2874
William Lallemand8a022572018-10-26 14:47:35 +02002875/*
2876 * Create the mworker CLI proxy
2877 */
2878int mworker_cli_proxy_create()
2879{
2880 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002881 char *msg = NULL;
2882 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002883
William Lallemandae787ba2021-07-29 15:13:22 +02002884 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002885 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002886 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002887
William Lallemandcf62f7e2018-10-26 14:47:40 +02002888 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002889 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2890 mworker_proxy->timeout.client = 0; /* no timeout */
2891 mworker_proxy->conf.file = strdup("MASTER");
2892 mworker_proxy->conf.line = 0;
2893 mworker_proxy->accept = frontend_accept;
2894 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2895
2896 /* Does not init the default target the CLI applet, but must be done in
2897 * the request parsing code */
2898 mworker_proxy->default_target = NULL;
2899
William Lallemand8a022572018-10-26 14:47:35 +02002900 /* create all servers using the mworker_proc list */
2901 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002902 struct server *newsrv = NULL;
2903 struct sockaddr_storage *sk;
2904 int port1, port2, port;
2905 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002906
William Lallemanda31b09e2020-01-14 15:25:02 +01002907 /* only the workers support the master CLI */
2908 if (!(child->options & PROC_O_TYPE_WORKER))
2909 continue;
2910
William Lallemand8a022572018-10-26 14:47:35 +02002911 newsrv = new_server(mworker_proxy);
2912 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002913 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002914
2915 /* we don't know the new pid yet */
2916 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002917 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002918 else
2919 memprintf(&msg, "old-%d", child->pid);
2920
2921 newsrv->next = mworker_proxy->srv;
2922 mworker_proxy->srv = newsrv;
2923 newsrv->conf.file = strdup(msg);
2924 newsrv->id = strdup(msg);
2925 newsrv->conf.line = 0;
2926
2927 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002928 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002929 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002930 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002931 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002932 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002933
Willy Tarreau5fc93282020-09-16 18:25:03 +02002934 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002935 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002936 }
2937
2938 /* no port specified */
2939 newsrv->flags |= SRV_F_MAPPORTS;
2940 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002941 /* don't let the server participate to load balancing */
2942 newsrv->iweight = 0;
2943 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002944 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002945
2946 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002947 }
William Lallemandae787ba2021-07-29 15:13:22 +02002948
2949 mworker_proxy->next = proxies_list;
2950 proxies_list = mworker_proxy;
2951
William Lallemand8a022572018-10-26 14:47:35 +02002952 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002953
2954error:
William Lallemand744a0892018-11-22 16:46:51 +01002955
2956 list_for_each_entry(child, &proc_list, list) {
2957 free((char *)child->srv->conf.file); /* cast because of const char * */
2958 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002959 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002960 }
William Lallemandae787ba2021-07-29 15:13:22 +02002961 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002962 free(msg);
2963
William Lallemandae787ba2021-07-29 15:13:22 +02002964error_proxy:
2965 ha_alert("%s\n", errmsg);
2966 free(errmsg);
2967
William Lallemand744a0892018-11-22 16:46:51 +01002968 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002969}
Olivier Houchardf886e342017-04-05 22:24:59 +02002970
William Lallemandce83b4a2018-10-26 14:47:30 +02002971/*
William Lallemande7361152018-10-26 14:47:36 +02002972 * Create a new listener for the master CLI proxy
2973 */
2974int mworker_cli_proxy_new_listener(char *line)
2975{
2976 struct bind_conf *bind_conf;
2977 struct listener *l;
2978 char *err = NULL;
2979 char *args[MAX_LINE_ARGS + 1];
2980 int arg;
2981 int cur_arg;
2982
William Lallemand2e945c82019-11-25 09:58:37 +01002983 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002984 args[0] = line;
2985
2986 /* args is a bind configuration with spaces replaced by commas */
2987 while (*line && arg < MAX_LINE_ARGS) {
2988
2989 if (*line == ',') {
2990 *line++ = '\0';
2991 while (*line == ',')
2992 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002993 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002994 }
2995 line++;
2996 }
2997
William Lallemand2e945c82019-11-25 09:58:37 +01002998 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002999
3000 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003001 if (!bind_conf)
3002 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003003
3004 bind_conf->level &= ~ACCESS_LVL_MASK;
3005 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003006 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003007
3008 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3009 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003010 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003011 }
3012
3013 cur_arg = 1;
3014
3015 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003016 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003017 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003018
3019 kw = bind_find_kw(args[cur_arg]);
3020 if (kw) {
3021 if (!kw->parse) {
3022 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3023 args[0], args[1], args[cur_arg]);
3024 goto err;
3025 }
3026
Willy Tarreau4975d142021-03-13 11:00:33 +01003027 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003028 if (err)
3029 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3030 else
3031 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3032 args[0], args[1], args[cur_arg]);
3033 goto err;
3034 }
3035
3036 cur_arg += 1 + kw->skip;
3037 continue;
3038 }
3039
Willy Tarreau433b05f2021-03-12 10:14:07 +01003040 best = bind_find_best_kw(args[cur_arg]);
3041 if (best)
3042 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3043 args[0], args[1], args[cur_arg], best);
3044 else
3045 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3046 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003047 goto err;
3048 }
3049
3050
3051 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003052 l->accept = session_accept_fd;
3053 l->default_target = mworker_proxy->default_target;
3054 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003055 l->options |= LI_O_UNLIMITED;
3056 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003057 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003058 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003059 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003060 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003061
3062 return 0;
3063
3064err:
3065 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003066 free(err);
3067 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003068 return -1;
3069
3070}
3071
3072/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003073 * Create a new CLI socket using a socketpair for a worker process
3074 * <mworker_proc> is the process structure, and <proc> is the process number
3075 */
3076int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3077{
3078 struct bind_conf *bind_conf;
3079 struct listener *l;
3080 char *path = NULL;
3081 char *err = NULL;
3082
3083 /* master pipe to ensure the master is still alive */
3084 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3085 ha_alert("Cannot create worker socketpair.\n");
3086 return -1;
3087 }
3088
3089 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003090 if (!global.cli_fe) {
3091 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003092 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003093 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003094 }
3095 }
3096
Willy Tarreau4975d142021-03-13 11:00:33 +01003097 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003098 if (!bind_conf)
3099 goto error;
3100
William Lallemandce83b4a2018-10-26 14:47:30 +02003101 bind_conf->level &= ~ACCESS_LVL_MASK;
3102 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003103 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003104
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3106 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003107 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003108 }
3109
Willy Tarreau4975d142021-03-13 11:00:33 +01003110 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003111 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003112 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003113 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003114 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003115 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003116
3117 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003118 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003119 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003120 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003121 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003122 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003123 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003124 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003125 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003126 }
3127
3128 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003129
3130error:
3131 close(mworker_proc->ipc_fd[0]);
3132 close(mworker_proc->ipc_fd[1]);
3133 free(err);
3134
3135 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003136}
3137
William Lallemand74c24fb2016-11-21 17:18:36 +01003138static struct applet cli_applet = {
3139 .obj_type = OBJ_TYPE_APPLET,
3140 .name = "<CLI>", /* used for logging */
3141 .fct = cli_io_handler,
3142 .release = cli_release_handler,
3143};
3144
William Lallemand99e0bb92020-11-05 10:28:53 +01003145/* master CLI */
3146static struct applet mcli_applet = {
3147 .obj_type = OBJ_TYPE_APPLET,
3148 .name = "<MCLI>", /* used for logging */
3149 .fct = cli_io_handler,
3150 .release = cli_release_handler,
3151};
3152
Willy Tarreau0a739292016-11-22 20:21:23 +01003153/* register cli keywords */
3154static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003155 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3156 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3157 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3158 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003159 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3160 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003161 { { "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 +02003162 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3163 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3164 { { "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 },
3165 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3166 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3167 { { "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 },
3168 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3169 { { "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 },
3170 { { "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 +01003171 { { "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 +02003172 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3173 { { "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 +01003174 {{},}
3175}};
3176
Willy Tarreau0108d902018-11-25 19:14:37 +01003177INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3178
William Lallemand74c24fb2016-11-21 17:18:36 +01003179static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003180 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003181 { 0, NULL, NULL },
3182}};
3183
Willy Tarreau0108d902018-11-25 19:14:37 +01003184INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3185
William Lallemand74c24fb2016-11-21 17:18:36 +01003186static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003187 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3188 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003189 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003190 { NULL, NULL, 0 },
3191}};
3192
Willy Tarreau0108d902018-11-25 19:14:37 +01003193INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003194
3195/*
3196 * Local variables:
3197 * c-indent-level: 8
3198 * c-basic-offset: 8
3199 * End:
3200 */