blob: c8891129e7916b4642d42dcda5a4accbe1f80f78 [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>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/applet-t.h>
32#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 Tarreau1e56f922020-06-04 23:20:13 +020055#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020056#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020057#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020058#include <haproxy/stats-t.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020059#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020060#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020061#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020062#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020063#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020064#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020065#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010066
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020067#define PAYLOAD_PATTERN "<<"
68
William Lallemand74c24fb2016-11-21 17:18:36 +010069static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010070static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010071
Willy Tarreau4975d142021-03-13 11:00:33 +010072static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010073 "Permission denied\n"
74 "";
75
76
Christopher Faulet1bc04c72017-10-29 20:14:08 +010077static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010078
79/* List head of cli keywords */
80static struct cli_kw_list cli_keywords = {
81 .list = LIST_HEAD_INIT(cli_keywords.list)
82};
83
84extern const char *stat_status_codes[];
85
Eric Salama1b8dacc2021-03-16 15:12:17 +010086struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand8a022572018-10-26 14:47:35 +020087
Willy Tarreau92fbbcc2021-05-09 21:45:29 +020088static int cmp_kw_entries(const void *a, const void *b)
89{
90 const struct cli_kw *l = *(const struct cli_kw **)a;
91 const struct cli_kw *r = *(const struct cli_kw **)b;
92
93 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
94}
95
Willy Tarreaub96a74c2021-03-12 17:13:28 +010096/* This will show the help message and list the commands supported at the
97 * current level that match all of the first words of <args> if args is not
98 * NULL, or all args if none matches or if args is null.
99 */
100static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100101{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200102 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100103 struct cli_kw_list *kw_list;
104 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200105 struct buffer *tmp = get_trash_chunk();
106 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100107 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100108 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200109 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100110 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200111 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100112
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100113 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100114
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200115 if (args && *args && strcmp(*args, "help") == 0) {
116 args++;
117 ishelp = 1;
118 }
119
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100120 /* first, let's measure the longest match */
121 list_for_each_entry(kw_list, &cli_keywords.list, list) {
122 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100123 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100124 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100125 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
126 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100127 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
128 continue;
129
130 /* OK this command is visible */
131 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
132 if (!kw->str_kw[idx])
133 break; // end of keyword
134 if (!args || !args[idx] || !*args[idx])
135 break; // end of command line
136 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
137 break;
138 if (idx + 1 > length)
139 length = idx + 1;
140 }
141 }
142 }
143
Willy Tarreaub7364582021-03-12 18:24:46 +0100144 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100145 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200146 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100147 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200148 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100149 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
150 else // partial match
151 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
152
Willy Tarreaub7364582021-03-12 18:24:46 +0100153 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
154 matches[idx].kw = NULL;
155 matches[idx].dist = INT_MAX;
156 }
157
158 /* In case of partial match we'll look for the best matching entries
159 * starting from position <length>
160 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100161 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100162 list_for_each_entry(kw_list, &cli_keywords.list, list) {
163 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100164 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100165 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100166 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
167 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
168 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100169 continue;
170
171 for (idx = 0; idx < length; idx++) {
172 if (!kw->str_kw[idx])
173 break; // end of keyword
174 if (!args || !args[idx] || !*args[idx])
175 break; // end of command line
176 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
177 break;
178 }
179
180 /* extra non-matching words are fuzzy-matched */
181 if (kw->usage && idx == length && args[idx] && *args[idx]) {
182 uint8_t word_sig[1024];
183 uint8_t list_sig[1024];
184 int dist = 0;
185 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100186 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100187
188 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100189 * on the remaining words. For this we're computing the signature
190 * of everything that remains and the cumulated length of the
191 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100192 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100193 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100194 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
195 update_word_fingerprint(word_sig, args[i]);
196 totlen += strlen(args[i]);
197 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100198
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100199 memset(list_sig, 0, sizeof(list_sig));
200 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
201 update_word_fingerprint(list_sig, kw->str_kw[i]);
202 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100203 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100204
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100205 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100206
207 /* insert this one at its place if relevant, in order to keep only
208 * the best matches.
209 */
210 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100211 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100212 matches[CLI_MAX_MATCHES-1] = swp;
213 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
214 if (matches[idx+1].dist >= matches[idx].dist)
215 break;
216 matches[idx+1] = matches[idx];
217 matches[idx] = swp;
218 }
219 }
220 }
221 }
222 }
223 }
224
Willy Tarreauec197e82021-03-15 10:35:04 +0100225 if (matches[0].kw) {
226 /* we have fuzzy matches, let's propose them */
227 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
228 kw = matches[idx].kw;
229 if (!kw)
230 break;
231
232 /* stop the dump if some words look very unlikely candidates */
233 if (matches[idx].dist > 5*matches[0].dist/2)
234 break;
235
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200236 if (help_entries < CLI_MAX_HELP_ENTRIES)
237 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100238 }
239 }
240
William Lallemand74c24fb2016-11-21 17:18:36 +0100241 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100242 /* no full dump if we've already found nice candidates */
243 if (matches[0].kw)
244 break;
245
Willy Tarreau91bc3592021-03-12 15:20:39 +0100246 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200247
Willy Tarreau91bc3592021-03-12 15:20:39 +0100248 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100249 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100250 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100251 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100252 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200253
William Lallemand2a171912022-02-02 11:43:20 +0100254 /* in master, if the CLI don't have the
255 * ACCESS_MCLI_DEBUG don't display commands that have
256 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100257 */
William Lallemand2a171912022-02-02 11:43:20 +0100258 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
259 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
260 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100261 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200262
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100263 for (idx = 0; idx < length; idx++) {
264 if (!kw->str_kw[idx])
265 break; // end of keyword
266 if (!args || !args[idx] || !*args[idx])
267 break; // end of command line
268 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
269 break;
270 }
271
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200272 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
273 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100274 }
275 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100276
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200277 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
278
279 for (idx = 0; idx < help_entries; idx++)
280 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
281
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100282 /* always show the prompt/help/quit commands */
283 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200284 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200285 " prompt : toggle interactive mode with prompt\n"
286 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100287
William Lallemand74c24fb2016-11-21 17:18:36 +0100288 chunk_init(&out, NULL, 0);
289 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200290 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200291
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100292 appctx->ctx.cli.severity = LOG_INFO;
293 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200294 appctx->st0 = CLI_ST_PRINT;
295
William Lallemand74c24fb2016-11-21 17:18:36 +0100296 return dynamic_usage_msg;
297}
298
299struct cli_kw* cli_find_kw(char **args)
300{
301 struct cli_kw_list *kw_list;
302 struct cli_kw *kw;/* current cli_kw */
303 char **tmp_args;
304 const char **tmp_str_kw;
305 int found = 0;
306
307 if (LIST_ISEMPTY(&cli_keywords.list))
308 return NULL;
309
310 list_for_each_entry(kw_list, &cli_keywords.list, list) {
311 kw = &kw_list->kw[0];
312 while (*kw->str_kw) {
313 tmp_args = args;
314 tmp_str_kw = kw->str_kw;
315 while (*tmp_str_kw) {
316 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
317 found = 1;
318 } else {
319 found = 0;
320 break;
321 }
322 tmp_args++;
323 tmp_str_kw++;
324 }
325 if (found)
326 return (kw);
327 kw++;
328 }
329 }
330 return NULL;
331}
332
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100333struct cli_kw* cli_find_kw_exact(char **args)
334{
335 struct cli_kw_list *kw_list;
336 int found = 0;
337 int i;
338 int j;
339
340 if (LIST_ISEMPTY(&cli_keywords.list))
341 return NULL;
342
343 list_for_each_entry(kw_list, &cli_keywords.list, list) {
344 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
345 found = 1;
346 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
347 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
348 break;
349 }
350 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
351 found = 0;
352 break;
353 }
354 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
355 found = 0;
356 break;
357 }
358 }
359 if (found)
360 return &kw_list->kw[i];
361 }
362 }
363 return NULL;
364}
365
William Lallemand74c24fb2016-11-21 17:18:36 +0100366void cli_register_kw(struct cli_kw_list *kw_list)
367{
Willy Tarreau2b718102021-04-21 07:32:39 +0200368 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100369}
370
371
372/* allocate a new stats frontend named <name>, and return it
373 * (or NULL in case of lack of memory).
374 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100375static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100376{
377 struct proxy *fe;
378
379 fe = calloc(1, sizeof(*fe));
380 if (!fe)
381 return NULL;
382
383 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100384 fe->next = proxies_list;
385 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100386 fe->last_change = now.tv_sec;
387 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200388 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100389 fe->maxconn = 10; /* default to 10 concurrent connections */
390 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
391 fe->conf.file = strdup(file);
392 fe->conf.line = line;
393 fe->accept = frontend_accept;
394 fe->default_target = &cli_applet.obj_type;
395
396 /* the stats frontend is the only one able to assign ID #0 */
397 fe->conf.id.key = fe->uuid = 0;
398 eb32_insert(&used_proxy_id, &fe->conf.id);
399 return fe;
400}
401
402/* This function parses a "stats" statement in the "global" section. It returns
403 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
404 * error message into the <err> buffer which will be preallocated. The trailing
405 * '\n' must not be written. The function must be called with <args> pointing to
406 * the first word after "stats".
407 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100408static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
409 const struct proxy *defpx, const char *file, int line,
410 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100411{
412 struct bind_conf *bind_conf;
413 struct listener *l;
414
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100415 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100416 int cur_arg;
417
418 if (*args[2] == 0) {
419 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
420 return -1;
421 }
422
Willy Tarreau4975d142021-03-13 11:00:33 +0100423 if (!global.cli_fe) {
424 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100425 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
426 return -1;
427 }
428 }
429
Willy Tarreau4975d142021-03-13 11:00:33 +0100430 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200431 if (!bind_conf) {
432 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
433 return -1;
434 }
William Lallemand07a62f72017-05-24 00:57:40 +0200435 bind_conf->level &= ~ACCESS_LVL_MASK;
436 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100437
Willy Tarreau4975d142021-03-13 11:00:33 +0100438 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100439 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
440 file, line, args[0], args[1], err && *err ? *err : "error");
441 return -1;
442 }
443
444 cur_arg = 3;
445 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100446 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100447 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100448 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100449
450 kw = bind_find_kw(args[cur_arg]);
451 if (kw) {
452 if (!kw->parse) {
453 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
454 args[0], args[1], args[cur_arg]);
455 return -1;
456 }
457
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100458 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
459
460 /* FIXME: this is ugly, we don't have a way to collect warnings,
461 * yet some important bind keywords may report warnings that we
462 * must display.
463 */
464 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
465 indent_msg(err, 2);
466 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
467 ha_free(err);
468 }
469
470 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100471 if (err && *err)
472 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
473 else
474 memprintf(err, "'%s %s' : error encountered while processing '%s'",
475 args[0], args[1], args[cur_arg]);
476 return -1;
477 }
478
479 cur_arg += 1 + kw->skip;
480 continue;
481 }
482
Willy Tarreau433b05f2021-03-12 10:14:07 +0100483 best = bind_find_best_kw(args[cur_arg]);
484 if (best)
485 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
486 args[0], args[1], args[cur_arg], best);
487 else
488 memprintf(err, "'%s %s' : unknown keyword '%s'.",
489 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100490 return -1;
491 }
492
493 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100494 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100495 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100496 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
497 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100498 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100499 }
500 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100501 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100502 unsigned timeout;
503 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
504
Willy Tarreau9faebe32019-06-07 19:00:37 +0200505 if (res == PARSE_TIME_OVER) {
506 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
507 args[2], args[0], args[1]);
508 return -1;
509 }
510 else if (res == PARSE_TIME_UNDER) {
511 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
512 args[2], args[0], args[1]);
513 return -1;
514 }
515 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100516 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
517 return -1;
518 }
519
520 if (!timeout) {
521 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
522 return -1;
523 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100524 if (!global.cli_fe) {
525 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100526 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
527 return -1;
528 }
529 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100530 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100531 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100532 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100533 int maxconn = atol(args[2]);
534
535 if (maxconn <= 0) {
536 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
537 return -1;
538 }
539
Willy Tarreau4975d142021-03-13 11:00:33 +0100540 if (!global.cli_fe) {
541 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
543 return -1;
544 }
545 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100546 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100547 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100548 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100549 int cur_arg = 2;
550 unsigned long set = 0;
551
Willy Tarreau4975d142021-03-13 11:00:33 +0100552 if (!global.cli_fe) {
553 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100554 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
555 return -1;
556 }
557 }
558
559 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100560 if (strcmp(args[cur_arg], "all") == 0) {
561 set = 0;
562 break;
563 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200564 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100565 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100566 return -1;
567 }
568 cur_arg++;
569 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100570 }
571 else {
572 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
573 return -1;
574 }
575 return 0;
576}
577
William Lallemand33d29e22019-04-01 11:30:06 +0200578/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200579 * This function exports the bound addresses of a <frontend> in the environment
580 * variable <varname>. Those addresses are separated by semicolons and prefixed
581 * with their type (abns@, unix@, sockpair@ etc)
582 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200583 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200584int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200585{
586 struct buffer *trash = get_trash_chunk();
587 struct bind_conf *bind_conf;
588
William Lallemand9a37fd02019-04-12 16:09:24 +0200589 if (frontend) {
590 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200591 struct listener *l;
592
593 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
594 char addr[46];
595 char port[6];
596
William Lallemand620072b2019-04-12 16:09:25 +0200597 /* separate listener by semicolons */
598 if (trash->data)
599 chunk_appendf(trash, ";");
600
Willy Tarreau37159062020-08-27 07:48:42 +0200601 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200602 const struct sockaddr_un *un;
603
Willy Tarreau37159062020-08-27 07:48:42 +0200604 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200605 if (un->sun_path[0] == '\0') {
606 chunk_appendf(trash, "abns@%s", un->sun_path+1);
607 } else {
608 chunk_appendf(trash, "unix@%s", un->sun_path);
609 }
Willy Tarreau37159062020-08-27 07:48:42 +0200610 } else if (l->rx.addr.ss_family == AF_INET) {
611 addr_to_str(&l->rx.addr, addr, sizeof(addr));
612 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200613 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200614 } else if (l->rx.addr.ss_family == AF_INET6) {
615 addr_to_str(&l->rx.addr, addr, sizeof(addr));
616 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200617 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200618 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
619 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200620 }
William Lallemand33d29e22019-04-01 11:30:06 +0200621 }
622 }
623 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200624 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200625 return -1;
626 }
627
628 return 0;
629}
630
William Lallemand9a37fd02019-04-12 16:09:24 +0200631int cli_socket_setenv()
632{
Willy Tarreau4975d142021-03-13 11:00:33 +0100633 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200634 return -1;
635 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
636 return -1;
637
638 return 0;
639}
640
William Lallemand33d29e22019-04-01 11:30:06 +0200641REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
642
Willy Tarreaude57a572016-11-23 17:01:39 +0100643/* Verifies that the CLI at least has a level at least as high as <level>
644 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
645 * failure, an error message is prepared and the appctx's state is adjusted
646 * to print it so that a return 1 is enough to abort any processing.
647 */
648int cli_has_level(struct appctx *appctx, int level)
649{
Willy Tarreaude57a572016-11-23 17:01:39 +0100650
William Lallemandf630d012018-12-13 09:05:44 +0100651 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100652 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100653 return 0;
654 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100655 return 1;
656}
657
William Lallemandb7ea1412018-12-13 09:05:47 +0100658/* same as cli_has_level but for the CLI proxy and without error message */
659int pcli_has_level(struct stream *s, int level)
660{
661 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
662 return 0;
663 }
664 return 1;
665}
666
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200667/* Returns severity_output for the current session if set, or default for the socket */
668static int cli_get_severity_output(struct appctx *appctx)
669{
670 if (appctx->cli_severity_output)
671 return appctx->cli_severity_output;
672 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
673}
William Lallemand74c24fb2016-11-21 17:18:36 +0100674
Willy Tarreau41908562016-11-24 16:23:38 +0100675/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100676 * from the CLI's IO handler running in an appctx context. The function returns
677 * 1 if the request was understood, otherwise zero (in which case an error
678 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100679 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
680 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
681 * have its own I/O handler called again. Most of the time, parsers will only
682 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100683 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
684 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100685 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200686static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100687{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100688 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200689 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100690 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100691
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200692 appctx->st2 = 0;
693 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100694
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200695 p = appctx->chunk->area;
696 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100697
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200698 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200699 * Get pointers on words.
700 * One extra slot is reserved to store a pointer on a null byte.
701 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100702 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200703 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100704
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200705 /* skip leading spaces/tabs */
706 p += strspn(p, " \t");
707 if (!*p)
708 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200709
710 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
711 /* payload pattern recognized here, this is not an arg anymore,
712 * the payload starts at the first byte that follows the zero
713 * after the pattern.
714 */
715 payload = p + strlen(PAYLOAD_PATTERN) + 1;
716 break;
717 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100718
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200719 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200720 while (1) {
721 p += strcspn(p, " \t\\");
722 /* escaped chars using backlashes (\) */
723 if (*p == '\\') {
724 if (!*++p)
725 break;
726 if (!*++p)
727 break;
728 } else {
729 break;
730 }
731 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200732 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100733
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200734 /* unescape backslashes (\) */
735 for (j = 0, k = 0; args[i][k]; k++) {
736 if (args[i][k] == '\\') {
737 if (args[i][k + 1] == '\\')
738 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100739 else
740 continue;
741 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100743 j++;
744 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200745 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100746
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200747 i++;
748 }
749 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200750 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100751 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200752 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100753
754 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100755 if (!kw ||
756 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100757 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
758 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100759 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100760 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100761 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100762 }
William Lallemand14721be2018-10-26 14:47:37 +0200763
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100764 /* don't handle expert mode commands if not in this mode. */
765 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
766 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200767 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100768 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200769
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100770 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
771 cli_err(appctx, "This command is restricted to experimental mode only.\n");
772 return 0;
773 }
774
Amaury Denoyellef4929922021-05-05 16:29:23 +0200775 if (kw->level == ACCESS_EXPERT)
776 mark_tainted(TAINTED_CLI_EXPERT_MODE);
777 else if (kw->level == ACCESS_EXPERIMENTAL)
778 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
779
Willy Tarreau41908562016-11-24 16:23:38 +0100780 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200781 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200782
783 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
784 goto fail;
785
786 /* kw->parse could set its own io_handler or io_release handler */
787 if (!appctx->io_handler)
788 goto fail;
789
790 appctx->st0 = CLI_ST_CALLBACK;
791 return 1;
792fail:
793 appctx->io_handler = NULL;
794 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100795 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100796}
797
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200798/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
799static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
800{
Willy Tarreau83061a82018-07-13 11:56:34 +0200801 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200802
803 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200804 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200805
806 tmp = get_trash_chunk();
807 chunk_reset(tmp);
808
809 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100810 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200811 chunk_printf(tmp, "[%d]: ", severity);
812 }
813 else {
814 switch (severity_output) {
815 case CLI_SEVERITY_NUMBER:
816 chunk_printf(tmp, "[%d]: ", severity);
817 break;
818 case CLI_SEVERITY_STRING:
819 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
820 break;
821 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100822 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200823 }
824 }
825 chunk_appendf(tmp, "%s", msg);
826
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200827 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200828}
829
William Lallemand74c24fb2016-11-21 17:18:36 +0100830/* This I/O handler runs as an applet embedded in a stream interface. It is
831 * used to processes I/O from/to the stats unix socket. The system relies on a
832 * state machine handling requests and various responses. We read a request,
833 * then we process it and send the response, and we possibly display a prompt.
834 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100835 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100836 * or not.
837 */
838static void cli_io_handler(struct appctx *appctx)
839{
840 struct stream_interface *si = appctx->owner;
841 struct channel *req = si_oc(si);
842 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200843 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100844 int reql;
845 int len;
846
847 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
848 goto out;
849
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800850 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200851 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100852 /* buf.size==0 means we failed to get a buffer and were
853 * already subscribed to a wait list to get a buffer.
854 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100855 goto out;
856 }
857
William Lallemand74c24fb2016-11-21 17:18:36 +0100858 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100859 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100860 /* Stats output not initialized yet */
861 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200862 /* reset severity to default at init */
863 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100864 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100865 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100866 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100867 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100868 /* Let's close for real now. We just close the request
869 * side, the conditions below will complete if needed.
870 */
871 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200872 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200873 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100874 break;
875 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100876 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200877 char *str;
878
879 /* use a trash chunk to store received data */
880 if (!appctx->chunk) {
881 appctx->chunk = alloc_trash_chunk();
882 if (!appctx->chunk) {
883 appctx->st0 = CLI_ST_END;
884 continue;
885 }
886 }
887
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200888 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200889
William Lallemand74c24fb2016-11-21 17:18:36 +0100890 /* ensure we have some output room left in the event we
891 * would want to return some info right after parsing.
892 */
893 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100894 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100895 break;
896 }
897
Willy Tarreau0011c252022-01-19 17:23:52 +0100898 /* payload doesn't take escapes nor does it end on semi-colons, so
899 * we use the regular getline. Normal mode however must stop on
900 * LFs and semi-colons that are not prefixed by a backslash. Note
901 * that we reserve one byte at the end to insert a trailing nul byte.
902 */
903
904 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
905 reql = co_getline(si_oc(si), str,
906 appctx->chunk->size - appctx->chunk->data - 1);
907 else
908 reql = co_getdelim(si_oc(si), str,
909 appctx->chunk->size - appctx->chunk->data - 1,
910 "\n;", '\\');
911
William Lallemand74c24fb2016-11-21 17:18:36 +0100912 if (reql <= 0) { /* closed or EOL not found */
913 if (reql == 0)
914 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100915 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100916 continue;
917 }
918
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200919 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
920 /* seek for a possible unescaped semi-colon. If we find
921 * one, we replace it with an LF and skip only this part.
922 */
923 for (len = 0; len < reql; len++) {
924 if (str[len] == '\\') {
925 len++;
926 continue;
927 }
928 if (str[len] == ';') {
929 str[len] = '\n';
930 reql = len + 1;
931 break;
932 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100933 }
934 }
935
936 /* now it is time to check that we have a full line,
937 * remove the trailing \n and possibly \r, then cut the
938 * line.
939 */
940 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200941 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100942 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100943 continue;
944 }
945
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200946 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100947 len--;
948
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200949 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200950 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200951
952 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200953 appctx->chunk->area[appctx->chunk->data] = '\n';
954 appctx->chunk->area[appctx->chunk->data + 1] = 0;
955 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200956 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100957
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100958 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200959
960 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
961 /* empty line */
962 if (!len) {
963 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200964 appctx->chunk->data -= 2;
965 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100966 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200967 chunk_reset(appctx->chunk);
968 /* NB: cli_sock_parse_request() may have put
969 * another CLI_ST_O_* into appctx->st0.
970 */
971
972 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100973 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100974 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200975 else {
976 /*
977 * Look for the "payload start" pattern at the end of a line
978 * Its location is not remembered here, this is just to switch
979 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100980 */
Willy Tarreauf2dda522021-09-17 11:07:45 +0200981 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200982 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200983 appctx->chunk->data++; // keep the trailing \0 after '<<'
984 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200985 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200986 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100987 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200988 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200989 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100990 }
991
992 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200993 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100994 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
995 }
996 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200997 const char *msg;
998 int sev;
999
William Lallemand74c24fb2016-11-21 17:18:36 +01001000 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001001 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001002 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001003 case CLI_ST_PRINT: /* print const message in msg */
1004 case CLI_ST_PRINT_ERR: /* print const error in msg */
1005 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1006 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
1007 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1008 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
1009 LOG_ERR : appctx->ctx.cli.severity;
1010 msg = appctx->ctx.cli.msg;
1011 }
1012 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1013 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
1014 LOG_ERR : appctx->ctx.cli.severity;
1015 msg = appctx->ctx.cli.err;
1016 if (!msg) {
1017 sev = LOG_ERR;
1018 msg = "Out of memory.\n";
1019 }
1020 }
1021 else {
1022 sev = LOG_ERR;
1023 msg = "Internal error.\n";
1024 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001025
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001026 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1027 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1028 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001029 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001030 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001031 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001032 }
1033 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001034 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001035 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001036
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001037 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 if (appctx->io_handler)
1039 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001040 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001041 if (appctx->io_release) {
1042 appctx->io_release(appctx);
1043 appctx->io_release = NULL;
1044 }
1045 }
1046 break;
1047 default: /* abnormal state */
1048 si->flags |= SI_FL_ERR;
1049 break;
1050 }
1051
1052 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001053 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001054 const char *prompt = "";
1055
1056 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1057 /*
1058 * when entering a payload with interactive mode, change the prompt
1059 * to emphasize that more data can still be sent
1060 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001061 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001062 prompt = "+ ";
1063 else
1064 prompt = "\n> ";
1065 }
1066 else {
William Lallemandad032882019-07-01 10:56:15 +02001067 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001068 prompt = "\n";
1069 }
1070
1071 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001072 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001073 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001074 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001075 }
1076
1077 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001078 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001079 break;
1080
1081 /* Now we close the output if one of the writers did so,
1082 * or if we're not in interactive mode and the request
1083 * buffer is empty. This still allows pipelined requests
1084 * to be sent in non-interactive mode.
1085 */
William Lallemand3de09d52018-12-11 16:10:56 +01001086 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1087 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001088 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001089 continue;
1090 }
1091
1092 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001093 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001094 /* reactivate the \n at the end of the response for the next command */
1095 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001096
1097 /* this forces us to yield between pipelined commands and
1098 * avoid extremely long latencies (e.g. "del map" etc). In
1099 * addition this increases the likelihood that the stream
1100 * refills the buffer with new bytes in non-interactive
1101 * mode, avoiding to close on apparently empty commands.
1102 */
1103 if (co_data(si_oc(si))) {
1104 appctx_wakeup(appctx);
1105 goto out;
1106 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001107 }
1108 }
1109
1110 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1111 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1112 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1113 /* Other side has closed, let's abort if we have no more processing to do
1114 * and nothing more to consume. This is comparable to a broken pipe, so
1115 * we forward the close to the request side so that it flows upstream to
1116 * the client.
1117 */
1118 si_shutw(si);
1119 }
1120
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001121 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001122 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1123 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1124 /* We have no more processing to do, and nothing more to send, and
1125 * the client side has closed. So we'll forward this state downstream
1126 * on the response buffer.
1127 */
1128 si_shutr(si);
1129 res->flags |= CF_READ_NULL;
1130 }
1131
1132 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001133 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 +01001134 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001135 si->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001136}
1137
William Lallemand74c24fb2016-11-21 17:18:36 +01001138/* This is called when the stream interface is closed. For instance, upon an
1139 * external abort, we won't call the i/o handler anymore so we may need to
1140 * remove back references to the stream currently being dumped.
1141 */
1142static void cli_release_handler(struct appctx *appctx)
1143{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001144 free_trash_chunk(appctx->chunk);
1145 appctx->chunk = NULL;
1146
William Lallemand74c24fb2016-11-21 17:18:36 +01001147 if (appctx->io_release) {
1148 appctx->io_release(appctx);
1149 appctx->io_release = NULL;
1150 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001151 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001152 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001153 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001154}
1155
1156/* This function dumps all environmnent variables to the buffer. It returns 0
1157 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001158 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1159 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001160 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001161static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001162{
Willy Tarreau0a739292016-11-22 20:21:23 +01001163 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001164 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001165
1166 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1167 return 1;
1168
1169 chunk_reset(&trash);
1170
1171 /* we have two inner loops here, one for the proxy, the other one for
1172 * the buffer.
1173 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001174 while (*var) {
1175 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001176
Willy Tarreau06d80a92017-10-19 14:32:15 +02001177 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001178 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001179 return 0;
1180 }
1181 if (appctx->st2 == STAT_ST_END)
1182 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001183 var++;
1184 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001185 }
1186
1187 /* dump complete */
1188 return 1;
1189}
1190
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001191/* This function dumps all file descriptors states (or the requested one) to
1192 * the buffer. It returns 0 if the output buffer is full and it needs to be
1193 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1194 * It uses cli.i0 as the fd number to restart from.
1195 */
1196static int cli_io_handler_show_fd(struct appctx *appctx)
1197{
1198 struct stream_interface *si = appctx->owner;
1199 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001200 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001201
1202 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001203 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001204
1205 chunk_reset(&trash);
1206
Willy Tarreauca1b1572018-12-18 15:45:11 +01001207 /* isolate the threads once per round. We're limited to a buffer worth
1208 * of output anyway, it cannot last very long.
1209 */
1210 thread_isolate();
1211
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001212 /* we have two inner loops here, one for the proxy, the other one for
1213 * the buffer.
1214 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001215 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001216 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001217 const struct listener *li = NULL;
1218 const struct server *sv = NULL;
1219 const struct proxy *px = NULL;
1220 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001221 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001222 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001223 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001224 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001225 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001226 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001227 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001228
1229 fdt = fdtab[fd];
1230
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001231 /* When DEBUG_FD is set, we also report closed FDs that have a
1232 * non-null event count to detect stuck ones.
1233 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001234 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001235#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001236 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001237#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001238 goto skip; // closed
1239 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001240 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001241 conn = (const struct connection *)fdt.owner;
1242 conn_flags = conn->flags;
1243 mux = conn->mux;
1244 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001245 xprt = conn->xprt;
1246 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001247 li = objt_listener(conn->target);
1248 sv = objt_server(conn->target);
1249 px = objt_proxy(conn->target);
1250 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001251 if (atleast2(fdt.thread_mask))
1252 suspicious = 1;
1253 if (conn->handle.fd != fd)
1254 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001255 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001256 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001257 li = fdt.owner;
1258
Willy Tarreaudacfde42021-01-21 09:07:29 +01001259 if (!fdt.thread_mask)
1260 suspicious = 1;
1261
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001262 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001263 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001264 fd,
1265 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001266 (fdt.state & FD_CLONED) ? 'C' : 'c',
1267 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001268 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1269 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1270 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1271 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1272 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001273 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1274 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1275 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1276 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1277 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1278 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001279 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001280 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001281 fdt.iocb);
1282 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001283
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001284 if (!fdt.owner) {
1285 chunk_appendf(&trash, ")");
1286 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001287 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001288 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001289
1290 if (conn->handle.fd != fd) {
1291 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1292 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001293 } else {
1294 struct sockaddr_storage sa;
1295 socklen_t salen;
1296
1297 salen = sizeof(sa);
1298 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1299 if (sa.ss_family == AF_INET)
1300 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1301 else if (sa.ss_family == AF_INET6)
1302 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1303 else if (sa.ss_family == AF_UNIX)
1304 chunk_appendf(&trash, " fam=unix");
1305 }
1306
1307 salen = sizeof(sa);
1308 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1309 if (sa.ss_family == AF_INET)
1310 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1311 else if (sa.ss_family == AF_INET6)
1312 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1313 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001314 }
1315
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001316 if (px)
1317 chunk_appendf(&trash, " px=%s", px->id);
1318 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001319 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001320 else if (li)
1321 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001322
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001323 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001324 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001325 if (!ctx)
1326 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001327 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001328 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001329 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001330 else
1331 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001332
1333 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001334 if (xprt) {
1335 if (xprt_ctx || xprt->show_fd)
1336 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1337 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001338 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001339 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001340 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001341 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001342 struct sockaddr_storage sa;
1343 socklen_t salen;
1344
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001345 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001346 listener_state_str(li),
1347 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001348
1349 salen = sizeof(sa);
1350 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1351 if (sa.ss_family == AF_INET)
1352 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1353 else if (sa.ss_family == AF_INET6)
1354 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1355 else if (sa.ss_family == AF_UNIX)
1356 chunk_appendf(&trash, " fam=unix");
1357 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001358 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001359 else
1360 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001361
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001362#ifdef DEBUG_FD
1363 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001364 if (fdtab[fd].event_count >= 1000000)
1365 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001366#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001367 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001368
Willy Tarreau06d80a92017-10-19 14:32:15 +02001369 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001370 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001371 appctx->ctx.cli.i0 = fd;
1372 ret = 0;
1373 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001374 }
1375 skip:
1376 if (appctx->st2 == STAT_ST_END)
1377 break;
1378
1379 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001380 }
1381
Willy Tarreauca1b1572018-12-18 15:45:11 +01001382 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001383 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001384
1385 thread_release();
1386 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001387}
1388
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001389/* This function dumps some activity counters used by developers and support to
1390 * rule out some hypothesis during bug reports. It returns 0 if the output
1391 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1392 * everything at once in the buffer and is not designed to do it in multiple
1393 * passes.
1394 */
1395static int cli_io_handler_show_activity(struct appctx *appctx)
1396{
1397 struct stream_interface *si = appctx->owner;
1398 int thr;
1399
1400 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1401 return 1;
1402
1403 chunk_reset(&trash);
1404
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001405#undef SHOW_TOT
1406#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001407 do { \
1408 unsigned int _v[MAX_THREADS]; \
1409 unsigned int _tot; \
1410 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001411 _tot = t = 0; \
1412 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001413 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001414 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001415 if (_nbt == 1) { \
1416 chunk_appendf(&trash, " %u\n", _tot); \
1417 break; \
1418 } \
1419 chunk_appendf(&trash, " %u [", _tot); \
1420 for (t = 0; t < _nbt; t++) \
1421 chunk_appendf(&trash, " %u", _v[t]); \
1422 chunk_appendf(&trash, " ]\n"); \
1423 } while (0)
1424
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001425#undef SHOW_AVG
1426#define SHOW_AVG(t, x) \
1427 do { \
1428 unsigned int _v[MAX_THREADS]; \
1429 unsigned int _tot; \
1430 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001431 _tot = t = 0; \
1432 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001433 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001434 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001435 if (_nbt == 1) { \
1436 chunk_appendf(&trash, " %u\n", _tot); \
1437 break; \
1438 } \
1439 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1440 for (t = 0; t < _nbt; t++) \
1441 chunk_appendf(&trash, " %u", _v[t]); \
1442 chunk_appendf(&trash, " ]\n"); \
1443 } while (0)
1444
Willy Tarreaua0211b82019-05-28 15:09:08 +02001445 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1446 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001447 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1448 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1449 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1450 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001451 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001452 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1453 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001454 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001455 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001456 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001457 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001458 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001459 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001460 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1461 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001462 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1463 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1464 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1465 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1466 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1467 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1468 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001469#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001470 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 +02001471 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001472#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001473
Willy Tarreaud6a78502019-05-27 07:03:38 +02001474#if defined(DEBUG_DEV)
1475 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001476 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1477 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1478 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001479#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001480
1481 if (ci_putchk(si_ic(si), &trash) == -1) {
1482 chunk_reset(&trash);
1483 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001484 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001485 }
1486
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001487#undef SHOW_AVG
1488#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001489 /* dump complete */
1490 return 1;
1491}
1492
William Lallemandeceddf72016-12-15 18:06:44 +01001493/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001494 * CLI IO handler for `show cli sockets`.
1495 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001496 */
1497static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1498{
1499 struct bind_conf *bind_conf;
1500 struct stream_interface *si = appctx->owner;
1501
1502 chunk_reset(&trash);
1503
1504 switch (appctx->st2) {
1505 case STAT_ST_INIT:
1506 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001507 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001508 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001509 return 0;
1510 }
William Lallemandeceddf72016-12-15 18:06:44 +01001511 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001512 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001513
1514 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001515 if (global.cli_fe) {
1516 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001517 struct listener *l;
1518
1519 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001520 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001521 * if the current node is the first of the list
1522 */
1523
Willy Tarreau3af9d832016-12-16 12:58:09 +01001524 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001525 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001526 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001527 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001528 continue;
1529 }
1530
1531 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1532
1533 char addr[46];
1534 char port[6];
1535
Willy Tarreau37159062020-08-27 07:48:42 +02001536 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001537 const struct sockaddr_un *un;
1538
Willy Tarreau37159062020-08-27 07:48:42 +02001539 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001540 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001541 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001542 } else {
1543 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1544 }
Willy Tarreau37159062020-08-27 07:48:42 +02001545 } else if (l->rx.addr.ss_family == AF_INET) {
1546 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1547 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001548 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001549 } else if (l->rx.addr.ss_family == AF_INET6) {
1550 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1551 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001552 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001553 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1554 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001555 } else
William Lallemand26314342018-10-26 14:47:41 +02001556 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001557
William Lallemand07a62f72017-05-24 00:57:40 +02001558 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001559 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001560 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1561 chunk_appendf(&trash, "operator ");
1562 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1563 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001564 else
1565 chunk_appendf(&trash, " ");
1566
Willy Tarreau72faef32021-06-15 08:36:30 +02001567 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001568
Willy Tarreau06d80a92017-10-19 14:32:15 +02001569 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001570 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001571 return 0;
1572 }
1573 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001574 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001575 }
1576 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001577 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001578 default:
1579 appctx->st2 = STAT_ST_FIN;
1580 return 1;
1581 }
1582}
1583
1584
Willy Tarreau0a739292016-11-22 20:21:23 +01001585/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001586 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1587 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001588 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001589static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001590{
1591 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001592 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001593
1594 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1595 return 1;
1596
Willy Tarreauf6710f82016-12-16 17:45:44 +01001597 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001598
1599 if (*args[2]) {
1600 int len = strlen(args[2]);
1601
Willy Tarreauf6710f82016-12-16 17:45:44 +01001602 for (; *var; var++) {
1603 if (strncmp(*var, args[2], len) == 0 &&
1604 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001605 break;
1606 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001607 if (!*var)
1608 return cli_err(appctx, "Variable not found\n");
1609
Willy Tarreau0a739292016-11-22 20:21:23 +01001610 appctx->st2 = STAT_ST_END;
1611 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001612 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001613 return 0;
1614}
1615
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001616/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1617 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1618 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1619 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001620static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001621{
1622 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1623 return 1;
1624
1625 appctx->ctx.cli.i0 = 0;
1626
1627 if (*args[2]) {
1628 appctx->ctx.cli.i0 = atoi(args[2]);
1629 appctx->st2 = STAT_ST_END;
1630 }
1631 return 0;
1632}
1633
Willy Tarreau599852e2016-11-22 20:33:32 +01001634/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001635static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001636{
1637 struct stream_interface *si = appctx->owner;
1638 struct stream *s = si_strm(si);
1639
1640 if (strcmp(args[2], "cli") == 0) {
1641 unsigned timeout;
1642 const char *res;
1643
Willy Tarreau9d008692019-08-09 11:21:01 +02001644 if (!*args[3])
1645 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001646
1647 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001648 if (res || timeout < 1)
1649 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001650
1651 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1652 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1653 return 1;
1654 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001655
1656 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001657}
1658
Willy Tarreau2af99412016-11-23 11:10:59 +01001659/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001660static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001661{
1662 int v;
1663
1664 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1665 return 1;
1666
Willy Tarreau9d008692019-08-09 11:21:01 +02001667 if (!*args[3])
1668 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001669
1670 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001671 if (v > global.hardmaxconn)
1672 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001673
1674 /* check for unlimited values */
1675 if (v <= 0)
1676 v = global.hardmaxconn;
1677
1678 global.maxconn = v;
1679
1680 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001681 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001682
1683 return 1;
1684}
1685
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001686static int set_severity_output(int *target, char *argument)
1687{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001688 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001689 *target = CLI_SEVERITY_NONE;
1690 return 1;
1691 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001692 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001693 *target = CLI_SEVERITY_NUMBER;
1694 return 1;
1695 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001696 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001697 *target = CLI_SEVERITY_STRING;
1698 return 1;
1699 }
1700 return 0;
1701}
1702
1703/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001704static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001705{
1706 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1707 return 0;
1708
Willy Tarreau9d008692019-08-09 11:21:01 +02001709 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001710}
William Lallemandeceddf72016-12-15 18:06:44 +01001711
William Lallemand67a234f2018-12-13 09:05:45 +01001712
1713/* show the level of the current CLI session */
1714static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1715{
William Lallemand67a234f2018-12-13 09:05:45 +01001716 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001717 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001718 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001719 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001720 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001721 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001722 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001723 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001724}
1725
1726/* parse and set the CLI level dynamically */
1727static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1728{
William Lallemandad032882019-07-01 10:56:15 +02001729 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001730 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001731 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1732
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001733 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001734 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1735 return 1;
1736 }
1737 appctx->cli_level &= ~ACCESS_LVL_MASK;
1738 appctx->cli_level |= ACCESS_LVL_OPER;
1739
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001740 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001741 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1742 return 1;
1743 }
1744 appctx->cli_level &= ~ACCESS_LVL_MASK;
1745 appctx->cli_level |= ACCESS_LVL_USER;
1746 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001747 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001748 return 1;
1749}
1750
1751
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001752/* parse and set the CLI expert/experimental-mode dynamically */
1753static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001754{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001755 int level;
1756 char *level_str;
1757 char *output = NULL;
1758
William Lallemand7267f782022-02-01 16:08:50 +01001759 /* this will ask the applet to not output a \n after the command */
1760 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1761 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1762
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001763 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1764 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001765
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001766 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001767 level = ACCESS_EXPERT;
1768 level_str = "expert-mode";
1769 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001770 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001771 level = ACCESS_EXPERIMENTAL;
1772 level_str = "experimental-mode";
1773 }
William Lallemand2a171912022-02-02 11:43:20 +01001774 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1775 level = ACCESS_MCLI_DEBUG;
1776 level_str = "mcli-debug-mode";
1777 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001778 else {
1779 return 1;
1780 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001781
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001782 if (!*args[1]) {
1783 memprintf(&output, "%s is %s\n", level_str,
1784 (appctx->cli_level & level) ? "ON" : "OFF");
1785 return cli_dynmsg(appctx, LOG_INFO, output);
1786 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001787
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001788 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001789 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001790 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001791 return 1;
1792}
1793
William Lallemand740629e2021-12-14 15:22:29 +01001794/* shows HAProxy version */
1795static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1796{
1797 char *msg = NULL;
1798
1799 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1800}
1801
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001802int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001803{
1804 return 0;
1805}
1806
Willy Tarreau45c742b2016-11-24 14:51:17 +01001807/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001808static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001809{
1810 int v;
1811 int *res;
1812 int mul = 1;
1813
1814 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1815 return 1;
1816
1817 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1818 res = &global.cps_lim;
1819 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1820 res = &global.sps_lim;
1821#ifdef USE_OPENSSL
1822 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1823 res = &global.ssl_lim;
1824#endif
1825 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1826 res = &global.comp_rate_lim;
1827 mul = 1024;
1828 }
1829 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001830 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001831 "'set rate-limit' only supports :\n"
1832 " - 'connections global' to set the per-process maximum connection rate\n"
1833 " - 'sessions global' to set the per-process maximum session rate\n"
1834#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001835 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001836#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001837 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001838 }
1839
Willy Tarreau9d008692019-08-09 11:21:01 +02001840 if (!*args[4])
1841 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001842
1843 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001844 if (v < 0)
1845 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001846
1847 *res = v * mul;
1848
1849 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001850 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001851
1852 return 1;
1853}
1854
William Lallemandf6975e92017-05-26 17:42:10 +02001855/* parse the "expose-fd" argument on the bind lines */
1856static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1857{
1858 if (!*args[cur_arg + 1]) {
1859 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1860 return ERR_ALERT | ERR_FATAL;
1861 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001862 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001863 conf->level |= ACCESS_FD_LISTENERS;
1864 } else {
1865 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1866 args[cur_arg], args[cur_arg+1]);
1867 return ERR_ALERT | ERR_FATAL;
1868 }
1869
1870 return 0;
1871}
1872
William Lallemand74c24fb2016-11-21 17:18:36 +01001873/* parse the "level" argument on the bind lines */
1874static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1875{
1876 if (!*args[cur_arg + 1]) {
1877 memprintf(err, "'%s' : missing level", args[cur_arg]);
1878 return ERR_ALERT | ERR_FATAL;
1879 }
1880
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001881 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001882 conf->level &= ~ACCESS_LVL_MASK;
1883 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001884 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001885 conf->level &= ~ACCESS_LVL_MASK;
1886 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001887 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001888 conf->level &= ~ACCESS_LVL_MASK;
1889 conf->level |= ACCESS_LVL_ADMIN;
1890 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001891 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1892 args[cur_arg], args[cur_arg+1]);
1893 return ERR_ALERT | ERR_FATAL;
1894 }
1895
1896 return 0;
1897}
1898
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001899static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1900{
1901 if (!*args[cur_arg + 1]) {
1902 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1903 return ERR_ALERT | ERR_FATAL;
1904 }
1905
1906 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1907 return 0;
1908 else {
1909 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1910 args[cur_arg], args[cur_arg+1]);
1911 return ERR_ALERT | ERR_FATAL;
1912 }
1913}
1914
Olivier Houchardf886e342017-04-05 22:24:59 +02001915/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001916static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001917{
1918 char *cmsgbuf = NULL;
1919 unsigned char *tmpbuf = NULL;
1920 struct cmsghdr *cmsg;
1921 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001922 struct stream *s = si_strm(si);
Christopher Faulet13a35e52021-12-20 15:34:16 +01001923 struct connection *remote = cs_conn(si_opposite(si)->cs);
Olivier Houchardf886e342017-04-05 22:24:59 +02001924 struct msghdr msghdr;
1925 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001926 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001927 const char *ns_name, *if_name;
1928 unsigned char ns_nlen, if_nlen;
1929 int nb_queued;
1930 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001931 int *tmpfd;
1932 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001933 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001934 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001935 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001936 int ret;
1937
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001938 if (!remote) {
1939 ha_warning("Only works on real connections\n");
1940 goto out;
1941 }
1942
1943 fd = remote->handle.fd;
1944
Olivier Houchardf886e342017-04-05 22:24:59 +02001945 /* Temporary set the FD in blocking mode, that will make our life easier */
1946 old_fcntl = fcntl(fd, F_GETFL);
1947 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001948 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001949 goto out;
1950 }
1951 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1952 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001953 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001954 goto out;
1955 }
1956 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001957 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001958 goto out;
1959 }
Olivier Houchard54740872017-04-06 14:45:14 +02001960 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001961 iov.iov_base = &tot_fd_nb;
1962 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001963 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001964 goto out;
1965 memset(&msghdr, 0, sizeof(msghdr));
1966 /*
1967 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001968 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001969 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001970 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001971 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001972
Olivier Houchardf886e342017-04-05 22:24:59 +02001973 if (tot_fd_nb == 0)
1974 goto out;
1975
1976 /* First send the total number of file descriptors, so that the
1977 * receiving end knows what to expect.
1978 */
1979 msghdr.msg_iov = &iov;
1980 msghdr.msg_iovlen = 1;
1981 ret = sendmsg(fd, &msghdr, 0);
1982 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001983 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001984 goto out;
1985 }
1986
1987 /* Now send the fds */
1988 msghdr.msg_control = cmsgbuf;
1989 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1990 cmsg = CMSG_FIRSTHDR(&msghdr);
1991 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1992 cmsg->cmsg_level = SOL_SOCKET;
1993 cmsg->cmsg_type = SCM_RIGHTS;
1994 tmpfd = (int *)CMSG_DATA(cmsg);
1995
Olivier Houchardf886e342017-04-05 22:24:59 +02001996 /* For each socket, e message is sent, containing the following :
1997 * Size of the namespace name (or 0 if none), as an unsigned char.
1998 * The namespace name, if any
1999 * Size of the interface name (or 0 if none), as an unsigned char
2000 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002001 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002002 */
2003 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002004 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002005 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002006 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002007 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002008 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002009 goto out;
2010 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002011
2012 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002013 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002014 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002015 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002016 continue;
2017
2018 ns_name = if_name = "";
2019 ns_nlen = if_nlen = 0;
2020
2021 /* for now we can only retrieve namespaces and interfaces from
2022 * pure listeners.
2023 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002024 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002025 const struct listener *l = fdtab[cur_fd].owner;
2026
Willy Tarreau818a92e2020-09-03 07:50:19 +02002027 if (l->rx.settings->interface) {
2028 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002029 if_nlen = strlen(if_name);
2030 }
2031
2032#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002033 if (l->rx.settings->netns) {
2034 ns_name = l->rx.settings->netns->node.key;
2035 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002036 }
2037#endif
2038 }
2039
2040 /* put the FD into the CMSG_DATA */
2041 tmpfd[nb_queued++] = cur_fd;
2042
2043 /* first block is <ns_name_len> <ns_name> */
2044 tmpbuf[curoff++] = ns_nlen;
2045 if (ns_nlen)
2046 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2047 curoff += ns_nlen;
2048
2049 /* second block is <if_name_len> <if_name> */
2050 tmpbuf[curoff++] = if_nlen;
2051 if (if_nlen)
2052 memcpy(tmpbuf + curoff, if_name, if_nlen);
2053 curoff += if_nlen;
2054
2055 /* we used to send the listener options here before 2.3 */
2056 memset(tmpbuf + curoff, 0, sizeof(int));
2057 curoff += sizeof(int);
2058
2059 /* there's a limit to how many FDs may be sent at once */
2060 if (nb_queued == MAX_SEND_FD) {
2061 iov.iov_len = curoff;
2062 if (sendmsg(fd, &msghdr, 0) != curoff) {
2063 ha_warning("Failed to transfer sockets\n");
2064 return -1;
2065 }
2066
2067 /* Wait for an ack */
2068 do {
2069 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2070 } while (ret == -1 && errno == EINTR);
2071
2072 if (ret <= 0) {
2073 ha_warning("Unexpected error while transferring sockets\n");
2074 return -1;
2075 }
2076 curoff = 0;
2077 nb_queued = 0;
2078 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002079 }
2080
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002081 /* flush pending stuff */
2082 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002083 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002084 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2085 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002086 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002087 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002088 goto out;
2089 }
2090 }
2091
2092out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002093 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002094 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002095 goto out;
2096 }
2097 appctx->st0 = CLI_ST_END;
2098 free(cmsgbuf);
2099 free(tmpbuf);
2100 return 1;
2101}
2102
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002103static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2104{
2105 if (*args[0] == 'h')
2106 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002107 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002108 else if (*args[0] == 'p')
2109 /* prompt */
2110 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2111 else if (*args[0] == 'q')
2112 /* quit */
2113 appctx->st0 = CLI_ST_END;
2114
2115 return 1;
2116}
Olivier Houchardf886e342017-04-05 22:24:59 +02002117
William Lallemand2f4ce202018-10-26 14:47:47 +02002118void pcli_write_prompt(struct stream *s)
2119{
2120 struct buffer *msg = get_trash_chunk();
2121 struct channel *oc = si_oc(&s->si[0]);
2122
William Lallemanddc12c2e2018-12-13 09:05:46 +01002123 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002124 return;
2125
William Lallemanddc12c2e2018-12-13 09:05:46 +01002126 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002127 chunk_appendf(msg, "+ ");
2128 } else {
2129 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002130 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002131 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002132 else
William Lallemanddae12c72022-02-02 14:13:54 +01002133 chunk_appendf(msg, "%d", s->pcli_next_pid);
2134
2135 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2136 chunk_appendf(msg, "(");
2137
2138 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2139 chunk_appendf(msg, "x");
2140
2141 if (s->pcli_flags & ACCESS_EXPERT)
2142 chunk_appendf(msg, "e");
2143
2144 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2145 chunk_appendf(msg, "d");
2146
2147 chunk_appendf(msg, ")");
2148 }
2149
2150 chunk_appendf(msg, "> ");
2151
2152
William Lallemandebf61802018-12-11 16:10:57 +01002153 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002154 co_inject(oc, msg->area, msg->data);
2155}
2156
William Lallemand291810d2018-10-26 14:47:38 +02002157
William Lallemandcf62f7e2018-10-26 14:47:40 +02002158/* The pcli_* functions are used for the CLI proxy in the master */
2159
William Lallemanddeeaa592018-10-26 14:47:48 +02002160void pcli_reply_and_close(struct stream *s, const char *msg)
2161{
2162 struct buffer *buf = get_trash_chunk();
2163
2164 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002165 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002166}
2167
William Lallemand291810d2018-10-26 14:47:38 +02002168static enum obj_type *pcli_pid_to_server(int proc_pid)
2169{
2170 struct mworker_proc *child;
2171
William Lallemand99e0bb92020-11-05 10:28:53 +01002172 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002173 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002174 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002175
William Lallemand291810d2018-10-26 14:47:38 +02002176 list_for_each_entry(child, &proc_list, list) {
2177 if (child->pid == proc_pid){
2178 return &child->srv->obj_type;
2179 }
2180 }
2181 return NULL;
2182}
2183
2184/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2185 * Return:
2186 * 0: master
2187 * > 0: pid of a worker
2188 * < 0: didn't find a worker
2189 */
2190static int pcli_prefix_to_pid(const char *prefix)
2191{
2192 int proc_pid;
2193 struct mworker_proc *child;
2194 char *errtol = NULL;
2195
2196 if (*prefix != '@') /* not a prefix, should not happen */
2197 return -1;
2198
2199 prefix++;
2200 if (!*prefix) /* sent @ alone, return the master */
2201 return 0;
2202
2203 if (strcmp("master", prefix) == 0) {
2204 return 0;
2205 } else if (*prefix == '!') {
2206 prefix++;
2207 if (!*prefix)
2208 return -1;
2209
2210 proc_pid = strtol(prefix, &errtol, 10);
2211 if (*errtol != '\0')
2212 return -1;
2213 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002214 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002215 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002216 if (child->pid == proc_pid){
2217 return child->pid;
2218 }
2219 }
2220 } else {
2221 struct mworker_proc *chosen = NULL;
2222 /* this is a relative pid */
2223
2224 proc_pid = strtol(prefix, &errtol, 10);
2225 if (*errtol != '\0')
2226 return -1;
2227
2228 if (proc_pid == 0) /* return the master */
2229 return 0;
2230
2231 /* chose the right process, the current one is the one with the
2232 least number of reloads */
2233 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002234 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002235 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002236 if (child->reloads == 0)
2237 return child->pid;
2238 else if (chosen == NULL || child->reloads < chosen->reloads)
2239 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002240 }
2241 if (chosen)
2242 return chosen->pid;
2243 }
2244 return -1;
2245}
2246
William Lallemandbddd33a2018-12-11 16:10:53 +01002247/* Return::
2248 * >= 0 : number of words to escape
2249 * = -1 : error
2250 */
2251
2252int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2253{
2254 if (argl < 1)
2255 return 0;
2256
2257 /* there is a prefix */
2258 if (args[0][0] == '@') {
2259 int target_pid = pcli_prefix_to_pid(args[0]);
2260
2261 if (target_pid == -1) {
2262 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2263 return -1;
2264 }
2265
2266 /* if the prefix is alone, define a default target */
2267 if (argl == 1)
2268 s->pcli_next_pid = target_pid;
2269 else
2270 *next_pid = target_pid;
2271 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002272 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002273 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002274 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002275
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002276 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002277 channel_shutr_now(&s->req);
2278 channel_shutw_now(&s->res);
2279 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002280 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002281 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2282 memprintf(errmsg, "Permission denied!\n");
2283 return -1;
2284 }
2285 s->pcli_flags &= ~ACCESS_LVL_MASK;
2286 s->pcli_flags |= ACCESS_LVL_OPER;
2287 return argl;
2288
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002289 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002290 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2291 memprintf(errmsg, "Permission denied!\n");
2292 return -1;
2293 }
2294 s->pcli_flags &= ~ACCESS_LVL_MASK;
2295 s->pcli_flags |= ACCESS_LVL_USER;
2296 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002297
2298 } else if (strcmp(args[0], "expert-mode") == 0) {
2299 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2300 memprintf(errmsg, "Permission denied!\n");
2301 return -1;
2302 }
2303
2304 s->pcli_flags &= ~ACCESS_EXPERT;
2305 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2306 s->pcli_flags |= ACCESS_EXPERT;
2307 return argl;
2308
2309 } else if (strcmp(args[0], "experimental-mode") == 0) {
2310 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2311 memprintf(errmsg, "Permission denied!\n");
2312 return -1;
2313 }
2314 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2315 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2316 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2317 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002318 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2319 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2320 memprintf(errmsg, "Permission denied!\n");
2321 return -1;
2322 }
2323 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2324 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2325 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2326 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002327 }
2328
2329 return 0;
2330}
2331
2332/*
2333 * Parse the CLI request:
2334 * - It does basically the same as the cli_io_handler, but as a proxy
2335 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002336 *
2337 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002338 * - the number of characters to forward or
2339 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002340 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002341int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002342{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002343 char *str;
2344 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002345 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002346 int argl; /* number of args */
2347 char *p;
2348 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002349 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002350 int wtrim = 0; /* number of words to trim */
2351 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002352 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002353 int i = 0;
2354
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002355 /* we cannot deal with a wrapping buffer, so let's take care of this
2356 * first.
2357 */
2358 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2359 b_slow_realign(&req->buf, trash.area, co_data(req));
2360
2361 str = (char *)ci_head(req);
2362 end = (char *)ci_stop(req);
2363
William Lallemandbddd33a2018-12-11 16:10:53 +01002364 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002365
William Lallemanddc12c2e2018-12-13 09:05:46 +01002366 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002367
2368 /* Looks for the end of one command */
2369 while (p+reql < end) {
2370 /* handle escaping */
2371 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002372 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002373 continue;
2374 }
2375 if (p[reql] == ';' || p[reql] == '\n') {
2376 /* found the end of the command */
2377 p[reql] = '\n';
2378 reql++;
2379 break;
2380 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002381 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002382 }
William Lallemandebf61802018-12-11 16:10:57 +01002383 } else {
2384 while (p+reql < end) {
2385 if (p[reql] == '\n') {
2386 /* found the end of the line */
2387 reql++;
2388 break;
2389 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002390 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002391 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002392 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002393
William Lallemandbddd33a2018-12-11 16:10:53 +01002394 /* set end to first byte after the end of the command */
2395 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002396
William Lallemandbddd33a2018-12-11 16:10:53 +01002397 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002398 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002399 return -1;
2400 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002401
William Lallemand3301f3e2018-12-13 09:05:48 +01002402 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2403 if (reql == 1) /* last line of the payload */
2404 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002405 return reql;
2406 }
2407
William Lallemandbddd33a2018-12-11 16:10:53 +01002408 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002409
William Lallemandbddd33a2018-12-11 16:10:53 +01002410 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002411 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002412 /* skip leading spaces/tabs */
2413 p += strspn(p, " \t");
2414 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002415 break;
2416
William Lallemandbddd33a2018-12-11 16:10:53 +01002417 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002418 while (1) {
2419 p += strcspn(p, " \t\\");
2420 /* escaped chars using backlashes (\) */
2421 if (*p == '\\') {
2422 if (!*++p)
2423 break;
2424 if (!*++p)
2425 break;
2426 } else {
2427 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002428 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002429 }
William Lallemandfe249c32020-06-18 18:03:57 +02002430 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002431 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432 }
2433
William Lallemandbddd33a2018-12-11 16:10:53 +01002434 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002435
Willy Tarreauf14c7572021-03-13 10:59:23 +01002436 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002437 args[i] = NULL;
2438
2439 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2440
2441 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002442 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002443 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002444 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002445 if (*p == '\0')
2446 *p = ' ';
2447 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448 }
2449
William Lallemand3301f3e2018-12-13 09:05:48 +01002450 payload = strstr(str, PAYLOAD_PATTERN);
2451 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2452 /* if the payload pattern is at the end */
2453 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002454 }
2455
William Lallemandbddd33a2018-12-11 16:10:53 +01002456 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002457
William Lallemandbddd33a2018-12-11 16:10:53 +01002458 if (wtrim > 0) {
2459 trim = &args[wtrim][0];
2460 if (trim == NULL) /* if this was the last word in the table */
2461 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002462
William Lallemandbddd33a2018-12-11 16:10:53 +01002463 b_del(&req->buf, trim - str);
2464
William Lallemandb7ea1412018-12-13 09:05:47 +01002465 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 } else if (wtrim < 0) {
2467 /* parsing error */
2468 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002469 } else {
2470 /* the whole string */
2471 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002472 }
2473
William Lallemandb7ea1412018-12-13 09:05:47 +01002474 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002475
2476 /* the mcli-debug-mode is only sent to the applet of the master */
2477 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2478 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2479 ret += strlen("mcli-debug-mode on -") + 2;
2480 }
William Lallemand7267f782022-02-01 16:08:50 +01002481 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2482 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2483 ret += strlen("experimental-mode on -") + 2;
2484 }
2485 if (s->pcli_flags & ACCESS_EXPERT) {
2486 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2487 ret += strlen("expert-mode on -") + 2;
2488 }
2489
William Lallemandb7ea1412018-12-13 09:05:47 +01002490 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2491 goto end;
2492 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002493 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2494 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002495 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002496 ci_insert_line2(req, 0, "user -", strlen("user -"));
2497 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002498 }
2499 }
2500end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002501
William Lallemandb7ea1412018-12-13 09:05:47 +01002502 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002503}
2504
2505int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2506{
William Lallemandbddd33a2018-12-11 16:10:53 +01002507 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002508 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002509 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002510
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002511 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002512 * current one. Just wait. At this stage, errors should be handled by
2513 * the response analyzer.
2514 */
2515 if (s->res.analysers & AN_RES_WAIT_CLI)
2516 return 0;
2517
William Lallemandb7ea1412018-12-13 09:05:47 +01002518 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2519 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2520
William Lallemandcf62f7e2018-10-26 14:47:40 +02002521read_again:
2522 /* if the channel is closed for read, we won't receive any more data
2523 from the client, but we don't want to forward this close to the
2524 server */
2525 channel_dont_close(req);
2526
2527 /* We don't know yet to which server we will connect */
2528 channel_dont_connect(req);
2529
William Lallemandcf62f7e2018-10-26 14:47:40 +02002530 req->flags |= CF_READ_DONTWAIT;
2531
2532 /* need more data */
2533 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002534 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002535
2536 /* If there is data available for analysis, log the end of the idle time. */
2537 if (c_data(req) && s->logs.t_idle == -1)
2538 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2539
William Lallemandbddd33a2018-12-11 16:10:53 +01002540 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002541 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002542 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002543 /* enough data */
2544
William Lallemandcf62f7e2018-10-26 14:47:40 +02002545 /* forward only 1 command */
2546 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002547
William Lallemanddc12c2e2018-12-13 09:05:46 +01002548 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002549 /* we send only 1 command per request, and we write close after it */
2550 channel_shutw_now(req);
2551 } else {
2552 pcli_write_prompt(s);
2553 }
2554
2555 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002556 s->res.analysers |= AN_RES_WAIT_CLI;
2557
William Lallemandebf61802018-12-11 16:10:57 +01002558 if (!(s->flags & SF_ASSIGNED)) {
2559 if (next_pid > -1)
2560 target_pid = next_pid;
2561 else
2562 target_pid = s->pcli_next_pid;
2563 /* we can connect now */
2564 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002565
William Lallemanddcbe7b92021-12-10 14:14:53 +01002566 if (!s->target)
2567 goto server_disconnect;
2568
William Lallemandebf61802018-12-11 16:10:57 +01002569 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2570 channel_auto_connect(req);
2571 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002572
2573 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002574 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002575 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002576 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002577 } else if (to_forward == -1) {
2578 if (errmsg) {
2579 /* there was an error during the parsing */
2580 pcli_reply_and_close(s, errmsg);
2581 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2582 return 0;
2583 }
2584 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002585 }
2586
2587 return 0;
2588
2589send_help:
2590 b_reset(&req->buf);
2591 b_putblk(&req->buf, "help\n", 5);
2592 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002593
Christopher Faulet0f727da2022-01-18 08:44:23 +01002594missing_data:
2595 if (req->flags & CF_SHUTR) {
2596 /* There is no more request or a only a partial one and we
2597 * receive a close from the client, we can leave */
2598 channel_shutw_now(&s->res);
2599 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2600 return 1;
2601 }
2602 else if (channel_full(req, global.tune.maxrewrite)) {
2603 /* buffer is full and we didn't catch the end of a command */
2604 goto send_help;
2605 }
2606 return 0;
2607
William Lallemanddcbe7b92021-12-10 14:14:53 +01002608server_disconnect:
2609 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2610 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002611}
2612
2613int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2614{
2615 struct proxy *fe = strm_fe(s);
2616 struct proxy *be = s->be;
2617
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002618 if (rep->flags & CF_READ_ERROR) {
2619 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002620 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002621 s->res.analysers &= ~AN_RES_WAIT_CLI;
2622 return 0;
2623 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002624 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2625 rep->flags |= CF_NEVER_WAIT;
2626
2627 /* don't forward the close */
2628 channel_dont_close(&s->res);
2629 channel_dont_close(&s->req);
2630
William Lallemanddc12c2e2018-12-13 09:05:46 +01002631 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002632 s->res.analysers &= ~AN_RES_WAIT_CLI;
2633 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2634 return 0;
2635 }
2636
William Lallemandcf62f7e2018-10-26 14:47:40 +02002637 /* forward the data */
2638 if (ci_data(rep)) {
2639 c_adv(rep, ci_data(rep));
2640 return 0;
2641 }
2642
2643 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2644 /* stream cleanup */
2645
William Lallemand2f4ce202018-10-26 14:47:47 +02002646 pcli_write_prompt(s);
2647
William Lallemandcf62f7e2018-10-26 14:47:40 +02002648 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2649 si_shutr(&s->si[1]);
2650 si_shutw(&s->si[1]);
2651
2652 /*
2653 * starting from there this the same code as
2654 * http_end_txn_clean_session().
2655 *
2656 * It allows to do frontend keepalive while reconnecting to a
2657 * new server for each request.
2658 */
2659
2660 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002661 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002662 if (unlikely(s->srv_conn))
2663 sess_change_server(s, NULL);
2664 }
2665
2666 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2667 stream_process_counters(s);
2668
2669 /* don't count other requests' data */
2670 s->logs.bytes_in -= ci_data(&s->req);
2671 s->logs.bytes_out -= ci_data(&s->res);
2672
2673 /* we may need to know the position in the queue */
2674 pendconn_free(s);
2675
2676 /* let's do a final log if we need it */
2677 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2678 !(s->flags & SF_MONITOR) &&
2679 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2680 s->do_log(s);
2681 }
2682
2683 /* stop tracking content-based counters */
2684 stream_stop_content_counters(s);
2685 stream_update_time_stats(s);
2686
2687 s->logs.accept_date = date; /* user-visible date for logging */
2688 s->logs.tv_accept = now; /* corrected date for internal use */
2689 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2690 s->logs.t_idle = -1;
2691 tv_zero(&s->logs.tv_request);
2692 s->logs.t_queue = -1;
2693 s->logs.t_connect = -1;
2694 s->logs.t_data = -1;
2695 s->logs.t_close = 0;
2696 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2697 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2698
2699 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2700 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2701
2702 stream_del_srv_conn(s);
2703 if (objt_server(s->target)) {
2704 if (s->flags & SF_CURR_SESS) {
2705 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002706 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002707 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002708 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002709 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002710 }
2711
2712 s->target = NULL;
2713
2714 /* only release our endpoint if we don't intend to reuse the
2715 * connection.
2716 */
2717 if (!si_conn_ready(&s->si[1])) {
Christopher Faulete00ad352021-12-16 14:44:31 +01002718 si_reset_endpoint(&s->si[1]);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002719 s->srv_conn = NULL;
2720 }
2721
Christopher Faulet16f16af2021-10-27 09:34:56 +02002722 sockaddr_free(&s->si[1].dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002723
William Lallemandcf62f7e2018-10-26 14:47:40 +02002724 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2725 s->si[1].err_type = SI_ET_NONE;
2726 s->si[1].conn_retries = 0; /* used for logging too */
2727 s->si[1].exp = TICK_ETERNITY;
2728 s->si[1].flags &= SI_FL_ISBACK | SI_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet22dc2482019-07-16 14:43:08 +02002729 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 +02002730 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);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002731 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2732 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2733 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2734 /* reinitialise the current rule list pointer to NULL. We are sure that
2735 * any rulelist match the NULL pointer.
2736 */
2737 s->current_rule_list = NULL;
2738
2739 s->be = strm_fe(s);
2740 s->logs.logwait = strm_fe(s)->to_log;
2741 s->logs.level = 0;
2742 stream_del_srv_conn(s);
2743 s->target = NULL;
2744 /* re-init store persistence */
2745 s->store_count = 0;
2746 s->uniq_id = global.req_count++;
2747
2748 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2749
2750 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2751
William Lallemandcf62f7e2018-10-26 14:47:40 +02002752 s->res.analysers &= ~AN_RES_WAIT_CLI;
2753
2754 /* We must trim any excess data from the response buffer, because we
2755 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002756 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002757 * we want those data to come along with next response. A typical
2758 * example of such data would be from a buggy server responding to
2759 * a HEAD with some data, or sending more than the advertised
2760 * content-length.
2761 */
2762 if (unlikely(ci_data(&s->res)))
2763 b_set_data(&s->res.buf, co_data(&s->res));
2764
2765 /* Now we can realign the response buffer */
2766 c_realign_if_empty(&s->res);
2767
2768 s->req.rto = strm_fe(s)->timeout.client;
2769 s->req.wto = TICK_ETERNITY;
2770
2771 s->res.rto = TICK_ETERNITY;
2772 s->res.wto = strm_fe(s)->timeout.client;
2773
2774 s->req.rex = TICK_ETERNITY;
2775 s->req.wex = TICK_ETERNITY;
2776 s->req.analyse_exp = TICK_ETERNITY;
2777 s->res.rex = TICK_ETERNITY;
2778 s->res.wex = TICK_ETERNITY;
2779 s->res.analyse_exp = TICK_ETERNITY;
2780 s->si[1].hcto = TICK_ETERNITY;
2781
2782 /* we're removing the analysers, we MUST re-enable events detection.
2783 * We don't enable close on the response channel since it's either
2784 * already closed, or in keep-alive with an idle connection handler.
2785 */
2786 channel_auto_read(&s->req);
2787 channel_auto_close(&s->req);
2788 channel_auto_read(&s->res);
2789
2790
2791 return 1;
2792 }
2793 return 0;
2794}
2795
William Lallemand8a022572018-10-26 14:47:35 +02002796/*
2797 * The mworker functions are used to initialize the CLI in the master process
2798 */
2799
William Lallemand309dc9a2018-10-26 14:47:45 +02002800 /*
2801 * Stop the mworker proxy
2802 */
2803void mworker_cli_proxy_stop()
2804{
William Lallemand550db6d2018-11-06 17:37:12 +01002805 if (mworker_proxy)
2806 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002807}
2808
William Lallemand8a022572018-10-26 14:47:35 +02002809/*
2810 * Create the mworker CLI proxy
2811 */
2812int mworker_cli_proxy_create()
2813{
2814 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002815 char *msg = NULL;
2816 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002817
William Lallemandae787ba2021-07-29 15:13:22 +02002818 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002819 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002820 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002821
William Lallemandcf62f7e2018-10-26 14:47:40 +02002822 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002823 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2824 mworker_proxy->timeout.client = 0; /* no timeout */
2825 mworker_proxy->conf.file = strdup("MASTER");
2826 mworker_proxy->conf.line = 0;
2827 mworker_proxy->accept = frontend_accept;
2828 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2829
2830 /* Does not init the default target the CLI applet, but must be done in
2831 * the request parsing code */
2832 mworker_proxy->default_target = NULL;
2833
William Lallemand8a022572018-10-26 14:47:35 +02002834 /* create all servers using the mworker_proc list */
2835 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002836 struct server *newsrv = NULL;
2837 struct sockaddr_storage *sk;
2838 int port1, port2, port;
2839 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002840
William Lallemanda31b09e2020-01-14 15:25:02 +01002841 /* only the workers support the master CLI */
2842 if (!(child->options & PROC_O_TYPE_WORKER))
2843 continue;
2844
William Lallemand8a022572018-10-26 14:47:35 +02002845 newsrv = new_server(mworker_proxy);
2846 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002847 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002848
2849 /* we don't know the new pid yet */
2850 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002851 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002852 else
2853 memprintf(&msg, "old-%d", child->pid);
2854
2855 newsrv->next = mworker_proxy->srv;
2856 mworker_proxy->srv = newsrv;
2857 newsrv->conf.file = strdup(msg);
2858 newsrv->id = strdup(msg);
2859 newsrv->conf.line = 0;
2860
2861 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002862 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002863 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002864 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002865 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002866 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002867
Willy Tarreau5fc93282020-09-16 18:25:03 +02002868 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002869 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002870 }
2871
2872 /* no port specified */
2873 newsrv->flags |= SRV_F_MAPPORTS;
2874 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002875 /* don't let the server participate to load balancing */
2876 newsrv->iweight = 0;
2877 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002878 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002879
2880 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002881 }
William Lallemandae787ba2021-07-29 15:13:22 +02002882
2883 mworker_proxy->next = proxies_list;
2884 proxies_list = mworker_proxy;
2885
William Lallemand8a022572018-10-26 14:47:35 +02002886 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002887
2888error:
William Lallemand744a0892018-11-22 16:46:51 +01002889
2890 list_for_each_entry(child, &proc_list, list) {
2891 free((char *)child->srv->conf.file); /* cast because of const char * */
2892 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002893 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002894 }
William Lallemandae787ba2021-07-29 15:13:22 +02002895 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002896 free(msg);
2897
William Lallemandae787ba2021-07-29 15:13:22 +02002898error_proxy:
2899 ha_alert("%s\n", errmsg);
2900 free(errmsg);
2901
William Lallemand744a0892018-11-22 16:46:51 +01002902 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002903}
Olivier Houchardf886e342017-04-05 22:24:59 +02002904
William Lallemandce83b4a2018-10-26 14:47:30 +02002905/*
William Lallemande7361152018-10-26 14:47:36 +02002906 * Create a new listener for the master CLI proxy
2907 */
2908int mworker_cli_proxy_new_listener(char *line)
2909{
2910 struct bind_conf *bind_conf;
2911 struct listener *l;
2912 char *err = NULL;
2913 char *args[MAX_LINE_ARGS + 1];
2914 int arg;
2915 int cur_arg;
2916
William Lallemand2e945c82019-11-25 09:58:37 +01002917 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002918 args[0] = line;
2919
2920 /* args is a bind configuration with spaces replaced by commas */
2921 while (*line && arg < MAX_LINE_ARGS) {
2922
2923 if (*line == ',') {
2924 *line++ = '\0';
2925 while (*line == ',')
2926 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002927 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002928 }
2929 line++;
2930 }
2931
William Lallemand2e945c82019-11-25 09:58:37 +01002932 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002933
2934 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002935 if (!bind_conf)
2936 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002937
2938 bind_conf->level &= ~ACCESS_LVL_MASK;
2939 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002940 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002941
2942 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2943 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002944 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002945 }
2946
2947 cur_arg = 1;
2948
2949 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002950 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002951 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002952
2953 kw = bind_find_kw(args[cur_arg]);
2954 if (kw) {
2955 if (!kw->parse) {
2956 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2957 args[0], args[1], args[cur_arg]);
2958 goto err;
2959 }
2960
Willy Tarreau4975d142021-03-13 11:00:33 +01002961 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002962 if (err)
2963 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2964 else
2965 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2966 args[0], args[1], args[cur_arg]);
2967 goto err;
2968 }
2969
2970 cur_arg += 1 + kw->skip;
2971 continue;
2972 }
2973
Willy Tarreau433b05f2021-03-12 10:14:07 +01002974 best = bind_find_best_kw(args[cur_arg]);
2975 if (best)
2976 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2977 args[0], args[1], args[cur_arg], best);
2978 else
2979 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2980 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002981 goto err;
2982 }
2983
2984
2985 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002986 l->accept = session_accept_fd;
2987 l->default_target = mworker_proxy->default_target;
2988 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002989 l->options |= LI_O_UNLIMITED;
2990 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002991 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002992 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002993 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002994 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002995
2996 return 0;
2997
2998err:
2999 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003000 free(err);
3001 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02003002 return -1;
3003
3004}
3005
3006/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003007 * Create a new CLI socket using a socketpair for a worker process
3008 * <mworker_proc> is the process structure, and <proc> is the process number
3009 */
3010int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3011{
3012 struct bind_conf *bind_conf;
3013 struct listener *l;
3014 char *path = NULL;
3015 char *err = NULL;
3016
3017 /* master pipe to ensure the master is still alive */
3018 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3019 ha_alert("Cannot create worker socketpair.\n");
3020 return -1;
3021 }
3022
3023 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003024 if (!global.cli_fe) {
3025 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003026 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003027 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003028 }
3029 }
3030
Willy Tarreau4975d142021-03-13 11:00:33 +01003031 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003032 if (!bind_conf)
3033 goto error;
3034
William Lallemandce83b4a2018-10-26 14:47:30 +02003035 bind_conf->level &= ~ACCESS_LVL_MASK;
3036 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003037 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003038
William Lallemandce83b4a2018-10-26 14:47:30 +02003039 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3040 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003041 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003042 }
3043
Willy Tarreau4975d142021-03-13 11:00:33 +01003044 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003045 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003046 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003047 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003048 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003049 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003050
3051 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003052 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01003053 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01003054 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003055 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003056 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003057 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003058 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003059 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003060 }
3061
3062 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003063
3064error:
3065 close(mworker_proc->ipc_fd[0]);
3066 close(mworker_proc->ipc_fd[1]);
3067 free(err);
3068
3069 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003070}
3071
William Lallemand74c24fb2016-11-21 17:18:36 +01003072static struct applet cli_applet = {
3073 .obj_type = OBJ_TYPE_APPLET,
3074 .name = "<CLI>", /* used for logging */
3075 .fct = cli_io_handler,
3076 .release = cli_release_handler,
3077};
3078
William Lallemand99e0bb92020-11-05 10:28:53 +01003079/* master CLI */
3080static struct applet mcli_applet = {
3081 .obj_type = OBJ_TYPE_APPLET,
3082 .name = "<MCLI>", /* used for logging */
3083 .fct = cli_io_handler,
3084 .release = cli_release_handler,
3085};
3086
Willy Tarreau0a739292016-11-22 20:21:23 +01003087/* register cli keywords */
3088static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003089 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3090 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3091 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3092 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003093 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3094 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003095 { { "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 +02003096 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3097 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3098 { { "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 },
3099 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3100 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3101 { { "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 },
3102 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3103 { { "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 },
3104 { { "show", "activity", NULL }, "show activity : show per-thread activity stats (for support/developers)", cli_parse_default, cli_io_handler_show_activity, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003105 { { "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 +02003106 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3107 { { "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 +01003108 {{},}
3109}};
3110
Willy Tarreau0108d902018-11-25 19:14:37 +01003111INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3112
William Lallemand74c24fb2016-11-21 17:18:36 +01003113static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003114 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003115 { 0, NULL, NULL },
3116}};
3117
Willy Tarreau0108d902018-11-25 19:14:37 +01003118INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3119
William Lallemand74c24fb2016-11-21 17:18:36 +01003120static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003121 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3122 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003123 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003124 { NULL, NULL, 0 },
3125}};
3126
Willy Tarreau0108d902018-11-25 19:14:37 +01003127INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003128
3129/*
3130 * Local variables:
3131 * c-indent-level: 8
3132 * c-basic-offset: 8
3133 * End:
3134 */