blob: ec164aebd4830654e5b02439b6b7707db53e4066 [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;
125 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
126 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
127 continue;
128
129 /* OK this command is visible */
130 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
131 if (!kw->str_kw[idx])
132 break; // end of keyword
133 if (!args || !args[idx] || !*args[idx])
134 break; // end of command line
135 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
136 break;
137 if (idx + 1 > length)
138 length = idx + 1;
139 }
140 }
141 }
142
Willy Tarreaub7364582021-03-12 18:24:46 +0100143 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100144 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200145 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100146 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Willy Tarreau5db446d2021-05-10 07:47:05 +0200147 else if (!length && (!args || !*args || !**args)) // no match
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100148 chunk_strcat(tmp, "Unknown command. Please enter one of the following commands only:\n");
149 else // partial match
150 chunk_strcat(tmp, "Unknown command, but maybe one of the following ones is a better match:\n");
151
Willy Tarreaub7364582021-03-12 18:24:46 +0100152 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
153 matches[idx].kw = NULL;
154 matches[idx].dist = INT_MAX;
155 }
156
157 /* In case of partial match we'll look for the best matching entries
158 * starting from position <length>
159 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100160 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100161 list_for_each_entry(kw_list, &cli_keywords.list, list) {
162 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100163 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100164 continue;
165 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
166 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
167 continue;
168
169 for (idx = 0; idx < length; idx++) {
170 if (!kw->str_kw[idx])
171 break; // end of keyword
172 if (!args || !args[idx] || !*args[idx])
173 break; // end of command line
174 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
175 break;
176 }
177
178 /* extra non-matching words are fuzzy-matched */
179 if (kw->usage && idx == length && args[idx] && *args[idx]) {
180 uint8_t word_sig[1024];
181 uint8_t list_sig[1024];
182 int dist = 0;
183 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100184 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100185
186 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100187 * on the remaining words. For this we're computing the signature
188 * of everything that remains and the cumulated length of the
189 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100190 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100191 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100192 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
193 update_word_fingerprint(word_sig, args[i]);
194 totlen += strlen(args[i]);
195 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100196
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100197 memset(list_sig, 0, sizeof(list_sig));
198 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
199 update_word_fingerprint(list_sig, kw->str_kw[i]);
200 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100201 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100202
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100203 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100204
205 /* insert this one at its place if relevant, in order to keep only
206 * the best matches.
207 */
208 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100209 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100210 matches[CLI_MAX_MATCHES-1] = swp;
211 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
212 if (matches[idx+1].dist >= matches[idx].dist)
213 break;
214 matches[idx+1] = matches[idx];
215 matches[idx] = swp;
216 }
217 }
218 }
219 }
220 }
221 }
222
Willy Tarreauec197e82021-03-15 10:35:04 +0100223 if (matches[0].kw) {
224 /* we have fuzzy matches, let's propose them */
225 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
226 kw = matches[idx].kw;
227 if (!kw)
228 break;
229
230 /* stop the dump if some words look very unlikely candidates */
231 if (matches[idx].dist > 5*matches[0].dist/2)
232 break;
233
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200234 if (help_entries < CLI_MAX_HELP_ENTRIES)
235 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100236 }
237 }
238
William Lallemand74c24fb2016-11-21 17:18:36 +0100239 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100240 /* no full dump if we've already found nice candidates */
241 if (matches[0].kw)
242 break;
243
Willy Tarreau91bc3592021-03-12 15:20:39 +0100244 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200245
Willy Tarreau91bc3592021-03-12 15:20:39 +0100246 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100247 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100248 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100249 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100250 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200251
Willy Tarreau91bc3592021-03-12 15:20:39 +0100252 /* in master don't display commands that have neither the master bit
253 * nor the master-only bit.
254 */
255 if ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
256 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
257 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200258
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100259 for (idx = 0; idx < length; idx++) {
260 if (!kw->str_kw[idx])
261 break; // end of keyword
262 if (!args || !args[idx] || !*args[idx])
263 break; // end of command line
264 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
265 break;
266 }
267
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200268 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
269 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100270 }
271 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100272
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200273 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
274
275 for (idx = 0; idx < help_entries; idx++)
276 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
277
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100278 /* always show the prompt/help/quit commands */
279 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200280 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200281 " prompt : toggle interactive mode with prompt\n"
282 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100283
William Lallemand74c24fb2016-11-21 17:18:36 +0100284 chunk_init(&out, NULL, 0);
285 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200286 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200287
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100288 appctx->ctx.cli.severity = LOG_INFO;
289 appctx->ctx.cli.msg = dynamic_usage_msg;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200290 appctx->st0 = CLI_ST_PRINT;
291
William Lallemand74c24fb2016-11-21 17:18:36 +0100292 return dynamic_usage_msg;
293}
294
295struct cli_kw* cli_find_kw(char **args)
296{
297 struct cli_kw_list *kw_list;
298 struct cli_kw *kw;/* current cli_kw */
299 char **tmp_args;
300 const char **tmp_str_kw;
301 int found = 0;
302
303 if (LIST_ISEMPTY(&cli_keywords.list))
304 return NULL;
305
306 list_for_each_entry(kw_list, &cli_keywords.list, list) {
307 kw = &kw_list->kw[0];
308 while (*kw->str_kw) {
309 tmp_args = args;
310 tmp_str_kw = kw->str_kw;
311 while (*tmp_str_kw) {
312 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
313 found = 1;
314 } else {
315 found = 0;
316 break;
317 }
318 tmp_args++;
319 tmp_str_kw++;
320 }
321 if (found)
322 return (kw);
323 kw++;
324 }
325 }
326 return NULL;
327}
328
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100329struct cli_kw* cli_find_kw_exact(char **args)
330{
331 struct cli_kw_list *kw_list;
332 int found = 0;
333 int i;
334 int j;
335
336 if (LIST_ISEMPTY(&cli_keywords.list))
337 return NULL;
338
339 list_for_each_entry(kw_list, &cli_keywords.list, list) {
340 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
341 found = 1;
342 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
343 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
344 break;
345 }
346 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
347 found = 0;
348 break;
349 }
350 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
351 found = 0;
352 break;
353 }
354 }
355 if (found)
356 return &kw_list->kw[i];
357 }
358 }
359 return NULL;
360}
361
William Lallemand74c24fb2016-11-21 17:18:36 +0100362void cli_register_kw(struct cli_kw_list *kw_list)
363{
Willy Tarreau2b718102021-04-21 07:32:39 +0200364 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100365}
366
367
368/* allocate a new stats frontend named <name>, and return it
369 * (or NULL in case of lack of memory).
370 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100371static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100372{
373 struct proxy *fe;
374
375 fe = calloc(1, sizeof(*fe));
376 if (!fe)
377 return NULL;
378
379 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100380 fe->next = proxies_list;
381 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100382 fe->last_change = now.tv_sec;
383 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200384 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100385 fe->maxconn = 10; /* default to 10 concurrent connections */
386 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
387 fe->conf.file = strdup(file);
388 fe->conf.line = line;
389 fe->accept = frontend_accept;
390 fe->default_target = &cli_applet.obj_type;
391
392 /* the stats frontend is the only one able to assign ID #0 */
393 fe->conf.id.key = fe->uuid = 0;
394 eb32_insert(&used_proxy_id, &fe->conf.id);
395 return fe;
396}
397
398/* This function parses a "stats" statement in the "global" section. It returns
399 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
400 * error message into the <err> buffer which will be preallocated. The trailing
401 * '\n' must not be written. The function must be called with <args> pointing to
402 * the first word after "stats".
403 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100404static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
405 const struct proxy *defpx, const char *file, int line,
406 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100407{
408 struct bind_conf *bind_conf;
409 struct listener *l;
410
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100411 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100412 int cur_arg;
413
414 if (*args[2] == 0) {
415 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
416 return -1;
417 }
418
Willy Tarreau4975d142021-03-13 11:00:33 +0100419 if (!global.cli_fe) {
420 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100421 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
422 return -1;
423 }
424 }
425
Willy Tarreau4975d142021-03-13 11:00:33 +0100426 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200427 if (!bind_conf) {
428 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
429 return -1;
430 }
William Lallemand07a62f72017-05-24 00:57:40 +0200431 bind_conf->level &= ~ACCESS_LVL_MASK;
432 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100433
Willy Tarreau4975d142021-03-13 11:00:33 +0100434 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100435 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
436 file, line, args[0], args[1], err && *err ? *err : "error");
437 return -1;
438 }
439
440 cur_arg = 3;
441 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100442 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100443 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100444 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100445
446 kw = bind_find_kw(args[cur_arg]);
447 if (kw) {
448 if (!kw->parse) {
449 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
450 args[0], args[1], args[cur_arg]);
451 return -1;
452 }
453
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100454 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
455
456 /* FIXME: this is ugly, we don't have a way to collect warnings,
457 * yet some important bind keywords may report warnings that we
458 * must display.
459 */
460 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
461 indent_msg(err, 2);
462 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
463 ha_free(err);
464 }
465
466 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100467 if (err && *err)
468 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
469 else
470 memprintf(err, "'%s %s' : error encountered while processing '%s'",
471 args[0], args[1], args[cur_arg]);
472 return -1;
473 }
474
475 cur_arg += 1 + kw->skip;
476 continue;
477 }
478
Willy Tarreau433b05f2021-03-12 10:14:07 +0100479 best = bind_find_best_kw(args[cur_arg]);
480 if (best)
481 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
482 args[0], args[1], args[cur_arg], best);
483 else
484 memprintf(err, "'%s %s' : unknown keyword '%s'.",
485 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100486 return -1;
487 }
488
489 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100490 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +0100491 l->default_target = global.cli_fe->default_target;
William Lallemand74c24fb2016-11-21 17:18:36 +0100492 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
493 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100494 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100495 }
496 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100497 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100498 unsigned timeout;
499 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
500
Willy Tarreau9faebe32019-06-07 19:00:37 +0200501 if (res == PARSE_TIME_OVER) {
502 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
503 args[2], args[0], args[1]);
504 return -1;
505 }
506 else if (res == PARSE_TIME_UNDER) {
507 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
508 args[2], args[0], args[1]);
509 return -1;
510 }
511 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100512 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
513 return -1;
514 }
515
516 if (!timeout) {
517 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
518 return -1;
519 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100520 if (!global.cli_fe) {
521 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100522 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
523 return -1;
524 }
525 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100526 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100527 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100528 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100529 int maxconn = atol(args[2]);
530
531 if (maxconn <= 0) {
532 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
533 return -1;
534 }
535
Willy Tarreau4975d142021-03-13 11:00:33 +0100536 if (!global.cli_fe) {
537 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100538 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
539 return -1;
540 }
541 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100542 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100543 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100544 else if (strcmp(args[1], "bind-process") == 0) { /* enable the socket only on some processes */
William Lallemand74c24fb2016-11-21 17:18:36 +0100545 int cur_arg = 2;
546 unsigned long set = 0;
547
Willy Tarreau4975d142021-03-13 11:00:33 +0100548 if (!global.cli_fe) {
549 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100550 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
551 return -1;
552 }
553 }
554
555 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100556 if (strcmp(args[cur_arg], "all") == 0) {
557 set = 0;
558 break;
559 }
Willy Tarreau72faef32021-06-15 08:36:30 +0200560 if (parse_process_number(args[cur_arg], &set, 1, NULL, err)) {
Christopher Fauletf1f0c5f2017-11-22 12:06:43 +0100561 memprintf(err, "'%s %s' : %s", args[0], args[1], *err);
William Lallemand74c24fb2016-11-21 17:18:36 +0100562 return -1;
563 }
564 cur_arg++;
565 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100566 }
567 else {
568 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
569 return -1;
570 }
571 return 0;
572}
573
William Lallemand33d29e22019-04-01 11:30:06 +0200574/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200575 * This function exports the bound addresses of a <frontend> in the environment
576 * variable <varname>. Those addresses are separated by semicolons and prefixed
577 * with their type (abns@, unix@, sockpair@ etc)
578 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200579 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200580int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200581{
582 struct buffer *trash = get_trash_chunk();
583 struct bind_conf *bind_conf;
584
William Lallemand9a37fd02019-04-12 16:09:24 +0200585 if (frontend) {
586 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200587 struct listener *l;
588
589 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
590 char addr[46];
591 char port[6];
592
William Lallemand620072b2019-04-12 16:09:25 +0200593 /* separate listener by semicolons */
594 if (trash->data)
595 chunk_appendf(trash, ";");
596
Willy Tarreau37159062020-08-27 07:48:42 +0200597 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200598 const struct sockaddr_un *un;
599
Willy Tarreau37159062020-08-27 07:48:42 +0200600 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200601 if (un->sun_path[0] == '\0') {
602 chunk_appendf(trash, "abns@%s", un->sun_path+1);
603 } else {
604 chunk_appendf(trash, "unix@%s", un->sun_path);
605 }
Willy Tarreau37159062020-08-27 07:48:42 +0200606 } else if (l->rx.addr.ss_family == AF_INET) {
607 addr_to_str(&l->rx.addr, addr, sizeof(addr));
608 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200609 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200610 } else if (l->rx.addr.ss_family == AF_INET6) {
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, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200614 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
615 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200616 }
William Lallemand33d29e22019-04-01 11:30:06 +0200617 }
618 }
619 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200620 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200621 return -1;
622 }
623
624 return 0;
625}
626
William Lallemand9a37fd02019-04-12 16:09:24 +0200627int cli_socket_setenv()
628{
Willy Tarreau4975d142021-03-13 11:00:33 +0100629 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200630 return -1;
631 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
632 return -1;
633
634 return 0;
635}
636
William Lallemand33d29e22019-04-01 11:30:06 +0200637REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
638
Willy Tarreaude57a572016-11-23 17:01:39 +0100639/* Verifies that the CLI at least has a level at least as high as <level>
640 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
641 * failure, an error message is prepared and the appctx's state is adjusted
642 * to print it so that a return 1 is enough to abort any processing.
643 */
644int cli_has_level(struct appctx *appctx, int level)
645{
Willy Tarreaude57a572016-11-23 17:01:39 +0100646
William Lallemandf630d012018-12-13 09:05:44 +0100647 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100648 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100649 return 0;
650 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100651 return 1;
652}
653
William Lallemandb7ea1412018-12-13 09:05:47 +0100654/* same as cli_has_level but for the CLI proxy and without error message */
655int pcli_has_level(struct stream *s, int level)
656{
657 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
658 return 0;
659 }
660 return 1;
661}
662
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200663/* Returns severity_output for the current session if set, or default for the socket */
664static int cli_get_severity_output(struct appctx *appctx)
665{
666 if (appctx->cli_severity_output)
667 return appctx->cli_severity_output;
668 return strm_li(si_strm(appctx->owner))->bind_conf->severity_output;
669}
William Lallemand74c24fb2016-11-21 17:18:36 +0100670
Willy Tarreau41908562016-11-24 16:23:38 +0100671/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100672 * from the CLI's IO handler running in an appctx context. The function returns
673 * 1 if the request was understood, otherwise zero (in which case an error
674 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100675 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
676 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
677 * have its own I/O handler called again. Most of the time, parsers will only
678 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100679 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
680 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100681 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200682static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100683{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100684 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200685 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100686 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100687
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200688 appctx->st2 = 0;
689 memset(&appctx->ctx.cli, 0, sizeof(appctx->ctx.cli));
William Lallemand74c24fb2016-11-21 17:18:36 +0100690
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200691 p = appctx->chunk->area;
692 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100693
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200694 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200695 * Get pointers on words.
696 * One extra slot is reserved to store a pointer on a null byte.
697 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100698 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200699 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100700
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200701 /* skip leading spaces/tabs */
702 p += strspn(p, " \t");
703 if (!*p)
704 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200705
706 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
707 /* payload pattern recognized here, this is not an arg anymore,
708 * the payload starts at the first byte that follows the zero
709 * after the pattern.
710 */
711 payload = p + strlen(PAYLOAD_PATTERN) + 1;
712 break;
713 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100714
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200715 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200716 while (1) {
717 p += strcspn(p, " \t\\");
718 /* escaped chars using backlashes (\) */
719 if (*p == '\\') {
720 if (!*++p)
721 break;
722 if (!*++p)
723 break;
724 } else {
725 break;
726 }
727 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200728 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100729
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 /* unescape backslashes (\) */
731 for (j = 0, k = 0; args[i][k]; k++) {
732 if (args[i][k] == '\\') {
733 if (args[i][k + 1] == '\\')
734 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100735 else
736 continue;
737 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100739 j++;
740 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 i++;
744 }
745 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200746 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100747 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100749
750 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100751 if (!kw ||
752 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
753 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER)) {
754 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100755 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100756 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100757 }
William Lallemand14721be2018-10-26 14:47:37 +0200758
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100759 /* don't handle expert mode commands if not in this mode. */
760 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
761 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200762 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100763 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200764
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100765 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
766 cli_err(appctx, "This command is restricted to experimental mode only.\n");
767 return 0;
768 }
769
Amaury Denoyellef4929922021-05-05 16:29:23 +0200770 if (kw->level == ACCESS_EXPERT)
771 mark_tainted(TAINTED_CLI_EXPERT_MODE);
772 else if (kw->level == ACCESS_EXPERIMENTAL)
773 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
774
Willy Tarreau41908562016-11-24 16:23:38 +0100775 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200776 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200777
778 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
779 goto fail;
780
781 /* kw->parse could set its own io_handler or io_release handler */
782 if (!appctx->io_handler)
783 goto fail;
784
785 appctx->st0 = CLI_ST_CALLBACK;
786 return 1;
787fail:
788 appctx->io_handler = NULL;
789 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100790 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100791}
792
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200793/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
794static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
795{
Willy Tarreau83061a82018-07-13 11:56:34 +0200796 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200797
798 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200799 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200800
801 tmp = get_trash_chunk();
802 chunk_reset(tmp);
803
804 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100805 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200806 chunk_printf(tmp, "[%d]: ", severity);
807 }
808 else {
809 switch (severity_output) {
810 case CLI_SEVERITY_NUMBER:
811 chunk_printf(tmp, "[%d]: ", severity);
812 break;
813 case CLI_SEVERITY_STRING:
814 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
815 break;
816 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100817 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200818 }
819 }
820 chunk_appendf(tmp, "%s", msg);
821
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200822 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200823}
824
William Lallemand74c24fb2016-11-21 17:18:36 +0100825/* This I/O handler runs as an applet embedded in a stream interface. It is
826 * used to processes I/O from/to the stats unix socket. The system relies on a
827 * state machine handling requests and various responses. We read a request,
828 * then we process it and send the response, and we possibly display a prompt.
829 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100830 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100831 * or not.
832 */
833static void cli_io_handler(struct appctx *appctx)
834{
835 struct stream_interface *si = appctx->owner;
836 struct channel *req = si_oc(si);
837 struct channel *res = si_ic(si);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200838 struct bind_conf *bind_conf = strm_li(si_strm(si))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100839 int reql;
840 int len;
841
842 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
843 goto out;
844
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800845 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200846 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100847 /* buf.size==0 means we failed to get a buffer and were
848 * already subscribed to a wait list to get a buffer.
849 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100850 goto out;
851 }
852
William Lallemand74c24fb2016-11-21 17:18:36 +0100853 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100854 if (appctx->st0 == CLI_ST_INIT) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100855 /* Stats output not initialized yet */
856 memset(&appctx->ctx.stats, 0, sizeof(appctx->ctx.stats));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200857 /* reset severity to default at init */
858 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100859 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100860 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100861 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100862 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100863 /* Let's close for real now. We just close the request
864 * side, the conditions below will complete if needed.
865 */
866 si_shutw(si);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200867 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200868 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100869 break;
870 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100871 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200872 char *str;
873
874 /* use a trash chunk to store received data */
875 if (!appctx->chunk) {
876 appctx->chunk = alloc_trash_chunk();
877 if (!appctx->chunk) {
878 appctx->st0 = CLI_ST_END;
879 continue;
880 }
881 }
882
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200883 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200884
William Lallemand74c24fb2016-11-21 17:18:36 +0100885 /* ensure we have some output room left in the event we
886 * would want to return some info right after parsing.
887 */
888 if (buffer_almost_full(si_ib(si))) {
Willy Tarreaudb398432018-11-15 11:08:52 +0100889 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +0100890 break;
891 }
892
Willy Tarreau0011c252022-01-19 17:23:52 +0100893 /* payload doesn't take escapes nor does it end on semi-colons, so
894 * we use the regular getline. Normal mode however must stop on
895 * LFs and semi-colons that are not prefixed by a backslash. Note
896 * that we reserve one byte at the end to insert a trailing nul byte.
897 */
898
899 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
900 reql = co_getline(si_oc(si), str,
901 appctx->chunk->size - appctx->chunk->data - 1);
902 else
903 reql = co_getdelim(si_oc(si), str,
904 appctx->chunk->size - appctx->chunk->data - 1,
905 "\n;", '\\');
906
William Lallemand74c24fb2016-11-21 17:18:36 +0100907 if (reql <= 0) { /* closed or EOL not found */
908 if (reql == 0)
909 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100910 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100911 continue;
912 }
913
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200914 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
915 /* seek for a possible unescaped semi-colon. If we find
916 * one, we replace it with an LF and skip only this part.
917 */
918 for (len = 0; len < reql; len++) {
919 if (str[len] == '\\') {
920 len++;
921 continue;
922 }
923 if (str[len] == ';') {
924 str[len] = '\n';
925 reql = len + 1;
926 break;
927 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100928 }
929 }
930
931 /* now it is time to check that we have a full line,
932 * remove the trailing \n and possibly \r, then cut the
933 * line.
934 */
935 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200936 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100937 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100938 continue;
939 }
940
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200941 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100942 len--;
943
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200944 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200945 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200946
947 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200948 appctx->chunk->area[appctx->chunk->data] = '\n';
949 appctx->chunk->area[appctx->chunk->data + 1] = 0;
950 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200951 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100952
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100953 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200954
955 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
956 /* empty line */
957 if (!len) {
958 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200959 appctx->chunk->data -= 2;
960 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100961 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200962 chunk_reset(appctx->chunk);
963 /* NB: cli_sock_parse_request() may have put
964 * another CLI_ST_O_* into appctx->st0.
965 */
966
967 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100968 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100969 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200970 else {
971 /*
972 * Look for the "payload start" pattern at the end of a line
973 * Its location is not remembered here, this is just to switch
974 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100975 */
Willy Tarreauf2dda522021-09-17 11:07:45 +0200976 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200977 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200978 appctx->chunk->data++; // keep the trailing \0 after '<<'
979 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200980 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200981 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100982 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200983 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200984 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100985 }
986
987 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200988 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100989 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
990 }
991 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200992 const char *msg;
993 int sev;
994
William Lallemand74c24fb2016-11-21 17:18:36 +0100995 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100996 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100997 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200998 case CLI_ST_PRINT: /* print const message in msg */
999 case CLI_ST_PRINT_ERR: /* print const error in msg */
1000 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
1001 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
1002 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1003 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
1004 LOG_ERR : appctx->ctx.cli.severity;
1005 msg = appctx->ctx.cli.msg;
1006 }
1007 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
1008 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
1009 LOG_ERR : appctx->ctx.cli.severity;
1010 msg = appctx->ctx.cli.err;
1011 if (!msg) {
1012 sev = LOG_ERR;
1013 msg = "Out of memory.\n";
1014 }
1015 }
1016 else {
1017 sev = LOG_ERR;
1018 msg = "Internal error.\n";
1019 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001020
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001021 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1022 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1023 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001024 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001025 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001026 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001027 }
1028 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001029 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001030 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001031
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001032 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001033 if (appctx->io_handler)
1034 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001035 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001036 if (appctx->io_release) {
1037 appctx->io_release(appctx);
1038 appctx->io_release = NULL;
1039 }
1040 }
1041 break;
1042 default: /* abnormal state */
1043 si->flags |= SI_FL_ERR;
1044 break;
1045 }
1046
1047 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001048 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001049 const char *prompt = "";
1050
1051 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1052 /*
1053 * when entering a payload with interactive mode, change the prompt
1054 * to emphasize that more data can still be sent
1055 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001056 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001057 prompt = "+ ";
1058 else
1059 prompt = "\n> ";
1060 }
1061 else {
William Lallemandad032882019-07-01 10:56:15 +02001062 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001063 prompt = "\n";
1064 }
1065
1066 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001067 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001068 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001069 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001070 }
1071
1072 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001073 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001074 break;
1075
1076 /* Now we close the output if one of the writers did so,
1077 * or if we're not in interactive mode and the request
1078 * buffer is empty. This still allows pipelined requests
1079 * to be sent in non-interactive mode.
1080 */
William Lallemand3de09d52018-12-11 16:10:56 +01001081 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1082 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001083 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001084 continue;
1085 }
1086
1087 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001088 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001089 /* reactivate the \n at the end of the response for the next command */
1090 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001091
1092 /* this forces us to yield between pipelined commands and
1093 * avoid extremely long latencies (e.g. "del map" etc). In
1094 * addition this increases the likelihood that the stream
1095 * refills the buffer with new bytes in non-interactive
1096 * mode, avoiding to close on apparently empty commands.
1097 */
1098 if (co_data(si_oc(si))) {
1099 appctx_wakeup(appctx);
1100 goto out;
1101 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001102 }
1103 }
1104
1105 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1106 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1107 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1108 /* Other side has closed, let's abort if we have no more processing to do
1109 * and nothing more to consume. This is comparable to a broken pipe, so
1110 * we forward the close to the request side so that it flows upstream to
1111 * the client.
1112 */
1113 si_shutw(si);
1114 }
1115
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001116 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001117 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1118 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1119 /* We have no more processing to do, and nothing more to send, and
1120 * the client side has closed. So we'll forward this state downstream
1121 * on the response buffer.
1122 */
1123 si_shutr(si);
1124 res->flags |= CF_READ_NULL;
1125 }
1126
1127 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001128 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 +01001129 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001130 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 +01001131}
1132
William Lallemand74c24fb2016-11-21 17:18:36 +01001133/* This is called when the stream interface is closed. For instance, upon an
1134 * external abort, we won't call the i/o handler anymore so we may need to
1135 * remove back references to the stream currently being dumped.
1136 */
1137static void cli_release_handler(struct appctx *appctx)
1138{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001139 free_trash_chunk(appctx->chunk);
1140 appctx->chunk = NULL;
1141
William Lallemand74c24fb2016-11-21 17:18:36 +01001142 if (appctx->io_release) {
1143 appctx->io_release(appctx);
1144 appctx->io_release = NULL;
1145 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001146 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001147 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001148 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001149}
1150
1151/* This function dumps all environmnent variables to the buffer. It returns 0
1152 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001153 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1154 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001155 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001156static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001157{
Willy Tarreau0a739292016-11-22 20:21:23 +01001158 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001159 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001160
1161 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1162 return 1;
1163
1164 chunk_reset(&trash);
1165
1166 /* we have two inner loops here, one for the proxy, the other one for
1167 * the buffer.
1168 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001169 while (*var) {
1170 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001171
Willy Tarreau06d80a92017-10-19 14:32:15 +02001172 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001173 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001174 return 0;
1175 }
1176 if (appctx->st2 == STAT_ST_END)
1177 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001178 var++;
1179 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001180 }
1181
1182 /* dump complete */
1183 return 1;
1184}
1185
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001186/* This function dumps all file descriptors states (or the requested one) to
1187 * the buffer. It returns 0 if the output buffer is full and it needs to be
1188 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1189 * It uses cli.i0 as the fd number to restart from.
1190 */
1191static int cli_io_handler_show_fd(struct appctx *appctx)
1192{
1193 struct stream_interface *si = appctx->owner;
1194 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001195 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001196
1197 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001198 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001199
1200 chunk_reset(&trash);
1201
Willy Tarreauca1b1572018-12-18 15:45:11 +01001202 /* isolate the threads once per round. We're limited to a buffer worth
1203 * of output anyway, it cannot last very long.
1204 */
1205 thread_isolate();
1206
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001207 /* we have two inner loops here, one for the proxy, the other one for
1208 * the buffer.
1209 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001210 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001211 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001212 const struct listener *li = NULL;
1213 const struct server *sv = NULL;
1214 const struct proxy *px = NULL;
1215 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001216 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001217 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001218 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001219 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001220 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001221 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001222 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001223
1224 fdt = fdtab[fd];
1225
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001226 /* When DEBUG_FD is set, we also report closed FDs that have a
1227 * non-null event count to detect stuck ones.
1228 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001229 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001230#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001231 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001232#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001233 goto skip; // closed
1234 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001235 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001236 conn = (const struct connection *)fdt.owner;
1237 conn_flags = conn->flags;
1238 mux = conn->mux;
1239 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001240 xprt = conn->xprt;
1241 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001242 li = objt_listener(conn->target);
1243 sv = objt_server(conn->target);
1244 px = objt_proxy(conn->target);
1245 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001246 if (atleast2(fdt.thread_mask))
1247 suspicious = 1;
1248 if (conn->handle.fd != fd)
1249 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001250 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001251 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001252 li = fdt.owner;
1253
Willy Tarreaudacfde42021-01-21 09:07:29 +01001254 if (!fdt.thread_mask)
1255 suspicious = 1;
1256
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001257 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001258 " %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 +02001259 fd,
1260 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001261 (fdt.state & FD_CLONED) ? 'C' : 'c',
1262 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001263 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1264 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1265 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1266 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1267 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001268 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1269 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1270 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1271 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1272 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1273 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001274 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001275 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001276 fdt.iocb);
1277 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001278
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001279 if (!fdt.owner) {
1280 chunk_appendf(&trash, ")");
1281 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001282 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001283 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001284
1285 if (conn->handle.fd != fd) {
1286 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1287 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001288 } else {
1289 struct sockaddr_storage sa;
1290 socklen_t salen;
1291
1292 salen = sizeof(sa);
1293 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1294 if (sa.ss_family == AF_INET)
1295 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1296 else if (sa.ss_family == AF_INET6)
1297 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1298 else if (sa.ss_family == AF_UNIX)
1299 chunk_appendf(&trash, " fam=unix");
1300 }
1301
1302 salen = sizeof(sa);
1303 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1304 if (sa.ss_family == AF_INET)
1305 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1306 else if (sa.ss_family == AF_INET6)
1307 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1308 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001309 }
1310
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001311 if (px)
1312 chunk_appendf(&trash, " px=%s", px->id);
1313 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001314 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001315 else if (li)
1316 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001317
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001318 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001319 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001320 if (!ctx)
1321 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001322 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001323 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001324 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001325 else
1326 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001327
1328 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001329 if (xprt) {
1330 if (xprt_ctx || xprt->show_fd)
1331 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1332 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001333 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001334 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001335 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001336 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001337 struct sockaddr_storage sa;
1338 socklen_t salen;
1339
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001340 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001341 listener_state_str(li),
1342 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001343
1344 salen = sizeof(sa);
1345 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1346 if (sa.ss_family == AF_INET)
1347 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1348 else if (sa.ss_family == AF_INET6)
1349 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1350 else if (sa.ss_family == AF_UNIX)
1351 chunk_appendf(&trash, " fam=unix");
1352 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001353 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001354 else
1355 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001356
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001357#ifdef DEBUG_FD
1358 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001359 if (fdtab[fd].event_count >= 1000000)
1360 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001361#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001362 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001363
Willy Tarreau06d80a92017-10-19 14:32:15 +02001364 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001365 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001366 appctx->ctx.cli.i0 = fd;
1367 ret = 0;
1368 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001369 }
1370 skip:
1371 if (appctx->st2 == STAT_ST_END)
1372 break;
1373
1374 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001375 }
1376
Willy Tarreauca1b1572018-12-18 15:45:11 +01001377 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001378 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001379
1380 thread_release();
1381 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001382}
1383
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001384/* This function dumps some activity counters used by developers and support to
1385 * rule out some hypothesis during bug reports. It returns 0 if the output
1386 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1387 * everything at once in the buffer and is not designed to do it in multiple
1388 * passes.
1389 */
1390static int cli_io_handler_show_activity(struct appctx *appctx)
1391{
1392 struct stream_interface *si = appctx->owner;
1393 int thr;
1394
1395 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1396 return 1;
1397
1398 chunk_reset(&trash);
1399
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001400#undef SHOW_TOT
1401#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001402 do { \
1403 unsigned int _v[MAX_THREADS]; \
1404 unsigned int _tot; \
1405 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001406 _tot = t = 0; \
1407 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001408 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001409 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001410 if (_nbt == 1) { \
1411 chunk_appendf(&trash, " %u\n", _tot); \
1412 break; \
1413 } \
1414 chunk_appendf(&trash, " %u [", _tot); \
1415 for (t = 0; t < _nbt; t++) \
1416 chunk_appendf(&trash, " %u", _v[t]); \
1417 chunk_appendf(&trash, " ]\n"); \
1418 } while (0)
1419
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001420#undef SHOW_AVG
1421#define SHOW_AVG(t, x) \
1422 do { \
1423 unsigned int _v[MAX_THREADS]; \
1424 unsigned int _tot; \
1425 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001426 _tot = t = 0; \
1427 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001428 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001429 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001430 if (_nbt == 1) { \
1431 chunk_appendf(&trash, " %u\n", _tot); \
1432 break; \
1433 } \
1434 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1435 for (t = 0; t < _nbt; t++) \
1436 chunk_appendf(&trash, " %u", _v[t]); \
1437 chunk_appendf(&trash, " ]\n"); \
1438 } while (0)
1439
Willy Tarreaua0211b82019-05-28 15:09:08 +02001440 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1441 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001442 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1443 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1444 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1445 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001446 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001447 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1448 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001449 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001450 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001451 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001452 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001453 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001454 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001455 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1456 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001457 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1458 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1459 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1460 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1461 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1462 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1463 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001464#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001465 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 +02001466 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001467#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001468
Willy Tarreaud6a78502019-05-27 07:03:38 +02001469#if defined(DEBUG_DEV)
1470 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001471 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1472 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1473 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001474#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001475
1476 if (ci_putchk(si_ic(si), &trash) == -1) {
1477 chunk_reset(&trash);
1478 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001479 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001480 }
1481
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001482#undef SHOW_AVG
1483#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001484 /* dump complete */
1485 return 1;
1486}
1487
William Lallemandeceddf72016-12-15 18:06:44 +01001488/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001489 * CLI IO handler for `show cli sockets`.
1490 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001491 */
1492static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1493{
1494 struct bind_conf *bind_conf;
1495 struct stream_interface *si = appctx->owner;
1496
1497 chunk_reset(&trash);
1498
1499 switch (appctx->st2) {
1500 case STAT_ST_INIT:
1501 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001502 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001503 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001504 return 0;
1505 }
William Lallemandeceddf72016-12-15 18:06:44 +01001506 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001507 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001508
1509 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001510 if (global.cli_fe) {
1511 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001512 struct listener *l;
1513
1514 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001515 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001516 * if the current node is the first of the list
1517 */
1518
Willy Tarreau3af9d832016-12-16 12:58:09 +01001519 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001520 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001521 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001522 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001523 continue;
1524 }
1525
1526 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1527
1528 char addr[46];
1529 char port[6];
1530
Willy Tarreau37159062020-08-27 07:48:42 +02001531 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001532 const struct sockaddr_un *un;
1533
Willy Tarreau37159062020-08-27 07:48:42 +02001534 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001535 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001536 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001537 } else {
1538 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1539 }
Willy Tarreau37159062020-08-27 07:48:42 +02001540 } else if (l->rx.addr.ss_family == AF_INET) {
1541 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1542 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001543 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001544 } else if (l->rx.addr.ss_family == AF_INET6) {
1545 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1546 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001547 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001548 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1549 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001550 } else
William Lallemand26314342018-10-26 14:47:41 +02001551 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001552
William Lallemand07a62f72017-05-24 00:57:40 +02001553 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001554 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001555 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1556 chunk_appendf(&trash, "operator ");
1557 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1558 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001559 else
1560 chunk_appendf(&trash, " ");
1561
Willy Tarreau72faef32021-06-15 08:36:30 +02001562 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001563
Willy Tarreau06d80a92017-10-19 14:32:15 +02001564 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001565 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001566 return 0;
1567 }
1568 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001569 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001570 }
1571 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001572 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001573 default:
1574 appctx->st2 = STAT_ST_FIN;
1575 return 1;
1576 }
1577}
1578
1579
Willy Tarreau0a739292016-11-22 20:21:23 +01001580/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001581 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1582 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001583 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001584static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001585{
1586 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001587 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001588
1589 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1590 return 1;
1591
Willy Tarreauf6710f82016-12-16 17:45:44 +01001592 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001593
1594 if (*args[2]) {
1595 int len = strlen(args[2]);
1596
Willy Tarreauf6710f82016-12-16 17:45:44 +01001597 for (; *var; var++) {
1598 if (strncmp(*var, args[2], len) == 0 &&
1599 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001600 break;
1601 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001602 if (!*var)
1603 return cli_err(appctx, "Variable not found\n");
1604
Willy Tarreau0a739292016-11-22 20:21:23 +01001605 appctx->st2 = STAT_ST_END;
1606 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001607 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001608 return 0;
1609}
1610
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001611/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1612 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1613 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1614 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001615static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001616{
1617 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1618 return 1;
1619
1620 appctx->ctx.cli.i0 = 0;
1621
1622 if (*args[2]) {
1623 appctx->ctx.cli.i0 = atoi(args[2]);
1624 appctx->st2 = STAT_ST_END;
1625 }
1626 return 0;
1627}
1628
Willy Tarreau599852e2016-11-22 20:33:32 +01001629/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001630static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001631{
1632 struct stream_interface *si = appctx->owner;
1633 struct stream *s = si_strm(si);
1634
1635 if (strcmp(args[2], "cli") == 0) {
1636 unsigned timeout;
1637 const char *res;
1638
Willy Tarreau9d008692019-08-09 11:21:01 +02001639 if (!*args[3])
1640 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001641
1642 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001643 if (res || timeout < 1)
1644 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001645
1646 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1647 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1648 return 1;
1649 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001650
1651 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001652}
1653
Willy Tarreau2af99412016-11-23 11:10:59 +01001654/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001655static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001656{
1657 int v;
1658
1659 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1660 return 1;
1661
Willy Tarreau9d008692019-08-09 11:21:01 +02001662 if (!*args[3])
1663 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001664
1665 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001666 if (v > global.hardmaxconn)
1667 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001668
1669 /* check for unlimited values */
1670 if (v <= 0)
1671 v = global.hardmaxconn;
1672
1673 global.maxconn = v;
1674
1675 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001676 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001677
1678 return 1;
1679}
1680
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001681static int set_severity_output(int *target, char *argument)
1682{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001683 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001684 *target = CLI_SEVERITY_NONE;
1685 return 1;
1686 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001687 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001688 *target = CLI_SEVERITY_NUMBER;
1689 return 1;
1690 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001691 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001692 *target = CLI_SEVERITY_STRING;
1693 return 1;
1694 }
1695 return 0;
1696}
1697
1698/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001699static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001700{
1701 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1702 return 0;
1703
Willy Tarreau9d008692019-08-09 11:21:01 +02001704 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001705}
William Lallemandeceddf72016-12-15 18:06:44 +01001706
William Lallemand67a234f2018-12-13 09:05:45 +01001707
1708/* show the level of the current CLI session */
1709static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1710{
William Lallemand67a234f2018-12-13 09:05:45 +01001711 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001712 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001713 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001714 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001715 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001716 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001717 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001718 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001719}
1720
1721/* parse and set the CLI level dynamically */
1722static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1723{
William Lallemandad032882019-07-01 10:56:15 +02001724 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001725 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001726 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1727
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001728 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001729 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1730 return 1;
1731 }
1732 appctx->cli_level &= ~ACCESS_LVL_MASK;
1733 appctx->cli_level |= ACCESS_LVL_OPER;
1734
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001735 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001736 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1737 return 1;
1738 }
1739 appctx->cli_level &= ~ACCESS_LVL_MASK;
1740 appctx->cli_level |= ACCESS_LVL_USER;
1741 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001742 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001743 return 1;
1744}
1745
1746
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001747/* parse and set the CLI expert/experimental-mode dynamically */
1748static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001749{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001750 int level;
1751 char *level_str;
1752 char *output = NULL;
1753
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001754 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1755 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001756
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001757 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001758 level = ACCESS_EXPERT;
1759 level_str = "expert-mode";
1760 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001761 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001762 level = ACCESS_EXPERIMENTAL;
1763 level_str = "experimental-mode";
1764 }
1765 else {
1766 return 1;
1767 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001768
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001769 if (!*args[1]) {
1770 memprintf(&output, "%s is %s\n", level_str,
1771 (appctx->cli_level & level) ? "ON" : "OFF");
1772 return cli_dynmsg(appctx, LOG_INFO, output);
1773 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001774
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001775 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001776 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001777 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001778 return 1;
1779}
1780
William Lallemand740629e2021-12-14 15:22:29 +01001781/* shows HAProxy version */
1782static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1783{
1784 char *msg = NULL;
1785
1786 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1787}
1788
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001789int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001790{
1791 return 0;
1792}
1793
Willy Tarreau45c742b2016-11-24 14:51:17 +01001794/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001795static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001796{
1797 int v;
1798 int *res;
1799 int mul = 1;
1800
1801 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1802 return 1;
1803
1804 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1805 res = &global.cps_lim;
1806 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1807 res = &global.sps_lim;
1808#ifdef USE_OPENSSL
1809 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1810 res = &global.ssl_lim;
1811#endif
1812 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1813 res = &global.comp_rate_lim;
1814 mul = 1024;
1815 }
1816 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001817 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001818 "'set rate-limit' only supports :\n"
1819 " - 'connections global' to set the per-process maximum connection rate\n"
1820 " - 'sessions global' to set the per-process maximum session rate\n"
1821#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001822 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001823#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001824 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001825 }
1826
Willy Tarreau9d008692019-08-09 11:21:01 +02001827 if (!*args[4])
1828 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001829
1830 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001831 if (v < 0)
1832 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001833
1834 *res = v * mul;
1835
1836 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001837 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001838
1839 return 1;
1840}
1841
William Lallemandf6975e92017-05-26 17:42:10 +02001842/* parse the "expose-fd" argument on the bind lines */
1843static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1844{
1845 if (!*args[cur_arg + 1]) {
1846 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1847 return ERR_ALERT | ERR_FATAL;
1848 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001849 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001850 conf->level |= ACCESS_FD_LISTENERS;
1851 } else {
1852 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1853 args[cur_arg], args[cur_arg+1]);
1854 return ERR_ALERT | ERR_FATAL;
1855 }
1856
1857 return 0;
1858}
1859
William Lallemand74c24fb2016-11-21 17:18:36 +01001860/* parse the "level" argument on the bind lines */
1861static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1862{
1863 if (!*args[cur_arg + 1]) {
1864 memprintf(err, "'%s' : missing level", args[cur_arg]);
1865 return ERR_ALERT | ERR_FATAL;
1866 }
1867
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001868 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001869 conf->level &= ~ACCESS_LVL_MASK;
1870 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001871 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001872 conf->level &= ~ACCESS_LVL_MASK;
1873 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001874 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001875 conf->level &= ~ACCESS_LVL_MASK;
1876 conf->level |= ACCESS_LVL_ADMIN;
1877 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001878 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1879 args[cur_arg], args[cur_arg+1]);
1880 return ERR_ALERT | ERR_FATAL;
1881 }
1882
1883 return 0;
1884}
1885
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001886static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1887{
1888 if (!*args[cur_arg + 1]) {
1889 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1890 return ERR_ALERT | ERR_FATAL;
1891 }
1892
1893 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1894 return 0;
1895 else {
1896 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1897 args[cur_arg], args[cur_arg+1]);
1898 return ERR_ALERT | ERR_FATAL;
1899 }
1900}
1901
Olivier Houchardf886e342017-04-05 22:24:59 +02001902/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001903static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001904{
1905 char *cmsgbuf = NULL;
1906 unsigned char *tmpbuf = NULL;
1907 struct cmsghdr *cmsg;
1908 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001909 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001910 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001911 struct msghdr msghdr;
1912 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001913 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001914 const char *ns_name, *if_name;
1915 unsigned char ns_nlen, if_nlen;
1916 int nb_queued;
1917 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001918 int *tmpfd;
1919 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001920 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001921 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001922 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001923 int ret;
1924
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001925 if (!remote) {
1926 ha_warning("Only works on real connections\n");
1927 goto out;
1928 }
1929
1930 fd = remote->handle.fd;
1931
Olivier Houchardf886e342017-04-05 22:24:59 +02001932 /* Temporary set the FD in blocking mode, that will make our life easier */
1933 old_fcntl = fcntl(fd, F_GETFL);
1934 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001935 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001936 goto out;
1937 }
1938 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1939 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001940 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001941 goto out;
1942 }
1943 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001944 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001945 goto out;
1946 }
Olivier Houchard54740872017-04-06 14:45:14 +02001947 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001948 iov.iov_base = &tot_fd_nb;
1949 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001950 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001951 goto out;
1952 memset(&msghdr, 0, sizeof(msghdr));
1953 /*
1954 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001955 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001956 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001957 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001958 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001959
Olivier Houchardf886e342017-04-05 22:24:59 +02001960 if (tot_fd_nb == 0)
1961 goto out;
1962
1963 /* First send the total number of file descriptors, so that the
1964 * receiving end knows what to expect.
1965 */
1966 msghdr.msg_iov = &iov;
1967 msghdr.msg_iovlen = 1;
1968 ret = sendmsg(fd, &msghdr, 0);
1969 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001970 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001971 goto out;
1972 }
1973
1974 /* Now send the fds */
1975 msghdr.msg_control = cmsgbuf;
1976 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1977 cmsg = CMSG_FIRSTHDR(&msghdr);
1978 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1979 cmsg->cmsg_level = SOL_SOCKET;
1980 cmsg->cmsg_type = SCM_RIGHTS;
1981 tmpfd = (int *)CMSG_DATA(cmsg);
1982
Olivier Houchardf886e342017-04-05 22:24:59 +02001983 /* For each socket, e message is sent, containing the following :
1984 * Size of the namespace name (or 0 if none), as an unsigned char.
1985 * The namespace name, if any
1986 * Size of the interface name (or 0 if none), as an unsigned char
1987 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001988 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001989 */
1990 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001991 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001992 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001993 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001994 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001995 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001996 goto out;
1997 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001998
1999 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002001 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002002 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002003 continue;
2004
2005 ns_name = if_name = "";
2006 ns_nlen = if_nlen = 0;
2007
2008 /* for now we can only retrieve namespaces and interfaces from
2009 * pure listeners.
2010 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002011 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002012 const struct listener *l = fdtab[cur_fd].owner;
2013
Willy Tarreau818a92e2020-09-03 07:50:19 +02002014 if (l->rx.settings->interface) {
2015 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002016 if_nlen = strlen(if_name);
2017 }
2018
2019#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002020 if (l->rx.settings->netns) {
2021 ns_name = l->rx.settings->netns->node.key;
2022 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002023 }
2024#endif
2025 }
2026
2027 /* put the FD into the CMSG_DATA */
2028 tmpfd[nb_queued++] = cur_fd;
2029
2030 /* first block is <ns_name_len> <ns_name> */
2031 tmpbuf[curoff++] = ns_nlen;
2032 if (ns_nlen)
2033 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2034 curoff += ns_nlen;
2035
2036 /* second block is <if_name_len> <if_name> */
2037 tmpbuf[curoff++] = if_nlen;
2038 if (if_nlen)
2039 memcpy(tmpbuf + curoff, if_name, if_nlen);
2040 curoff += if_nlen;
2041
2042 /* we used to send the listener options here before 2.3 */
2043 memset(tmpbuf + curoff, 0, sizeof(int));
2044 curoff += sizeof(int);
2045
2046 /* there's a limit to how many FDs may be sent at once */
2047 if (nb_queued == MAX_SEND_FD) {
2048 iov.iov_len = curoff;
2049 if (sendmsg(fd, &msghdr, 0) != curoff) {
2050 ha_warning("Failed to transfer sockets\n");
2051 return -1;
2052 }
2053
2054 /* Wait for an ack */
2055 do {
2056 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2057 } while (ret == -1 && errno == EINTR);
2058
2059 if (ret <= 0) {
2060 ha_warning("Unexpected error while transferring sockets\n");
2061 return -1;
2062 }
2063 curoff = 0;
2064 nb_queued = 0;
2065 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002066 }
2067
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002068 /* flush pending stuff */
2069 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002070 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002071 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2072 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002073 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002074 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002075 goto out;
2076 }
2077 }
2078
2079out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002080 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002081 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002082 goto out;
2083 }
2084 appctx->st0 = CLI_ST_END;
2085 free(cmsgbuf);
2086 free(tmpbuf);
2087 return 1;
2088}
2089
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002090static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2091{
2092 if (*args[0] == 'h')
2093 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002094 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002095 else if (*args[0] == 'p')
2096 /* prompt */
2097 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2098 else if (*args[0] == 'q')
2099 /* quit */
2100 appctx->st0 = CLI_ST_END;
2101
2102 return 1;
2103}
Olivier Houchardf886e342017-04-05 22:24:59 +02002104
William Lallemand2f4ce202018-10-26 14:47:47 +02002105void pcli_write_prompt(struct stream *s)
2106{
2107 struct buffer *msg = get_trash_chunk();
2108 struct channel *oc = si_oc(&s->si[0]);
2109
William Lallemanddc12c2e2018-12-13 09:05:46 +01002110 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002111 return;
2112
William Lallemanddc12c2e2018-12-13 09:05:46 +01002113 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002114 chunk_appendf(msg, "+ ");
2115 } else {
2116 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002117 chunk_appendf(msg, "master%s> ",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002118 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002119 else
2120 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2121 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002122 co_inject(oc, msg->area, msg->data);
2123}
2124
William Lallemand291810d2018-10-26 14:47:38 +02002125
William Lallemandcf62f7e2018-10-26 14:47:40 +02002126/* The pcli_* functions are used for the CLI proxy in the master */
2127
William Lallemanddeeaa592018-10-26 14:47:48 +02002128void pcli_reply_and_close(struct stream *s, const char *msg)
2129{
2130 struct buffer *buf = get_trash_chunk();
2131
2132 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002133 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002134}
2135
William Lallemand291810d2018-10-26 14:47:38 +02002136static enum obj_type *pcli_pid_to_server(int proc_pid)
2137{
2138 struct mworker_proc *child;
2139
William Lallemand99e0bb92020-11-05 10:28:53 +01002140 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002141 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002142 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002143
William Lallemand291810d2018-10-26 14:47:38 +02002144 list_for_each_entry(child, &proc_list, list) {
2145 if (child->pid == proc_pid){
2146 return &child->srv->obj_type;
2147 }
2148 }
2149 return NULL;
2150}
2151
2152/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2153 * Return:
2154 * 0: master
2155 * > 0: pid of a worker
2156 * < 0: didn't find a worker
2157 */
2158static int pcli_prefix_to_pid(const char *prefix)
2159{
2160 int proc_pid;
2161 struct mworker_proc *child;
2162 char *errtol = NULL;
2163
2164 if (*prefix != '@') /* not a prefix, should not happen */
2165 return -1;
2166
2167 prefix++;
2168 if (!*prefix) /* sent @ alone, return the master */
2169 return 0;
2170
2171 if (strcmp("master", prefix) == 0) {
2172 return 0;
2173 } else if (*prefix == '!') {
2174 prefix++;
2175 if (!*prefix)
2176 return -1;
2177
2178 proc_pid = strtol(prefix, &errtol, 10);
2179 if (*errtol != '\0')
2180 return -1;
2181 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002182 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002183 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002184 if (child->pid == proc_pid){
2185 return child->pid;
2186 }
2187 }
2188 } else {
2189 struct mworker_proc *chosen = NULL;
2190 /* this is a relative pid */
2191
2192 proc_pid = strtol(prefix, &errtol, 10);
2193 if (*errtol != '\0')
2194 return -1;
2195
2196 if (proc_pid == 0) /* return the master */
2197 return 0;
2198
2199 /* chose the right process, the current one is the one with the
2200 least number of reloads */
2201 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002202 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002203 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002204 if (child->reloads == 0)
2205 return child->pid;
2206 else if (chosen == NULL || child->reloads < chosen->reloads)
2207 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002208 }
2209 if (chosen)
2210 return chosen->pid;
2211 }
2212 return -1;
2213}
2214
William Lallemandbddd33a2018-12-11 16:10:53 +01002215/* Return::
2216 * >= 0 : number of words to escape
2217 * = -1 : error
2218 */
2219
2220int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2221{
2222 if (argl < 1)
2223 return 0;
2224
2225 /* there is a prefix */
2226 if (args[0][0] == '@') {
2227 int target_pid = pcli_prefix_to_pid(args[0]);
2228
2229 if (target_pid == -1) {
2230 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2231 return -1;
2232 }
2233
2234 /* if the prefix is alone, define a default target */
2235 if (argl == 1)
2236 s->pcli_next_pid = target_pid;
2237 else
2238 *next_pid = target_pid;
2239 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002240 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002241 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002242 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002243
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002244 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002245 channel_shutr_now(&s->req);
2246 channel_shutw_now(&s->res);
2247 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002248 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002249 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2250 memprintf(errmsg, "Permission denied!\n");
2251 return -1;
2252 }
2253 s->pcli_flags &= ~ACCESS_LVL_MASK;
2254 s->pcli_flags |= ACCESS_LVL_OPER;
2255 return argl;
2256
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002257 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002258 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2259 memprintf(errmsg, "Permission denied!\n");
2260 return -1;
2261 }
2262 s->pcli_flags &= ~ACCESS_LVL_MASK;
2263 s->pcli_flags |= ACCESS_LVL_USER;
2264 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002265 }
2266
2267 return 0;
2268}
2269
2270/*
2271 * Parse the CLI request:
2272 * - It does basically the same as the cli_io_handler, but as a proxy
2273 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002274 *
2275 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002276 * - the number of characters to forward or
2277 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002278 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002279int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002280{
William Lallemandbddd33a2018-12-11 16:10:53 +01002281 char *str = (char *)ci_head(req);
2282 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002283 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002284 int argl; /* number of args */
2285 char *p;
2286 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002287 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002288 int wtrim = 0; /* number of words to trim */
2289 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002290 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002291 int i = 0;
2292
2293 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002294
William Lallemanddc12c2e2018-12-13 09:05:46 +01002295 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002296
2297 /* Looks for the end of one command */
2298 while (p+reql < end) {
2299 /* handle escaping */
2300 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002301 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002302 continue;
2303 }
2304 if (p[reql] == ';' || p[reql] == '\n') {
2305 /* found the end of the command */
2306 p[reql] = '\n';
2307 reql++;
2308 break;
2309 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002310 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002311 }
William Lallemandebf61802018-12-11 16:10:57 +01002312 } else {
2313 while (p+reql < end) {
2314 if (p[reql] == '\n') {
2315 /* found the end of the line */
2316 reql++;
2317 break;
2318 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002319 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002320 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002321 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002322
William Lallemandbddd33a2018-12-11 16:10:53 +01002323 /* set end to first byte after the end of the command */
2324 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002325
William Lallemandbddd33a2018-12-11 16:10:53 +01002326 /* there is no end to this command, need more to parse ! */
2327 if (*(end-1) != '\n') {
2328 return -1;
2329 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002330
William Lallemand3301f3e2018-12-13 09:05:48 +01002331 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2332 if (reql == 1) /* last line of the payload */
2333 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002334 return reql;
2335 }
2336
William Lallemandbddd33a2018-12-11 16:10:53 +01002337 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002338
William Lallemandbddd33a2018-12-11 16:10:53 +01002339 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002340 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002341 /* skip leading spaces/tabs */
2342 p += strspn(p, " \t");
2343 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002344 break;
2345
William Lallemandbddd33a2018-12-11 16:10:53 +01002346 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002347 while (1) {
2348 p += strcspn(p, " \t\\");
2349 /* escaped chars using backlashes (\) */
2350 if (*p == '\\') {
2351 if (!*++p)
2352 break;
2353 if (!*++p)
2354 break;
2355 } else {
2356 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002357 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002358 }
William Lallemandfe249c32020-06-18 18:03:57 +02002359 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002360 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002361 }
2362
William Lallemandbddd33a2018-12-11 16:10:53 +01002363 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002364
Willy Tarreauf14c7572021-03-13 10:59:23 +01002365 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002366 args[i] = NULL;
2367
2368 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2369
2370 /* End of words are ending by \0, we need to replace the \0s by spaces
23711 before forwarding them */
2372 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002373 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002374 if (*p == '\0')
2375 *p = ' ';
2376 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002377 }
2378
William Lallemand3301f3e2018-12-13 09:05:48 +01002379 payload = strstr(str, PAYLOAD_PATTERN);
2380 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2381 /* if the payload pattern is at the end */
2382 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002383 }
2384
William Lallemandbddd33a2018-12-11 16:10:53 +01002385 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002386
William Lallemandbddd33a2018-12-11 16:10:53 +01002387 if (wtrim > 0) {
2388 trim = &args[wtrim][0];
2389 if (trim == NULL) /* if this was the last word in the table */
2390 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002391
William Lallemandbddd33a2018-12-11 16:10:53 +01002392 b_del(&req->buf, trim - str);
2393
William Lallemandb7ea1412018-12-13 09:05:47 +01002394 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002395 } else if (wtrim < 0) {
2396 /* parsing error */
2397 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002398 } else {
2399 /* the whole string */
2400 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002401 }
2402
William Lallemandb7ea1412018-12-13 09:05:47 +01002403 if (ret > 1) {
2404 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2405 goto end;
2406 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002407 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2408 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002409 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002410 ci_insert_line2(req, 0, "user -", strlen("user -"));
2411 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002412 }
2413 }
2414end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002415
William Lallemandb7ea1412018-12-13 09:05:47 +01002416 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002417}
2418
2419int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2420{
William Lallemandbddd33a2018-12-11 16:10:53 +01002421 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002422 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002423 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002424
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002425 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002426 * current one. Just wait. At this stage, errors should be handled by
2427 * the response analyzer.
2428 */
2429 if (s->res.analysers & AN_RES_WAIT_CLI)
2430 return 0;
2431
William Lallemandb7ea1412018-12-13 09:05:47 +01002432 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2433 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2434
William Lallemandcf62f7e2018-10-26 14:47:40 +02002435read_again:
2436 /* if the channel is closed for read, we won't receive any more data
2437 from the client, but we don't want to forward this close to the
2438 server */
2439 channel_dont_close(req);
2440
2441 /* We don't know yet to which server we will connect */
2442 channel_dont_connect(req);
2443
William Lallemandcf62f7e2018-10-26 14:47:40 +02002444 req->flags |= CF_READ_DONTWAIT;
2445
2446 /* need more data */
2447 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002448 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002449
2450 /* If there is data available for analysis, log the end of the idle time. */
2451 if (c_data(req) && s->logs.t_idle == -1)
2452 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2453
William Lallemandbddd33a2018-12-11 16:10:53 +01002454 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002455 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002456 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002457 /* enough data */
2458
William Lallemandcf62f7e2018-10-26 14:47:40 +02002459 /* forward only 1 command */
2460 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002461
William Lallemanddc12c2e2018-12-13 09:05:46 +01002462 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002463 /* we send only 1 command per request, and we write close after it */
2464 channel_shutw_now(req);
2465 } else {
2466 pcli_write_prompt(s);
2467 }
2468
2469 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002470 s->res.analysers |= AN_RES_WAIT_CLI;
2471
William Lallemandebf61802018-12-11 16:10:57 +01002472 if (!(s->flags & SF_ASSIGNED)) {
2473 if (next_pid > -1)
2474 target_pid = next_pid;
2475 else
2476 target_pid = s->pcli_next_pid;
2477 /* we can connect now */
2478 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002479
William Lallemanddcbe7b92021-12-10 14:14:53 +01002480 if (!s->target)
2481 goto server_disconnect;
2482
William Lallemandebf61802018-12-11 16:10:57 +01002483 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2484 channel_auto_connect(req);
2485 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002486
2487 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002488 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002489 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002490 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002491 } else if (to_forward == -1) {
2492 if (errmsg) {
2493 /* there was an error during the parsing */
2494 pcli_reply_and_close(s, errmsg);
2495 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2496 return 0;
2497 }
2498 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002499 }
2500
2501 return 0;
2502
2503send_help:
2504 b_reset(&req->buf);
2505 b_putblk(&req->buf, "help\n", 5);
2506 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002507
Christopher Faulet0f727da2022-01-18 08:44:23 +01002508missing_data:
2509 if (req->flags & CF_SHUTR) {
2510 /* There is no more request or a only a partial one and we
2511 * receive a close from the client, we can leave */
2512 channel_shutw_now(&s->res);
2513 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2514 return 1;
2515 }
2516 else if (channel_full(req, global.tune.maxrewrite)) {
2517 /* buffer is full and we didn't catch the end of a command */
2518 goto send_help;
2519 }
2520 return 0;
2521
William Lallemanddcbe7b92021-12-10 14:14:53 +01002522server_disconnect:
2523 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2524 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002525}
2526
2527int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2528{
2529 struct proxy *fe = strm_fe(s);
2530 struct proxy *be = s->be;
2531
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002532 if (rep->flags & CF_READ_ERROR) {
2533 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002534 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002535 s->res.analysers &= ~AN_RES_WAIT_CLI;
2536 return 0;
2537 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002538 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2539 rep->flags |= CF_NEVER_WAIT;
2540
2541 /* don't forward the close */
2542 channel_dont_close(&s->res);
2543 channel_dont_close(&s->req);
2544
William Lallemanddc12c2e2018-12-13 09:05:46 +01002545 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002546 s->res.analysers &= ~AN_RES_WAIT_CLI;
2547 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2548 return 0;
2549 }
2550
William Lallemandcf62f7e2018-10-26 14:47:40 +02002551 /* forward the data */
2552 if (ci_data(rep)) {
2553 c_adv(rep, ci_data(rep));
2554 return 0;
2555 }
2556
2557 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2558 /* stream cleanup */
2559
William Lallemand2f4ce202018-10-26 14:47:47 +02002560 pcli_write_prompt(s);
2561
William Lallemandcf62f7e2018-10-26 14:47:40 +02002562 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2563 si_shutr(&s->si[1]);
2564 si_shutw(&s->si[1]);
2565
2566 /*
2567 * starting from there this the same code as
2568 * http_end_txn_clean_session().
2569 *
2570 * It allows to do frontend keepalive while reconnecting to a
2571 * new server for each request.
2572 */
2573
2574 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002575 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002576 if (unlikely(s->srv_conn))
2577 sess_change_server(s, NULL);
2578 }
2579
2580 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2581 stream_process_counters(s);
2582
2583 /* don't count other requests' data */
2584 s->logs.bytes_in -= ci_data(&s->req);
2585 s->logs.bytes_out -= ci_data(&s->res);
2586
2587 /* we may need to know the position in the queue */
2588 pendconn_free(s);
2589
2590 /* let's do a final log if we need it */
2591 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2592 !(s->flags & SF_MONITOR) &&
2593 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2594 s->do_log(s);
2595 }
2596
2597 /* stop tracking content-based counters */
2598 stream_stop_content_counters(s);
2599 stream_update_time_stats(s);
2600
2601 s->logs.accept_date = date; /* user-visible date for logging */
2602 s->logs.tv_accept = now; /* corrected date for internal use */
2603 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2604 s->logs.t_idle = -1;
2605 tv_zero(&s->logs.tv_request);
2606 s->logs.t_queue = -1;
2607 s->logs.t_connect = -1;
2608 s->logs.t_data = -1;
2609 s->logs.t_close = 0;
2610 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2611 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2612
2613 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2614 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2615
2616 stream_del_srv_conn(s);
2617 if (objt_server(s->target)) {
2618 if (s->flags & SF_CURR_SESS) {
2619 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002620 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002621 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002622 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002623 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002624 }
2625
2626 s->target = NULL;
2627
2628 /* only release our endpoint if we don't intend to reuse the
2629 * connection.
2630 */
2631 if (!si_conn_ready(&s->si[1])) {
2632 si_release_endpoint(&s->si[1]);
2633 s->srv_conn = NULL;
2634 }
2635
Christopher Faulet16f16af2021-10-27 09:34:56 +02002636 sockaddr_free(&s->si[1].dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002637
William Lallemandcf62f7e2018-10-26 14:47:40 +02002638 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2639 s->si[1].err_type = SI_ET_NONE;
2640 s->si[1].conn_retries = 0; /* used for logging too */
2641 s->si[1].exp = TICK_ETERNITY;
2642 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 +02002643 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 +02002644 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 +02002645 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2646 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2647 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2648 /* reinitialise the current rule list pointer to NULL. We are sure that
2649 * any rulelist match the NULL pointer.
2650 */
2651 s->current_rule_list = NULL;
2652
2653 s->be = strm_fe(s);
2654 s->logs.logwait = strm_fe(s)->to_log;
2655 s->logs.level = 0;
2656 stream_del_srv_conn(s);
2657 s->target = NULL;
2658 /* re-init store persistence */
2659 s->store_count = 0;
2660 s->uniq_id = global.req_count++;
2661
2662 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2663
2664 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2665
William Lallemandcf62f7e2018-10-26 14:47:40 +02002666 s->res.analysers &= ~AN_RES_WAIT_CLI;
2667
2668 /* We must trim any excess data from the response buffer, because we
2669 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002670 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002671 * we want those data to come along with next response. A typical
2672 * example of such data would be from a buggy server responding to
2673 * a HEAD with some data, or sending more than the advertised
2674 * content-length.
2675 */
2676 if (unlikely(ci_data(&s->res)))
2677 b_set_data(&s->res.buf, co_data(&s->res));
2678
2679 /* Now we can realign the response buffer */
2680 c_realign_if_empty(&s->res);
2681
2682 s->req.rto = strm_fe(s)->timeout.client;
2683 s->req.wto = TICK_ETERNITY;
2684
2685 s->res.rto = TICK_ETERNITY;
2686 s->res.wto = strm_fe(s)->timeout.client;
2687
2688 s->req.rex = TICK_ETERNITY;
2689 s->req.wex = TICK_ETERNITY;
2690 s->req.analyse_exp = TICK_ETERNITY;
2691 s->res.rex = TICK_ETERNITY;
2692 s->res.wex = TICK_ETERNITY;
2693 s->res.analyse_exp = TICK_ETERNITY;
2694 s->si[1].hcto = TICK_ETERNITY;
2695
2696 /* we're removing the analysers, we MUST re-enable events detection.
2697 * We don't enable close on the response channel since it's either
2698 * already closed, or in keep-alive with an idle connection handler.
2699 */
2700 channel_auto_read(&s->req);
2701 channel_auto_close(&s->req);
2702 channel_auto_read(&s->res);
2703
2704
2705 return 1;
2706 }
2707 return 0;
2708}
2709
William Lallemand8a022572018-10-26 14:47:35 +02002710/*
2711 * The mworker functions are used to initialize the CLI in the master process
2712 */
2713
William Lallemand309dc9a2018-10-26 14:47:45 +02002714 /*
2715 * Stop the mworker proxy
2716 */
2717void mworker_cli_proxy_stop()
2718{
William Lallemand550db6d2018-11-06 17:37:12 +01002719 if (mworker_proxy)
2720 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002721}
2722
William Lallemand8a022572018-10-26 14:47:35 +02002723/*
2724 * Create the mworker CLI proxy
2725 */
2726int mworker_cli_proxy_create()
2727{
2728 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002729 char *msg = NULL;
2730 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002731
William Lallemandae787ba2021-07-29 15:13:22 +02002732 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002733 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002734 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002735
William Lallemandcf62f7e2018-10-26 14:47:40 +02002736 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002737 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2738 mworker_proxy->timeout.client = 0; /* no timeout */
2739 mworker_proxy->conf.file = strdup("MASTER");
2740 mworker_proxy->conf.line = 0;
2741 mworker_proxy->accept = frontend_accept;
2742 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2743
2744 /* Does not init the default target the CLI applet, but must be done in
2745 * the request parsing code */
2746 mworker_proxy->default_target = NULL;
2747
William Lallemand8a022572018-10-26 14:47:35 +02002748 /* create all servers using the mworker_proc list */
2749 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002750 struct server *newsrv = NULL;
2751 struct sockaddr_storage *sk;
2752 int port1, port2, port;
2753 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002754
William Lallemanda31b09e2020-01-14 15:25:02 +01002755 /* only the workers support the master CLI */
2756 if (!(child->options & PROC_O_TYPE_WORKER))
2757 continue;
2758
William Lallemand8a022572018-10-26 14:47:35 +02002759 newsrv = new_server(mworker_proxy);
2760 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002761 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002762
2763 /* we don't know the new pid yet */
2764 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002765 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002766 else
2767 memprintf(&msg, "old-%d", child->pid);
2768
2769 newsrv->next = mworker_proxy->srv;
2770 mworker_proxy->srv = newsrv;
2771 newsrv->conf.file = strdup(msg);
2772 newsrv->id = strdup(msg);
2773 newsrv->conf.line = 0;
2774
2775 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002776 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002777 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002778 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002779 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002780 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002781
Willy Tarreau5fc93282020-09-16 18:25:03 +02002782 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002783 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002784 }
2785
2786 /* no port specified */
2787 newsrv->flags |= SRV_F_MAPPORTS;
2788 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002789 /* don't let the server participate to load balancing */
2790 newsrv->iweight = 0;
2791 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002792 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002793
2794 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002795 }
William Lallemandae787ba2021-07-29 15:13:22 +02002796
2797 mworker_proxy->next = proxies_list;
2798 proxies_list = mworker_proxy;
2799
William Lallemand8a022572018-10-26 14:47:35 +02002800 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002801
2802error:
William Lallemand744a0892018-11-22 16:46:51 +01002803
2804 list_for_each_entry(child, &proc_list, list) {
2805 free((char *)child->srv->conf.file); /* cast because of const char * */
2806 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002807 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002808 }
William Lallemandae787ba2021-07-29 15:13:22 +02002809 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002810 free(msg);
2811
William Lallemandae787ba2021-07-29 15:13:22 +02002812error_proxy:
2813 ha_alert("%s\n", errmsg);
2814 free(errmsg);
2815
William Lallemand744a0892018-11-22 16:46:51 +01002816 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002817}
Olivier Houchardf886e342017-04-05 22:24:59 +02002818
William Lallemandce83b4a2018-10-26 14:47:30 +02002819/*
William Lallemande7361152018-10-26 14:47:36 +02002820 * Create a new listener for the master CLI proxy
2821 */
2822int mworker_cli_proxy_new_listener(char *line)
2823{
2824 struct bind_conf *bind_conf;
2825 struct listener *l;
2826 char *err = NULL;
2827 char *args[MAX_LINE_ARGS + 1];
2828 int arg;
2829 int cur_arg;
2830
William Lallemand2e945c82019-11-25 09:58:37 +01002831 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002832 args[0] = line;
2833
2834 /* args is a bind configuration with spaces replaced by commas */
2835 while (*line && arg < MAX_LINE_ARGS) {
2836
2837 if (*line == ',') {
2838 *line++ = '\0';
2839 while (*line == ',')
2840 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002841 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002842 }
2843 line++;
2844 }
2845
William Lallemand2e945c82019-11-25 09:58:37 +01002846 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002847
2848 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002849 if (!bind_conf)
2850 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002851
2852 bind_conf->level &= ~ACCESS_LVL_MASK;
2853 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002854 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002855
2856 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2857 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002858 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002859 }
2860
2861 cur_arg = 1;
2862
2863 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002864 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002865 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002866
2867 kw = bind_find_kw(args[cur_arg]);
2868 if (kw) {
2869 if (!kw->parse) {
2870 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2871 args[0], args[1], args[cur_arg]);
2872 goto err;
2873 }
2874
Willy Tarreau4975d142021-03-13 11:00:33 +01002875 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002876 if (err)
2877 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2878 else
2879 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2880 args[0], args[1], args[cur_arg]);
2881 goto err;
2882 }
2883
2884 cur_arg += 1 + kw->skip;
2885 continue;
2886 }
2887
Willy Tarreau433b05f2021-03-12 10:14:07 +01002888 best = bind_find_best_kw(args[cur_arg]);
2889 if (best)
2890 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2891 args[0], args[1], args[cur_arg], best);
2892 else
2893 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2894 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002895 goto err;
2896 }
2897
2898
2899 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002900 l->accept = session_accept_fd;
2901 l->default_target = mworker_proxy->default_target;
2902 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002903 l->options |= LI_O_UNLIMITED;
2904 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002905 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002906 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002907 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002908 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002909
2910 return 0;
2911
2912err:
2913 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002914 free(err);
2915 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002916 return -1;
2917
2918}
2919
2920/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002921 * Create a new CLI socket using a socketpair for a worker process
2922 * <mworker_proc> is the process structure, and <proc> is the process number
2923 */
2924int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2925{
2926 struct bind_conf *bind_conf;
2927 struct listener *l;
2928 char *path = NULL;
2929 char *err = NULL;
2930
2931 /* master pipe to ensure the master is still alive */
2932 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2933 ha_alert("Cannot create worker socketpair.\n");
2934 return -1;
2935 }
2936
2937 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002938 if (!global.cli_fe) {
2939 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002940 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002941 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002942 }
2943 }
2944
Willy Tarreau4975d142021-03-13 11:00:33 +01002945 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002946 if (!bind_conf)
2947 goto error;
2948
William Lallemandce83b4a2018-10-26 14:47:30 +02002949 bind_conf->level &= ~ACCESS_LVL_MASK;
2950 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01002951 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02002952
William Lallemandce83b4a2018-10-26 14:47:30 +02002953 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2954 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002955 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002956 }
2957
Willy Tarreau4975d142021-03-13 11:00:33 +01002958 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002959 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002960 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002961 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002962 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002963 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002964
2965 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002966 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002967 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002968 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002969 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002970 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002971 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002972 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002973 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002974 }
2975
2976 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002977
2978error:
2979 close(mworker_proc->ipc_fd[0]);
2980 close(mworker_proc->ipc_fd[1]);
2981 free(err);
2982
2983 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002984}
2985
William Lallemand74c24fb2016-11-21 17:18:36 +01002986static struct applet cli_applet = {
2987 .obj_type = OBJ_TYPE_APPLET,
2988 .name = "<CLI>", /* used for logging */
2989 .fct = cli_io_handler,
2990 .release = cli_release_handler,
2991};
2992
William Lallemand99e0bb92020-11-05 10:28:53 +01002993/* master CLI */
2994static struct applet mcli_applet = {
2995 .obj_type = OBJ_TYPE_APPLET,
2996 .name = "<MCLI>", /* used for logging */
2997 .fct = cli_io_handler,
2998 .release = cli_release_handler,
2999};
3000
Willy Tarreau0a739292016-11-22 20:21:23 +01003001/* register cli keywords */
3002static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003003 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3004 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3005 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3006 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
3007 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
3008 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
3009 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3010 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3011 { { "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 },
3012 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
3013 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3014 { { "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 },
3015 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3016 { { "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 },
3017 { { "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 +01003018 { { "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 +02003019 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3020 { { "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 +01003021 {{},}
3022}};
3023
Willy Tarreau0108d902018-11-25 19:14:37 +01003024INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3025
William Lallemand74c24fb2016-11-21 17:18:36 +01003026static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003027 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003028 { 0, NULL, NULL },
3029}};
3030
Willy Tarreau0108d902018-11-25 19:14:37 +01003031INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3032
William Lallemand74c24fb2016-11-21 17:18:36 +01003033static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003034 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3035 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003036 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003037 { NULL, NULL, 0 },
3038}};
3039
Willy Tarreau0108d902018-11-25 19:14:37 +01003040INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003041
3042/*
3043 * Local variables:
3044 * c-indent-level: 8
3045 * c-basic-offset: 8
3046 * End:
3047 */