blob: bd77418fe596e9493cf0075b29e403302dde15fc [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreaub2551052020-06-09 09:07:15 +020029#include <haproxy/activity.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020030#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020031#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020032#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020033#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020034#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020035#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020036#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020037#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020038#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020039#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/fd.h>
41#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020042#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020043#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020044#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020045#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020046#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010047#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020048#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020049#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020050#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020051#include <haproxy/pipe.h>
52#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020053#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020054#include <haproxy/sample-t.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020055#include <haproxy/sc_strm.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020056#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020057#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020058#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020059#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020060#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020061#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020062#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020063#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020064#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020065#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020066#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010067
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020068#define PAYLOAD_PATTERN "<<"
69
William Lallemand74c24fb2016-11-21 17:18:36 +010070static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010071static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010072
Willy Tarreau4975d142021-03-13 11:00:33 +010073static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010074 "Permission denied\n"
75 "";
76
77
Christopher Faulet1bc04c72017-10-29 20:14:08 +010078static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010079
80/* List head of cli keywords */
81static struct cli_kw_list cli_keywords = {
82 .list = LIST_HEAD_INIT(cli_keywords.list)
83};
84
85extern const char *stat_status_codes[];
86
Eric Salama1b8dacc2021-03-16 15:12:17 +010087struct proxy *mworker_proxy; /* CLI proxy of the master */
William 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 Tarreauc12b3212022-05-27 11:08:15 +0200900 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200901 struct channel *req = sc_oc(sc);
902 struct channel *res = sc_ic(sc);
903 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100904 int reql;
905 int len;
906
Willy Tarreau475e4632022-05-27 10:26:46 +0200907 if (unlikely(sc->state == SC_ST_DIS || sc->state == SC_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100908 goto out;
909
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800910 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200911 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100912 /* buf.size==0 means we failed to get a buffer and were
913 * already subscribed to a wait list to get a buffer.
914 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100915 goto out;
916 }
917
William Lallemand74c24fb2016-11-21 17:18:36 +0100918 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100919 if (appctx->st0 == CLI_ST_INIT) {
Willy Tarreau7bf20ca2022-05-03 17:02:03 +0200920 /* CLI/stats not initialized yet */
921 memset(&appctx->ctx, 0, sizeof(appctx->ctx));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200922 /* reset severity to default at init */
923 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100924 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100925 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100926 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100927 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100928 /* Let's close for real now. We just close the request
929 * side, the conditions below will complete if needed.
930 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200931 sc_shutw(sc);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200932 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200933 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100934 break;
935 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100936 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200937 char *str;
938
939 /* use a trash chunk to store received data */
940 if (!appctx->chunk) {
941 appctx->chunk = alloc_trash_chunk();
942 if (!appctx->chunk) {
943 appctx->st0 = CLI_ST_END;
944 continue;
945 }
946 }
947
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200948 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200949
William Lallemand74c24fb2016-11-21 17:18:36 +0100950 /* ensure we have some output room left in the event we
951 * would want to return some info right after parsing.
952 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200953 if (buffer_almost_full(sc_ib(sc))) {
954 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +0100955 break;
956 }
957
Willy Tarreau0011c252022-01-19 17:23:52 +0100958 /* payload doesn't take escapes nor does it end on semi-colons, so
959 * we use the regular getline. Normal mode however must stop on
960 * LFs and semi-colons that are not prefixed by a backslash. Note
961 * that we reserve one byte at the end to insert a trailing nul byte.
962 */
963
964 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200965 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100966 appctx->chunk->size - appctx->chunk->data - 1);
967 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200968 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100969 appctx->chunk->size - appctx->chunk->data - 1,
970 "\n;", '\\');
971
William Lallemand74c24fb2016-11-21 17:18:36 +0100972 if (reql <= 0) { /* closed or EOL not found */
973 if (reql == 0)
974 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100975 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100976 continue;
977 }
978
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200979 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
980 /* seek for a possible unescaped semi-colon. If we find
981 * one, we replace it with an LF and skip only this part.
982 */
983 for (len = 0; len < reql; len++) {
984 if (str[len] == '\\') {
985 len++;
986 continue;
987 }
988 if (str[len] == ';') {
989 str[len] = '\n';
990 reql = len + 1;
991 break;
992 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100993 }
994 }
995
996 /* now it is time to check that we have a full line,
997 * remove the trailing \n and possibly \r, then cut the
998 * line.
999 */
1000 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001001 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001002 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001003 continue;
1004 }
1005
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001006 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +01001007 len--;
1008
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001009 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001010 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001011
1012 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001013 appctx->chunk->area[appctx->chunk->data] = '\n';
1014 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1015 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001016 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001017
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001018 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001019
1020 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1021 /* empty line */
1022 if (!len) {
1023 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001024 appctx->chunk->data -= 2;
1025 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001026 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001027 chunk_reset(appctx->chunk);
1028 /* NB: cli_sock_parse_request() may have put
1029 * another CLI_ST_O_* into appctx->st0.
1030 */
1031
1032 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001033 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001034 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001035 else {
1036 /*
1037 * Look for the "payload start" pattern at the end of a line
1038 * Its location is not remembered here, this is just to switch
1039 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001040 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001041 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001042 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001043 appctx->chunk->data++; // keep the trailing \0 after '<<'
1044 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001045 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001046 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001047 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001048 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001049 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001050 }
1051
1052 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001053 co_skip(sc_oc(sc), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001054 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1055 }
1056 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001057 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001058 const char *msg;
1059 int sev;
1060
William Lallemand74c24fb2016-11-21 17:18:36 +01001061 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001062 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001063 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001064 case CLI_ST_PRINT: /* print const message in msg */
1065 case CLI_ST_PRINT_ERR: /* print const error in msg */
1066 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1067 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001068 /* the message is in the svcctx */
1069 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001070 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1071 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001072 LOG_ERR : ctx->severity;
1073 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001074 }
1075 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1076 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001077 LOG_ERR : ctx->severity;
1078 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001079 if (!msg) {
1080 sev = LOG_ERR;
1081 msg = "Out of memory.\n";
1082 }
1083 }
1084 else {
1085 sev = LOG_ERR;
1086 msg = "Internal error.\n";
1087 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001088
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1090 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1091 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001092 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001093 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001094 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001095 }
1096 else
Willy Tarreau475e4632022-05-27 10:26:46 +02001097 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001099
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001100 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001101 if (appctx->io_handler)
1102 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001103 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001104 if (appctx->io_release) {
1105 appctx->io_release(appctx);
1106 appctx->io_release = NULL;
1107 }
1108 }
1109 break;
1110 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001111 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 break;
1113 }
1114
1115 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001116 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001117 const char *prompt = "";
1118
1119 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1120 /*
1121 * when entering a payload with interactive mode, change the prompt
1122 * to emphasize that more data can still be sent
1123 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001124 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001125 prompt = "+ ";
1126 else
1127 prompt = "\n> ";
1128 }
1129 else {
William Lallemandad032882019-07-01 10:56:15 +02001130 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001131 prompt = "\n";
1132 }
1133
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001134 if (applet_putstr(appctx, prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001135 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001136 }
1137
1138 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001139 if (appctx->st0 >= CLI_ST_OUTPUT) {
1140 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001141 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001142 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001143
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;
Christopher Faulet4167e052022-06-01 17:25:42 +02001157 applet_will_consume(appctx);
1158
William Lallemandad032882019-07-01 10:56:15 +02001159 /* reactivate the \n at the end of the response for the next command */
1160 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001161
1162 /* this forces us to yield between pipelined commands and
1163 * avoid extremely long latencies (e.g. "del map" etc). In
1164 * addition this increases the likelihood that the stream
1165 * refills the buffer with new bytes in non-interactive
1166 * mode, avoiding to close on apparently empty commands.
1167 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001168 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001169 appctx_wakeup(appctx);
1170 goto out;
1171 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001172 }
1173 }
1174
Willy Tarreau475e4632022-05-27 10:26:46 +02001175 if ((res->flags & CF_SHUTR) && (sc->state == SC_ST_EST)) {
1176 DPRINTF(stderr, "%s@%d: sc to buf closed. req=%08x, res=%08x, st=%d\n",
1177 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001178 /* Other side has closed, let's abort if we have no more processing to do
1179 * and nothing more to consume. This is comparable to a broken pipe, so
1180 * we forward the close to the request side so that it flows upstream to
1181 * the client.
1182 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001183 sc_shutw(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001184 }
1185
Willy Tarreau475e4632022-05-27 10:26:46 +02001186 if ((req->flags & CF_SHUTW) && (sc->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
1187 DPRINTF(stderr, "%s@%d: buf to sc closed. req=%08x, res=%08x, st=%d\n",
1188 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001189 /* We have no more processing to do, and nothing more to send, and
1190 * the client side has closed. So we'll forward this state downstream
1191 * on the response buffer.
1192 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001193 sc_shutr(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001194 res->flags |= CF_READ_NULL;
1195 }
1196
1197 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001198 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 +01001199 __FUNCTION__, __LINE__,
Willy Tarreau475e4632022-05-27 10:26:46 +02001200 sc->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001201}
1202
Willy Tarreau4596fe22022-05-17 19:07:51 +02001203/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001204 * external abort, we won't call the i/o handler anymore so we may need to
1205 * remove back references to the stream currently being dumped.
1206 */
1207static void cli_release_handler(struct appctx *appctx)
1208{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001209 free_trash_chunk(appctx->chunk);
1210 appctx->chunk = NULL;
1211
William Lallemand74c24fb2016-11-21 17:18:36 +01001212 if (appctx->io_release) {
1213 appctx->io_release(appctx);
1214 appctx->io_release = NULL;
1215 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001216 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001217 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1218
1219 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001220 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001221}
1222
1223/* This function dumps all environmnent variables to the buffer. It returns 0
1224 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001225 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1226 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001227 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001228static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001229{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001230 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001231 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001232 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001233
Willy Tarreau475e4632022-05-27 10:26:46 +02001234 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001235 return 1;
1236
1237 chunk_reset(&trash);
1238
1239 /* we have two inner loops here, one for the proxy, the other one for
1240 * the buffer.
1241 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001242 while (*var) {
1243 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001244
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001245 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001246 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001247
Willy Tarreau307dbb32022-05-05 17:45:52 +02001248 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001249 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001250 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001251 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001252 }
1253
1254 /* dump complete */
1255 return 1;
1256}
1257
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001258/* This function dumps all file descriptors states (or the requested one) to
1259 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001260 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1261 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1262 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001263 */
1264static int cli_io_handler_show_fd(struct appctx *appctx)
1265{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001266 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001267 struct show_fd_ctx *fdctx = appctx->svcctx;
1268 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001269 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001270
Willy Tarreau475e4632022-05-27 10:26:46 +02001271 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001272 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001273
1274 chunk_reset(&trash);
1275
Willy Tarreauca1b1572018-12-18 15:45:11 +01001276 /* isolate the threads once per round. We're limited to a buffer worth
1277 * of output anyway, it cannot last very long.
1278 */
1279 thread_isolate();
1280
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001281 /* we have two inner loops here, one for the proxy, the other one for
1282 * the buffer.
1283 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001284 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001285 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001286 const struct listener *li = NULL;
1287 const struct server *sv = NULL;
1288 const struct proxy *px = NULL;
1289 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001290 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001291 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001292 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001293 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001294 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001295 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001296 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001297
1298 fdt = fdtab[fd];
1299
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001300 /* When DEBUG_FD is set, we also report closed FDs that have a
1301 * non-null event count to detect stuck ones.
1302 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001303 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001304#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001305 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001306#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001307 goto skip; // closed
1308 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001309 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001310 conn = (const struct connection *)fdt.owner;
1311 conn_flags = conn->flags;
1312 mux = conn->mux;
1313 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001314 xprt = conn->xprt;
1315 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001316 li = objt_listener(conn->target);
1317 sv = objt_server(conn->target);
1318 px = objt_proxy(conn->target);
1319 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001320 if (atleast2(fdt.thread_mask))
1321 suspicious = 1;
1322 if (conn->handle.fd != fd)
1323 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001324 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001325 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001326 li = fdt.owner;
1327
Willy Tarreaudacfde42021-01-21 09:07:29 +01001328 if (!fdt.thread_mask)
1329 suspicious = 1;
1330
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001331 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001332 " %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 +02001333 fd,
1334 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001335 (fdt.state & FD_CLONED) ? 'C' : 'c',
1336 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001337 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1338 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1339 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1340 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1341 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001342 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1343 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1344 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1345 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1346 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1347 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001348 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001349 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001350 fdt.iocb);
1351 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001352
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001353 if (!fdt.owner) {
1354 chunk_appendf(&trash, ")");
1355 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001356 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001357 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001358
1359 if (conn->handle.fd != fd) {
1360 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1361 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001362 } else {
1363 struct sockaddr_storage sa;
1364 socklen_t salen;
1365
1366 salen = sizeof(sa);
1367 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1368 if (sa.ss_family == AF_INET)
1369 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1370 else if (sa.ss_family == AF_INET6)
1371 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1372 else if (sa.ss_family == AF_UNIX)
1373 chunk_appendf(&trash, " fam=unix");
1374 }
1375
1376 salen = sizeof(sa);
1377 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1378 if (sa.ss_family == AF_INET)
1379 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1380 else if (sa.ss_family == AF_INET6)
1381 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1382 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001383 }
1384
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001385 if (px)
1386 chunk_appendf(&trash, " px=%s", px->id);
1387 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001388 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001389 else if (li)
1390 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001391
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001392 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001393 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001394 if (!ctx)
1395 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001396 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001397 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001398 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001399 else
1400 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001401
1402 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001403 if (xprt) {
1404 if (xprt_ctx || xprt->show_fd)
1405 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1406 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001407 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001408 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001409 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001410 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001411 struct sockaddr_storage sa;
1412 socklen_t salen;
1413
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001414 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001415 listener_state_str(li),
1416 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001417
1418 salen = sizeof(sa);
1419 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1420 if (sa.ss_family == AF_INET)
1421 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1422 else if (sa.ss_family == AF_INET6)
1423 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1424 else if (sa.ss_family == AF_UNIX)
1425 chunk_appendf(&trash, " fam=unix");
1426 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001427 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001428 else
1429 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001430
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001431#ifdef DEBUG_FD
1432 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001433 if (fdtab[fd].event_count >= 1000000)
1434 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001435#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001436 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001437
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001438 if (applet_putchk(appctx, &trash) == -1) {
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 Tarreauc12b3212022-05-27 11:08:15 +02001465 struct stconn *sc = appctx_sc(appctx);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001466 int thr;
1467
Willy Tarreau475e4632022-05-27 10:26:46 +02001468 if (unlikely(sc_ic(sc)->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
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001549 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001550 chunk_reset(&trash);
1551 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001552 }
1553
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001554#undef SHOW_AVG
1555#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001556 /* dump complete */
1557 return 1;
1558}
1559
William Lallemandeceddf72016-12-15 18:06:44 +01001560/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001561 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001562 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1563 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001564 */
1565static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1566{
Willy Tarreaub128f492022-05-05 19:11:05 +02001567 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1568 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001569
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001570 if (!global.cli_fe)
1571 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001572
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001573 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001574
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001575 if (!bind_conf) {
1576 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001577 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001578 goto full;
1579 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1580 }
William Lallemandeceddf72016-12-15 18:06:44 +01001581
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001582 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001583 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001584
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001585 if (!l)
1586 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001587
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001588 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1589 char addr[46];
1590 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001591
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001592 if (l->rx.addr.ss_family == AF_UNIX) {
1593 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001594
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001595 un = (struct sockaddr_un *)&l->rx.addr;
1596 if (un->sun_path[0] == '\0') {
1597 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1598 } else {
1599 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1600 }
1601 } else if (l->rx.addr.ss_family == AF_INET) {
1602 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1603 port_to_str(&l->rx.addr, port, sizeof(port));
1604 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1605 } else if (l->rx.addr.ss_family == AF_INET6) {
1606 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1607 port_to_str(&l->rx.addr, port, sizeof(port));
1608 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1609 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1610 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1611 } else
1612 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001613
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001614 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1615 chunk_appendf(&trash, "admin ");
1616 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1617 chunk_appendf(&trash, "operator ");
1618 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1619 chunk_appendf(&trash, "user ");
1620 else
1621 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001622
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001623 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001624
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001625 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001626 ctx->bind_conf = bind_conf;
1627 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001628 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001629 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001630 }
William Lallemandeceddf72016-12-15 18:06:44 +01001631 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001632 done:
1633 return 1;
1634 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001635 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001636}
1637
1638
Willy Tarreau0a739292016-11-22 20:21:23 +01001639/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001640 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1641 * be dumped as well as a flag if a single variable is requested, otherwise puts
1642 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001643 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001644static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001645{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001646 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001647 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001648 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001649
1650 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1651 return 1;
1652
Willy Tarreauf6710f82016-12-16 17:45:44 +01001653 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001654
1655 if (*args[2]) {
1656 int len = strlen(args[2]);
1657
Willy Tarreauf6710f82016-12-16 17:45:44 +01001658 for (; *var; var++) {
1659 if (strncmp(*var, args[2], len) == 0 &&
1660 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001661 break;
1662 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001663 if (!*var)
1664 return cli_err(appctx, "Variable not found\n");
1665
Willy Tarreau307dbb32022-05-05 17:45:52 +02001666 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001667 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001668 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001669 return 0;
1670}
1671
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001672/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001673 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1674 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001675 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001676static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001677{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001678 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1679
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001680 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1681 return 1;
1682
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001683 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001684 ctx->fd = atoi(args[2]);
1685 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001686 }
1687 return 0;
1688}
1689
Willy Tarreau599852e2016-11-22 20:33:32 +01001690/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001691static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001692{
Willy Tarreau0698c802022-05-11 14:09:57 +02001693 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001694
1695 if (strcmp(args[2], "cli") == 0) {
1696 unsigned timeout;
1697 const char *res;
1698
Willy Tarreau9d008692019-08-09 11:21:01 +02001699 if (!*args[3])
1700 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001701
1702 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001703 if (res || timeout < 1)
1704 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001705
1706 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1707 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1708 return 1;
1709 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001710
1711 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001712}
1713
Willy Tarreau2af99412016-11-23 11:10:59 +01001714/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001715static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001716{
1717 int v;
1718
1719 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1720 return 1;
1721
Willy Tarreau9d008692019-08-09 11:21:01 +02001722 if (!*args[3])
1723 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001724
1725 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001726 if (v > global.hardmaxconn)
1727 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001728
1729 /* check for unlimited values */
1730 if (v <= 0)
1731 v = global.hardmaxconn;
1732
1733 global.maxconn = v;
1734
1735 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001736 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001737
1738 return 1;
1739}
1740
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001741static int set_severity_output(int *target, char *argument)
1742{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001743 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001744 *target = CLI_SEVERITY_NONE;
1745 return 1;
1746 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001747 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001748 *target = CLI_SEVERITY_NUMBER;
1749 return 1;
1750 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001751 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001752 *target = CLI_SEVERITY_STRING;
1753 return 1;
1754 }
1755 return 0;
1756}
1757
1758/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001759static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001760{
1761 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1762 return 0;
1763
Willy Tarreau9d008692019-08-09 11:21:01 +02001764 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001765}
William Lallemandeceddf72016-12-15 18:06:44 +01001766
William Lallemand67a234f2018-12-13 09:05:45 +01001767
1768/* show the level of the current CLI session */
1769static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1770{
William Lallemand67a234f2018-12-13 09:05:45 +01001771 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001772 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001773 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001774 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001775 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001776 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001777 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001778 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001779}
1780
1781/* parse and set the CLI level dynamically */
1782static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1783{
William Lallemandad032882019-07-01 10:56:15 +02001784 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001785 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001786 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1787
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001788 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001789 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1790 return 1;
1791 }
1792 appctx->cli_level &= ~ACCESS_LVL_MASK;
1793 appctx->cli_level |= ACCESS_LVL_OPER;
1794
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001795 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001796 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1797 return 1;
1798 }
1799 appctx->cli_level &= ~ACCESS_LVL_MASK;
1800 appctx->cli_level |= ACCESS_LVL_USER;
1801 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001802 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001803 return 1;
1804}
1805
1806
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001807/* parse and set the CLI expert/experimental-mode dynamically */
1808static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001809{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001810 int level;
1811 char *level_str;
1812 char *output = NULL;
1813
William Lallemand7267f782022-02-01 16:08:50 +01001814 /* this will ask the applet to not output a \n after the command */
1815 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1816 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1817
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001818 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1819 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001820
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001821 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001822 level = ACCESS_EXPERT;
1823 level_str = "expert-mode";
1824 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001825 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001826 level = ACCESS_EXPERIMENTAL;
1827 level_str = "experimental-mode";
1828 }
William Lallemand2a171912022-02-02 11:43:20 +01001829 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1830 level = ACCESS_MCLI_DEBUG;
1831 level_str = "mcli-debug-mode";
1832 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001833 else {
1834 return 1;
1835 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001836
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001837 if (!*args[1]) {
1838 memprintf(&output, "%s is %s\n", level_str,
1839 (appctx->cli_level & level) ? "ON" : "OFF");
1840 return cli_dynmsg(appctx, LOG_INFO, output);
1841 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001842
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001843 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001844 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001845 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001846 return 1;
1847}
1848
William Lallemand740629e2021-12-14 15:22:29 +01001849/* shows HAProxy version */
1850static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1851{
1852 char *msg = NULL;
1853
1854 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1855}
1856
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001857int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001858{
1859 return 0;
1860}
1861
Willy Tarreau45c742b2016-11-24 14:51:17 +01001862/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001863static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001864{
1865 int v;
1866 int *res;
1867 int mul = 1;
1868
1869 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1870 return 1;
1871
1872 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1873 res = &global.cps_lim;
1874 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1875 res = &global.sps_lim;
1876#ifdef USE_OPENSSL
1877 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1878 res = &global.ssl_lim;
1879#endif
1880 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1881 res = &global.comp_rate_lim;
1882 mul = 1024;
1883 }
1884 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001885 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001886 "'set rate-limit' only supports :\n"
1887 " - 'connections global' to set the per-process maximum connection rate\n"
1888 " - 'sessions global' to set the per-process maximum session rate\n"
1889#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001890 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001891#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001892 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001893 }
1894
Willy Tarreau9d008692019-08-09 11:21:01 +02001895 if (!*args[4])
1896 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001897
1898 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001899 if (v < 0)
1900 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001901
1902 *res = v * mul;
1903
1904 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001905 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001906
1907 return 1;
1908}
1909
William Lallemandf6975e92017-05-26 17:42:10 +02001910/* parse the "expose-fd" argument on the bind lines */
1911static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1912{
1913 if (!*args[cur_arg + 1]) {
1914 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1915 return ERR_ALERT | ERR_FATAL;
1916 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001917 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001918 conf->level |= ACCESS_FD_LISTENERS;
1919 } else {
1920 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1921 args[cur_arg], args[cur_arg+1]);
1922 return ERR_ALERT | ERR_FATAL;
1923 }
1924
1925 return 0;
1926}
1927
William Lallemand74c24fb2016-11-21 17:18:36 +01001928/* parse the "level" argument on the bind lines */
1929static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1930{
1931 if (!*args[cur_arg + 1]) {
1932 memprintf(err, "'%s' : missing level", args[cur_arg]);
1933 return ERR_ALERT | ERR_FATAL;
1934 }
1935
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001936 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001937 conf->level &= ~ACCESS_LVL_MASK;
1938 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001939 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001940 conf->level &= ~ACCESS_LVL_MASK;
1941 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001942 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001943 conf->level &= ~ACCESS_LVL_MASK;
1944 conf->level |= ACCESS_LVL_ADMIN;
1945 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001946 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1947 args[cur_arg], args[cur_arg+1]);
1948 return ERR_ALERT | ERR_FATAL;
1949 }
1950
1951 return 0;
1952}
1953
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001954static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1955{
1956 if (!*args[cur_arg + 1]) {
1957 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1958 return ERR_ALERT | ERR_FATAL;
1959 }
1960
1961 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1962 return 0;
1963 else {
1964 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1965 args[cur_arg], args[cur_arg+1]);
1966 return ERR_ALERT | ERR_FATAL;
1967 }
1968}
1969
Olivier Houchardf886e342017-04-05 22:24:59 +02001970/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001971static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001972{
1973 char *cmsgbuf = NULL;
1974 unsigned char *tmpbuf = NULL;
1975 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001976 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02001977 struct stream *s = __sc_strm(sc);
1978 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02001979 struct msghdr msghdr;
1980 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001981 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001982 const char *ns_name, *if_name;
1983 unsigned char ns_nlen, if_nlen;
1984 int nb_queued;
1985 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001986 int *tmpfd;
1987 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001988 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001989 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001990 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001991 int ret;
1992
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001993 if (!remote) {
1994 ha_warning("Only works on real connections\n");
1995 goto out;
1996 }
1997
1998 fd = remote->handle.fd;
1999
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 /* Temporary set the FD in blocking mode, that will make our life easier */
2001 old_fcntl = fcntl(fd, F_GETFL);
2002 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002003 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002004 goto out;
2005 }
2006 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2007 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002008 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002009 goto out;
2010 }
2011 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002012 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002013 goto out;
2014 }
Olivier Houchard54740872017-04-06 14:45:14 +02002015 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002016 iov.iov_base = &tot_fd_nb;
2017 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002018 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002019 goto out;
2020 memset(&msghdr, 0, sizeof(msghdr));
2021 /*
2022 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002023 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002024 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002025 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002026 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002027
Olivier Houchardf886e342017-04-05 22:24:59 +02002028 if (tot_fd_nb == 0)
2029 goto out;
2030
2031 /* First send the total number of file descriptors, so that the
2032 * receiving end knows what to expect.
2033 */
2034 msghdr.msg_iov = &iov;
2035 msghdr.msg_iovlen = 1;
2036 ret = sendmsg(fd, &msghdr, 0);
2037 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002038 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002039 goto out;
2040 }
2041
2042 /* Now send the fds */
2043 msghdr.msg_control = cmsgbuf;
2044 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2045 cmsg = CMSG_FIRSTHDR(&msghdr);
2046 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2047 cmsg->cmsg_level = SOL_SOCKET;
2048 cmsg->cmsg_type = SCM_RIGHTS;
2049 tmpfd = (int *)CMSG_DATA(cmsg);
2050
Olivier Houchardf886e342017-04-05 22:24:59 +02002051 /* For each socket, e message is sent, containing the following :
2052 * Size of the namespace name (or 0 if none), as an unsigned char.
2053 * The namespace name, if any
2054 * Size of the interface name (or 0 if none), as an unsigned char
2055 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002056 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002057 */
2058 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002059 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002060 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002061 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002062 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002063 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002064 goto out;
2065 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002066
2067 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002068 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002069 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002070 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002071 continue;
2072
2073 ns_name = if_name = "";
2074 ns_nlen = if_nlen = 0;
2075
2076 /* for now we can only retrieve namespaces and interfaces from
2077 * pure listeners.
2078 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002079 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002080 const struct listener *l = fdtab[cur_fd].owner;
2081
Willy Tarreau818a92e2020-09-03 07:50:19 +02002082 if (l->rx.settings->interface) {
2083 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002084 if_nlen = strlen(if_name);
2085 }
2086
2087#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002088 if (l->rx.settings->netns) {
2089 ns_name = l->rx.settings->netns->node.key;
2090 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002091 }
2092#endif
2093 }
2094
2095 /* put the FD into the CMSG_DATA */
2096 tmpfd[nb_queued++] = cur_fd;
2097
2098 /* first block is <ns_name_len> <ns_name> */
2099 tmpbuf[curoff++] = ns_nlen;
2100 if (ns_nlen)
2101 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2102 curoff += ns_nlen;
2103
2104 /* second block is <if_name_len> <if_name> */
2105 tmpbuf[curoff++] = if_nlen;
2106 if (if_nlen)
2107 memcpy(tmpbuf + curoff, if_name, if_nlen);
2108 curoff += if_nlen;
2109
2110 /* we used to send the listener options here before 2.3 */
2111 memset(tmpbuf + curoff, 0, sizeof(int));
2112 curoff += sizeof(int);
2113
2114 /* there's a limit to how many FDs may be sent at once */
2115 if (nb_queued == MAX_SEND_FD) {
2116 iov.iov_len = curoff;
2117 if (sendmsg(fd, &msghdr, 0) != curoff) {
2118 ha_warning("Failed to transfer sockets\n");
2119 return -1;
2120 }
2121
2122 /* Wait for an ack */
2123 do {
2124 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2125 } while (ret == -1 && errno == EINTR);
2126
2127 if (ret <= 0) {
2128 ha_warning("Unexpected error while transferring sockets\n");
2129 return -1;
2130 }
2131 curoff = 0;
2132 nb_queued = 0;
2133 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002134 }
2135
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002136 /* flush pending stuff */
2137 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002138 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002139 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2140 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002141 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002142 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002143 goto out;
2144 }
2145 }
2146
2147out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002148 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002149 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002150 goto out;
2151 }
2152 appctx->st0 = CLI_ST_END;
2153 free(cmsgbuf);
2154 free(tmpbuf);
2155 return 1;
2156}
2157
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002158static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2159{
2160 if (*args[0] == 'h')
2161 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002162 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002163 else if (*args[0] == 'p')
2164 /* prompt */
2165 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2166 else if (*args[0] == 'q')
2167 /* quit */
2168 appctx->st0 = CLI_ST_END;
2169
2170 return 1;
2171}
Olivier Houchardf886e342017-04-05 22:24:59 +02002172
William Lallemand2f4ce202018-10-26 14:47:47 +02002173void pcli_write_prompt(struct stream *s)
2174{
2175 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002176 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002177
William Lallemanddc12c2e2018-12-13 09:05:46 +01002178 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002179 return;
2180
William Lallemanddc12c2e2018-12-13 09:05:46 +01002181 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002182 chunk_appendf(msg, "+ ");
2183 } else {
2184 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002185 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002186 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002187 else
William Lallemanddae12c72022-02-02 14:13:54 +01002188 chunk_appendf(msg, "%d", s->pcli_next_pid);
2189
2190 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2191 chunk_appendf(msg, "(");
2192
2193 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2194 chunk_appendf(msg, "x");
2195
2196 if (s->pcli_flags & ACCESS_EXPERT)
2197 chunk_appendf(msg, "e");
2198
2199 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2200 chunk_appendf(msg, "d");
2201
2202 chunk_appendf(msg, ")");
2203 }
2204
2205 chunk_appendf(msg, "> ");
2206
2207
William Lallemandebf61802018-12-11 16:10:57 +01002208 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002209 co_inject(oc, msg->area, msg->data);
2210}
2211
William Lallemand291810d2018-10-26 14:47:38 +02002212
William Lallemandcf62f7e2018-10-26 14:47:40 +02002213/* The pcli_* functions are used for the CLI proxy in the master */
2214
William Lallemanddeeaa592018-10-26 14:47:48 +02002215void pcli_reply_and_close(struct stream *s, const char *msg)
2216{
2217 struct buffer *buf = get_trash_chunk();
2218
2219 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002220 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002221}
2222
William Lallemand291810d2018-10-26 14:47:38 +02002223static enum obj_type *pcli_pid_to_server(int proc_pid)
2224{
2225 struct mworker_proc *child;
2226
William Lallemand99e0bb92020-11-05 10:28:53 +01002227 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002228 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002229 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002230
William Lallemand291810d2018-10-26 14:47:38 +02002231 list_for_each_entry(child, &proc_list, list) {
2232 if (child->pid == proc_pid){
2233 return &child->srv->obj_type;
2234 }
2235 }
2236 return NULL;
2237}
2238
2239/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2240 * Return:
2241 * 0: master
2242 * > 0: pid of a worker
2243 * < 0: didn't find a worker
2244 */
2245static int pcli_prefix_to_pid(const char *prefix)
2246{
2247 int proc_pid;
2248 struct mworker_proc *child;
2249 char *errtol = NULL;
2250
2251 if (*prefix != '@') /* not a prefix, should not happen */
2252 return -1;
2253
2254 prefix++;
2255 if (!*prefix) /* sent @ alone, return the master */
2256 return 0;
2257
2258 if (strcmp("master", prefix) == 0) {
2259 return 0;
2260 } else if (*prefix == '!') {
2261 prefix++;
2262 if (!*prefix)
2263 return -1;
2264
2265 proc_pid = strtol(prefix, &errtol, 10);
2266 if (*errtol != '\0')
2267 return -1;
2268 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002269 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002270 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002271 if (child->pid == proc_pid){
2272 return child->pid;
2273 }
2274 }
2275 } else {
2276 struct mworker_proc *chosen = NULL;
2277 /* this is a relative pid */
2278
2279 proc_pid = strtol(prefix, &errtol, 10);
2280 if (*errtol != '\0')
2281 return -1;
2282
2283 if (proc_pid == 0) /* return the master */
2284 return 0;
2285
2286 /* chose the right process, the current one is the one with the
2287 least number of reloads */
2288 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002289 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002290 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002291 if (child->reloads == 0)
2292 return child->pid;
2293 else if (chosen == NULL || child->reloads < chosen->reloads)
2294 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002295 }
2296 if (chosen)
2297 return chosen->pid;
2298 }
2299 return -1;
2300}
2301
William Lallemandbddd33a2018-12-11 16:10:53 +01002302/* Return::
2303 * >= 0 : number of words to escape
2304 * = -1 : error
2305 */
2306
2307int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2308{
2309 if (argl < 1)
2310 return 0;
2311
2312 /* there is a prefix */
2313 if (args[0][0] == '@') {
2314 int target_pid = pcli_prefix_to_pid(args[0]);
2315
2316 if (target_pid == -1) {
2317 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2318 return -1;
2319 }
2320
2321 /* if the prefix is alone, define a default target */
2322 if (argl == 1)
2323 s->pcli_next_pid = target_pid;
2324 else
2325 *next_pid = target_pid;
2326 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002327 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002328 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002329 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002330
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002331 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002332 channel_shutr_now(&s->req);
2333 channel_shutw_now(&s->res);
2334 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002335 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002336 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2337 memprintf(errmsg, "Permission denied!\n");
2338 return -1;
2339 }
2340 s->pcli_flags &= ~ACCESS_LVL_MASK;
2341 s->pcli_flags |= ACCESS_LVL_OPER;
2342 return argl;
2343
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002344 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002345 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2346 memprintf(errmsg, "Permission denied!\n");
2347 return -1;
2348 }
2349 s->pcli_flags &= ~ACCESS_LVL_MASK;
2350 s->pcli_flags |= ACCESS_LVL_USER;
2351 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002352
2353 } else if (strcmp(args[0], "expert-mode") == 0) {
2354 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2355 memprintf(errmsg, "Permission denied!\n");
2356 return -1;
2357 }
2358
2359 s->pcli_flags &= ~ACCESS_EXPERT;
2360 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2361 s->pcli_flags |= ACCESS_EXPERT;
2362 return argl;
2363
2364 } else if (strcmp(args[0], "experimental-mode") == 0) {
2365 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2366 memprintf(errmsg, "Permission denied!\n");
2367 return -1;
2368 }
2369 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2370 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2371 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2372 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002373 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2374 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2375 memprintf(errmsg, "Permission denied!\n");
2376 return -1;
2377 }
2378 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2379 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2380 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2381 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002382 }
2383
2384 return 0;
2385}
2386
2387/*
2388 * Parse the CLI request:
2389 * - It does basically the same as the cli_io_handler, but as a proxy
2390 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002391 *
2392 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002393 * - the number of characters to forward or
2394 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002395 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002396int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002397{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002398 char *str;
2399 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002400 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002401 int argl; /* number of args */
2402 char *p;
2403 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002404 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002405 int wtrim = 0; /* number of words to trim */
2406 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002407 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002408 int i = 0;
2409
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002410 /* we cannot deal with a wrapping buffer, so let's take care of this
2411 * first.
2412 */
2413 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2414 b_slow_realign(&req->buf, trash.area, co_data(req));
2415
2416 str = (char *)ci_head(req);
2417 end = (char *)ci_stop(req);
2418
William Lallemandbddd33a2018-12-11 16:10:53 +01002419 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002420
William Lallemanddc12c2e2018-12-13 09:05:46 +01002421 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002422
2423 /* Looks for the end of one command */
2424 while (p+reql < end) {
2425 /* handle escaping */
2426 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002427 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002428 continue;
2429 }
2430 if (p[reql] == ';' || p[reql] == '\n') {
2431 /* found the end of the command */
2432 p[reql] = '\n';
2433 reql++;
2434 break;
2435 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002436 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002437 }
William Lallemandebf61802018-12-11 16:10:57 +01002438 } else {
2439 while (p+reql < end) {
2440 if (p[reql] == '\n') {
2441 /* found the end of the line */
2442 reql++;
2443 break;
2444 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002445 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002446 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002447 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448
William Lallemandbddd33a2018-12-11 16:10:53 +01002449 /* set end to first byte after the end of the command */
2450 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002451
William Lallemandbddd33a2018-12-11 16:10:53 +01002452 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002453 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002454 return -1;
2455 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002456
William Lallemand3301f3e2018-12-13 09:05:48 +01002457 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2458 if (reql == 1) /* last line of the payload */
2459 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002460 return reql;
2461 }
2462
William Lallemandbddd33a2018-12-11 16:10:53 +01002463 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002464
William Lallemandbddd33a2018-12-11 16:10:53 +01002465 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002466 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002467 /* skip leading spaces/tabs */
2468 p += strspn(p, " \t");
2469 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002470 break;
2471
William Lallemandbddd33a2018-12-11 16:10:53 +01002472 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002473 while (1) {
2474 p += strcspn(p, " \t\\");
2475 /* escaped chars using backlashes (\) */
2476 if (*p == '\\') {
2477 if (!*++p)
2478 break;
2479 if (!*++p)
2480 break;
2481 } else {
2482 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002483 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002484 }
William Lallemandfe249c32020-06-18 18:03:57 +02002485 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002486 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002487 }
2488
William Lallemandbddd33a2018-12-11 16:10:53 +01002489 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002490
Willy Tarreauf14c7572021-03-13 10:59:23 +01002491 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002492 args[i] = NULL;
2493
2494 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2495
2496 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002497 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002498 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002499 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002500 if (*p == '\0')
2501 *p = ' ';
2502 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002503 }
2504
William Lallemand3301f3e2018-12-13 09:05:48 +01002505 payload = strstr(str, PAYLOAD_PATTERN);
2506 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2507 /* if the payload pattern is at the end */
2508 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002509 }
2510
William Lallemandbddd33a2018-12-11 16:10:53 +01002511 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002512
William Lallemandbddd33a2018-12-11 16:10:53 +01002513 if (wtrim > 0) {
2514 trim = &args[wtrim][0];
2515 if (trim == NULL) /* if this was the last word in the table */
2516 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002517
William Lallemandbddd33a2018-12-11 16:10:53 +01002518 b_del(&req->buf, trim - str);
2519
William Lallemandb7ea1412018-12-13 09:05:47 +01002520 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002521 } else if (wtrim < 0) {
2522 /* parsing error */
2523 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002524 } else {
2525 /* the whole string */
2526 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002527 }
2528
William Lallemandb7ea1412018-12-13 09:05:47 +01002529 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002530
2531 /* the mcli-debug-mode is only sent to the applet of the master */
2532 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2533 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2534 ret += strlen("mcli-debug-mode on -") + 2;
2535 }
William Lallemand7267f782022-02-01 16:08:50 +01002536 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2537 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2538 ret += strlen("experimental-mode on -") + 2;
2539 }
2540 if (s->pcli_flags & ACCESS_EXPERT) {
2541 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2542 ret += strlen("expert-mode on -") + 2;
2543 }
2544
William Lallemandb7ea1412018-12-13 09:05:47 +01002545 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2546 goto end;
2547 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002548 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2549 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002550 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002551 ci_insert_line2(req, 0, "user -", strlen("user -"));
2552 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002553 }
2554 }
2555end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002556
William Lallemandb7ea1412018-12-13 09:05:47 +01002557 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002558}
2559
2560int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2561{
William Lallemandbddd33a2018-12-11 16:10:53 +01002562 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002563 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002564 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002565
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002566 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002567 * current one. Just wait. At this stage, errors should be handled by
2568 * the response analyzer.
2569 */
2570 if (s->res.analysers & AN_RES_WAIT_CLI)
2571 return 0;
2572
William Lallemandb7ea1412018-12-13 09:05:47 +01002573 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2574 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2575
William Lallemandcf62f7e2018-10-26 14:47:40 +02002576read_again:
2577 /* if the channel is closed for read, we won't receive any more data
2578 from the client, but we don't want to forward this close to the
2579 server */
2580 channel_dont_close(req);
2581
2582 /* We don't know yet to which server we will connect */
2583 channel_dont_connect(req);
2584
William Lallemandcf62f7e2018-10-26 14:47:40 +02002585 req->flags |= CF_READ_DONTWAIT;
2586
2587 /* need more data */
2588 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002589 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002590
2591 /* If there is data available for analysis, log the end of the idle time. */
2592 if (c_data(req) && s->logs.t_idle == -1)
2593 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2594
William Lallemandbddd33a2018-12-11 16:10:53 +01002595 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002596 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002597 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002598 /* enough data */
2599
William Lallemandcf62f7e2018-10-26 14:47:40 +02002600 /* forward only 1 command */
2601 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002602
William Lallemanddc12c2e2018-12-13 09:05:46 +01002603 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002604 /* we send only 1 command per request, and we write close after it */
2605 channel_shutw_now(req);
2606 } else {
2607 pcli_write_prompt(s);
2608 }
2609
2610 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002611 s->res.analysers |= AN_RES_WAIT_CLI;
2612
William Lallemandebf61802018-12-11 16:10:57 +01002613 if (!(s->flags & SF_ASSIGNED)) {
2614 if (next_pid > -1)
2615 target_pid = next_pid;
2616 else
2617 target_pid = s->pcli_next_pid;
2618 /* we can connect now */
2619 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002620
William Lallemanddcbe7b92021-12-10 14:14:53 +01002621 if (!s->target)
2622 goto server_disconnect;
2623
William Lallemandebf61802018-12-11 16:10:57 +01002624 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2625 channel_auto_connect(req);
2626 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002627
2628 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002629 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002630 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002631 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002632 } else if (to_forward == -1) {
2633 if (errmsg) {
2634 /* there was an error during the parsing */
2635 pcli_reply_and_close(s, errmsg);
2636 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2637 return 0;
2638 }
2639 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002640 }
2641
2642 return 0;
2643
2644send_help:
2645 b_reset(&req->buf);
2646 b_putblk(&req->buf, "help\n", 5);
2647 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002648
Christopher Faulet0f727da2022-01-18 08:44:23 +01002649missing_data:
2650 if (req->flags & CF_SHUTR) {
2651 /* There is no more request or a only a partial one and we
2652 * receive a close from the client, we can leave */
2653 channel_shutw_now(&s->res);
2654 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2655 return 1;
2656 }
2657 else if (channel_full(req, global.tune.maxrewrite)) {
2658 /* buffer is full and we didn't catch the end of a command */
2659 goto send_help;
2660 }
2661 return 0;
2662
William Lallemanddcbe7b92021-12-10 14:14:53 +01002663server_disconnect:
2664 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2665 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002666}
2667
2668int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2669{
2670 struct proxy *fe = strm_fe(s);
2671 struct proxy *be = s->be;
2672
Christopher Faulete8cefac2022-03-07 18:20:21 +01002673 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2674 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002675 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002676 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002677 s->res.analysers &= ~AN_RES_WAIT_CLI;
2678 return 0;
2679 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002680 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2681 rep->flags |= CF_NEVER_WAIT;
2682
2683 /* don't forward the close */
2684 channel_dont_close(&s->res);
2685 channel_dont_close(&s->req);
2686
William Lallemanddc12c2e2018-12-13 09:05:46 +01002687 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002688 s->res.analysers &= ~AN_RES_WAIT_CLI;
2689 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2690 return 0;
2691 }
2692
William Lallemandcf62f7e2018-10-26 14:47:40 +02002693 /* forward the data */
2694 if (ci_data(rep)) {
2695 c_adv(rep, ci_data(rep));
2696 return 0;
2697 }
2698
2699 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2700 /* stream cleanup */
2701
William Lallemand2f4ce202018-10-26 14:47:47 +02002702 pcli_write_prompt(s);
2703
Willy Tarreaucb041662022-05-17 19:44:42 +02002704 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreauf61dd192022-05-27 09:00:19 +02002705 sc_shutr(s->scb);
2706 sc_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002707
2708 /*
2709 * starting from there this the same code as
2710 * http_end_txn_clean_session().
2711 *
2712 * It allows to do frontend keepalive while reconnecting to a
2713 * new server for each request.
2714 */
2715
2716 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002717 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002718 if (unlikely(s->srv_conn))
2719 sess_change_server(s, NULL);
2720 }
2721
2722 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2723 stream_process_counters(s);
2724
2725 /* don't count other requests' data */
2726 s->logs.bytes_in -= ci_data(&s->req);
2727 s->logs.bytes_out -= ci_data(&s->res);
2728
2729 /* we may need to know the position in the queue */
2730 pendconn_free(s);
2731
2732 /* let's do a final log if we need it */
2733 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2734 !(s->flags & SF_MONITOR) &&
2735 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2736 s->do_log(s);
2737 }
2738
2739 /* stop tracking content-based counters */
2740 stream_stop_content_counters(s);
2741 stream_update_time_stats(s);
2742
2743 s->logs.accept_date = date; /* user-visible date for logging */
2744 s->logs.tv_accept = now; /* corrected date for internal use */
2745 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2746 s->logs.t_idle = -1;
2747 tv_zero(&s->logs.tv_request);
2748 s->logs.t_queue = -1;
2749 s->logs.t_connect = -1;
2750 s->logs.t_data = -1;
2751 s->logs.t_close = 0;
2752 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2753 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2754
2755 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2756 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2757
2758 stream_del_srv_conn(s);
2759 if (objt_server(s->target)) {
2760 if (s->flags & SF_CURR_SESS) {
2761 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002762 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002763 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002764 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002765 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002766 }
2767
2768 s->target = NULL;
2769
2770 /* only release our endpoint if we don't intend to reuse the
2771 * connection.
2772 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002773 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002774 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002775 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002776 if (!s->conn_err_type)
2777 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002778 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002779 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002780 return 1;
2781 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002782 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002783 }
2784
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002785 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002786
Willy Tarreau74568cf2022-05-27 09:03:30 +02002787 sc_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002788 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 +02002789 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 +02002790 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 +02002791 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002792 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2793 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002794 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002795 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002796 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002797 /* reinitialise the current rule list pointer to NULL. We are sure that
2798 * any rulelist match the NULL pointer.
2799 */
2800 s->current_rule_list = NULL;
2801
2802 s->be = strm_fe(s);
2803 s->logs.logwait = strm_fe(s)->to_log;
2804 s->logs.level = 0;
2805 stream_del_srv_conn(s);
2806 s->target = NULL;
2807 /* re-init store persistence */
2808 s->store_count = 0;
2809 s->uniq_id = global.req_count++;
2810
2811 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2812
2813 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2814
William Lallemandcf62f7e2018-10-26 14:47:40 +02002815 s->res.analysers &= ~AN_RES_WAIT_CLI;
2816
2817 /* We must trim any excess data from the response buffer, because we
2818 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002819 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002820 * we want those data to come along with next response. A typical
2821 * example of such data would be from a buggy server responding to
2822 * a HEAD with some data, or sending more than the advertised
2823 * content-length.
2824 */
2825 if (unlikely(ci_data(&s->res)))
2826 b_set_data(&s->res.buf, co_data(&s->res));
2827
2828 /* Now we can realign the response buffer */
2829 c_realign_if_empty(&s->res);
2830
2831 s->req.rto = strm_fe(s)->timeout.client;
2832 s->req.wto = TICK_ETERNITY;
2833
2834 s->res.rto = TICK_ETERNITY;
2835 s->res.wto = strm_fe(s)->timeout.client;
2836
2837 s->req.rex = TICK_ETERNITY;
2838 s->req.wex = TICK_ETERNITY;
2839 s->req.analyse_exp = TICK_ETERNITY;
2840 s->res.rex = TICK_ETERNITY;
2841 s->res.wex = TICK_ETERNITY;
2842 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002843 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002844
2845 /* we're removing the analysers, we MUST re-enable events detection.
2846 * We don't enable close on the response channel since it's either
2847 * already closed, or in keep-alive with an idle connection handler.
2848 */
2849 channel_auto_read(&s->req);
2850 channel_auto_close(&s->req);
2851 channel_auto_read(&s->res);
2852
2853
2854 return 1;
2855 }
2856 return 0;
2857}
2858
William Lallemand8a022572018-10-26 14:47:35 +02002859/*
2860 * The mworker functions are used to initialize the CLI in the master process
2861 */
2862
William Lallemand309dc9a2018-10-26 14:47:45 +02002863 /*
2864 * Stop the mworker proxy
2865 */
2866void mworker_cli_proxy_stop()
2867{
William Lallemand550db6d2018-11-06 17:37:12 +01002868 if (mworker_proxy)
2869 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002870}
2871
William Lallemand8a022572018-10-26 14:47:35 +02002872/*
2873 * Create the mworker CLI proxy
2874 */
2875int mworker_cli_proxy_create()
2876{
2877 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002878 char *msg = NULL;
2879 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002880
William Lallemandae787ba2021-07-29 15:13:22 +02002881 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002882 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002883 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002884
William Lallemandcf62f7e2018-10-26 14:47:40 +02002885 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002886 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2887 mworker_proxy->timeout.client = 0; /* no timeout */
2888 mworker_proxy->conf.file = strdup("MASTER");
2889 mworker_proxy->conf.line = 0;
2890 mworker_proxy->accept = frontend_accept;
2891 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2892
2893 /* Does not init the default target the CLI applet, but must be done in
2894 * the request parsing code */
2895 mworker_proxy->default_target = NULL;
2896
William Lallemand8a022572018-10-26 14:47:35 +02002897 /* create all servers using the mworker_proc list */
2898 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002899 struct server *newsrv = NULL;
2900 struct sockaddr_storage *sk;
2901 int port1, port2, port;
2902 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002903
William Lallemanda31b09e2020-01-14 15:25:02 +01002904 /* only the workers support the master CLI */
2905 if (!(child->options & PROC_O_TYPE_WORKER))
2906 continue;
2907
William Lallemand8a022572018-10-26 14:47:35 +02002908 newsrv = new_server(mworker_proxy);
2909 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002910 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002911
2912 /* we don't know the new pid yet */
2913 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002914 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002915 else
2916 memprintf(&msg, "old-%d", child->pid);
2917
2918 newsrv->next = mworker_proxy->srv;
2919 mworker_proxy->srv = newsrv;
2920 newsrv->conf.file = strdup(msg);
2921 newsrv->id = strdup(msg);
2922 newsrv->conf.line = 0;
2923
2924 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002925 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002926 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002927 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002928 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002929 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002930
Willy Tarreau5fc93282020-09-16 18:25:03 +02002931 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002932 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002933 }
2934
2935 /* no port specified */
2936 newsrv->flags |= SRV_F_MAPPORTS;
2937 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002938 /* don't let the server participate to load balancing */
2939 newsrv->iweight = 0;
2940 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002941 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002942
2943 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002944 }
William Lallemandae787ba2021-07-29 15:13:22 +02002945
2946 mworker_proxy->next = proxies_list;
2947 proxies_list = mworker_proxy;
2948
William Lallemand8a022572018-10-26 14:47:35 +02002949 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002950
2951error:
William Lallemand744a0892018-11-22 16:46:51 +01002952
2953 list_for_each_entry(child, &proc_list, list) {
2954 free((char *)child->srv->conf.file); /* cast because of const char * */
2955 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002956 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002957 }
William Lallemandae787ba2021-07-29 15:13:22 +02002958 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002959 free(msg);
2960
William Lallemandae787ba2021-07-29 15:13:22 +02002961error_proxy:
2962 ha_alert("%s\n", errmsg);
2963 free(errmsg);
2964
William Lallemand744a0892018-11-22 16:46:51 +01002965 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002966}
Olivier Houchardf886e342017-04-05 22:24:59 +02002967
William Lallemandce83b4a2018-10-26 14:47:30 +02002968/*
William Lallemande7361152018-10-26 14:47:36 +02002969 * Create a new listener for the master CLI proxy
2970 */
2971int mworker_cli_proxy_new_listener(char *line)
2972{
2973 struct bind_conf *bind_conf;
2974 struct listener *l;
2975 char *err = NULL;
2976 char *args[MAX_LINE_ARGS + 1];
2977 int arg;
2978 int cur_arg;
2979
William Lallemand2e945c82019-11-25 09:58:37 +01002980 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002981 args[0] = line;
2982
2983 /* args is a bind configuration with spaces replaced by commas */
2984 while (*line && arg < MAX_LINE_ARGS) {
2985
2986 if (*line == ',') {
2987 *line++ = '\0';
2988 while (*line == ',')
2989 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002990 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002991 }
2992 line++;
2993 }
2994
William Lallemand2e945c82019-11-25 09:58:37 +01002995 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002996
2997 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002998 if (!bind_conf)
2999 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003000
3001 bind_conf->level &= ~ACCESS_LVL_MASK;
3002 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003003 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003004
3005 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3006 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003007 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003008 }
3009
3010 cur_arg = 1;
3011
3012 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003013 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003014 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003015
3016 kw = bind_find_kw(args[cur_arg]);
3017 if (kw) {
3018 if (!kw->parse) {
3019 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3020 args[0], args[1], args[cur_arg]);
3021 goto err;
3022 }
3023
Willy Tarreau4975d142021-03-13 11:00:33 +01003024 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003025 if (err)
3026 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3027 else
3028 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3029 args[0], args[1], args[cur_arg]);
3030 goto err;
3031 }
3032
3033 cur_arg += 1 + kw->skip;
3034 continue;
3035 }
3036
Willy Tarreau433b05f2021-03-12 10:14:07 +01003037 best = bind_find_best_kw(args[cur_arg]);
3038 if (best)
3039 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3040 args[0], args[1], args[cur_arg], best);
3041 else
3042 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3043 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003044 goto err;
3045 }
3046
3047
3048 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003049 l->accept = session_accept_fd;
3050 l->default_target = mworker_proxy->default_target;
3051 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003052 l->options |= LI_O_UNLIMITED;
3053 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003054 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003055 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003056 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003057 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003058
3059 return 0;
3060
3061err:
3062 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003063 free(err);
3064 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003065 return -1;
3066
3067}
3068
3069/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003070 * Create a new CLI socket using a socketpair for a worker process
3071 * <mworker_proc> is the process structure, and <proc> is the process number
3072 */
3073int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3074{
3075 struct bind_conf *bind_conf;
3076 struct listener *l;
3077 char *path = NULL;
3078 char *err = NULL;
3079
3080 /* master pipe to ensure the master is still alive */
3081 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3082 ha_alert("Cannot create worker socketpair.\n");
3083 return -1;
3084 }
3085
3086 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003087 if (!global.cli_fe) {
3088 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003089 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003090 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003091 }
3092 }
3093
Willy Tarreau4975d142021-03-13 11:00:33 +01003094 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003095 if (!bind_conf)
3096 goto error;
3097
William Lallemandce83b4a2018-10-26 14:47:30 +02003098 bind_conf->level &= ~ACCESS_LVL_MASK;
3099 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003100 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003101
William Lallemandce83b4a2018-10-26 14:47:30 +02003102 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3103 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003104 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 }
3106
Willy Tarreau4975d142021-03-13 11:00:33 +01003107 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003108 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003109 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003110 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003111 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003112 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003113
3114 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003115 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003116 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003117 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003118 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003119 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003120 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003121 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003122 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003123 }
3124
3125 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003126
3127error:
3128 close(mworker_proc->ipc_fd[0]);
3129 close(mworker_proc->ipc_fd[1]);
3130 free(err);
3131
3132 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003133}
3134
William Lallemand74c24fb2016-11-21 17:18:36 +01003135static struct applet cli_applet = {
3136 .obj_type = OBJ_TYPE_APPLET,
3137 .name = "<CLI>", /* used for logging */
3138 .fct = cli_io_handler,
3139 .release = cli_release_handler,
3140};
3141
William Lallemand99e0bb92020-11-05 10:28:53 +01003142/* master CLI */
3143static struct applet mcli_applet = {
3144 .obj_type = OBJ_TYPE_APPLET,
3145 .name = "<MCLI>", /* used for logging */
3146 .fct = cli_io_handler,
3147 .release = cli_release_handler,
3148};
3149
Willy Tarreau0a739292016-11-22 20:21:23 +01003150/* register cli keywords */
3151static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003152 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3153 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3154 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3155 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003156 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3157 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003158 { { "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 +02003159 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3160 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3161 { { "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 },
3162 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3163 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3164 { { "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 },
3165 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3166 { { "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 },
3167 { { "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 +01003168 { { "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 +02003169 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3170 { { "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 +01003171 {{},}
3172}};
3173
Willy Tarreau0108d902018-11-25 19:14:37 +01003174INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3175
William Lallemand74c24fb2016-11-21 17:18:36 +01003176static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003177 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003178 { 0, NULL, NULL },
3179}};
3180
Willy Tarreau0108d902018-11-25 19:14:37 +01003181INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3182
William Lallemand74c24fb2016-11-21 17:18:36 +01003183static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003184 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3185 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003186 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003187 { NULL, NULL, 0 },
3188}};
3189
Willy Tarreau0108d902018-11-25 19:14:37 +01003190INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003191
3192/*
3193 * Local variables:
3194 * c-indent-level: 8
3195 * c-basic-offset: 8
3196 * End:
3197 */