blob: 4724ba4f6b3f117abed4e90cc4702e731d5044eb [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 Tarreau9a7fa902022-07-15 16:51:16 +020089/* CLI context for the "show activity" command */
90struct show_activity_ctx {
91 int thr; /* thread ID to show or -1 for all */
92};
93
Willy Tarreau307dbb32022-05-05 17:45:52 +020094/* CLI context for the "show env" command */
95struct show_env_ctx {
96 char **var; /* first variable to show */
97 int show_one; /* stop after showing the first one */
98};
99
Willy Tarreau741a5a92022-05-05 17:56:58 +0200100/* CLI context for the "show fd" command */
101struct show_fd_ctx {
102 int fd; /* first FD to show */
103 int show_one; /* stop after showing one FD */
104};
105
Willy Tarreaub128f492022-05-05 19:11:05 +0200106/* CLI context for the "show cli sockets" command */
107struct show_sock_ctx {
108 struct bind_conf *bind_conf;
109 struct listener *listener;
110};
111
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200112static int cmp_kw_entries(const void *a, const void *b)
113{
114 const struct cli_kw *l = *(const struct cli_kw **)a;
115 const struct cli_kw *r = *(const struct cli_kw **)b;
116
117 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
118}
119
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100120/* This will show the help message and list the commands supported at the
121 * current level that match all of the first words of <args> if args is not
122 * NULL, or all args if none matches or if args is null.
123 */
124static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100125{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200126 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100127 struct cli_kw_list *kw_list;
128 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200129 struct buffer *tmp = get_trash_chunk();
130 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100131 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100132 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200133 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100134 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200135 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100136
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100137 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100138
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200139 if (args && *args && strcmp(*args, "help") == 0) {
140 args++;
141 ishelp = 1;
142 }
143
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100144 /* first, let's measure the longest match */
145 list_for_each_entry(kw_list, &cli_keywords.list, list) {
146 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100147 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100148 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100149 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
150 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100151 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
152 continue;
153
154 /* OK this command is visible */
155 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
156 if (!kw->str_kw[idx])
157 break; // end of keyword
158 if (!args || !args[idx] || !*args[idx])
159 break; // end of command line
160 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
161 break;
162 if (idx + 1 > length)
163 length = idx + 1;
164 }
165 }
166 }
167
Willy Tarreaub7364582021-03-12 18:24:46 +0100168 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100169 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200170 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100171 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200172 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100173 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
174 else // partial match
175 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
176
Willy Tarreaub7364582021-03-12 18:24:46 +0100177 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
178 matches[idx].kw = NULL;
179 matches[idx].dist = INT_MAX;
180 }
181
182 /* In case of partial match we'll look for the best matching entries
183 * starting from position <length>
184 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100185 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100186 list_for_each_entry(kw_list, &cli_keywords.list, list) {
187 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100188 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100189 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100190 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
191 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
192 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100193 continue;
194
195 for (idx = 0; idx < length; idx++) {
196 if (!kw->str_kw[idx])
197 break; // end of keyword
198 if (!args || !args[idx] || !*args[idx])
199 break; // end of command line
200 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
201 break;
202 }
203
204 /* extra non-matching words are fuzzy-matched */
205 if (kw->usage && idx == length && args[idx] && *args[idx]) {
206 uint8_t word_sig[1024];
207 uint8_t list_sig[1024];
208 int dist = 0;
209 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100210 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100211
212 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100213 * on the remaining words. For this we're computing the signature
214 * of everything that remains and the cumulated length of the
215 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100216 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100217 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100218 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
219 update_word_fingerprint(word_sig, args[i]);
220 totlen += strlen(args[i]);
221 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100222
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100223 memset(list_sig, 0, sizeof(list_sig));
224 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
225 update_word_fingerprint(list_sig, kw->str_kw[i]);
226 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100227 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100228
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100229 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100230
231 /* insert this one at its place if relevant, in order to keep only
232 * the best matches.
233 */
234 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100235 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100236 matches[CLI_MAX_MATCHES-1] = swp;
237 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
238 if (matches[idx+1].dist >= matches[idx].dist)
239 break;
240 matches[idx+1] = matches[idx];
241 matches[idx] = swp;
242 }
243 }
244 }
245 }
246 }
247 }
248
Willy Tarreauec197e82021-03-15 10:35:04 +0100249 if (matches[0].kw) {
250 /* we have fuzzy matches, let's propose them */
251 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
252 kw = matches[idx].kw;
253 if (!kw)
254 break;
255
256 /* stop the dump if some words look very unlikely candidates */
257 if (matches[idx].dist > 5*matches[0].dist/2)
258 break;
259
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200260 if (help_entries < CLI_MAX_HELP_ENTRIES)
261 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100262 }
263 }
264
William Lallemand74c24fb2016-11-21 17:18:36 +0100265 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100266 /* no full dump if we've already found nice candidates */
267 if (matches[0].kw)
268 break;
269
Willy Tarreau91bc3592021-03-12 15:20:39 +0100270 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200271
Willy Tarreau91bc3592021-03-12 15:20:39 +0100272 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100273 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100274 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100275 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100276 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200277
William Lallemand2a171912022-02-02 11:43:20 +0100278 /* in master, if the CLI don't have the
279 * ACCESS_MCLI_DEBUG don't display commands that have
280 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100281 */
William Lallemand2a171912022-02-02 11:43:20 +0100282 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
283 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
284 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100285 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200286
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100287 for (idx = 0; idx < length; idx++) {
288 if (!kw->str_kw[idx])
289 break; // end of keyword
290 if (!args || !args[idx] || !*args[idx])
291 break; // end of command line
292 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
293 break;
294 }
295
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200296 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
297 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100298 }
299 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100300
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200301 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
302
303 for (idx = 0; idx < help_entries; idx++)
304 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
305
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100306 /* always show the prompt/help/quit commands */
307 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200308 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200309 " prompt : toggle interactive mode with prompt\n"
310 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100311
William Lallemand74c24fb2016-11-21 17:18:36 +0100312 chunk_init(&out, NULL, 0);
313 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200314 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200315
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200316 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100317 return dynamic_usage_msg;
318}
319
320struct cli_kw* cli_find_kw(char **args)
321{
322 struct cli_kw_list *kw_list;
323 struct cli_kw *kw;/* current cli_kw */
324 char **tmp_args;
325 const char **tmp_str_kw;
326 int found = 0;
327
328 if (LIST_ISEMPTY(&cli_keywords.list))
329 return NULL;
330
331 list_for_each_entry(kw_list, &cli_keywords.list, list) {
332 kw = &kw_list->kw[0];
333 while (*kw->str_kw) {
334 tmp_args = args;
335 tmp_str_kw = kw->str_kw;
336 while (*tmp_str_kw) {
337 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
338 found = 1;
339 } else {
340 found = 0;
341 break;
342 }
343 tmp_args++;
344 tmp_str_kw++;
345 }
346 if (found)
347 return (kw);
348 kw++;
349 }
350 }
351 return NULL;
352}
353
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100354struct cli_kw* cli_find_kw_exact(char **args)
355{
356 struct cli_kw_list *kw_list;
357 int found = 0;
358 int i;
359 int j;
360
361 if (LIST_ISEMPTY(&cli_keywords.list))
362 return NULL;
363
364 list_for_each_entry(kw_list, &cli_keywords.list, list) {
365 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
366 found = 1;
367 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
368 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
369 break;
370 }
371 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
372 found = 0;
373 break;
374 }
375 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
376 found = 0;
377 break;
378 }
379 }
380 if (found)
381 return &kw_list->kw[i];
382 }
383 }
384 return NULL;
385}
386
William Lallemand74c24fb2016-11-21 17:18:36 +0100387void cli_register_kw(struct cli_kw_list *kw_list)
388{
Willy Tarreau2b718102021-04-21 07:32:39 +0200389 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100390}
391
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200392/* list all known keywords on stdout, one per line */
393void cli_list_keywords(void)
394{
395 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200396 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200397 int idx;
398
Willy Tarreau44651712022-03-30 12:02:35 +0200399 for (kwn = kwp = NULL;; kwp = kwn) {
400 list_for_each_entry(kw_list, &cli_keywords.list, list) {
401 /* note: we sort based on the usage message when available,
402 * otherwise we fall back to the first keyword.
403 */
404 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
405 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
406 kw->usage ? kw->usage : kw->str_kw[0],
407 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
408 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200409 }
Willy Tarreau44651712022-03-30 12:02:35 +0200410 }
411
412 if (kwn == kwp)
413 break;
414
415 for (idx = 0; kwn->str_kw[idx]; idx++) {
416 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200417 }
Willy Tarreau44651712022-03-30 12:02:35 +0200418 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
419 printf("[MASTER] ");
420 if (!(kwn->level & ACCESS_MASTER_ONLY))
421 printf("[WORKER] ");
422 if (kwn->level & ACCESS_EXPERT)
423 printf("[EXPERT] ");
424 if (kwn->level & ACCESS_EXPERIMENTAL)
425 printf("[EXPERIM] ");
426 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200427 }
428}
William Lallemand74c24fb2016-11-21 17:18:36 +0100429
430/* allocate a new stats frontend named <name>, and return it
431 * (or NULL in case of lack of memory).
432 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100433static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100434{
435 struct proxy *fe;
436
437 fe = calloc(1, sizeof(*fe));
438 if (!fe)
439 return NULL;
440
441 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100442 fe->next = proxies_list;
443 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100444 fe->last_change = now.tv_sec;
445 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200446 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100447 fe->maxconn = 10; /* default to 10 concurrent connections */
448 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
449 fe->conf.file = strdup(file);
450 fe->conf.line = line;
451 fe->accept = frontend_accept;
452 fe->default_target = &cli_applet.obj_type;
453
454 /* the stats frontend is the only one able to assign ID #0 */
455 fe->conf.id.key = fe->uuid = 0;
456 eb32_insert(&used_proxy_id, &fe->conf.id);
457 return fe;
458}
459
460/* This function parses a "stats" statement in the "global" section. It returns
461 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
462 * error message into the <err> buffer which will be preallocated. The trailing
463 * '\n' must not be written. The function must be called with <args> pointing to
464 * the first word after "stats".
465 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100466static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
467 const struct proxy *defpx, const char *file, int line,
468 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100469{
470 struct bind_conf *bind_conf;
471 struct listener *l;
472
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100473 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100474 int cur_arg;
475
476 if (*args[2] == 0) {
477 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
478 return -1;
479 }
480
Willy Tarreau4975d142021-03-13 11:00:33 +0100481 if (!global.cli_fe) {
482 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100483 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
484 return -1;
485 }
486 }
487
Willy Tarreau4975d142021-03-13 11:00:33 +0100488 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200489 if (!bind_conf) {
490 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
491 return -1;
492 }
William Lallemand07a62f72017-05-24 00:57:40 +0200493 bind_conf->level &= ~ACCESS_LVL_MASK;
494 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
Willy Tarreau6bdf9452022-07-06 11:52:24 +0200495 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemand74c24fb2016-11-21 17:18:36 +0100496
Willy Tarreau4975d142021-03-13 11:00:33 +0100497 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100498 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
499 file, line, args[0], args[1], err && *err ? *err : "error");
500 return -1;
501 }
502
503 cur_arg = 3;
504 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100505 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100506 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100507 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100508
509 kw = bind_find_kw(args[cur_arg]);
510 if (kw) {
511 if (!kw->parse) {
512 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
513 args[0], args[1], args[cur_arg]);
514 return -1;
515 }
516
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100517 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
518
519 /* FIXME: this is ugly, we don't have a way to collect warnings,
520 * yet some important bind keywords may report warnings that we
521 * must display.
522 */
523 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
524 indent_msg(err, 2);
525 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
526 ha_free(err);
527 }
528
529 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100530 if (err && *err)
531 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
532 else
533 memprintf(err, "'%s %s' : error encountered while processing '%s'",
534 args[0], args[1], args[cur_arg]);
535 return -1;
536 }
537
538 cur_arg += 1 + kw->skip;
539 continue;
540 }
541
Willy Tarreau433b05f2021-03-12 10:14:07 +0100542 best = bind_find_best_kw(args[cur_arg]);
543 if (best)
544 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
545 args[0], args[1], args[cur_arg], best);
546 else
547 memprintf(err, "'%s %s' : unknown keyword '%s'.",
548 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100549 return -1;
550 }
551
552 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100553 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100554 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100555 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
556 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100557 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100558 }
559 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100560 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100561 unsigned timeout;
562 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
563
Willy Tarreau9faebe32019-06-07 19:00:37 +0200564 if (res == PARSE_TIME_OVER) {
565 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
566 args[2], args[0], args[1]);
567 return -1;
568 }
569 else if (res == PARSE_TIME_UNDER) {
570 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
571 args[2], args[0], args[1]);
572 return -1;
573 }
574 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100575 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
576 return -1;
577 }
578
579 if (!timeout) {
580 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
581 return -1;
582 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100583 if (!global.cli_fe) {
584 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100585 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
586 return -1;
587 }
588 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100589 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100590 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100591 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100592 int maxconn = atol(args[2]);
593
594 if (maxconn <= 0) {
595 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
596 return -1;
597 }
598
Willy Tarreau4975d142021-03-13 11:00:33 +0100599 if (!global.cli_fe) {
600 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100601 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
602 return -1;
603 }
604 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100605 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100606 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200607 else if (strcmp(args[1], "bind-process") == 0) {
608 memprintf(err, "'%s' is not supported anymore.", args[0]);
609 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100610 }
611 else {
612 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
613 return -1;
614 }
615 return 0;
616}
617
William Lallemand33d29e22019-04-01 11:30:06 +0200618/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200619 * This function exports the bound addresses of a <frontend> in the environment
620 * variable <varname>. Those addresses are separated by semicolons and prefixed
621 * with their type (abns@, unix@, sockpair@ etc)
622 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200623 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200624int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200625{
626 struct buffer *trash = get_trash_chunk();
627 struct bind_conf *bind_conf;
628
William Lallemand9a37fd02019-04-12 16:09:24 +0200629 if (frontend) {
630 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200631 struct listener *l;
632
633 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
634 char addr[46];
635 char port[6];
636
William Lallemand620072b2019-04-12 16:09:25 +0200637 /* separate listener by semicolons */
638 if (trash->data)
639 chunk_appendf(trash, ";");
640
Willy Tarreau37159062020-08-27 07:48:42 +0200641 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200642 const struct sockaddr_un *un;
643
Willy Tarreau37159062020-08-27 07:48:42 +0200644 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200645 if (un->sun_path[0] == '\0') {
646 chunk_appendf(trash, "abns@%s", un->sun_path+1);
647 } else {
648 chunk_appendf(trash, "unix@%s", un->sun_path);
649 }
Willy Tarreau37159062020-08-27 07:48:42 +0200650 } else if (l->rx.addr.ss_family == AF_INET) {
651 addr_to_str(&l->rx.addr, addr, sizeof(addr));
652 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200653 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200654 } else if (l->rx.addr.ss_family == AF_INET6) {
655 addr_to_str(&l->rx.addr, addr, sizeof(addr));
656 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200657 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200658 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
659 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200660 }
William Lallemand33d29e22019-04-01 11:30:06 +0200661 }
662 }
663 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200664 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200665 return -1;
666 }
667
668 return 0;
669}
670
William Lallemand9a37fd02019-04-12 16:09:24 +0200671int cli_socket_setenv()
672{
Willy Tarreau4975d142021-03-13 11:00:33 +0100673 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200674 return -1;
675 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
676 return -1;
677
678 return 0;
679}
680
William Lallemand33d29e22019-04-01 11:30:06 +0200681REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
682
Willy Tarreaude57a572016-11-23 17:01:39 +0100683/* Verifies that the CLI at least has a level at least as high as <level>
684 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
685 * failure, an error message is prepared and the appctx's state is adjusted
686 * to print it so that a return 1 is enough to abort any processing.
687 */
688int cli_has_level(struct appctx *appctx, int level)
689{
Willy Tarreaude57a572016-11-23 17:01:39 +0100690
William Lallemandf630d012018-12-13 09:05:44 +0100691 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100692 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100693 return 0;
694 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100695 return 1;
696}
697
William Lallemandb7ea1412018-12-13 09:05:47 +0100698/* same as cli_has_level but for the CLI proxy and without error message */
699int pcli_has_level(struct stream *s, int level)
700{
701 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
702 return 0;
703 }
704 return 1;
705}
706
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200707/* Returns severity_output for the current session if set, or default for the socket */
708static int cli_get_severity_output(struct appctx *appctx)
709{
710 if (appctx->cli_severity_output)
711 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200712 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200713}
William Lallemand74c24fb2016-11-21 17:18:36 +0100714
Willy Tarreau41908562016-11-24 16:23:38 +0100715/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100716 * from the CLI's IO handler running in an appctx context. The function returns
717 * 1 if the request was understood, otherwise zero (in which case an error
718 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100719 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
720 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
721 * have its own I/O handler called again. Most of the time, parsers will only
722 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100723 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
724 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100725 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200726static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100727{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100728 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200729 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100730 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100731
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200732 p = appctx->chunk->area;
733 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100734
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200735 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736 * Get pointers on words.
737 * One extra slot is reserved to store a pointer on a null byte.
738 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100739 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200740 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100741
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 /* skip leading spaces/tabs */
743 p += strspn(p, " \t");
744 if (!*p)
745 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200746
747 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
748 /* payload pattern recognized here, this is not an arg anymore,
749 * the payload starts at the first byte that follows the zero
750 * after the pattern.
751 */
752 payload = p + strlen(PAYLOAD_PATTERN) + 1;
753 break;
754 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100755
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200756 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200757 while (1) {
758 p += strcspn(p, " \t\\");
759 /* escaped chars using backlashes (\) */
760 if (*p == '\\') {
761 if (!*++p)
762 break;
763 if (!*++p)
764 break;
765 } else {
766 break;
767 }
768 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200769 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100770
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200771 /* unescape backslashes (\) */
772 for (j = 0, k = 0; args[i][k]; k++) {
773 if (args[i][k] == '\\') {
774 if (args[i][k + 1] == '\\')
775 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100776 else
777 continue;
778 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200779 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100780 j++;
781 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200782 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100783
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200784 i++;
785 }
786 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200787 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100788 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200789 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100790
791 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100792 if (!kw ||
793 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100794 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
795 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100796 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100797 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100798 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100799 }
William Lallemand14721be2018-10-26 14:47:37 +0200800
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100801 /* don't handle expert mode commands if not in this mode. */
802 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
803 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200804 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100805 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200806
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100807 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
808 cli_err(appctx, "This command is restricted to experimental mode only.\n");
809 return 0;
810 }
811
Amaury Denoyellef4929922021-05-05 16:29:23 +0200812 if (kw->level == ACCESS_EXPERT)
813 mark_tainted(TAINTED_CLI_EXPERT_MODE);
814 else if (kw->level == ACCESS_EXPERIMENTAL)
815 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
816
Willy Tarreau41908562016-11-24 16:23:38 +0100817 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200818 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200819
820 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
821 goto fail;
822
823 /* kw->parse could set its own io_handler or io_release handler */
824 if (!appctx->io_handler)
825 goto fail;
826
827 appctx->st0 = CLI_ST_CALLBACK;
828 return 1;
829fail:
830 appctx->io_handler = NULL;
831 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100832 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100833}
834
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200835/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
836static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
837{
Willy Tarreau83061a82018-07-13 11:56:34 +0200838 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200839
840 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200841 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200842
843 tmp = get_trash_chunk();
844 chunk_reset(tmp);
845
846 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100847 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200848 chunk_printf(tmp, "[%d]: ", severity);
849 }
850 else {
851 switch (severity_output) {
852 case CLI_SEVERITY_NUMBER:
853 chunk_printf(tmp, "[%d]: ", severity);
854 break;
855 case CLI_SEVERITY_STRING:
856 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
857 break;
858 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100859 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200860 }
861 }
862 chunk_appendf(tmp, "%s", msg);
863
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200864 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200865}
866
Willy Tarreau4596fe22022-05-17 19:07:51 +0200867/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100868 * used to processes I/O from/to the stats unix socket. The system relies on a
869 * state machine handling requests and various responses. We read a request,
870 * then we process it and send the response, and we possibly display a prompt.
871 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100872 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100873 * or not.
874 */
875static void cli_io_handler(struct appctx *appctx)
876{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200877 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200878 struct channel *req = sc_oc(sc);
879 struct channel *res = sc_ic(sc);
880 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100881 int reql;
882 int len;
883
Willy Tarreau475e4632022-05-27 10:26:46 +0200884 if (unlikely(sc->state == SC_ST_DIS || sc->state == SC_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100885 goto out;
886
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800887 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200888 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100889 /* buf.size==0 means we failed to get a buffer and were
890 * already subscribed to a wait list to get a buffer.
891 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100892 goto out;
893 }
894
William Lallemand74c24fb2016-11-21 17:18:36 +0100895 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100896 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200897 /* reset severity to default at init */
898 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100899 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100900 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100901 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100902 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 /* Let's close for real now. We just close the request
904 * side, the conditions below will complete if needed.
905 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200906 sc_shutw(sc);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200907 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200908 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100909 break;
910 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100911 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200912 char *str;
913
914 /* use a trash chunk to store received data */
915 if (!appctx->chunk) {
916 appctx->chunk = alloc_trash_chunk();
917 if (!appctx->chunk) {
918 appctx->st0 = CLI_ST_END;
919 continue;
920 }
921 }
922
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200923 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200924
William Lallemand74c24fb2016-11-21 17:18:36 +0100925 /* ensure we have some output room left in the event we
926 * would want to return some info right after parsing.
927 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200928 if (buffer_almost_full(sc_ib(sc))) {
929 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +0100930 break;
931 }
932
Willy Tarreau0011c252022-01-19 17:23:52 +0100933 /* payload doesn't take escapes nor does it end on semi-colons, so
934 * we use the regular getline. Normal mode however must stop on
935 * LFs and semi-colons that are not prefixed by a backslash. Note
936 * that we reserve one byte at the end to insert a trailing nul byte.
937 */
938
939 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200940 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100941 appctx->chunk->size - appctx->chunk->data - 1);
942 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200943 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100944 appctx->chunk->size - appctx->chunk->data - 1,
945 "\n;", '\\');
946
William Lallemand74c24fb2016-11-21 17:18:36 +0100947 if (reql <= 0) { /* closed or EOL not found */
948 if (reql == 0)
949 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100950 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 continue;
952 }
953
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200954 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
955 /* seek for a possible unescaped semi-colon. If we find
956 * one, we replace it with an LF and skip only this part.
957 */
958 for (len = 0; len < reql; len++) {
959 if (str[len] == '\\') {
960 len++;
961 continue;
962 }
963 if (str[len] == ';') {
964 str[len] = '\n';
965 reql = len + 1;
966 break;
967 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100968 }
969 }
970
971 /* now it is time to check that we have a full line,
972 * remove the trailing \n and possibly \r, then cut the
973 * line.
974 */
975 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200976 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100977 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100978 continue;
979 }
980
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200981 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100982 len--;
983
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200984 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200985 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200986
987 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200988 appctx->chunk->area[appctx->chunk->data] = '\n';
989 appctx->chunk->area[appctx->chunk->data + 1] = 0;
990 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200991 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100992
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100993 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200994
995 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
996 /* empty line */
997 if (!len) {
998 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200999 appctx->chunk->data -= 2;
1000 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001001 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001002 chunk_reset(appctx->chunk);
1003 /* NB: cli_sock_parse_request() may have put
1004 * another CLI_ST_O_* into appctx->st0.
1005 */
1006
1007 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001008 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001009 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001010 else {
1011 /*
1012 * Look for the "payload start" pattern at the end of a line
1013 * Its location is not remembered here, this is just to switch
1014 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001015 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001016 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001017 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001018 appctx->chunk->data++; // keep the trailing \0 after '<<'
1019 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001020 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001021 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001022 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001023 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001024 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001025 }
1026
1027 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001028 co_skip(sc_oc(sc), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001029 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1030 }
1031 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001032 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001033 const char *msg;
1034 int sev;
1035
William Lallemand74c24fb2016-11-21 17:18:36 +01001036 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001037 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001039 case CLI_ST_PRINT: /* print const message in msg */
1040 case CLI_ST_PRINT_ERR: /* print const error in msg */
1041 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1042 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001043 /* the message is in the svcctx */
1044 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001045 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1046 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001047 LOG_ERR : ctx->severity;
1048 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001049 }
1050 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1051 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001052 LOG_ERR : ctx->severity;
1053 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001054 if (!msg) {
1055 sev = LOG_ERR;
1056 msg = "Out of memory.\n";
1057 }
1058 }
1059 else {
1060 sev = LOG_ERR;
1061 msg = "Internal error.\n";
1062 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001063
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001064 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1065 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1066 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001067 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001068 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001069 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001070 }
1071 else
Willy Tarreau475e4632022-05-27 10:26:46 +02001072 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001073 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001074
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001075 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001076 if (appctx->io_handler)
1077 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001078 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001079 if (appctx->io_release) {
1080 appctx->io_release(appctx);
1081 appctx->io_release = NULL;
1082 }
1083 }
1084 break;
1085 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001086 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001087 break;
1088 }
1089
1090 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001091 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001092 const char *prompt = "";
1093
1094 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1095 /*
1096 * when entering a payload with interactive mode, change the prompt
1097 * to emphasize that more data can still be sent
1098 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001099 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001100 prompt = "+ ";
1101 else
1102 prompt = "\n> ";
1103 }
1104 else {
William Lallemandad032882019-07-01 10:56:15 +02001105 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001106 prompt = "\n";
1107 }
1108
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001109 if (applet_putstr(appctx, prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001110 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001111 }
1112
1113 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001114 if (appctx->st0 >= CLI_ST_OUTPUT) {
1115 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001116 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001117 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001118
1119 /* Now we close the output if one of the writers did so,
1120 * or if we're not in interactive mode and the request
1121 * buffer is empty. This still allows pipelined requests
1122 * to be sent in non-interactive mode.
1123 */
William Lallemand3de09d52018-12-11 16:10:56 +01001124 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1125 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001126 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001127 continue;
1128 }
1129
1130 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001131 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001132 applet_will_consume(appctx);
1133
William Lallemandad032882019-07-01 10:56:15 +02001134 /* reactivate the \n at the end of the response for the next command */
1135 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001136
1137 /* this forces us to yield between pipelined commands and
1138 * avoid extremely long latencies (e.g. "del map" etc). In
1139 * addition this increases the likelihood that the stream
1140 * refills the buffer with new bytes in non-interactive
1141 * mode, avoiding to close on apparently empty commands.
1142 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001143 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001144 appctx_wakeup(appctx);
1145 goto out;
1146 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001147 }
1148 }
1149
Willy Tarreau475e4632022-05-27 10:26:46 +02001150 if ((res->flags & CF_SHUTR) && (sc->state == SC_ST_EST)) {
1151 DPRINTF(stderr, "%s@%d: sc to buf closed. req=%08x, res=%08x, st=%d\n",
1152 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001153 /* Other side has closed, let's abort if we have no more processing to do
1154 * and nothing more to consume. This is comparable to a broken pipe, so
1155 * we forward the close to the request side so that it flows upstream to
1156 * the client.
1157 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001158 sc_shutw(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001159 }
1160
Willy Tarreau475e4632022-05-27 10:26:46 +02001161 if ((req->flags & CF_SHUTW) && (sc->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
1162 DPRINTF(stderr, "%s@%d: buf to sc closed. req=%08x, res=%08x, st=%d\n",
1163 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001164 /* We have no more processing to do, and nothing more to send, and
1165 * the client side has closed. So we'll forward this state downstream
1166 * on the response buffer.
1167 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001168 sc_shutr(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001169 res->flags |= CF_READ_NULL;
1170 }
1171
1172 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001173 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 +01001174 __FUNCTION__, __LINE__,
Willy Tarreau475e4632022-05-27 10:26:46 +02001175 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 +01001176}
1177
Willy Tarreau4596fe22022-05-17 19:07:51 +02001178/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001179 * external abort, we won't call the i/o handler anymore so we may need to
1180 * remove back references to the stream currently being dumped.
1181 */
1182static void cli_release_handler(struct appctx *appctx)
1183{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001184 free_trash_chunk(appctx->chunk);
1185 appctx->chunk = NULL;
1186
William Lallemand74c24fb2016-11-21 17:18:36 +01001187 if (appctx->io_release) {
1188 appctx->io_release(appctx);
1189 appctx->io_release = NULL;
1190 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001191 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001192 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1193
1194 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001195 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001196}
1197
1198/* This function dumps all environmnent variables to the buffer. It returns 0
1199 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001200 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1201 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001202 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001203static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001204{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001205 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001206 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001207 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001208
Willy Tarreau475e4632022-05-27 10:26:46 +02001209 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
William Lallemand74c24fb2016-11-21 17:18:36 +01001210 return 1;
1211
1212 chunk_reset(&trash);
1213
1214 /* we have two inner loops here, one for the proxy, the other one for
1215 * the buffer.
1216 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001217 while (*var) {
1218 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001219
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001220 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001221 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001222
Willy Tarreau307dbb32022-05-05 17:45:52 +02001223 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001224 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001225 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001226 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001227 }
1228
1229 /* dump complete */
1230 return 1;
1231}
1232
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001233/* This function dumps all file descriptors states (or the requested one) to
1234 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001235 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1236 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1237 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001238 */
1239static int cli_io_handler_show_fd(struct appctx *appctx)
1240{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001241 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001242 struct show_fd_ctx *fdctx = appctx->svcctx;
1243 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001244 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001245
Willy Tarreau475e4632022-05-27 10:26:46 +02001246 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001247 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001248
1249 chunk_reset(&trash);
1250
Willy Tarreauca1b1572018-12-18 15:45:11 +01001251 /* isolate the threads once per round. We're limited to a buffer worth
1252 * of output anyway, it cannot last very long.
1253 */
1254 thread_isolate();
1255
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001256 /* we have two inner loops here, one for the proxy, the other one for
1257 * the buffer.
1258 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001259 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001260 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001261 const struct listener *li = NULL;
1262 const struct server *sv = NULL;
1263 const struct proxy *px = NULL;
1264 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001265 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001266 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001267 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001268 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001269 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001270 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001271 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001272
1273 fdt = fdtab[fd];
1274
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001275 /* When DEBUG_FD is set, we also report closed FDs that have a
1276 * non-null event count to detect stuck ones.
1277 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001278 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001279#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001280 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001281#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001282 goto skip; // closed
1283 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001284 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001285 conn = (const struct connection *)fdt.owner;
1286 conn_flags = conn->flags;
1287 mux = conn->mux;
1288 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001289 xprt = conn->xprt;
1290 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001291 li = objt_listener(conn->target);
1292 sv = objt_server(conn->target);
1293 px = objt_proxy(conn->target);
1294 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001295 if (atleast2(fdt.thread_mask))
1296 suspicious = 1;
1297 if (conn->handle.fd != fd)
1298 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001299 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001300 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001301 li = fdt.owner;
1302
Willy Tarreaudacfde42021-01-21 09:07:29 +01001303 if (!fdt.thread_mask)
1304 suspicious = 1;
1305
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001306 chunk_printf(&trash,
Willy Tarreauc2431822022-07-08 10:23:01 +02001307 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) ref=%#x gid=%d tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001308 fd,
1309 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001310 (fdt.state & FD_CLONED) ? 'C' : 'c',
1311 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001312 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1313 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1314 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1315 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1316 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001317 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1318 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1319 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1320 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1321 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1322 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001323 (fdt.refc_tgid >> 4) & 0xffff,
1324 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001325 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001326 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001327 fdt.iocb);
1328 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001329
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001330 if (!fdt.owner) {
1331 chunk_appendf(&trash, ")");
1332 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001333 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001334 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001335
1336 if (conn->handle.fd != fd) {
1337 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1338 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001339 } else {
1340 struct sockaddr_storage sa;
1341 socklen_t salen;
1342
1343 salen = sizeof(sa);
1344 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1345 if (sa.ss_family == AF_INET)
1346 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1347 else if (sa.ss_family == AF_INET6)
1348 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1349 else if (sa.ss_family == AF_UNIX)
1350 chunk_appendf(&trash, " fam=unix");
1351 }
1352
1353 salen = sizeof(sa);
1354 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1355 if (sa.ss_family == AF_INET)
1356 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1357 else if (sa.ss_family == AF_INET6)
1358 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1359 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001360 }
1361
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001362 if (px)
1363 chunk_appendf(&trash, " px=%s", px->id);
1364 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001365 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001366 else if (li)
1367 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001368
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001369 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001370 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001371 if (!ctx)
1372 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001373 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001374 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001375 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001376 else
1377 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001378
1379 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001380 if (xprt) {
1381 if (xprt_ctx || xprt->show_fd)
1382 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1383 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001384 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001385 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001386 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001387 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001388 struct sockaddr_storage sa;
1389 socklen_t salen;
1390
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001391 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001392 listener_state_str(li),
1393 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001394
1395 salen = sizeof(sa);
1396 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1397 if (sa.ss_family == AF_INET)
1398 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1399 else if (sa.ss_family == AF_INET6)
1400 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1401 else if (sa.ss_family == AF_UNIX)
1402 chunk_appendf(&trash, " fam=unix");
1403 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001404 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001405 else
1406 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001407
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001408#ifdef DEBUG_FD
1409 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001410 if (fdtab[fd].event_count >= 1000000)
1411 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001412#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001413 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001414
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001415 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001416 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001417 ret = 0;
1418 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001419 }
1420 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001421 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001422 break;
1423
1424 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001425 }
1426
Willy Tarreauca1b1572018-12-18 15:45:11 +01001427 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001428 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001429
1430 thread_release();
1431 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001432}
1433
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001434/* This function dumps some activity counters used by developers and support to
1435 * rule out some hypothesis during bug reports. It returns 0 if the output
1436 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1437 * everything at once in the buffer and is not designed to do it in multiple
1438 * passes.
1439 */
1440static int cli_io_handler_show_activity(struct appctx *appctx)
1441{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001442 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001443 struct show_activity_ctx *actctx = appctx->svcctx;
1444 int tgt = actctx->thr; // target thread, -1 for all, 0 for total only
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001445 int thr;
1446
Willy Tarreau475e4632022-05-27 10:26:46 +02001447 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001448 return 1;
1449
1450 chunk_reset(&trash);
1451
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001452#undef SHOW_TOT
1453#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001454 do { \
1455 unsigned int _v[MAX_THREADS]; \
1456 unsigned int _tot; \
1457 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001458 _tot = t = 0; \
1459 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001460 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001461 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001462 if (_nbt == 1) { \
1463 chunk_appendf(&trash, " %u\n", _tot); \
1464 break; \
1465 } \
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001466 if (tgt == -1) { \
1467 chunk_appendf(&trash, " %u [", _tot); \
1468 for (t = 0; t < _nbt; t++) \
1469 chunk_appendf(&trash, " %u", _v[t]); \
1470 chunk_appendf(&trash, " ]\n"); \
1471 } else if (tgt == 0) \
1472 chunk_appendf(&trash, " %u\n", _tot); \
1473 else \
1474 chunk_appendf(&trash, " %u\n", _v[tgt-1]);\
Willy Tarreaua0211b82019-05-28 15:09:08 +02001475 } while (0)
1476
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001477#undef SHOW_AVG
1478#define SHOW_AVG(t, x) \
1479 do { \
1480 unsigned int _v[MAX_THREADS]; \
1481 unsigned int _tot; \
1482 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001483 _tot = t = 0; \
1484 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001485 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001486 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001487 if (_nbt == 1) { \
1488 chunk_appendf(&trash, " %u\n", _tot); \
1489 break; \
1490 } \
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001491 if (tgt == -1) { \
1492 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1493 for (t = 0; t < _nbt; t++) \
1494 chunk_appendf(&trash, " %u", _v[t]); \
1495 chunk_appendf(&trash, " ]\n"); \
1496 } else if (tgt == 0) \
1497 chunk_appendf(&trash, " %u\n", (_tot + _nbt/2) / _nbt); \
1498 else \
1499 chunk_appendf(&trash, " %u\n", _v[tgt-1]);\
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001500 } while (0)
1501
Willy Tarreaua0211b82019-05-28 15:09:08 +02001502 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1503 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001504 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1505 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1506 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1507 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001508 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001509 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1510 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001511 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001512 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001513 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001514 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001515 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001516 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001517 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1518 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001519 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1520 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1521 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1522 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1523 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1524 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1525 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001526#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001527 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 +02001528 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001529#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001530
Willy Tarreaud6a78502019-05-27 07:03:38 +02001531#if defined(DEBUG_DEV)
1532 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001533 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1534 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1535 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001536#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001537
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001538 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001539 chunk_reset(&trash);
1540 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001541 }
1542
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001543#undef SHOW_AVG
1544#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001545 /* dump complete */
1546 return 1;
1547}
1548
William Lallemandeceddf72016-12-15 18:06:44 +01001549/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001550 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001551 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1552 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001553 */
1554static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1555{
Willy Tarreaub128f492022-05-05 19:11:05 +02001556 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1557 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001558
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001559 if (!global.cli_fe)
1560 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001561
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001562 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001563
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001564 if (!bind_conf) {
1565 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001566 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001567 goto full;
1568 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1569 }
William Lallemandeceddf72016-12-15 18:06:44 +01001570
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001571 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001572 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001573
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001574 if (!l)
1575 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001576
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001577 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1578 char addr[46];
1579 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001580
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001581 if (l->rx.addr.ss_family == AF_UNIX) {
1582 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001583
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001584 un = (struct sockaddr_un *)&l->rx.addr;
1585 if (un->sun_path[0] == '\0') {
1586 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1587 } else {
1588 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1589 }
1590 } else if (l->rx.addr.ss_family == AF_INET) {
1591 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1592 port_to_str(&l->rx.addr, port, sizeof(port));
1593 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1594 } else if (l->rx.addr.ss_family == AF_INET6) {
1595 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1596 port_to_str(&l->rx.addr, port, sizeof(port));
1597 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1598 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1599 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1600 } else
1601 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001602
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001603 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1604 chunk_appendf(&trash, "admin ");
1605 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1606 chunk_appendf(&trash, "operator ");
1607 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1608 chunk_appendf(&trash, "user ");
1609 else
1610 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001611
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001612 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001613
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001614 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001615 ctx->bind_conf = bind_conf;
1616 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001617 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001618 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001619 }
William Lallemandeceddf72016-12-15 18:06:44 +01001620 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001621 done:
1622 return 1;
1623 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001624 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001625}
1626
1627
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001628/* parse a "show activity" CLI request. Returns 0 if it needs to continue, 1 if it
1629 * wants to stop here. It sets a show_activity_ctx context where, if a specific
1630 * thread is requested, it puts the thread number into ->thr otherwise sets it to
1631 * -1.
1632 */
1633static int cli_parse_show_activity(char **args, char *payload, struct appctx *appctx, void *private)
1634{
1635 struct show_activity_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1636
1637 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1638 return 1;
1639
1640 ctx->thr = -1; // show all by default
1641 if (*args[2])
1642 ctx->thr = atoi(args[2]);
1643
1644 if (ctx->thr < -1 || ctx->thr > global.nbthread)
1645 return cli_err(appctx, "Thread ID number must be between -1 and nbthread\n");
1646
1647 return 0;
1648}
1649
Willy Tarreau0a739292016-11-22 20:21:23 +01001650/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001651 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1652 * be dumped as well as a flag if a single variable is requested, otherwise puts
1653 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001654 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001655static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001656{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001657 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001658 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001659 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001660
1661 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1662 return 1;
1663
Willy Tarreauf6710f82016-12-16 17:45:44 +01001664 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001665
1666 if (*args[2]) {
1667 int len = strlen(args[2]);
1668
Willy Tarreauf6710f82016-12-16 17:45:44 +01001669 for (; *var; var++) {
1670 if (strncmp(*var, args[2], len) == 0 &&
1671 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001672 break;
1673 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001674 if (!*var)
1675 return cli_err(appctx, "Variable not found\n");
1676
Willy Tarreau307dbb32022-05-05 17:45:52 +02001677 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001678 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001679 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001680 return 0;
1681}
1682
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001683/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001684 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1685 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001686 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001687static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001688{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001689 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1690
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001691 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1692 return 1;
1693
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001694 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001695 ctx->fd = atoi(args[2]);
1696 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001697 }
1698 return 0;
1699}
1700
Willy Tarreau599852e2016-11-22 20:33:32 +01001701/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001702static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001703{
Willy Tarreau0698c802022-05-11 14:09:57 +02001704 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001705
1706 if (strcmp(args[2], "cli") == 0) {
1707 unsigned timeout;
1708 const char *res;
1709
Willy Tarreau9d008692019-08-09 11:21:01 +02001710 if (!*args[3])
1711 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001712
1713 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001714 if (res || timeout < 1)
1715 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001716
1717 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1718 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1719 return 1;
1720 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001721
1722 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001723}
1724
Willy Tarreau2af99412016-11-23 11:10:59 +01001725/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001726static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001727{
1728 int v;
1729
1730 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1731 return 1;
1732
Willy Tarreau9d008692019-08-09 11:21:01 +02001733 if (!*args[3])
1734 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001735
1736 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001737 if (v > global.hardmaxconn)
1738 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001739
1740 /* check for unlimited values */
1741 if (v <= 0)
1742 v = global.hardmaxconn;
1743
1744 global.maxconn = v;
1745
1746 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001747 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001748
1749 return 1;
1750}
1751
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001752static int set_severity_output(int *target, char *argument)
1753{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001754 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001755 *target = CLI_SEVERITY_NONE;
1756 return 1;
1757 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001758 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001759 *target = CLI_SEVERITY_NUMBER;
1760 return 1;
1761 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001762 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001763 *target = CLI_SEVERITY_STRING;
1764 return 1;
1765 }
1766 return 0;
1767}
1768
1769/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001770static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001771{
1772 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1773 return 0;
1774
Willy Tarreau9d008692019-08-09 11:21:01 +02001775 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001776}
William Lallemandeceddf72016-12-15 18:06:44 +01001777
William Lallemand67a234f2018-12-13 09:05:45 +01001778
1779/* show the level of the current CLI session */
1780static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1781{
William Lallemand67a234f2018-12-13 09:05:45 +01001782 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001783 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001784 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001785 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001786 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001787 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001788 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001789 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001790}
1791
1792/* parse and set the CLI level dynamically */
1793static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1794{
William Lallemandad032882019-07-01 10:56:15 +02001795 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001796 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001797 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1798
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001799 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001800 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1801 return 1;
1802 }
1803 appctx->cli_level &= ~ACCESS_LVL_MASK;
1804 appctx->cli_level |= ACCESS_LVL_OPER;
1805
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001806 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001807 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1808 return 1;
1809 }
1810 appctx->cli_level &= ~ACCESS_LVL_MASK;
1811 appctx->cli_level |= ACCESS_LVL_USER;
1812 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001813 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001814 return 1;
1815}
1816
1817
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001818/* parse and set the CLI expert/experimental-mode dynamically */
1819static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001820{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001821 int level;
1822 char *level_str;
1823 char *output = NULL;
1824
William Lallemand7267f782022-02-01 16:08:50 +01001825 /* this will ask the applet to not output a \n after the command */
1826 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1827 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1828
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001829 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1830 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001831
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001832 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001833 level = ACCESS_EXPERT;
1834 level_str = "expert-mode";
1835 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001836 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001837 level = ACCESS_EXPERIMENTAL;
1838 level_str = "experimental-mode";
1839 }
William Lallemand2a171912022-02-02 11:43:20 +01001840 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1841 level = ACCESS_MCLI_DEBUG;
1842 level_str = "mcli-debug-mode";
1843 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001844 else {
1845 return 1;
1846 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001847
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001848 if (!*args[1]) {
1849 memprintf(&output, "%s is %s\n", level_str,
1850 (appctx->cli_level & level) ? "ON" : "OFF");
1851 return cli_dynmsg(appctx, LOG_INFO, output);
1852 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001853
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001854 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001855 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001856 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001857 return 1;
1858}
1859
William Lallemand740629e2021-12-14 15:22:29 +01001860/* shows HAProxy version */
1861static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1862{
1863 char *msg = NULL;
1864
1865 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1866}
1867
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001868int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001869{
1870 return 0;
1871}
1872
Willy Tarreau45c742b2016-11-24 14:51:17 +01001873/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001874static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001875{
1876 int v;
1877 int *res;
1878 int mul = 1;
1879
1880 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1881 return 1;
1882
1883 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1884 res = &global.cps_lim;
1885 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1886 res = &global.sps_lim;
1887#ifdef USE_OPENSSL
1888 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1889 res = &global.ssl_lim;
1890#endif
1891 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1892 res = &global.comp_rate_lim;
1893 mul = 1024;
1894 }
1895 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001896 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001897 "'set rate-limit' only supports :\n"
1898 " - 'connections global' to set the per-process maximum connection rate\n"
1899 " - 'sessions global' to set the per-process maximum session rate\n"
1900#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001901 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001902#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001903 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001904 }
1905
Willy Tarreau9d008692019-08-09 11:21:01 +02001906 if (!*args[4])
1907 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001908
1909 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001910 if (v < 0)
1911 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001912
1913 *res = v * mul;
1914
1915 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001916 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001917
1918 return 1;
1919}
1920
William Lallemandf6975e92017-05-26 17:42:10 +02001921/* parse the "expose-fd" argument on the bind lines */
1922static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1923{
1924 if (!*args[cur_arg + 1]) {
1925 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1926 return ERR_ALERT | ERR_FATAL;
1927 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001928 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001929 conf->level |= ACCESS_FD_LISTENERS;
1930 } else {
1931 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1932 args[cur_arg], args[cur_arg+1]);
1933 return ERR_ALERT | ERR_FATAL;
1934 }
1935
1936 return 0;
1937}
1938
William Lallemand74c24fb2016-11-21 17:18:36 +01001939/* parse the "level" argument on the bind lines */
1940static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1941{
1942 if (!*args[cur_arg + 1]) {
1943 memprintf(err, "'%s' : missing level", args[cur_arg]);
1944 return ERR_ALERT | ERR_FATAL;
1945 }
1946
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001947 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001948 conf->level &= ~ACCESS_LVL_MASK;
1949 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001950 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001951 conf->level &= ~ACCESS_LVL_MASK;
1952 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001953 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001954 conf->level &= ~ACCESS_LVL_MASK;
1955 conf->level |= ACCESS_LVL_ADMIN;
1956 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001957 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1958 args[cur_arg], args[cur_arg+1]);
1959 return ERR_ALERT | ERR_FATAL;
1960 }
1961
1962 return 0;
1963}
1964
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001965static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1966{
1967 if (!*args[cur_arg + 1]) {
1968 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1969 return ERR_ALERT | ERR_FATAL;
1970 }
1971
1972 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1973 return 0;
1974 else {
1975 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1976 args[cur_arg], args[cur_arg+1]);
1977 return ERR_ALERT | ERR_FATAL;
1978 }
1979}
1980
Olivier Houchardf886e342017-04-05 22:24:59 +02001981/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001982static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001983{
1984 char *cmsgbuf = NULL;
1985 unsigned char *tmpbuf = NULL;
1986 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001987 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02001988 struct stream *s = __sc_strm(sc);
1989 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02001990 struct msghdr msghdr;
1991 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001992 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001993 const char *ns_name, *if_name;
1994 unsigned char ns_nlen, if_nlen;
1995 int nb_queued;
1996 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001997 int *tmpfd;
1998 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001999 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002001 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002002 int ret;
2003
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002004 if (!remote) {
2005 ha_warning("Only works on real connections\n");
2006 goto out;
2007 }
2008
2009 fd = remote->handle.fd;
2010
Olivier Houchardf886e342017-04-05 22:24:59 +02002011 /* Temporary set the FD in blocking mode, that will make our life easier */
2012 old_fcntl = fcntl(fd, F_GETFL);
2013 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002014 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002015 goto out;
2016 }
2017 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2018 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002019 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002020 goto out;
2021 }
2022 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002023 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002024 goto out;
2025 }
Olivier Houchard54740872017-04-06 14:45:14 +02002026 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002027 iov.iov_base = &tot_fd_nb;
2028 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002029 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002030 goto out;
2031 memset(&msghdr, 0, sizeof(msghdr));
2032 /*
2033 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002034 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002035 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002036 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002037 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002038
Olivier Houchardf886e342017-04-05 22:24:59 +02002039 if (tot_fd_nb == 0)
2040 goto out;
2041
2042 /* First send the total number of file descriptors, so that the
2043 * receiving end knows what to expect.
2044 */
2045 msghdr.msg_iov = &iov;
2046 msghdr.msg_iovlen = 1;
2047 ret = sendmsg(fd, &msghdr, 0);
2048 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002049 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002050 goto out;
2051 }
2052
2053 /* Now send the fds */
2054 msghdr.msg_control = cmsgbuf;
2055 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2056 cmsg = CMSG_FIRSTHDR(&msghdr);
2057 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2058 cmsg->cmsg_level = SOL_SOCKET;
2059 cmsg->cmsg_type = SCM_RIGHTS;
2060 tmpfd = (int *)CMSG_DATA(cmsg);
2061
Olivier Houchardf886e342017-04-05 22:24:59 +02002062 /* For each socket, e message is sent, containing the following :
2063 * Size of the namespace name (or 0 if none), as an unsigned char.
2064 * The namespace name, if any
2065 * Size of the interface name (or 0 if none), as an unsigned char
2066 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002067 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002068 */
2069 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002070 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002071 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002072 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002073 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002074 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002075 goto out;
2076 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002077
2078 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002079 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002080 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002081 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002082 continue;
2083
2084 ns_name = if_name = "";
2085 ns_nlen = if_nlen = 0;
2086
2087 /* for now we can only retrieve namespaces and interfaces from
2088 * pure listeners.
2089 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002090 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002091 const struct listener *l = fdtab[cur_fd].owner;
2092
Willy Tarreau818a92e2020-09-03 07:50:19 +02002093 if (l->rx.settings->interface) {
2094 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002095 if_nlen = strlen(if_name);
2096 }
2097
2098#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002099 if (l->rx.settings->netns) {
2100 ns_name = l->rx.settings->netns->node.key;
2101 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002102 }
2103#endif
2104 }
2105
2106 /* put the FD into the CMSG_DATA */
2107 tmpfd[nb_queued++] = cur_fd;
2108
2109 /* first block is <ns_name_len> <ns_name> */
2110 tmpbuf[curoff++] = ns_nlen;
2111 if (ns_nlen)
2112 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2113 curoff += ns_nlen;
2114
2115 /* second block is <if_name_len> <if_name> */
2116 tmpbuf[curoff++] = if_nlen;
2117 if (if_nlen)
2118 memcpy(tmpbuf + curoff, if_name, if_nlen);
2119 curoff += if_nlen;
2120
2121 /* we used to send the listener options here before 2.3 */
2122 memset(tmpbuf + curoff, 0, sizeof(int));
2123 curoff += sizeof(int);
2124
2125 /* there's a limit to how many FDs may be sent at once */
2126 if (nb_queued == MAX_SEND_FD) {
2127 iov.iov_len = curoff;
2128 if (sendmsg(fd, &msghdr, 0) != curoff) {
2129 ha_warning("Failed to transfer sockets\n");
2130 return -1;
2131 }
2132
2133 /* Wait for an ack */
2134 do {
2135 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2136 } while (ret == -1 && errno == EINTR);
2137
2138 if (ret <= 0) {
2139 ha_warning("Unexpected error while transferring sockets\n");
2140 return -1;
2141 }
2142 curoff = 0;
2143 nb_queued = 0;
2144 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002145 }
2146
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002147 /* flush pending stuff */
2148 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002149 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002150 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2151 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002152 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002153 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002154 goto out;
2155 }
2156 }
2157
2158out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002159 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002160 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002161 goto out;
2162 }
2163 appctx->st0 = CLI_ST_END;
2164 free(cmsgbuf);
2165 free(tmpbuf);
2166 return 1;
2167}
2168
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002169static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2170{
2171 if (*args[0] == 'h')
2172 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002173 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002174 else if (*args[0] == 'p')
2175 /* prompt */
2176 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2177 else if (*args[0] == 'q')
2178 /* quit */
2179 appctx->st0 = CLI_ST_END;
2180
2181 return 1;
2182}
Olivier Houchardf886e342017-04-05 22:24:59 +02002183
William Lallemand2f4ce202018-10-26 14:47:47 +02002184void pcli_write_prompt(struct stream *s)
2185{
2186 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002187 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002188
William Lallemanddc12c2e2018-12-13 09:05:46 +01002189 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002190 return;
2191
William Lallemanddc12c2e2018-12-13 09:05:46 +01002192 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002193 chunk_appendf(msg, "+ ");
2194 } else {
2195 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002196 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002197 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002198 else
William Lallemanddae12c72022-02-02 14:13:54 +01002199 chunk_appendf(msg, "%d", s->pcli_next_pid);
2200
2201 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2202 chunk_appendf(msg, "(");
2203
2204 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2205 chunk_appendf(msg, "x");
2206
2207 if (s->pcli_flags & ACCESS_EXPERT)
2208 chunk_appendf(msg, "e");
2209
2210 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2211 chunk_appendf(msg, "d");
2212
2213 chunk_appendf(msg, ")");
2214 }
2215
2216 chunk_appendf(msg, "> ");
2217
2218
William Lallemandebf61802018-12-11 16:10:57 +01002219 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002220 co_inject(oc, msg->area, msg->data);
2221}
2222
William Lallemand291810d2018-10-26 14:47:38 +02002223
William Lallemandcf62f7e2018-10-26 14:47:40 +02002224/* The pcli_* functions are used for the CLI proxy in the master */
2225
William Lallemanddeeaa592018-10-26 14:47:48 +02002226void pcli_reply_and_close(struct stream *s, const char *msg)
2227{
2228 struct buffer *buf = get_trash_chunk();
2229
2230 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002231 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002232}
2233
William Lallemand291810d2018-10-26 14:47:38 +02002234static enum obj_type *pcli_pid_to_server(int proc_pid)
2235{
2236 struct mworker_proc *child;
2237
William Lallemand99e0bb92020-11-05 10:28:53 +01002238 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002239 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002240 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002241
William Lallemand291810d2018-10-26 14:47:38 +02002242 list_for_each_entry(child, &proc_list, list) {
2243 if (child->pid == proc_pid){
2244 return &child->srv->obj_type;
2245 }
2246 }
2247 return NULL;
2248}
2249
2250/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2251 * Return:
2252 * 0: master
2253 * > 0: pid of a worker
2254 * < 0: didn't find a worker
2255 */
2256static int pcli_prefix_to_pid(const char *prefix)
2257{
2258 int proc_pid;
2259 struct mworker_proc *child;
2260 char *errtol = NULL;
2261
2262 if (*prefix != '@') /* not a prefix, should not happen */
2263 return -1;
2264
2265 prefix++;
2266 if (!*prefix) /* sent @ alone, return the master */
2267 return 0;
2268
2269 if (strcmp("master", prefix) == 0) {
2270 return 0;
2271 } else if (*prefix == '!') {
2272 prefix++;
2273 if (!*prefix)
2274 return -1;
2275
2276 proc_pid = strtol(prefix, &errtol, 10);
2277 if (*errtol != '\0')
2278 return -1;
2279 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002280 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002281 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002282 if (child->pid == proc_pid){
2283 return child->pid;
2284 }
2285 }
2286 } else {
2287 struct mworker_proc *chosen = NULL;
2288 /* this is a relative pid */
2289
2290 proc_pid = strtol(prefix, &errtol, 10);
2291 if (*errtol != '\0')
2292 return -1;
2293
2294 if (proc_pid == 0) /* return the master */
2295 return 0;
2296
William Lallemandbac3a822022-07-20 14:30:56 +02002297 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2298 return -1;
2299
William Lallemand291810d2018-10-26 14:47:38 +02002300 /* chose the right process, the current one is the one with the
2301 least number of reloads */
2302 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002303 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002304 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002305 if (child->reloads == 0)
2306 return child->pid;
2307 else if (chosen == NULL || child->reloads < chosen->reloads)
2308 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002309 }
2310 if (chosen)
2311 return chosen->pid;
2312 }
2313 return -1;
2314}
2315
William Lallemandbddd33a2018-12-11 16:10:53 +01002316/* Return::
2317 * >= 0 : number of words to escape
2318 * = -1 : error
2319 */
2320
2321int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2322{
2323 if (argl < 1)
2324 return 0;
2325
2326 /* there is a prefix */
2327 if (args[0][0] == '@') {
2328 int target_pid = pcli_prefix_to_pid(args[0]);
2329
2330 if (target_pid == -1) {
2331 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2332 return -1;
2333 }
2334
2335 /* if the prefix is alone, define a default target */
2336 if (argl == 1)
2337 s->pcli_next_pid = target_pid;
2338 else
2339 *next_pid = target_pid;
2340 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002341 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002342 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002343 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002344
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002345 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002346 channel_shutr_now(&s->req);
2347 channel_shutw_now(&s->res);
2348 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002349 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002350 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2351 memprintf(errmsg, "Permission denied!\n");
2352 return -1;
2353 }
2354 s->pcli_flags &= ~ACCESS_LVL_MASK;
2355 s->pcli_flags |= ACCESS_LVL_OPER;
2356 return argl;
2357
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002358 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002359 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2360 memprintf(errmsg, "Permission denied!\n");
2361 return -1;
2362 }
2363 s->pcli_flags &= ~ACCESS_LVL_MASK;
2364 s->pcli_flags |= ACCESS_LVL_USER;
2365 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002366
2367 } else if (strcmp(args[0], "expert-mode") == 0) {
2368 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2369 memprintf(errmsg, "Permission denied!\n");
2370 return -1;
2371 }
2372
2373 s->pcli_flags &= ~ACCESS_EXPERT;
2374 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2375 s->pcli_flags |= ACCESS_EXPERT;
2376 return argl;
2377
2378 } else if (strcmp(args[0], "experimental-mode") == 0) {
2379 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2380 memprintf(errmsg, "Permission denied!\n");
2381 return -1;
2382 }
2383 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2384 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2385 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2386 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002387 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2388 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2389 memprintf(errmsg, "Permission denied!\n");
2390 return -1;
2391 }
2392 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2393 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2394 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2395 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002396 }
2397
2398 return 0;
2399}
2400
2401/*
2402 * Parse the CLI request:
2403 * - It does basically the same as the cli_io_handler, but as a proxy
2404 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002405 *
2406 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002407 * - the number of characters to forward or
2408 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002409 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002410int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002411{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002412 char *str;
2413 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002414 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002415 int argl; /* number of args */
2416 char *p;
2417 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002418 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002419 int wtrim = 0; /* number of words to trim */
2420 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002421 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002422 int i = 0;
2423
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002424 /* we cannot deal with a wrapping buffer, so let's take care of this
2425 * first.
2426 */
2427 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2428 b_slow_realign(&req->buf, trash.area, co_data(req));
2429
2430 str = (char *)ci_head(req);
2431 end = (char *)ci_stop(req);
2432
William Lallemandbddd33a2018-12-11 16:10:53 +01002433 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434
William Lallemanddc12c2e2018-12-13 09:05:46 +01002435 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002436
2437 /* Looks for the end of one command */
2438 while (p+reql < end) {
2439 /* handle escaping */
2440 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002441 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002442 continue;
2443 }
2444 if (p[reql] == ';' || p[reql] == '\n') {
2445 /* found the end of the command */
2446 p[reql] = '\n';
2447 reql++;
2448 break;
2449 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002451 }
William Lallemandebf61802018-12-11 16:10:57 +01002452 } else {
2453 while (p+reql < end) {
2454 if (p[reql] == '\n') {
2455 /* found the end of the line */
2456 reql++;
2457 break;
2458 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002459 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002460 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002461 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002462
William Lallemandbddd33a2018-12-11 16:10:53 +01002463 /* set end to first byte after the end of the command */
2464 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002465
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002467 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002468 return -1;
2469 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002470
William Lallemand3301f3e2018-12-13 09:05:48 +01002471 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2472 if (reql == 1) /* last line of the payload */
2473 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002474 return reql;
2475 }
2476
William Lallemandbddd33a2018-12-11 16:10:53 +01002477 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002478
William Lallemandbddd33a2018-12-11 16:10:53 +01002479 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002480 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002481 /* skip leading spaces/tabs */
2482 p += strspn(p, " \t");
2483 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002484 break;
2485
William Lallemandbddd33a2018-12-11 16:10:53 +01002486 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002487 while (1) {
2488 p += strcspn(p, " \t\\");
2489 /* escaped chars using backlashes (\) */
2490 if (*p == '\\') {
2491 if (!*++p)
2492 break;
2493 if (!*++p)
2494 break;
2495 } else {
2496 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002497 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002498 }
William Lallemandfe249c32020-06-18 18:03:57 +02002499 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002500 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002501 }
2502
William Lallemandbddd33a2018-12-11 16:10:53 +01002503 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002504
Willy Tarreauf14c7572021-03-13 10:59:23 +01002505 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002506 args[i] = NULL;
2507
2508 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2509
2510 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002511 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002512 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002513 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002514 if (*p == '\0')
2515 *p = ' ';
2516 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002517 }
2518
William Lallemand3301f3e2018-12-13 09:05:48 +01002519 payload = strstr(str, PAYLOAD_PATTERN);
2520 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2521 /* if the payload pattern is at the end */
2522 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002523 }
2524
William Lallemandbddd33a2018-12-11 16:10:53 +01002525 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002526
William Lallemandbddd33a2018-12-11 16:10:53 +01002527 if (wtrim > 0) {
2528 trim = &args[wtrim][0];
2529 if (trim == NULL) /* if this was the last word in the table */
2530 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002531
William Lallemandbddd33a2018-12-11 16:10:53 +01002532 b_del(&req->buf, trim - str);
2533
William Lallemandb7ea1412018-12-13 09:05:47 +01002534 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002535 } else if (wtrim < 0) {
2536 /* parsing error */
2537 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002538 } else {
2539 /* the whole string */
2540 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002541 }
2542
William Lallemandb7ea1412018-12-13 09:05:47 +01002543 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002544
2545 /* the mcli-debug-mode is only sent to the applet of the master */
2546 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2547 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2548 ret += strlen("mcli-debug-mode on -") + 2;
2549 }
William Lallemand7267f782022-02-01 16:08:50 +01002550 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2551 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2552 ret += strlen("experimental-mode on -") + 2;
2553 }
2554 if (s->pcli_flags & ACCESS_EXPERT) {
2555 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2556 ret += strlen("expert-mode on -") + 2;
2557 }
2558
William Lallemandb7ea1412018-12-13 09:05:47 +01002559 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2560 goto end;
2561 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002562 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2563 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002564 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002565 ci_insert_line2(req, 0, "user -", strlen("user -"));
2566 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002567 }
2568 }
2569end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002570
William Lallemandb7ea1412018-12-13 09:05:47 +01002571 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002572}
2573
2574int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2575{
William Lallemandbddd33a2018-12-11 16:10:53 +01002576 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002577 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002578 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002579
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002580 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002581 * current one. Just wait. At this stage, errors should be handled by
2582 * the response analyzer.
2583 */
2584 if (s->res.analysers & AN_RES_WAIT_CLI)
2585 return 0;
2586
William Lallemandb7ea1412018-12-13 09:05:47 +01002587 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2588 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2589
William Lallemandcf62f7e2018-10-26 14:47:40 +02002590read_again:
2591 /* if the channel is closed for read, we won't receive any more data
2592 from the client, but we don't want to forward this close to the
2593 server */
2594 channel_dont_close(req);
2595
2596 /* We don't know yet to which server we will connect */
2597 channel_dont_connect(req);
2598
William Lallemandcf62f7e2018-10-26 14:47:40 +02002599 req->flags |= CF_READ_DONTWAIT;
2600
2601 /* need more data */
2602 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002603 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002604
2605 /* If there is data available for analysis, log the end of the idle time. */
2606 if (c_data(req) && s->logs.t_idle == -1)
2607 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2608
William Lallemandbddd33a2018-12-11 16:10:53 +01002609 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002610 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002611 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002612 /* enough data */
2613
William Lallemandcf62f7e2018-10-26 14:47:40 +02002614 /* forward only 1 command */
2615 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002616
William Lallemanddc12c2e2018-12-13 09:05:46 +01002617 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002618 /* we send only 1 command per request, and we write close after it */
2619 channel_shutw_now(req);
2620 } else {
2621 pcli_write_prompt(s);
2622 }
2623
2624 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002625 s->res.analysers |= AN_RES_WAIT_CLI;
2626
William Lallemandebf61802018-12-11 16:10:57 +01002627 if (!(s->flags & SF_ASSIGNED)) {
2628 if (next_pid > -1)
2629 target_pid = next_pid;
2630 else
2631 target_pid = s->pcli_next_pid;
2632 /* we can connect now */
2633 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002634
William Lallemanddcbe7b92021-12-10 14:14:53 +01002635 if (!s->target)
2636 goto server_disconnect;
2637
William Lallemandebf61802018-12-11 16:10:57 +01002638 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2639 channel_auto_connect(req);
2640 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002641
2642 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002643 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002644 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002645 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002646 } else if (to_forward == -1) {
2647 if (errmsg) {
2648 /* there was an error during the parsing */
2649 pcli_reply_and_close(s, errmsg);
2650 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2651 return 0;
2652 }
2653 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002654 }
2655
2656 return 0;
2657
2658send_help:
2659 b_reset(&req->buf);
2660 b_putblk(&req->buf, "help\n", 5);
2661 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002662
Christopher Faulet0f727da2022-01-18 08:44:23 +01002663missing_data:
2664 if (req->flags & CF_SHUTR) {
2665 /* There is no more request or a only a partial one and we
2666 * receive a close from the client, we can leave */
2667 channel_shutw_now(&s->res);
2668 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2669 return 1;
2670 }
2671 else if (channel_full(req, global.tune.maxrewrite)) {
2672 /* buffer is full and we didn't catch the end of a command */
2673 goto send_help;
2674 }
2675 return 0;
2676
William Lallemanddcbe7b92021-12-10 14:14:53 +01002677server_disconnect:
2678 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2679 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002680}
2681
2682int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2683{
2684 struct proxy *fe = strm_fe(s);
2685 struct proxy *be = s->be;
2686
Christopher Faulete8cefac2022-03-07 18:20:21 +01002687 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2688 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002689 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002690 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002691 s->res.analysers &= ~AN_RES_WAIT_CLI;
2692 return 0;
2693 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002694 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2695 rep->flags |= CF_NEVER_WAIT;
2696
2697 /* don't forward the close */
2698 channel_dont_close(&s->res);
2699 channel_dont_close(&s->req);
2700
William Lallemanddc12c2e2018-12-13 09:05:46 +01002701 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002702 s->res.analysers &= ~AN_RES_WAIT_CLI;
2703 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2704 return 0;
2705 }
2706
William Lallemandcf62f7e2018-10-26 14:47:40 +02002707 /* forward the data */
2708 if (ci_data(rep)) {
2709 c_adv(rep, ci_data(rep));
2710 return 0;
2711 }
2712
2713 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2714 /* stream cleanup */
2715
William Lallemand2f4ce202018-10-26 14:47:47 +02002716 pcli_write_prompt(s);
2717
Willy Tarreaucb041662022-05-17 19:44:42 +02002718 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreauf61dd192022-05-27 09:00:19 +02002719 sc_shutr(s->scb);
2720 sc_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002721
2722 /*
2723 * starting from there this the same code as
2724 * http_end_txn_clean_session().
2725 *
2726 * It allows to do frontend keepalive while reconnecting to a
2727 * new server for each request.
2728 */
2729
2730 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002731 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002732 if (unlikely(s->srv_conn))
2733 sess_change_server(s, NULL);
2734 }
2735
2736 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2737 stream_process_counters(s);
2738
2739 /* don't count other requests' data */
2740 s->logs.bytes_in -= ci_data(&s->req);
2741 s->logs.bytes_out -= ci_data(&s->res);
2742
2743 /* we may need to know the position in the queue */
2744 pendconn_free(s);
2745
2746 /* let's do a final log if we need it */
2747 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2748 !(s->flags & SF_MONITOR) &&
2749 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2750 s->do_log(s);
2751 }
2752
2753 /* stop tracking content-based counters */
2754 stream_stop_content_counters(s);
2755 stream_update_time_stats(s);
2756
2757 s->logs.accept_date = date; /* user-visible date for logging */
2758 s->logs.tv_accept = now; /* corrected date for internal use */
2759 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2760 s->logs.t_idle = -1;
2761 tv_zero(&s->logs.tv_request);
2762 s->logs.t_queue = -1;
2763 s->logs.t_connect = -1;
2764 s->logs.t_data = -1;
2765 s->logs.t_close = 0;
2766 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2767 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2768
2769 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2770 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2771
2772 stream_del_srv_conn(s);
2773 if (objt_server(s->target)) {
2774 if (s->flags & SF_CURR_SESS) {
2775 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002776 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002777 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002778 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002779 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002780 }
2781
2782 s->target = NULL;
2783
2784 /* only release our endpoint if we don't intend to reuse the
2785 * connection.
2786 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002787 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002788 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002789 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002790 if (!s->conn_err_type)
2791 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002792 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002793 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002794 return 1;
2795 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002796 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002797 }
2798
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002799 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002800
Willy Tarreau74568cf2022-05-27 09:03:30 +02002801 sc_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002802 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 +02002803 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 +02002804 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 +02002805 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002806 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2807 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002808 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002809 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002810 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002811 /* reinitialise the current rule list pointer to NULL. We are sure that
2812 * any rulelist match the NULL pointer.
2813 */
2814 s->current_rule_list = NULL;
2815
2816 s->be = strm_fe(s);
2817 s->logs.logwait = strm_fe(s)->to_log;
2818 s->logs.level = 0;
2819 stream_del_srv_conn(s);
2820 s->target = NULL;
2821 /* re-init store persistence */
2822 s->store_count = 0;
2823 s->uniq_id = global.req_count++;
2824
2825 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2826
2827 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2828
William Lallemandcf62f7e2018-10-26 14:47:40 +02002829 s->res.analysers &= ~AN_RES_WAIT_CLI;
2830
2831 /* We must trim any excess data from the response buffer, because we
2832 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002833 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002834 * we want those data to come along with next response. A typical
2835 * example of such data would be from a buggy server responding to
2836 * a HEAD with some data, or sending more than the advertised
2837 * content-length.
2838 */
2839 if (unlikely(ci_data(&s->res)))
2840 b_set_data(&s->res.buf, co_data(&s->res));
2841
2842 /* Now we can realign the response buffer */
2843 c_realign_if_empty(&s->res);
2844
2845 s->req.rto = strm_fe(s)->timeout.client;
2846 s->req.wto = TICK_ETERNITY;
2847
2848 s->res.rto = TICK_ETERNITY;
2849 s->res.wto = strm_fe(s)->timeout.client;
2850
2851 s->req.rex = TICK_ETERNITY;
2852 s->req.wex = TICK_ETERNITY;
2853 s->req.analyse_exp = TICK_ETERNITY;
2854 s->res.rex = TICK_ETERNITY;
2855 s->res.wex = TICK_ETERNITY;
2856 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002857 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002858
2859 /* we're removing the analysers, we MUST re-enable events detection.
2860 * We don't enable close on the response channel since it's either
2861 * already closed, or in keep-alive with an idle connection handler.
2862 */
2863 channel_auto_read(&s->req);
2864 channel_auto_close(&s->req);
2865 channel_auto_read(&s->res);
2866
2867
2868 return 1;
2869 }
2870 return 0;
2871}
2872
William Lallemand8a022572018-10-26 14:47:35 +02002873/*
2874 * The mworker functions are used to initialize the CLI in the master process
2875 */
2876
William Lallemand309dc9a2018-10-26 14:47:45 +02002877 /*
2878 * Stop the mworker proxy
2879 */
2880void mworker_cli_proxy_stop()
2881{
William Lallemand550db6d2018-11-06 17:37:12 +01002882 if (mworker_proxy)
2883 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002884}
2885
William Lallemand8a022572018-10-26 14:47:35 +02002886/*
2887 * Create the mworker CLI proxy
2888 */
2889int mworker_cli_proxy_create()
2890{
2891 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002892 char *msg = NULL;
2893 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002894
William Lallemandae787ba2021-07-29 15:13:22 +02002895 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002896 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002897 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002898
William Lallemandcf62f7e2018-10-26 14:47:40 +02002899 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002900 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2901 mworker_proxy->timeout.client = 0; /* no timeout */
2902 mworker_proxy->conf.file = strdup("MASTER");
2903 mworker_proxy->conf.line = 0;
2904 mworker_proxy->accept = frontend_accept;
2905 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2906
2907 /* Does not init the default target the CLI applet, but must be done in
2908 * the request parsing code */
2909 mworker_proxy->default_target = NULL;
2910
William Lallemand8a022572018-10-26 14:47:35 +02002911 /* create all servers using the mworker_proc list */
2912 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002913 struct server *newsrv = NULL;
2914 struct sockaddr_storage *sk;
2915 int port1, port2, port;
2916 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002917
William Lallemanda31b09e2020-01-14 15:25:02 +01002918 /* only the workers support the master CLI */
2919 if (!(child->options & PROC_O_TYPE_WORKER))
2920 continue;
2921
William Lallemand8a022572018-10-26 14:47:35 +02002922 newsrv = new_server(mworker_proxy);
2923 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002924 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002925
2926 /* we don't know the new pid yet */
2927 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002928 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002929 else
2930 memprintf(&msg, "old-%d", child->pid);
2931
2932 newsrv->next = mworker_proxy->srv;
2933 mworker_proxy->srv = newsrv;
2934 newsrv->conf.file = strdup(msg);
2935 newsrv->id = strdup(msg);
2936 newsrv->conf.line = 0;
2937
2938 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002939 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002940 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002941 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002942 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002943 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002944
Willy Tarreau5fc93282020-09-16 18:25:03 +02002945 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002946 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002947 }
2948
2949 /* no port specified */
2950 newsrv->flags |= SRV_F_MAPPORTS;
2951 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002952 /* don't let the server participate to load balancing */
2953 newsrv->iweight = 0;
2954 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002955 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002956
2957 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002958 }
William Lallemandae787ba2021-07-29 15:13:22 +02002959
2960 mworker_proxy->next = proxies_list;
2961 proxies_list = mworker_proxy;
2962
William Lallemand8a022572018-10-26 14:47:35 +02002963 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002964
2965error:
William Lallemand744a0892018-11-22 16:46:51 +01002966
2967 list_for_each_entry(child, &proc_list, list) {
2968 free((char *)child->srv->conf.file); /* cast because of const char * */
2969 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002970 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002971 }
William Lallemandae787ba2021-07-29 15:13:22 +02002972 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002973 free(msg);
2974
William Lallemandae787ba2021-07-29 15:13:22 +02002975error_proxy:
2976 ha_alert("%s\n", errmsg);
2977 free(errmsg);
2978
William Lallemand744a0892018-11-22 16:46:51 +01002979 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002980}
Olivier Houchardf886e342017-04-05 22:24:59 +02002981
William Lallemandce83b4a2018-10-26 14:47:30 +02002982/*
William Lallemande7361152018-10-26 14:47:36 +02002983 * Create a new listener for the master CLI proxy
2984 */
2985int mworker_cli_proxy_new_listener(char *line)
2986{
2987 struct bind_conf *bind_conf;
2988 struct listener *l;
2989 char *err = NULL;
2990 char *args[MAX_LINE_ARGS + 1];
2991 int arg;
2992 int cur_arg;
2993
William Lallemand2e945c82019-11-25 09:58:37 +01002994 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002995 args[0] = line;
2996
2997 /* args is a bind configuration with spaces replaced by commas */
2998 while (*line && arg < MAX_LINE_ARGS) {
2999
3000 if (*line == ',') {
3001 *line++ = '\0';
3002 while (*line == ',')
3003 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01003004 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02003005 }
3006 line++;
3007 }
3008
William Lallemand2e945c82019-11-25 09:58:37 +01003009 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02003010
3011 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003012 if (!bind_conf)
3013 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003014
3015 bind_conf->level &= ~ACCESS_LVL_MASK;
3016 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003017 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
Willy Tarreaudcbd7632022-07-06 11:46:34 +02003018 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemande7361152018-10-26 14:47:36 +02003019
3020 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3021 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003022 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003023 }
3024
3025 cur_arg = 1;
3026
3027 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003028 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003029 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003030
3031 kw = bind_find_kw(args[cur_arg]);
3032 if (kw) {
3033 if (!kw->parse) {
3034 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3035 args[0], args[1], args[cur_arg]);
3036 goto err;
3037 }
3038
Willy Tarreau4975d142021-03-13 11:00:33 +01003039 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003040 if (err)
3041 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3042 else
3043 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3044 args[0], args[1], args[cur_arg]);
3045 goto err;
3046 }
3047
3048 cur_arg += 1 + kw->skip;
3049 continue;
3050 }
3051
Willy Tarreau433b05f2021-03-12 10:14:07 +01003052 best = bind_find_best_kw(args[cur_arg]);
3053 if (best)
3054 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3055 args[0], args[1], args[cur_arg], best);
3056 else
3057 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3058 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003059 goto err;
3060 }
3061
3062
3063 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003064 l->accept = session_accept_fd;
3065 l->default_target = mworker_proxy->default_target;
3066 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003067 l->options |= LI_O_UNLIMITED;
3068 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003069 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003070 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003071 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003072 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003073
3074 return 0;
3075
3076err:
3077 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003078 free(err);
3079 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003080 return -1;
3081
3082}
3083
3084/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003085 * Create a new CLI socket using a socketpair for a worker process
3086 * <mworker_proc> is the process structure, and <proc> is the process number
3087 */
3088int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3089{
3090 struct bind_conf *bind_conf;
3091 struct listener *l;
3092 char *path = NULL;
3093 char *err = NULL;
3094
3095 /* master pipe to ensure the master is still alive */
3096 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3097 ha_alert("Cannot create worker socketpair.\n");
3098 return -1;
3099 }
3100
3101 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003102 if (!global.cli_fe) {
3103 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003104 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003105 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003106 }
3107 }
3108
Willy Tarreau4975d142021-03-13 11:00:33 +01003109 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003110 if (!bind_conf)
3111 goto error;
3112
William Lallemandce83b4a2018-10-26 14:47:30 +02003113 bind_conf->level &= ~ACCESS_LVL_MASK;
3114 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003115 bind_conf->level |= ACCESS_FD_LISTENERS;
Willy Tarreaudcbd7632022-07-06 11:46:34 +02003116 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemandce83b4a2018-10-26 14:47:30 +02003117
William Lallemandce83b4a2018-10-26 14:47:30 +02003118 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3119 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003120 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003121 }
3122
Willy Tarreau4975d142021-03-13 11:00:33 +01003123 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003124 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003125 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003126 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003127 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003128 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003129
3130 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003131 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003132 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003133 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003134 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003135 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003136 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003137 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003138 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003139 }
3140
3141 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003142
3143error:
3144 close(mworker_proc->ipc_fd[0]);
3145 close(mworker_proc->ipc_fd[1]);
3146 free(err);
3147
3148 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003149}
3150
William Lallemand74c24fb2016-11-21 17:18:36 +01003151static struct applet cli_applet = {
3152 .obj_type = OBJ_TYPE_APPLET,
3153 .name = "<CLI>", /* used for logging */
3154 .fct = cli_io_handler,
3155 .release = cli_release_handler,
3156};
3157
William Lallemand99e0bb92020-11-05 10:28:53 +01003158/* master CLI */
3159static struct applet mcli_applet = {
3160 .obj_type = OBJ_TYPE_APPLET,
3161 .name = "<MCLI>", /* used for logging */
3162 .fct = cli_io_handler,
3163 .release = cli_release_handler,
3164};
3165
Willy Tarreau0a739292016-11-22 20:21:23 +01003166/* register cli keywords */
3167static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003168 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3169 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3170 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3171 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003172 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3173 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003174 { { "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 +02003175 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3176 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3177 { { "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 },
3178 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3179 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3180 { { "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 },
3181 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3182 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use or a specific one", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
Willy Tarreau9a7fa902022-07-15 16:51:16 +02003183 { { "show", "activity", NULL }, "show activity [-1|0|thread_num] : show per-thread activity stats (for support/developers)", cli_parse_show_activity, cli_io_handler_show_activity, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003184 { { "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 +02003185 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3186 { { "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 +01003187 {{},}
3188}};
3189
Willy Tarreau0108d902018-11-25 19:14:37 +01003190INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3191
William Lallemand74c24fb2016-11-21 17:18:36 +01003192static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003193 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003194 { 0, NULL, NULL },
3195}};
3196
Willy Tarreau0108d902018-11-25 19:14:37 +01003197INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3198
William Lallemand74c24fb2016-11-21 17:18:36 +01003199static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003200 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3201 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003202 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003203 { NULL, NULL, 0 },
3204}};
3205
Willy Tarreau0108d902018-11-25 19:14:37 +01003206INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003207
3208/*
3209 * Local variables:
3210 * c-indent-level: 8
3211 * c-basic-offset: 8
3212 * End:
3213 */