blob: c5c9a0f79f4faa9fedbd0ecb75cb296dda69c8a0 [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
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200893 /* '- 1' is to ensure a null byte can always be inserted at the end */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200894 reql = co_getline(si_oc(si), str,
895 appctx->chunk->size - appctx->chunk->data - 1);
William Lallemand74c24fb2016-11-21 17:18:36 +0100896 if (reql <= 0) { /* closed or EOL not found */
897 if (reql == 0)
898 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100899 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100900 continue;
901 }
902
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200903 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
904 /* seek for a possible unescaped semi-colon. If we find
905 * one, we replace it with an LF and skip only this part.
906 */
907 for (len = 0; len < reql; len++) {
908 if (str[len] == '\\') {
909 len++;
910 continue;
911 }
912 if (str[len] == ';') {
913 str[len] = '\n';
914 reql = len + 1;
915 break;
916 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100917 }
918 }
919
920 /* now it is time to check that we have a full line,
921 * remove the trailing \n and possibly \r, then cut the
922 * line.
923 */
924 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200925 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100926 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100927 continue;
928 }
929
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200930 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100931 len--;
932
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200933 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200934 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200935
936 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200937 appctx->chunk->area[appctx->chunk->data] = '\n';
938 appctx->chunk->area[appctx->chunk->data + 1] = 0;
939 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200940 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100941
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100942 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200943
944 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
945 /* empty line */
946 if (!len) {
947 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200948 appctx->chunk->data -= 2;
949 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100950 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200951 chunk_reset(appctx->chunk);
952 /* NB: cli_sock_parse_request() may have put
953 * another CLI_ST_O_* into appctx->st0.
954 */
955
956 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +0100957 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100958 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200959 else {
960 /*
961 * Look for the "payload start" pattern at the end of a line
962 * Its location is not remembered here, this is just to switch
963 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +0100964 */
Willy Tarreauf2dda522021-09-17 11:07:45 +0200965 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200966 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200967 appctx->chunk->data++; // keep the trailing \0 after '<<'
968 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200969 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200970 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100971 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200972 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +0200973 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100974 }
975
976 /* re-adjust req buffer */
Willy Tarreau06d80a92017-10-19 14:32:15 +0200977 co_skip(si_oc(si), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +0100978 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
979 }
980 else { /* output functions */
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200981 const char *msg;
982 int sev;
983
William Lallemand74c24fb2016-11-21 17:18:36 +0100984 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100985 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +0100986 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +0200987 case CLI_ST_PRINT: /* print const message in msg */
988 case CLI_ST_PRINT_ERR: /* print const error in msg */
989 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
990 case CLI_ST_PRINT_FREE: /* print dyn error in err, free */
991 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
992 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
993 LOG_ERR : appctx->ctx.cli.severity;
994 msg = appctx->ctx.cli.msg;
995 }
996 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_FREE) {
997 sev = appctx->st0 == CLI_ST_PRINT_FREE ?
998 LOG_ERR : appctx->ctx.cli.severity;
999 msg = appctx->ctx.cli.err;
1000 if (!msg) {
1001 sev = LOG_ERR;
1002 msg = "Out of memory.\n";
1003 }
1004 }
1005 else {
1006 sev = LOG_ERR;
1007 msg = "Internal error.\n";
1008 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001009
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001010 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
1011 if (appctx->st0 == CLI_ST_PRINT_FREE ||
1012 appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001013 ha_free(&appctx->ctx.cli.err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001014 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001015 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001016 }
1017 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001018 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001019 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001020
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001021 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001022 if (appctx->io_handler)
1023 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001024 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001025 if (appctx->io_release) {
1026 appctx->io_release(appctx);
1027 appctx->io_release = NULL;
1028 }
1029 }
1030 break;
1031 default: /* abnormal state */
1032 si->flags |= SI_FL_ERR;
1033 break;
1034 }
1035
1036 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001037 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001038 const char *prompt = "";
1039
1040 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1041 /*
1042 * when entering a payload with interactive mode, change the prompt
1043 * to emphasize that more data can still be sent
1044 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001045 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001046 prompt = "+ ";
1047 else
1048 prompt = "\n> ";
1049 }
1050 else {
William Lallemandad032882019-07-01 10:56:15 +02001051 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001052 prompt = "\n";
1053 }
1054
1055 if (ci_putstr(si_ic(si), prompt) != -1)
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001056 appctx->st0 = CLI_ST_GETREQ;
William Lallemand74c24fb2016-11-21 17:18:36 +01001057 else
Willy Tarreaudb398432018-11-15 11:08:52 +01001058 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001059 }
1060
1061 /* If the output functions are still there, it means they require more room. */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001062 if (appctx->st0 >= CLI_ST_OUTPUT)
William Lallemand74c24fb2016-11-21 17:18:36 +01001063 break;
1064
1065 /* Now we close the output if one of the writers did so,
1066 * or if we're not in interactive mode and the request
1067 * buffer is empty. This still allows pipelined requests
1068 * to be sent in non-interactive mode.
1069 */
William Lallemand3de09d52018-12-11 16:10:56 +01001070 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1071 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001072 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001073 continue;
1074 }
1075
1076 /* switch state back to GETREQ to read next requests */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001077 appctx->st0 = CLI_ST_GETREQ;
William Lallemandad032882019-07-01 10:56:15 +02001078 /* reactivate the \n at the end of the response for the next command */
1079 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001080
1081 /* this forces us to yield between pipelined commands and
1082 * avoid extremely long latencies (e.g. "del map" etc). In
1083 * addition this increases the likelihood that the stream
1084 * refills the buffer with new bytes in non-interactive
1085 * mode, avoiding to close on apparently empty commands.
1086 */
1087 if (co_data(si_oc(si))) {
1088 appctx_wakeup(appctx);
1089 goto out;
1090 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001091 }
1092 }
1093
1094 if ((res->flags & CF_SHUTR) && (si->state == SI_ST_EST)) {
1095 DPRINTF(stderr, "%s@%d: si to buf closed. req=%08x, res=%08x, st=%d\n",
1096 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1097 /* Other side has closed, let's abort if we have no more processing to do
1098 * and nothing more to consume. This is comparable to a broken pipe, so
1099 * we forward the close to the request side so that it flows upstream to
1100 * the client.
1101 */
1102 si_shutw(si);
1103 }
1104
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001105 if ((req->flags & CF_SHUTW) && (si->state == SI_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
William Lallemand74c24fb2016-11-21 17:18:36 +01001106 DPRINTF(stderr, "%s@%d: buf to si closed. req=%08x, res=%08x, st=%d\n",
1107 __FUNCTION__, __LINE__, req->flags, res->flags, si->state);
1108 /* We have no more processing to do, and nothing more to send, and
1109 * the client side has closed. So we'll forward this state downstream
1110 * on the response buffer.
1111 */
1112 si_shutr(si);
1113 res->flags |= CF_READ_NULL;
1114 }
1115
1116 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001117 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 +01001118 __FUNCTION__, __LINE__,
Christopher Faulet45073512018-07-20 10:16:29 +02001119 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 +01001120}
1121
William Lallemand74c24fb2016-11-21 17:18:36 +01001122/* This is called when the stream interface is closed. For instance, upon an
1123 * external abort, we won't call the i/o handler anymore so we may need to
1124 * remove back references to the stream currently being dumped.
1125 */
1126static void cli_release_handler(struct appctx *appctx)
1127{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001128 free_trash_chunk(appctx->chunk);
1129 appctx->chunk = NULL;
1130
William Lallemand74c24fb2016-11-21 17:18:36 +01001131 if (appctx->io_release) {
1132 appctx->io_release(appctx);
1133 appctx->io_release = NULL;
1134 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001135 else if (appctx->st0 == CLI_ST_PRINT_FREE || appctx->st0 == CLI_ST_PRINT_DYN) {
Willy Tarreau61cfdf42021-02-20 10:46:51 +01001136 ha_free(&appctx->ctx.cli.err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001137 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001138}
1139
1140/* This function dumps all environmnent variables to the buffer. It returns 0
1141 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreauf6710f82016-12-16 17:45:44 +01001142 * non-zero. Dumps only one entry if st2 == STAT_ST_END. It uses cli.p0 as the
1143 * pointer to the current variable.
William Lallemand74c24fb2016-11-21 17:18:36 +01001144 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001145static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001146{
Willy Tarreau0a739292016-11-22 20:21:23 +01001147 struct stream_interface *si = appctx->owner;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001148 char **var = appctx->ctx.cli.p0;
William Lallemand74c24fb2016-11-21 17:18:36 +01001149
1150 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1151 return 1;
1152
1153 chunk_reset(&trash);
1154
1155 /* we have two inner loops here, one for the proxy, the other one for
1156 * the buffer.
1157 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001158 while (*var) {
1159 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001160
Willy Tarreau06d80a92017-10-19 14:32:15 +02001161 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001162 si_rx_room_blk(si);
William Lallemand74c24fb2016-11-21 17:18:36 +01001163 return 0;
1164 }
1165 if (appctx->st2 == STAT_ST_END)
1166 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001167 var++;
1168 appctx->ctx.cli.p0 = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001169 }
1170
1171 /* dump complete */
1172 return 1;
1173}
1174
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001175/* This function dumps all file descriptors states (or the requested one) to
1176 * the buffer. It returns 0 if the output buffer is full and it needs to be
1177 * called again, otherwise non-zero. Dumps only one entry if st2 == STAT_ST_END.
1178 * It uses cli.i0 as the fd number to restart from.
1179 */
1180static int cli_io_handler_show_fd(struct appctx *appctx)
1181{
1182 struct stream_interface *si = appctx->owner;
1183 int fd = appctx->ctx.cli.i0;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001184 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001185
1186 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001187 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001188
1189 chunk_reset(&trash);
1190
Willy Tarreauca1b1572018-12-18 15:45:11 +01001191 /* isolate the threads once per round. We're limited to a buffer worth
1192 * of output anyway, it cannot last very long.
1193 */
1194 thread_isolate();
1195
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001196 /* we have two inner loops here, one for the proxy, the other one for
1197 * the buffer.
1198 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001199 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001200 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001201 const struct listener *li = NULL;
1202 const struct server *sv = NULL;
1203 const struct proxy *px = NULL;
1204 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001205 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001206 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001207 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001208 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001209 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001210 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001211 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001212
1213 fdt = fdtab[fd];
1214
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001215 /* When DEBUG_FD is set, we also report closed FDs that have a
1216 * non-null event count to detect stuck ones.
1217 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001218 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001219#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001220 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001221#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001222 goto skip; // closed
1223 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001224 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001225 conn = (const struct connection *)fdt.owner;
1226 conn_flags = conn->flags;
1227 mux = conn->mux;
1228 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001229 xprt = conn->xprt;
1230 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001231 li = objt_listener(conn->target);
1232 sv = objt_server(conn->target);
1233 px = objt_proxy(conn->target);
1234 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001235 if (atleast2(fdt.thread_mask))
1236 suspicious = 1;
1237 if (conn->handle.fd != fd)
1238 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001239 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001240 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001241 li = fdt.owner;
1242
Willy Tarreaudacfde42021-01-21 09:07:29 +01001243 if (!fdt.thread_mask)
1244 suspicious = 1;
1245
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001246 chunk_printf(&trash,
Willy Tarreau184b2122021-04-07 08:48:12 +02001247 " %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 +02001248 fd,
1249 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001250 (fdt.state & FD_CLONED) ? 'C' : 'c',
1251 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001252 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1253 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1254 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1255 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1256 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001257 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1258 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1259 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1260 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1261 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1262 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc754b342018-03-30 15:00:15 +02001263 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001264 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001265 fdt.iocb);
1266 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001267
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001268 if (!fdt.owner) {
1269 chunk_appendf(&trash, ")");
1270 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001271 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001272 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001273
1274 if (conn->handle.fd != fd) {
1275 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1276 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001277 } else {
1278 struct sockaddr_storage sa;
1279 socklen_t salen;
1280
1281 salen = sizeof(sa);
1282 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1283 if (sa.ss_family == AF_INET)
1284 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1285 else if (sa.ss_family == AF_INET6)
1286 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1287 else if (sa.ss_family == AF_UNIX)
1288 chunk_appendf(&trash, " fam=unix");
1289 }
1290
1291 salen = sizeof(sa);
1292 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1293 if (sa.ss_family == AF_INET)
1294 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1295 else if (sa.ss_family == AF_INET6)
1296 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1297 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001298 }
1299
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001300 if (px)
1301 chunk_appendf(&trash, " px=%s", px->id);
1302 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001303 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001304 else if (li)
1305 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001306
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001307 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001308 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001309 if (!ctx)
1310 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001311 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001312 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001313 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001314 else
1315 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001316
1317 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001318 if (xprt) {
1319 if (xprt_ctx || xprt->show_fd)
1320 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1321 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001322 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001323 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001324 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001325 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001326 struct sockaddr_storage sa;
1327 socklen_t salen;
1328
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001329 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001330 listener_state_str(li),
1331 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001332
1333 salen = sizeof(sa);
1334 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1335 if (sa.ss_family == AF_INET)
1336 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1337 else if (sa.ss_family == AF_INET6)
1338 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1339 else if (sa.ss_family == AF_UNIX)
1340 chunk_appendf(&trash, " fam=unix");
1341 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001342 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001343 else
1344 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001345
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001346#ifdef DEBUG_FD
1347 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001348 if (fdtab[fd].event_count >= 1000000)
1349 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001350#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001351 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001352
Willy Tarreau06d80a92017-10-19 14:32:15 +02001353 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001354 si_rx_room_blk(si);
Willy Tarreauca1b1572018-12-18 15:45:11 +01001355 appctx->ctx.cli.i0 = fd;
1356 ret = 0;
1357 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001358 }
1359 skip:
1360 if (appctx->st2 == STAT_ST_END)
1361 break;
1362
1363 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001364 }
1365
Willy Tarreauca1b1572018-12-18 15:45:11 +01001366 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001367 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001368
1369 thread_release();
1370 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001371}
1372
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001373/* This function dumps some activity counters used by developers and support to
1374 * rule out some hypothesis during bug reports. It returns 0 if the output
1375 * buffer is full and it needs to be called again, otherwise non-zero. It dumps
1376 * everything at once in the buffer and is not designed to do it in multiple
1377 * passes.
1378 */
1379static int cli_io_handler_show_activity(struct appctx *appctx)
1380{
1381 struct stream_interface *si = appctx->owner;
1382 int thr;
1383
1384 if (unlikely(si_ic(si)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
1385 return 1;
1386
1387 chunk_reset(&trash);
1388
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001389#undef SHOW_TOT
1390#define SHOW_TOT(t, x) \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001391 do { \
1392 unsigned int _v[MAX_THREADS]; \
1393 unsigned int _tot; \
1394 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001395 _tot = t = 0; \
1396 do { \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001397 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001398 } while (++t < _nbt); \
Willy Tarreaua0211b82019-05-28 15:09:08 +02001399 if (_nbt == 1) { \
1400 chunk_appendf(&trash, " %u\n", _tot); \
1401 break; \
1402 } \
1403 chunk_appendf(&trash, " %u [", _tot); \
1404 for (t = 0; t < _nbt; t++) \
1405 chunk_appendf(&trash, " %u", _v[t]); \
1406 chunk_appendf(&trash, " ]\n"); \
1407 } while (0)
1408
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001409#undef SHOW_AVG
1410#define SHOW_AVG(t, x) \
1411 do { \
1412 unsigned int _v[MAX_THREADS]; \
1413 unsigned int _tot; \
1414 const unsigned int _nbt = global.nbthread; \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001415 _tot = t = 0; \
1416 do { \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001417 _tot += _v[t] = (x); \
Willy Tarreau97b5d072021-11-20 19:17:38 +01001418 } while (++t < _nbt); \
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001419 if (_nbt == 1) { \
1420 chunk_appendf(&trash, " %u\n", _tot); \
1421 break; \
1422 } \
1423 chunk_appendf(&trash, " %u [", (_tot + _nbt/2) / _nbt); \
1424 for (t = 0; t < _nbt; t++) \
1425 chunk_appendf(&trash, " %u", _v[t]); \
1426 chunk_appendf(&trash, " ]\n"); \
1427 } while (0)
1428
Willy Tarreaua0211b82019-05-28 15:09:08 +02001429 chunk_appendf(&trash, "thread_id: %u (%u..%u)\n", tid + 1, 1, global.nbthread);
1430 chunk_appendf(&trash, "date_now: %lu.%06lu\n", (long)now.tv_sec, (long)now.tv_usec);
Willy Tarreaua00cf9b2020-06-17 20:44:28 +02001431 chunk_appendf(&trash, "ctxsw:"); SHOW_TOT(thr, activity[thr].ctxsw);
1432 chunk_appendf(&trash, "tasksw:"); SHOW_TOT(thr, activity[thr].tasksw);
1433 chunk_appendf(&trash, "empty_rq:"); SHOW_TOT(thr, activity[thr].empty_rq);
1434 chunk_appendf(&trash, "long_rq:"); SHOW_TOT(thr, activity[thr].long_rq);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001435 chunk_appendf(&trash, "loops:"); SHOW_TOT(thr, activity[thr].loops);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001436 chunk_appendf(&trash, "wake_tasks:"); SHOW_TOT(thr, activity[thr].wake_tasks);
1437 chunk_appendf(&trash, "wake_signal:"); SHOW_TOT(thr, activity[thr].wake_signal);
Willy Tarreaue5451532020-06-17 20:25:18 +02001438 chunk_appendf(&trash, "poll_io:"); SHOW_TOT(thr, activity[thr].poll_io);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001439 chunk_appendf(&trash, "poll_exp:"); SHOW_TOT(thr, activity[thr].poll_exp);
Willy Tarreaue4063862020-06-17 20:35:33 +02001440 chunk_appendf(&trash, "poll_drop_fd:"); SHOW_TOT(thr, activity[thr].poll_drop_fd);
Willy Tarreaue4063862020-06-17 20:35:33 +02001441 chunk_appendf(&trash, "poll_skip_fd:"); SHOW_TOT(thr, activity[thr].poll_skip_fd);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001442 chunk_appendf(&trash, "conn_dead:"); SHOW_TOT(thr, activity[thr].conn_dead);
Willy Tarreau7af4fa92020-06-17 20:49:49 +02001443 chunk_appendf(&trash, "stream_calls:"); SHOW_TOT(thr, activity[thr].stream_calls);
Willy Tarreaua8b2ce02019-05-28 17:04:16 +02001444 chunk_appendf(&trash, "pool_fail:"); SHOW_TOT(thr, activity[thr].pool_fail);
1445 chunk_appendf(&trash, "buf_wait:"); SHOW_TOT(thr, activity[thr].buf_wait);
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001446 chunk_appendf(&trash, "cpust_ms_tot:"); SHOW_TOT(thr, activity[thr].cpust_total / 2);
1447 chunk_appendf(&trash, "cpust_ms_1s:"); SHOW_TOT(thr, read_freq_ctr(&activity[thr].cpust_1s) / 2);
1448 chunk_appendf(&trash, "cpust_ms_15s:"); SHOW_TOT(thr, read_freq_ctr_period(&activity[thr].cpust_15s, 15000) / 2);
1449 chunk_appendf(&trash, "avg_loop_us:"); SHOW_AVG(thr, swrate_avg(activity[thr].avg_loop_us, TIME_STATS_SAMPLES));
1450 chunk_appendf(&trash, "accepted:"); SHOW_TOT(thr, activity[thr].accepted);
1451 chunk_appendf(&trash, "accq_pushed:"); SHOW_TOT(thr, activity[thr].accq_pushed);
1452 chunk_appendf(&trash, "accq_full:"); SHOW_TOT(thr, activity[thr].accq_full);
Willy Tarreaue6182842019-04-15 18:54:10 +02001453#ifdef USE_THREAD
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001454 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 +02001455 chunk_appendf(&trash, "fd_takeover:"); SHOW_TOT(thr, activity[thr].fd_takeover);
Willy Tarreaue6182842019-04-15 18:54:10 +02001456#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001457
Willy Tarreaud6a78502019-05-27 07:03:38 +02001458#if defined(DEBUG_DEV)
1459 /* keep these ones at the end */
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001460 chunk_appendf(&trash, "ctr0:"); SHOW_TOT(thr, activity[thr].ctr0);
1461 chunk_appendf(&trash, "ctr1:"); SHOW_TOT(thr, activity[thr].ctr1);
1462 chunk_appendf(&trash, "ctr2:"); SHOW_TOT(thr, activity[thr].ctr2);
Willy Tarreaud6a78502019-05-27 07:03:38 +02001463#endif
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001464
1465 if (ci_putchk(si_ic(si), &trash) == -1) {
1466 chunk_reset(&trash);
1467 chunk_printf(&trash, "[output too large, cannot dump]\n");
Willy Tarreaudb398432018-11-15 11:08:52 +01001468 si_rx_room_blk(si);
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001469 }
1470
Willy Tarreaud78d08f2019-05-28 16:32:06 +02001471#undef SHOW_AVG
1472#undef SHOW_TOT
Willy Tarreaud80cb4e2018-01-20 19:30:13 +01001473 /* dump complete */
1474 return 1;
1475}
1476
William Lallemandeceddf72016-12-15 18:06:44 +01001477/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001478 * CLI IO handler for `show cli sockets`.
1479 * Uses ctx.cli.p0 to store the restart pointer.
William Lallemandeceddf72016-12-15 18:06:44 +01001480 */
1481static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1482{
1483 struct bind_conf *bind_conf;
1484 struct stream_interface *si = appctx->owner;
1485
1486 chunk_reset(&trash);
1487
1488 switch (appctx->st2) {
1489 case STAT_ST_INIT:
1490 chunk_printf(&trash, "# socket lvl processes\n");
Willy Tarreau06d80a92017-10-19 14:32:15 +02001491 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001492 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001493 return 0;
1494 }
William Lallemandeceddf72016-12-15 18:06:44 +01001495 appctx->st2 = STAT_ST_LIST;
Tim Duesterhus588b3142020-05-29 14:35:51 +02001496 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001497
1498 case STAT_ST_LIST:
Willy Tarreau4975d142021-03-13 11:00:33 +01001499 if (global.cli_fe) {
1500 list_for_each_entry(bind_conf, &global.cli_fe->conf.bind, by_fe) {
William Lallemandeceddf72016-12-15 18:06:44 +01001501 struct listener *l;
1502
1503 /*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001504 * get the latest dumped node in appctx->ctx.cli.p0
William Lallemandeceddf72016-12-15 18:06:44 +01001505 * if the current node is the first of the list
1506 */
1507
Willy Tarreau3af9d832016-12-16 12:58:09 +01001508 if (appctx->ctx.cli.p0 &&
Willy Tarreau4975d142021-03-13 11:00:33 +01001509 &bind_conf->by_fe == (&global.cli_fe->conf.bind)->n) {
William Lallemandeceddf72016-12-15 18:06:44 +01001510 /* change the current node to the latest dumped and continue the loop */
Willy Tarreau3af9d832016-12-16 12:58:09 +01001511 bind_conf = LIST_ELEM(appctx->ctx.cli.p0, typeof(bind_conf), by_fe);
William Lallemandeceddf72016-12-15 18:06:44 +01001512 continue;
1513 }
1514
1515 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
1516
1517 char addr[46];
1518 char port[6];
1519
Willy Tarreau37159062020-08-27 07:48:42 +02001520 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemandeceddf72016-12-15 18:06:44 +01001521 const struct sockaddr_un *un;
1522
Willy Tarreau37159062020-08-27 07:48:42 +02001523 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemande58915f2019-04-01 11:30:05 +02001524 if (un->sun_path[0] == '\0') {
William Lallemand75812a72019-04-01 11:30:04 +02001525 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
William Lallemande58915f2019-04-01 11:30:05 +02001526 } else {
1527 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1528 }
Willy Tarreau37159062020-08-27 07:48:42 +02001529 } else if (l->rx.addr.ss_family == AF_INET) {
1530 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1531 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001532 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001533 } else if (l->rx.addr.ss_family == AF_INET6) {
1534 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1535 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemande58915f2019-04-01 11:30:05 +02001536 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +02001537 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1538 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemandeceddf72016-12-15 18:06:44 +01001539 } else
William Lallemand26314342018-10-26 14:47:41 +02001540 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001541
William Lallemand07a62f72017-05-24 00:57:40 +02001542 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
William Lallemandeceddf72016-12-15 18:06:44 +01001543 chunk_appendf(&trash, "admin ");
William Lallemand07a62f72017-05-24 00:57:40 +02001544 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1545 chunk_appendf(&trash, "operator ");
1546 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1547 chunk_appendf(&trash, "user ");
William Lallemandeceddf72016-12-15 18:06:44 +01001548 else
1549 chunk_appendf(&trash, " ");
1550
Willy Tarreau72faef32021-06-15 08:36:30 +02001551 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001552
Willy Tarreau06d80a92017-10-19 14:32:15 +02001553 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001554 si_rx_room_blk(si);
William Lallemandeceddf72016-12-15 18:06:44 +01001555 return 0;
1556 }
1557 }
Willy Tarreau3af9d832016-12-16 12:58:09 +01001558 appctx->ctx.cli.p0 = &bind_conf->by_fe; /* store the latest list node dumped */
William Lallemandeceddf72016-12-15 18:06:44 +01001559 }
1560 }
Tim Duesterhus588b3142020-05-29 14:35:51 +02001561 /* fall through */
William Lallemandeceddf72016-12-15 18:06:44 +01001562 default:
1563 appctx->st2 = STAT_ST_FIN;
1564 return 1;
1565 }
1566}
1567
1568
Willy Tarreau0a739292016-11-22 20:21:23 +01001569/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreauf6710f82016-12-16 17:45:44 +01001570 * wants to stop here. It puts the variable to be dumped into cli.p0 if a single
1571 * variable is requested otherwise puts environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001572 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001573static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001574{
1575 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001576 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001577
1578 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1579 return 1;
1580
Willy Tarreauf6710f82016-12-16 17:45:44 +01001581 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001582
1583 if (*args[2]) {
1584 int len = strlen(args[2]);
1585
Willy Tarreauf6710f82016-12-16 17:45:44 +01001586 for (; *var; var++) {
1587 if (strncmp(*var, args[2], len) == 0 &&
1588 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001589 break;
1590 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001591 if (!*var)
1592 return cli_err(appctx, "Variable not found\n");
1593
Willy Tarreau0a739292016-11-22 20:21:23 +01001594 appctx->st2 = STAT_ST_END;
1595 }
Willy Tarreauf6710f82016-12-16 17:45:44 +01001596 appctx->ctx.cli.p0 = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001597 return 0;
1598}
1599
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001600/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
1601 * wants to stop here. It puts the FD number into cli.i0 if a specific FD is
1602 * requested and sets st2 to STAT_ST_END, otherwise leaves 0 in i0.
1603 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001604static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001605{
1606 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1607 return 1;
1608
1609 appctx->ctx.cli.i0 = 0;
1610
1611 if (*args[2]) {
1612 appctx->ctx.cli.i0 = atoi(args[2]);
1613 appctx->st2 = STAT_ST_END;
1614 }
1615 return 0;
1616}
1617
Willy Tarreau599852e2016-11-22 20:33:32 +01001618/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001619static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001620{
1621 struct stream_interface *si = appctx->owner;
1622 struct stream *s = si_strm(si);
1623
1624 if (strcmp(args[2], "cli") == 0) {
1625 unsigned timeout;
1626 const char *res;
1627
Willy Tarreau9d008692019-08-09 11:21:01 +02001628 if (!*args[3])
1629 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001630
1631 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001632 if (res || timeout < 1)
1633 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001634
1635 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1636 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1637 return 1;
1638 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001639
1640 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001641}
1642
Willy Tarreau2af99412016-11-23 11:10:59 +01001643/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001644static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001645{
1646 int v;
1647
1648 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1649 return 1;
1650
Willy Tarreau9d008692019-08-09 11:21:01 +02001651 if (!*args[3])
1652 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001653
1654 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001655 if (v > global.hardmaxconn)
1656 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001657
1658 /* check for unlimited values */
1659 if (v <= 0)
1660 v = global.hardmaxconn;
1661
1662 global.maxconn = v;
1663
1664 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001665 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001666
1667 return 1;
1668}
1669
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001670static int set_severity_output(int *target, char *argument)
1671{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001672 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001673 *target = CLI_SEVERITY_NONE;
1674 return 1;
1675 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001676 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001677 *target = CLI_SEVERITY_NUMBER;
1678 return 1;
1679 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001680 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001681 *target = CLI_SEVERITY_STRING;
1682 return 1;
1683 }
1684 return 0;
1685}
1686
1687/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001688static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001689{
1690 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1691 return 0;
1692
Willy Tarreau9d008692019-08-09 11:21:01 +02001693 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001694}
William Lallemandeceddf72016-12-15 18:06:44 +01001695
William Lallemand67a234f2018-12-13 09:05:45 +01001696
1697/* show the level of the current CLI session */
1698static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1699{
William Lallemand67a234f2018-12-13 09:05:45 +01001700 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001701 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001702 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001703 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001704 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001705 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001706 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001707 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001708}
1709
1710/* parse and set the CLI level dynamically */
1711static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1712{
William Lallemandad032882019-07-01 10:56:15 +02001713 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001714 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001715 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1716
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001717 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001718 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1719 return 1;
1720 }
1721 appctx->cli_level &= ~ACCESS_LVL_MASK;
1722 appctx->cli_level |= ACCESS_LVL_OPER;
1723
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001724 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001725 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1726 return 1;
1727 }
1728 appctx->cli_level &= ~ACCESS_LVL_MASK;
1729 appctx->cli_level |= ACCESS_LVL_USER;
1730 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001731 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001732 return 1;
1733}
1734
1735
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001736/* parse and set the CLI expert/experimental-mode dynamically */
1737static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001738{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001739 int level;
1740 char *level_str;
1741 char *output = NULL;
1742
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001743 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1744 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001745
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001746 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001747 level = ACCESS_EXPERT;
1748 level_str = "expert-mode";
1749 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001750 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001751 level = ACCESS_EXPERIMENTAL;
1752 level_str = "experimental-mode";
1753 }
1754 else {
1755 return 1;
1756 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001757
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001758 if (!*args[1]) {
1759 memprintf(&output, "%s is %s\n", level_str,
1760 (appctx->cli_level & level) ? "ON" : "OFF");
1761 return cli_dynmsg(appctx, LOG_INFO, output);
1762 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001763
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001764 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001765 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001766 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001767 return 1;
1768}
1769
William Lallemand740629e2021-12-14 15:22:29 +01001770/* shows HAProxy version */
1771static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1772{
1773 char *msg = NULL;
1774
1775 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1776}
1777
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001778int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001779{
1780 return 0;
1781}
1782
Willy Tarreau45c742b2016-11-24 14:51:17 +01001783/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001784static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001785{
1786 int v;
1787 int *res;
1788 int mul = 1;
1789
1790 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1791 return 1;
1792
1793 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1794 res = &global.cps_lim;
1795 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1796 res = &global.sps_lim;
1797#ifdef USE_OPENSSL
1798 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1799 res = &global.ssl_lim;
1800#endif
1801 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1802 res = &global.comp_rate_lim;
1803 mul = 1024;
1804 }
1805 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001806 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001807 "'set rate-limit' only supports :\n"
1808 " - 'connections global' to set the per-process maximum connection rate\n"
1809 " - 'sessions global' to set the per-process maximum session rate\n"
1810#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001811 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001812#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001813 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001814 }
1815
Willy Tarreau9d008692019-08-09 11:21:01 +02001816 if (!*args[4])
1817 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001818
1819 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001820 if (v < 0)
1821 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001822
1823 *res = v * mul;
1824
1825 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001826 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001827
1828 return 1;
1829}
1830
William Lallemandf6975e92017-05-26 17:42:10 +02001831/* parse the "expose-fd" argument on the bind lines */
1832static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1833{
1834 if (!*args[cur_arg + 1]) {
1835 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1836 return ERR_ALERT | ERR_FATAL;
1837 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001838 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001839 conf->level |= ACCESS_FD_LISTENERS;
1840 } else {
1841 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1842 args[cur_arg], args[cur_arg+1]);
1843 return ERR_ALERT | ERR_FATAL;
1844 }
1845
1846 return 0;
1847}
1848
William Lallemand74c24fb2016-11-21 17:18:36 +01001849/* parse the "level" argument on the bind lines */
1850static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1851{
1852 if (!*args[cur_arg + 1]) {
1853 memprintf(err, "'%s' : missing level", args[cur_arg]);
1854 return ERR_ALERT | ERR_FATAL;
1855 }
1856
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001857 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001858 conf->level &= ~ACCESS_LVL_MASK;
1859 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001860 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001861 conf->level &= ~ACCESS_LVL_MASK;
1862 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001863 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001864 conf->level &= ~ACCESS_LVL_MASK;
1865 conf->level |= ACCESS_LVL_ADMIN;
1866 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001867 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1868 args[cur_arg], args[cur_arg+1]);
1869 return ERR_ALERT | ERR_FATAL;
1870 }
1871
1872 return 0;
1873}
1874
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001875static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1876{
1877 if (!*args[cur_arg + 1]) {
1878 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1879 return ERR_ALERT | ERR_FATAL;
1880 }
1881
1882 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1883 return 0;
1884 else {
1885 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1886 args[cur_arg], args[cur_arg+1]);
1887 return ERR_ALERT | ERR_FATAL;
1888 }
1889}
1890
Olivier Houchardf886e342017-04-05 22:24:59 +02001891/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001892static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001893{
1894 char *cmsgbuf = NULL;
1895 unsigned char *tmpbuf = NULL;
1896 struct cmsghdr *cmsg;
1897 struct stream_interface *si = appctx->owner;
William Lallemandf6975e92017-05-26 17:42:10 +02001898 struct stream *s = si_strm(si);
Olivier Houchard9aaf7782017-09-13 18:30:23 +02001899 struct connection *remote = cs_conn(objt_cs(si_opposite(si)->end));
Olivier Houchardf886e342017-04-05 22:24:59 +02001900 struct msghdr msghdr;
1901 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001902 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001903 const char *ns_name, *if_name;
1904 unsigned char ns_nlen, if_nlen;
1905 int nb_queued;
1906 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001907 int *tmpfd;
1908 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001909 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001910 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001911 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001912 int ret;
1913
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001914 if (!remote) {
1915 ha_warning("Only works on real connections\n");
1916 goto out;
1917 }
1918
1919 fd = remote->handle.fd;
1920
Olivier Houchardf886e342017-04-05 22:24:59 +02001921 /* Temporary set the FD in blocking mode, that will make our life easier */
1922 old_fcntl = fcntl(fd, F_GETFL);
1923 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001924 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001925 goto out;
1926 }
1927 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1928 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001929 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001930 goto out;
1931 }
1932 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001933 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001934 goto out;
1935 }
Olivier Houchard54740872017-04-06 14:45:14 +02001936 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001937 iov.iov_base = &tot_fd_nb;
1938 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001939 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001940 goto out;
1941 memset(&msghdr, 0, sizeof(msghdr));
1942 /*
1943 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001944 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001945 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001946 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02001947 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01001948
Olivier Houchardf886e342017-04-05 22:24:59 +02001949 if (tot_fd_nb == 0)
1950 goto out;
1951
1952 /* First send the total number of file descriptors, so that the
1953 * receiving end knows what to expect.
1954 */
1955 msghdr.msg_iov = &iov;
1956 msghdr.msg_iovlen = 1;
1957 ret = sendmsg(fd, &msghdr, 0);
1958 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001959 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001960 goto out;
1961 }
1962
1963 /* Now send the fds */
1964 msghdr.msg_control = cmsgbuf;
1965 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
1966 cmsg = CMSG_FIRSTHDR(&msghdr);
1967 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
1968 cmsg->cmsg_level = SOL_SOCKET;
1969 cmsg->cmsg_type = SCM_RIGHTS;
1970 tmpfd = (int *)CMSG_DATA(cmsg);
1971
Olivier Houchardf886e342017-04-05 22:24:59 +02001972 /* For each socket, e message is sent, containing the following :
1973 * Size of the namespace name (or 0 if none), as an unsigned char.
1974 * The namespace name, if any
1975 * Size of the interface name (or 0 if none), as an unsigned char
1976 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02001977 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02001978 */
1979 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05001980 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02001981 */
Olivier Houchardf143b802017-11-04 15:13:01 +01001982 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02001983 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05001984 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001985 goto out;
1986 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001987
1988 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001989 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001990 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02001991 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001992 continue;
1993
1994 ns_name = if_name = "";
1995 ns_nlen = if_nlen = 0;
1996
1997 /* for now we can only retrieve namespaces and interfaces from
1998 * pure listeners.
1999 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002000 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002001 const struct listener *l = fdtab[cur_fd].owner;
2002
Willy Tarreau818a92e2020-09-03 07:50:19 +02002003 if (l->rx.settings->interface) {
2004 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002005 if_nlen = strlen(if_name);
2006 }
2007
2008#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002009 if (l->rx.settings->netns) {
2010 ns_name = l->rx.settings->netns->node.key;
2011 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002012 }
2013#endif
2014 }
2015
2016 /* put the FD into the CMSG_DATA */
2017 tmpfd[nb_queued++] = cur_fd;
2018
2019 /* first block is <ns_name_len> <ns_name> */
2020 tmpbuf[curoff++] = ns_nlen;
2021 if (ns_nlen)
2022 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2023 curoff += ns_nlen;
2024
2025 /* second block is <if_name_len> <if_name> */
2026 tmpbuf[curoff++] = if_nlen;
2027 if (if_nlen)
2028 memcpy(tmpbuf + curoff, if_name, if_nlen);
2029 curoff += if_nlen;
2030
2031 /* we used to send the listener options here before 2.3 */
2032 memset(tmpbuf + curoff, 0, sizeof(int));
2033 curoff += sizeof(int);
2034
2035 /* there's a limit to how many FDs may be sent at once */
2036 if (nb_queued == MAX_SEND_FD) {
2037 iov.iov_len = curoff;
2038 if (sendmsg(fd, &msghdr, 0) != curoff) {
2039 ha_warning("Failed to transfer sockets\n");
2040 return -1;
2041 }
2042
2043 /* Wait for an ack */
2044 do {
2045 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2046 } while (ret == -1 && errno == EINTR);
2047
2048 if (ret <= 0) {
2049 ha_warning("Unexpected error while transferring sockets\n");
2050 return -1;
2051 }
2052 curoff = 0;
2053 nb_queued = 0;
2054 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002055 }
2056
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002057 /* flush pending stuff */
2058 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002059 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002060 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2061 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002062 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002063 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002064 goto out;
2065 }
2066 }
2067
2068out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002069 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002070 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002071 goto out;
2072 }
2073 appctx->st0 = CLI_ST_END;
2074 free(cmsgbuf);
2075 free(tmpbuf);
2076 return 1;
2077}
2078
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002079static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2080{
2081 if (*args[0] == 'h')
2082 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002083 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002084 else if (*args[0] == 'p')
2085 /* prompt */
2086 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2087 else if (*args[0] == 'q')
2088 /* quit */
2089 appctx->st0 = CLI_ST_END;
2090
2091 return 1;
2092}
Olivier Houchardf886e342017-04-05 22:24:59 +02002093
William Lallemand2f4ce202018-10-26 14:47:47 +02002094void pcli_write_prompt(struct stream *s)
2095{
2096 struct buffer *msg = get_trash_chunk();
2097 struct channel *oc = si_oc(&s->si[0]);
2098
William Lallemanddc12c2e2018-12-13 09:05:46 +01002099 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002100 return;
2101
William Lallemanddc12c2e2018-12-13 09:05:46 +01002102 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002103 chunk_appendf(msg, "+ ");
2104 } else {
2105 if (s->pcli_next_pid == 0)
Willy Tarreau52880f92018-12-15 13:30:03 +01002106 chunk_appendf(msg, "master%s> ",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002107 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002108 else
2109 chunk_appendf(msg, "%d> ", s->pcli_next_pid);
2110 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002111 co_inject(oc, msg->area, msg->data);
2112}
2113
William Lallemand291810d2018-10-26 14:47:38 +02002114
William Lallemandcf62f7e2018-10-26 14:47:40 +02002115/* The pcli_* functions are used for the CLI proxy in the master */
2116
William Lallemanddeeaa592018-10-26 14:47:48 +02002117void pcli_reply_and_close(struct stream *s, const char *msg)
2118{
2119 struct buffer *buf = get_trash_chunk();
2120
2121 chunk_initstr(buf, msg);
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01002122 si_retnclose(&s->si[0], buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002123}
2124
William Lallemand291810d2018-10-26 14:47:38 +02002125static enum obj_type *pcli_pid_to_server(int proc_pid)
2126{
2127 struct mworker_proc *child;
2128
William Lallemand99e0bb92020-11-05 10:28:53 +01002129 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002130 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002131 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002132
William Lallemand291810d2018-10-26 14:47:38 +02002133 list_for_each_entry(child, &proc_list, list) {
2134 if (child->pid == proc_pid){
2135 return &child->srv->obj_type;
2136 }
2137 }
2138 return NULL;
2139}
2140
2141/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2142 * Return:
2143 * 0: master
2144 * > 0: pid of a worker
2145 * < 0: didn't find a worker
2146 */
2147static int pcli_prefix_to_pid(const char *prefix)
2148{
2149 int proc_pid;
2150 struct mworker_proc *child;
2151 char *errtol = NULL;
2152
2153 if (*prefix != '@') /* not a prefix, should not happen */
2154 return -1;
2155
2156 prefix++;
2157 if (!*prefix) /* sent @ alone, return the master */
2158 return 0;
2159
2160 if (strcmp("master", prefix) == 0) {
2161 return 0;
2162 } else if (*prefix == '!') {
2163 prefix++;
2164 if (!*prefix)
2165 return -1;
2166
2167 proc_pid = strtol(prefix, &errtol, 10);
2168 if (*errtol != '\0')
2169 return -1;
2170 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002171 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002172 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002173 if (child->pid == proc_pid){
2174 return child->pid;
2175 }
2176 }
2177 } else {
2178 struct mworker_proc *chosen = NULL;
2179 /* this is a relative pid */
2180
2181 proc_pid = strtol(prefix, &errtol, 10);
2182 if (*errtol != '\0')
2183 return -1;
2184
2185 if (proc_pid == 0) /* return the master */
2186 return 0;
2187
2188 /* chose the right process, the current one is the one with the
2189 least number of reloads */
2190 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002191 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002192 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002193 if (child->reloads == 0)
2194 return child->pid;
2195 else if (chosen == NULL || child->reloads < chosen->reloads)
2196 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002197 }
2198 if (chosen)
2199 return chosen->pid;
2200 }
2201 return -1;
2202}
2203
William Lallemandbddd33a2018-12-11 16:10:53 +01002204/* Return::
2205 * >= 0 : number of words to escape
2206 * = -1 : error
2207 */
2208
2209int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2210{
2211 if (argl < 1)
2212 return 0;
2213
2214 /* there is a prefix */
2215 if (args[0][0] == '@') {
2216 int target_pid = pcli_prefix_to_pid(args[0]);
2217
2218 if (target_pid == -1) {
2219 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2220 return -1;
2221 }
2222
2223 /* if the prefix is alone, define a default target */
2224 if (argl == 1)
2225 s->pcli_next_pid = target_pid;
2226 else
2227 *next_pid = target_pid;
2228 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002229 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002230 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002231 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002232
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002233 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002234 channel_shutr_now(&s->req);
2235 channel_shutw_now(&s->res);
2236 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002237 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002238 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2239 memprintf(errmsg, "Permission denied!\n");
2240 return -1;
2241 }
2242 s->pcli_flags &= ~ACCESS_LVL_MASK;
2243 s->pcli_flags |= ACCESS_LVL_OPER;
2244 return argl;
2245
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002246 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002247 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2248 memprintf(errmsg, "Permission denied!\n");
2249 return -1;
2250 }
2251 s->pcli_flags &= ~ACCESS_LVL_MASK;
2252 s->pcli_flags |= ACCESS_LVL_USER;
2253 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002254 }
2255
2256 return 0;
2257}
2258
2259/*
2260 * Parse the CLI request:
2261 * - It does basically the same as the cli_io_handler, but as a proxy
2262 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002263 *
2264 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002265 * - the number of characters to forward or
2266 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002267 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002268int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002269{
William Lallemandbddd33a2018-12-11 16:10:53 +01002270 char *str = (char *)ci_head(req);
2271 char *end = (char *)ci_stop(req);
Willy Tarreauf14c7572021-03-13 10:59:23 +01002272 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002273 int argl; /* number of args */
2274 char *p;
2275 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002276 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002277 int wtrim = 0; /* number of words to trim */
2278 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002279 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002280 int i = 0;
2281
2282 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002283
William Lallemanddc12c2e2018-12-13 09:05:46 +01002284 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002285
2286 /* Looks for the end of one command */
2287 while (p+reql < end) {
2288 /* handle escaping */
2289 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002290 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002291 continue;
2292 }
2293 if (p[reql] == ';' || p[reql] == '\n') {
2294 /* found the end of the command */
2295 p[reql] = '\n';
2296 reql++;
2297 break;
2298 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002299 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002300 }
William Lallemandebf61802018-12-11 16:10:57 +01002301 } else {
2302 while (p+reql < end) {
2303 if (p[reql] == '\n') {
2304 /* found the end of the line */
2305 reql++;
2306 break;
2307 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002308 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002309 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002310 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002311
William Lallemandbddd33a2018-12-11 16:10:53 +01002312 /* set end to first byte after the end of the command */
2313 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002314
William Lallemandbddd33a2018-12-11 16:10:53 +01002315 /* there is no end to this command, need more to parse ! */
2316 if (*(end-1) != '\n') {
2317 return -1;
2318 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002319
William Lallemand3301f3e2018-12-13 09:05:48 +01002320 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2321 if (reql == 1) /* last line of the payload */
2322 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002323 return reql;
2324 }
2325
William Lallemandbddd33a2018-12-11 16:10:53 +01002326 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002327
William Lallemandbddd33a2018-12-11 16:10:53 +01002328 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002329 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002330 /* skip leading spaces/tabs */
2331 p += strspn(p, " \t");
2332 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002333 break;
2334
William Lallemandbddd33a2018-12-11 16:10:53 +01002335 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002336 while (1) {
2337 p += strcspn(p, " \t\\");
2338 /* escaped chars using backlashes (\) */
2339 if (*p == '\\') {
2340 if (!*++p)
2341 break;
2342 if (!*++p)
2343 break;
2344 } else {
2345 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002346 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002347 }
William Lallemandfe249c32020-06-18 18:03:57 +02002348 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002349 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002350 }
2351
William Lallemandbddd33a2018-12-11 16:10:53 +01002352 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002353
Willy Tarreauf14c7572021-03-13 10:59:23 +01002354 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002355 args[i] = NULL;
2356
2357 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2358
2359 /* End of words are ending by \0, we need to replace the \0s by spaces
23601 before forwarding them */
2361 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002362 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002363 if (*p == '\0')
2364 *p = ' ';
2365 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002366 }
2367
William Lallemand3301f3e2018-12-13 09:05:48 +01002368 payload = strstr(str, PAYLOAD_PATTERN);
2369 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2370 /* if the payload pattern is at the end */
2371 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002372 }
2373
William Lallemandbddd33a2018-12-11 16:10:53 +01002374 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002375
William Lallemandbddd33a2018-12-11 16:10:53 +01002376 if (wtrim > 0) {
2377 trim = &args[wtrim][0];
2378 if (trim == NULL) /* if this was the last word in the table */
2379 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002380
William Lallemandbddd33a2018-12-11 16:10:53 +01002381 b_del(&req->buf, trim - str);
2382
William Lallemandb7ea1412018-12-13 09:05:47 +01002383 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002384 } else if (wtrim < 0) {
2385 /* parsing error */
2386 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002387 } else {
2388 /* the whole string */
2389 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002390 }
2391
William Lallemandb7ea1412018-12-13 09:05:47 +01002392 if (ret > 1) {
2393 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2394 goto end;
2395 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002396 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2397 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002398 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002399 ci_insert_line2(req, 0, "user -", strlen("user -"));
2400 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002401 }
2402 }
2403end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002404
William Lallemandb7ea1412018-12-13 09:05:47 +01002405 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002406}
2407
2408int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2409{
William Lallemandbddd33a2018-12-11 16:10:53 +01002410 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002411 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002412 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002413
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002414 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002415 * current one. Just wait. At this stage, errors should be handled by
2416 * the response analyzer.
2417 */
2418 if (s->res.analysers & AN_RES_WAIT_CLI)
2419 return 0;
2420
William Lallemandb7ea1412018-12-13 09:05:47 +01002421 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2422 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2423
William Lallemandcf62f7e2018-10-26 14:47:40 +02002424read_again:
2425 /* if the channel is closed for read, we won't receive any more data
2426 from the client, but we don't want to forward this close to the
2427 server */
2428 channel_dont_close(req);
2429
2430 /* We don't know yet to which server we will connect */
2431 channel_dont_connect(req);
2432
2433
2434 /* we are not waiting for a response, there is no more request and we
2435 * receive a close from the client, we can leave */
2436 if (!(ci_data(req)) && req->flags & CF_SHUTR) {
2437 channel_shutw_now(&s->res);
2438 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2439 return 1;
2440 }
2441
2442 req->flags |= CF_READ_DONTWAIT;
2443
2444 /* need more data */
2445 if (!ci_data(req))
2446 return 0;
2447
2448 /* If there is data available for analysis, log the end of the idle time. */
2449 if (c_data(req) && s->logs.t_idle == -1)
2450 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2451
William Lallemandbddd33a2018-12-11 16:10:53 +01002452 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002453 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002454 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002455 /* enough data */
2456
William Lallemandcf62f7e2018-10-26 14:47:40 +02002457 /* forward only 1 command */
2458 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002459
William Lallemanddc12c2e2018-12-13 09:05:46 +01002460 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002461 /* we send only 1 command per request, and we write close after it */
2462 channel_shutw_now(req);
2463 } else {
2464 pcli_write_prompt(s);
2465 }
2466
2467 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002468 s->res.analysers |= AN_RES_WAIT_CLI;
2469
William Lallemandebf61802018-12-11 16:10:57 +01002470 if (!(s->flags & SF_ASSIGNED)) {
2471 if (next_pid > -1)
2472 target_pid = next_pid;
2473 else
2474 target_pid = s->pcli_next_pid;
2475 /* we can connect now */
2476 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002477
William Lallemanddcbe7b92021-12-10 14:14:53 +01002478 if (!s->target)
2479 goto server_disconnect;
2480
William Lallemandebf61802018-12-11 16:10:57 +01002481 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2482 channel_auto_connect(req);
2483 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002484
2485 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002486 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002487 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002488 goto read_again;
William Lallemandbddd33a2018-12-11 16:10:53 +01002489 } else if (to_forward == -1 && errmsg) {
2490 /* there was an error during the parsing */
2491 pcli_reply_and_close(s, errmsg);
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002492 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemandbddd33a2018-12-11 16:10:53 +01002493 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002494 } else if (to_forward == -1 && channel_full(req, global.tune.maxrewrite)) {
2495 /* buffer is full and we didn't catch the end of a command */
2496 goto send_help;
2497 }
2498
2499 return 0;
2500
2501send_help:
2502 b_reset(&req->buf);
2503 b_putblk(&req->buf, "help\n", 5);
2504 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002505
2506server_disconnect:
2507 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2508 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002509}
2510
2511int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2512{
2513 struct proxy *fe = strm_fe(s);
2514 struct proxy *be = s->be;
2515
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002516 if (rep->flags & CF_READ_ERROR) {
2517 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002518 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002519 s->res.analysers &= ~AN_RES_WAIT_CLI;
2520 return 0;
2521 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002522 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2523 rep->flags |= CF_NEVER_WAIT;
2524
2525 /* don't forward the close */
2526 channel_dont_close(&s->res);
2527 channel_dont_close(&s->req);
2528
William Lallemanddc12c2e2018-12-13 09:05:46 +01002529 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002530 s->res.analysers &= ~AN_RES_WAIT_CLI;
2531 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2532 return 0;
2533 }
2534
William Lallemandcf62f7e2018-10-26 14:47:40 +02002535 /* forward the data */
2536 if (ci_data(rep)) {
2537 c_adv(rep, ci_data(rep));
2538 return 0;
2539 }
2540
2541 if ((rep->flags & (CF_SHUTR|CF_READ_NULL))) {
2542 /* stream cleanup */
2543
William Lallemand2f4ce202018-10-26 14:47:47 +02002544 pcli_write_prompt(s);
2545
William Lallemandcf62f7e2018-10-26 14:47:40 +02002546 s->si[1].flags |= SI_FL_NOLINGER | SI_FL_NOHALF;
2547 si_shutr(&s->si[1]);
2548 si_shutw(&s->si[1]);
2549
2550 /*
2551 * starting from there this the same code as
2552 * http_end_txn_clean_session().
2553 *
2554 * It allows to do frontend keepalive while reconnecting to a
2555 * new server for each request.
2556 */
2557
2558 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002559 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002560 if (unlikely(s->srv_conn))
2561 sess_change_server(s, NULL);
2562 }
2563
2564 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2565 stream_process_counters(s);
2566
2567 /* don't count other requests' data */
2568 s->logs.bytes_in -= ci_data(&s->req);
2569 s->logs.bytes_out -= ci_data(&s->res);
2570
2571 /* we may need to know the position in the queue */
2572 pendconn_free(s);
2573
2574 /* let's do a final log if we need it */
2575 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2576 !(s->flags & SF_MONITOR) &&
2577 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2578 s->do_log(s);
2579 }
2580
2581 /* stop tracking content-based counters */
2582 stream_stop_content_counters(s);
2583 stream_update_time_stats(s);
2584
2585 s->logs.accept_date = date; /* user-visible date for logging */
2586 s->logs.tv_accept = now; /* corrected date for internal use */
2587 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2588 s->logs.t_idle = -1;
2589 tv_zero(&s->logs.tv_request);
2590 s->logs.t_queue = -1;
2591 s->logs.t_connect = -1;
2592 s->logs.t_data = -1;
2593 s->logs.t_close = 0;
2594 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2595 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2596
2597 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2598 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2599
2600 stream_del_srv_conn(s);
2601 if (objt_server(s->target)) {
2602 if (s->flags & SF_CURR_SESS) {
2603 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002604 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002605 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002606 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002607 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002608 }
2609
2610 s->target = NULL;
2611
2612 /* only release our endpoint if we don't intend to reuse the
2613 * connection.
2614 */
2615 if (!si_conn_ready(&s->si[1])) {
2616 si_release_endpoint(&s->si[1]);
2617 s->srv_conn = NULL;
2618 }
2619
Christopher Faulet16f16af2021-10-27 09:34:56 +02002620 sockaddr_free(&s->si[1].dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002621
William Lallemandcf62f7e2018-10-26 14:47:40 +02002622 s->si[1].state = s->si[1].prev_state = SI_ST_INI;
2623 s->si[1].err_type = SI_ET_NONE;
2624 s->si[1].conn_retries = 0; /* used for logging too */
2625 s->si[1].exp = TICK_ETERNITY;
2626 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 +02002627 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 +02002628 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 +02002629 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_ADDR_SET|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
2630 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2631 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
2632 /* reinitialise the current rule list pointer to NULL. We are sure that
2633 * any rulelist match the NULL pointer.
2634 */
2635 s->current_rule_list = NULL;
2636
2637 s->be = strm_fe(s);
2638 s->logs.logwait = strm_fe(s)->to_log;
2639 s->logs.level = 0;
2640 stream_del_srv_conn(s);
2641 s->target = NULL;
2642 /* re-init store persistence */
2643 s->store_count = 0;
2644 s->uniq_id = global.req_count++;
2645
2646 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2647
2648 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2649
William Lallemandcf62f7e2018-10-26 14:47:40 +02002650 s->res.analysers &= ~AN_RES_WAIT_CLI;
2651
2652 /* We must trim any excess data from the response buffer, because we
2653 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002654 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002655 * we want those data to come along with next response. A typical
2656 * example of such data would be from a buggy server responding to
2657 * a HEAD with some data, or sending more than the advertised
2658 * content-length.
2659 */
2660 if (unlikely(ci_data(&s->res)))
2661 b_set_data(&s->res.buf, co_data(&s->res));
2662
2663 /* Now we can realign the response buffer */
2664 c_realign_if_empty(&s->res);
2665
2666 s->req.rto = strm_fe(s)->timeout.client;
2667 s->req.wto = TICK_ETERNITY;
2668
2669 s->res.rto = TICK_ETERNITY;
2670 s->res.wto = strm_fe(s)->timeout.client;
2671
2672 s->req.rex = TICK_ETERNITY;
2673 s->req.wex = TICK_ETERNITY;
2674 s->req.analyse_exp = TICK_ETERNITY;
2675 s->res.rex = TICK_ETERNITY;
2676 s->res.wex = TICK_ETERNITY;
2677 s->res.analyse_exp = TICK_ETERNITY;
2678 s->si[1].hcto = TICK_ETERNITY;
2679
2680 /* we're removing the analysers, we MUST re-enable events detection.
2681 * We don't enable close on the response channel since it's either
2682 * already closed, or in keep-alive with an idle connection handler.
2683 */
2684 channel_auto_read(&s->req);
2685 channel_auto_close(&s->req);
2686 channel_auto_read(&s->res);
2687
2688
2689 return 1;
2690 }
2691 return 0;
2692}
2693
William Lallemand8a022572018-10-26 14:47:35 +02002694/*
2695 * The mworker functions are used to initialize the CLI in the master process
2696 */
2697
William Lallemand309dc9a2018-10-26 14:47:45 +02002698 /*
2699 * Stop the mworker proxy
2700 */
2701void mworker_cli_proxy_stop()
2702{
William Lallemand550db6d2018-11-06 17:37:12 +01002703 if (mworker_proxy)
2704 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002705}
2706
William Lallemand8a022572018-10-26 14:47:35 +02002707/*
2708 * Create the mworker CLI proxy
2709 */
2710int mworker_cli_proxy_create()
2711{
2712 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002713 char *msg = NULL;
2714 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002715
William Lallemandae787ba2021-07-29 15:13:22 +02002716 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002717 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002718 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002719
William Lallemandcf62f7e2018-10-26 14:47:40 +02002720 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002721 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2722 mworker_proxy->timeout.client = 0; /* no timeout */
2723 mworker_proxy->conf.file = strdup("MASTER");
2724 mworker_proxy->conf.line = 0;
2725 mworker_proxy->accept = frontend_accept;
2726 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2727
2728 /* Does not init the default target the CLI applet, but must be done in
2729 * the request parsing code */
2730 mworker_proxy->default_target = NULL;
2731
William Lallemand8a022572018-10-26 14:47:35 +02002732 /* create all servers using the mworker_proc list */
2733 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002734 struct server *newsrv = NULL;
2735 struct sockaddr_storage *sk;
2736 int port1, port2, port;
2737 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002738
William Lallemanda31b09e2020-01-14 15:25:02 +01002739 /* only the workers support the master CLI */
2740 if (!(child->options & PROC_O_TYPE_WORKER))
2741 continue;
2742
William Lallemand8a022572018-10-26 14:47:35 +02002743 newsrv = new_server(mworker_proxy);
2744 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002745 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002746
2747 /* we don't know the new pid yet */
2748 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002749 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002750 else
2751 memprintf(&msg, "old-%d", child->pid);
2752
2753 newsrv->next = mworker_proxy->srv;
2754 mworker_proxy->srv = newsrv;
2755 newsrv->conf.file = strdup(msg);
2756 newsrv->id = strdup(msg);
2757 newsrv->conf.line = 0;
2758
2759 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002760 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002761 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002762 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002763 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002764 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002765
Willy Tarreau5fc93282020-09-16 18:25:03 +02002766 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002767 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002768 }
2769
2770 /* no port specified */
2771 newsrv->flags |= SRV_F_MAPPORTS;
2772 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002773 /* don't let the server participate to load balancing */
2774 newsrv->iweight = 0;
2775 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002776 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002777
2778 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002779 }
William Lallemandae787ba2021-07-29 15:13:22 +02002780
2781 mworker_proxy->next = proxies_list;
2782 proxies_list = mworker_proxy;
2783
William Lallemand8a022572018-10-26 14:47:35 +02002784 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002785
2786error:
William Lallemand744a0892018-11-22 16:46:51 +01002787
2788 list_for_each_entry(child, &proc_list, list) {
2789 free((char *)child->srv->conf.file); /* cast because of const char * */
2790 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002791 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002792 }
William Lallemandae787ba2021-07-29 15:13:22 +02002793 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002794 free(msg);
2795
William Lallemandae787ba2021-07-29 15:13:22 +02002796error_proxy:
2797 ha_alert("%s\n", errmsg);
2798 free(errmsg);
2799
William Lallemand744a0892018-11-22 16:46:51 +01002800 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002801}
Olivier Houchardf886e342017-04-05 22:24:59 +02002802
William Lallemandce83b4a2018-10-26 14:47:30 +02002803/*
William Lallemande7361152018-10-26 14:47:36 +02002804 * Create a new listener for the master CLI proxy
2805 */
2806int mworker_cli_proxy_new_listener(char *line)
2807{
2808 struct bind_conf *bind_conf;
2809 struct listener *l;
2810 char *err = NULL;
2811 char *args[MAX_LINE_ARGS + 1];
2812 int arg;
2813 int cur_arg;
2814
William Lallemand2e945c82019-11-25 09:58:37 +01002815 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002816 args[0] = line;
2817
2818 /* args is a bind configuration with spaces replaced by commas */
2819 while (*line && arg < MAX_LINE_ARGS) {
2820
2821 if (*line == ',') {
2822 *line++ = '\0';
2823 while (*line == ',')
2824 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002825 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002826 }
2827 line++;
2828 }
2829
William Lallemand2e945c82019-11-25 09:58:37 +01002830 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002831
2832 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002833 if (!bind_conf)
2834 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002835
2836 bind_conf->level &= ~ACCESS_LVL_MASK;
2837 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01002838 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02002839
2840 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
2841 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01002842 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002843 }
2844
2845 cur_arg = 1;
2846
2847 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02002848 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01002849 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02002850
2851 kw = bind_find_kw(args[cur_arg]);
2852 if (kw) {
2853 if (!kw->parse) {
2854 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
2855 args[0], args[1], args[cur_arg]);
2856 goto err;
2857 }
2858
Willy Tarreau4975d142021-03-13 11:00:33 +01002859 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02002860 if (err)
2861 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
2862 else
2863 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
2864 args[0], args[1], args[cur_arg]);
2865 goto err;
2866 }
2867
2868 cur_arg += 1 + kw->skip;
2869 continue;
2870 }
2871
Willy Tarreau433b05f2021-03-12 10:14:07 +01002872 best = bind_find_best_kw(args[cur_arg]);
2873 if (best)
2874 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
2875 args[0], args[1], args[cur_arg], best);
2876 else
2877 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
2878 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02002879 goto err;
2880 }
2881
2882
2883 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02002884 l->accept = session_accept_fd;
2885 l->default_target = mworker_proxy->default_target;
2886 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02002887 l->options |= LI_O_UNLIMITED;
2888 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02002889 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002890 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02002891 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01002892 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02002893
2894 return 0;
2895
2896err:
2897 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01002898 free(err);
2899 free(bind_conf);
William Lallemande7361152018-10-26 14:47:36 +02002900 return -1;
2901
2902}
2903
2904/*
William Lallemandce83b4a2018-10-26 14:47:30 +02002905 * Create a new CLI socket using a socketpair for a worker process
2906 * <mworker_proc> is the process structure, and <proc> is the process number
2907 */
2908int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
2909{
2910 struct bind_conf *bind_conf;
2911 struct listener *l;
2912 char *path = NULL;
2913 char *err = NULL;
2914
2915 /* master pipe to ensure the master is still alive */
2916 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
2917 ha_alert("Cannot create worker socketpair.\n");
2918 return -1;
2919 }
2920
2921 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01002922 if (!global.cli_fe) {
2923 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002924 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01002925 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002926 }
2927 }
2928
Willy Tarreau4975d142021-03-13 11:00:33 +01002929 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002930 if (!bind_conf)
2931 goto error;
2932
William Lallemandce83b4a2018-10-26 14:47:30 +02002933 bind_conf->level &= ~ACCESS_LVL_MASK;
2934 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01002935 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02002936
William Lallemandce83b4a2018-10-26 14:47:30 +02002937 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
2938 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01002939 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002940 }
2941
Willy Tarreau4975d142021-03-13 11:00:33 +01002942 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002943 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002944 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01002945 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02002946 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002947 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02002948
2949 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemandce83b4a2018-10-26 14:47:30 +02002950 l->accept = session_accept_fd;
Willy Tarreau4975d142021-03-13 11:00:33 +01002951 l->default_target = global.cli_fe->default_target;
William Lallemanda3372292018-11-16 16:57:22 +01002952 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02002953 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02002954 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02002955 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02002956 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01002957 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02002958 }
2959
2960 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002961
2962error:
2963 close(mworker_proc->ipc_fd[0]);
2964 close(mworker_proc->ipc_fd[1]);
2965 free(err);
2966
2967 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02002968}
2969
William Lallemand74c24fb2016-11-21 17:18:36 +01002970static struct applet cli_applet = {
2971 .obj_type = OBJ_TYPE_APPLET,
2972 .name = "<CLI>", /* used for logging */
2973 .fct = cli_io_handler,
2974 .release = cli_release_handler,
2975};
2976
William Lallemand99e0bb92020-11-05 10:28:53 +01002977/* master CLI */
2978static struct applet mcli_applet = {
2979 .obj_type = OBJ_TYPE_APPLET,
2980 .name = "<MCLI>", /* used for logging */
2981 .fct = cli_io_handler,
2982 .release = cli_release_handler,
2983};
2984
Willy Tarreau0a739292016-11-22 20:21:23 +01002985/* register cli keywords */
2986static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002987 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2988 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2989 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
2990 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
2991 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2992 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL }, // not listed
2993 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
2994 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
2995 { { "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 },
2996 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
2997 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
2998 { { "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 },
2999 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3000 { { "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 },
3001 { { "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 +01003002 { { "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 +02003003 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3004 { { "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 +01003005 {{},}
3006}};
3007
Willy Tarreau0108d902018-11-25 19:14:37 +01003008INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3009
William Lallemand74c24fb2016-11-21 17:18:36 +01003010static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003011 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003012 { 0, NULL, NULL },
3013}};
3014
Willy Tarreau0108d902018-11-25 19:14:37 +01003015INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3016
William Lallemand74c24fb2016-11-21 17:18:36 +01003017static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003018 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3019 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003020 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003021 { NULL, NULL, 0 },
3022}};
3023
Willy Tarreau0108d902018-11-25 19:14:37 +01003024INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003025
3026/*
3027 * Local variables:
3028 * c-indent-level: 8
3029 * c-basic-offset: 8
3030 * End:
3031 */